{"componentChunkName":"component---src-templates-post-jsx","path":"/fr/event-api","result":{"data":{"markdownRemark":{"html":"

Depuis toujours , Drupal fournit une multitude de hooks qui donnent la possibilité de procéder à un traitement spécifique lié à une action donnée.

\n

Avant d'attaquer l'Api Event, Il faut préciser que les hooks ne sont que des fonctions PHP qui permettent d’interagir avec le cœur, les modules ainsi que les thèmes de Drupal.

\n

Exemple des hooks:

\n
/**\n * Implements hook_ENTITY_insert().\n *\n */\nfunction hook_entity_insert(Drupal\\Core\\Entity\\EntityInterface $entity) {  \n  if ($entity->getEntityType()->id() == 'node' && $entity->bundle() == \"article\") {  \n   $entity->setTitle($entity->label() . ' ' . date(\"Y/m/d\"));  \n   $entity->save();  \n  }  \n}
\n

Dans cet exemple, le hookENTITYinsert nous a permis d'interagir avec l'entité Node, en modifiant cette dernière avant qu'elle soit sauvegardée dans la base de donnée.\nIl faut pas nier que le système des hooks est surpuissant, vous allez vous demander pourquoi alors adopter l'API Event !

\n

Après l'arrivée de Drupal 8 ....

\n

Comme on l'avait vu dans la section précédente; le système des hooks à fait ses preuves dans les anciennes versions de Drupal, mais avec l'arrivée de Drupal 8, le plus grand défi était de refaire le CMS d'une façon à ce qu'il adopte le paradigme d'orienté objet, dans ce cadre Drupal a introduit l'API Event de Symfony dans sa version 8 toute en gardant le système des hooks qui est supposé être totalement supprimer dans la version 9 de Drupal.

\n

Mais comment peut-on utiliser l'API Event sur Drupal 8 ?

\n

Théoriquement, il existe un registre d'événements appelé Event Registry

\n\n

Un pas vers la pratique de l'API Event :)

\n

1. Event dispatcher

\n

Comme on l'avait déjà cité, l'API Event nous permet de propager un événement dans notre site afin qu'on puisse l'écouter par un listener

\n

Créons ensemble notre module Custom events qui va contenir tous nos travaux sur l'Event API:

\n
custom_events.info.yml
\n
name: Custom events\ntype: module\ndescription: Example events distpacher and subscriber.\ncore: 8.x\t\npackage: Custom
\n

Comment définir notre propre Événement ?

\n

Il faut définir la classe d'événement dans le répertoire src/Event dans la racine du module, dans notre cas c'est custom_events/src/Event/ExampleEvent.php :

\n
<?php  \n  \nnamespace Drupal\\project\\Event;  \n  \nuse Symfony\\Component\\EventDispatcher\\Event;  \n  \nclass ExampleEvent extends Event  \n{  \n  const SUBMIT = 'event.submit';  \n protected $referenceID;  \n  \n public function __construct($referenceID)  \n {  $this->referenceID = $referenceID;  \n  }  \n  \n  public function getReferenceID()  \n {  return $this->referenceID;  \n  }  \n  \n  public function myEventMessage()  \n {  return \"Ceci est un exemple d'événement.\";  \n  }  \n}
\n\n

Comment DISPATCHER notre événement ?

\n

C'est ici que se cache la puissance de API Event, notre événement peut être propager n'importe où dans notre application, comment? voyons voir ensemble :

\n
<?php\n\n// On utilise le namespace de notre event (ExampleEvent)\nuse Drupal\\example_events\\ExampleEvent;\n\n// On charge le service event_dispatcher\n$dispatcher = \\Drupal::service('event_dispatcher');\n\n// On crée une nouvelle instance de notre event (ExampleEvent) \n$event = new ExampleEvent($form_state->getValue('name'));\n\n// On dispatche l'événement via la méthode \"dispatch\" et on passe dedant le nom de l'événement qu'on souhaite propager et l'objet d'événement '$event' comme paramètre. \n\n$dispatcher->dispatch(ExampleEvent::SUBMIT, $event);
\n

Le code snippet si-dessus montre comment dispatcher un événement n'importe où dans notre site.

\n

Dans ce tutoriel, on va créer un formulaire dans lequel on dispatchera notre événement et plus précisément dans le callback submitForm, on verra ça toute de suite :

\n
<?php  \n/**  \n * @file  \n  * Contains \\Drupal\\example_events\\Form\\DemoEventDispatchForm.  \n */\nnamespace Drupal\\project\\Form;  \nuse Drupal\\Core\\Form\\FormBase;  \nuse Drupal\\Core\\Form\\FormStateInterface;  \nuse Drupal\\example_events\\Event\\ExampleEvent;  \n/**  \n * Class DemoEventDispatchForm. \n *  \n * @package Drupal\\example_events\\Form  \n */\n class EventDispatchForm extends FormBase {  \n  /**  \n * {@inheritdoc}  \n */  \n public function getFormId() {  \n  return 'event_dispatch_form';  \n  }  \n  /**  \n * {@inheritdoc}  \n */  \n public function buildForm(array $form, FormStateInterface $form_state) {  \n  $form['reference'] = array(  \n  '#type' => 'textfield',  \n  '#title' => $this->t('Reference'),  \n  '#description' => $this->t(\"Veuillez écrire quelque chose qui servira comme object d'événement\"),  \n  '#maxlength' => 64,  \n  '#size' => 64,  \n  );  \n  $form['dispatch_action'] = array(  \n  '#type' => 'submit',  \n  '#value' => $this->t('Dispatcher'),  \n  );  \n return $form;  \n  }  \n \n /**  \n * {@inheritdoc}  \n */  \n public function submitForm(array &$form, FormStateInterface $form_state) {  \n  \n  // On dispatche notre événement\n  $dispatcher = \\Drupal::service('event_dispatcher');  \n  $event = new ExampleEvent($form_state->getValue('reference'));  \n  $dispatcher->dispatch(ExampleEvent::SUBMIT, $event);  \n  }  \n}
\n

Il est temps de créer notre première Route sur laquelle on affichera notre formulaire:

\n
example_events.event_dispatcher_form:  \n  path: 'event-dispatch-form'  \n  defaults:  \n    _form: '\\Drupal\\example_events\\Form\\EventDispatchForm'  \n  _title: 'Event Dispatcher Form'  \n  requirements:  \n    _permission: 'access content'
\n

Parfait, jusqu'ici nous avons réussi à créer notre Event et le dispatcher une fois que notre formulaire est enregistré (submitForm callback).

\n

2. Event Subscriber

\n

Comment souscrire à notre événement ?

\n

2.1 Création de la classe de l'Event Subscriber
\nRegardons ensemble maintenant comment on peut souscrire à l'événement qu'on a déjà créé (ExampleEvent).

\n

Pour souscrire à un événement existant, il faudra créer la classe de l'Event Subscriber sur /ModuleRacine/src/EventSubscriber/, dans notre example c'est sur /example_events/src/EventSubscriber/ExampleEventSubscriber

\n
<?php  \n/**  \n * @file  \n  * Contains \\Drupal\\project\\ExampleEventSubscriber.  \n */\nnamespace Drupal\\example_events\\EventSubscriber;  \nuse Drupal\\Core\\Config\\ConfigCrudEvent;  \nuse Drupal\\Core\\Config\\ConfigEvents;  \nuse Drupal\\example_events\\Event\\ExampleEvent;  \nuse Symfony\\Component\\EventDispatcher\\EventSubscriberInterface;  \n\n/**  \n * Class ExampleEventSubscriber. \n */\nclass ExampleEventSubscriber implements EventSubscriberInterface {  \n\n  /**  \n * {@inheritdoc}  \n */  \npublic static function getSubscribedEvents() {  \n\treturn [ \n\t  ConfigEvents::SAVE => ['savingConfig', 800],  \n\t  ExampleEvent::SUBMIT => array('executeAction', 800)  \n\t ];\n }  \n  \n /**  \n * Subscriber Callback for the event. \n */  \npublic function executeAction(ExampleEvent $event) {  \n \\Drupal::messenger()->addStatus(t(\"Vous avez souscrit à l'événement ExampleEvent qui a été dispatché lors de l'enregistrement du formulaire avec \" . $event->getReferenceID() . \" comme référence \"));  \n  }  \n  \n /**  \n * Subscriber Callback for the event.\n */  \n \npublic function savingConfig(ConfigCrudEvent $event) {  \n \\Drupal::messenger()->addStatus(t(\"La configuration \" . $event->getConfig()->getName() . \" a été sauvegardée\"));  \n  }  \n}
\n

Top, regardons ensemble ce qu'on a fait dans cette classe :

\n\n

Vous allez certainement vous demander d’où vient ConfigEvents::SAVE; c'est un événement existant par défaut dispatché par le cœur de Drupal.\nC'est une bonne pratique de définir les nouveaux événements qu'on est entrain de créer comme des constantes pour qu'ils soient globalement disponibles dans notre classe.

\n

2.2 Taguer la classe de l'Event Subscriber par event_subscriber

\n
services:\nexample_events.event_subscriber_example:\nclass: Drupal\\example_events\\EventSubscriber\\ExampleEventSubscriber\ntags:\n- { name: 'event_subscriber' }
\n

Ci-dessus nous avons créer notre premier service example_events.event_subscriber_example dans example_events.services.yml et on a tagué ce dernier par event_subscriber, comme ça notre service est enregistré comme un EventSubscriber dans le service container.

\n

Voici à quoi ressemble notre formulaire après enregistrement d'une référence:

\n

\n

Code source du module disponible sur Github :)

","excerpt":"Depuis toujours , Drupal fournit une multitude de hooks qui donnent la possibilité de procéder à un traitement spécifique lié à une action donnée. Avant d…","frontmatter":{"date":"2019-11-24","metaDate":"2019-11-24","title":"Event API","tags":["Event API","Hooks","Drupal 8","Module development"],"path":"/event-api","cover":{"childImageSharp":{"fluid":{"base64":"data:image/jpeg;base64,/9j/2wBDABALDA4MChAODQ4SERATGCgaGBYWGDEjJR0oOjM9PDkzODdASFxOQERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVGC8aGi9jQjhCY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2P/wgARCAANABQDASIAAhEBAxEB/8QAFwAAAwEAAAAAAAAAAAAAAAAAAAECBf/EABcBAAMBAAAAAAAAAAAAAAAAAAABAgT/2gAMAwEAAhADEAAAAcu5nbDGM//EABcQAQADAAAAAAAAAAAAAAAAAAAQIUL/2gAIAQEAAQUCnKn/xAAVEQEBAAAAAAAAAAAAAAAAAAAAEf/aAAgBAwEBPwGI/8QAFREBAQAAAAAAAAAAAAAAAAAAABH/2gAIAQIBAT8Bqv/EABUQAQEAAAAAAAAAAAAAAAAAABAR/9oACAEBAAY/Amv/xAAbEAACAwADAAAAAAAAAAAAAAAAAREhMUFRkf/aAAgBAQABPyFIgZas1kvOBdk/T//aAAwDAQACAAMAAAAQzw//xAAVEQEBAAAAAAAAAAAAAAAAAAAQIf/aAAgBAwEBPxCh/8QAFREBAQAAAAAAAAAAAAAAAAAAECH/2gAIAQIBAT8Qkf/EABoQAQEBAQEBAQAAAAAAAAAAAAERACFBMWH/2gAIAQEAAT8Q/LFhJ324A5Th+hhjpKqGsdDfpG//2Q==","aspectRatio":1.5,"src":"/static/02c52a6255ab81e19850d39b206f6662/88110/listener.jpg","srcSet":"/static/02c52a6255ab81e19850d39b206f6662/0b320/listener.jpg 480w,\n/static/02c52a6255ab81e19850d39b206f6662/60b32/listener.jpg 960w,\n/static/02c52a6255ab81e19850d39b206f6662/88110/listener.jpg 1920w,\n/static/02c52a6255ab81e19850d39b206f6662/40175/listener.jpg 2880w,\n/static/02c52a6255ab81e19850d39b206f6662/e58c2/listener.jpg 3840w,\n/static/02c52a6255ab81e19850d39b206f6662/4bfbc/listener.jpg 6240w","srcWebp":"/static/02c52a6255ab81e19850d39b206f6662/d1a9d/listener.webp","srcSetWebp":"/static/02c52a6255ab81e19850d39b206f6662/bc3bf/listener.webp 480w,\n/static/02c52a6255ab81e19850d39b206f6662/39337/listener.webp 960w,\n/static/02c52a6255ab81e19850d39b206f6662/d1a9d/listener.webp 1920w,\n/static/02c52a6255ab81e19850d39b206f6662/fcbe1/listener.webp 2880w,\n/static/02c52a6255ab81e19850d39b206f6662/c136d/listener.webp 3840w,\n/static/02c52a6255ab81e19850d39b206f6662/5aa0d/listener.webp 6240w","sizes":"(max-width: 1920px) 100vw, 1920px"},"resize":{"src":"/static/02c52a6255ab81e19850d39b206f6662/c4f3a/listener.jpg"}}}}}},"pageContext":{"isCreatedByStatefulCreatePages":false,"pathSlug":"/event-api","locale":"fr","prev":null,"next":{"fields":{"locale":"fr"},"frontmatter":{"path":"/cache-api","title":"Cache API","tags":["Cache","Performance","Module development","Drupal 8"]}}}}}