Snippets

Les snippets sont des bout de code.

Présenté ici de manière volontairement « brute », ces snippets ont vocation à servir d'aide mémoire.

N'hésitez-pas à poser un commentaire si vous rencontrez un problème avec un des éléments.

Vous pouvez utiliser la navigation via les tags présents sur la droite

  • Drupal 8 - ajouter du css ou du javascript à un module

    Posté le Lundi 15 juillet 2019 - 12:21

    Voici comment attacher une librairie javascript ou un fichier css à un module custom dans drupal 8.

    Dans les extraits de code ci-dessous, le nom machine du module sera « shoutbox ».

    Déclaration de la librairie

    1. #shoutbox.libraries.yml
    2.  
    3. # nom de la librairie
    4. shoutbox :
    5.   js:
    6. # chemin vers le fichier relatif au module
    7.   js/shoutbox.js: {}
    8.   css:
    9.   theme :
    10. # chemin vers le fichier relatif au module
    11.   css/administration.css : {}

    Voici comment attacher cette librairies dans un bloc, un preprocess de template ou un controller

    1. // suivant l'endroit ooù l'on attache la librairie, cela peut être $build, $variables...
    2. // la partie avant le slash définie le nom du module qui défini la librairie
    3. // la partie après le slash est le nom de la librairie choisie dans le fichier shoutbox.libraries.yml
    4.  
    5. $variables['#attached']['library'][] = 'shoutbox/shoutbox';

     

  • Drupal 8 - Surcharger la classe de contrôle d'accès d'un type d'entité

    Posté le Jeudi 11 juillet 2019 - 16:04
    Dernière mise à jour le Jeudi 11 juillet 2019 - 19:38

    Sous drupal 8, les types d'entités, comme les noeuds, viennent avec leur classe pour gérer le contrôle d'accès (création / modification / visualisation / suppression).

    Il est possible de surcharger ces classes pour personnaliser plus finement ce contrôle.

    Nous allons ici surcharger le contrôle d'accès pour un type d'entité « shoutbox », mais c'est le même principe pour les nodes.

    1. # mon_module.module
    2. function mon_module_entity_type_alter(array &$entity_types) {
    3. $entity_types['shoutbox']->setHandlerClass('access', \Drupal\mon_module\Entity\AccessControlHandler\CustomShoutboxAccessControlHandler::class);
    4. // Note : si on avait voulu surcharger le controle d'accès aux noeuds :
    5. // $entity_types['node']->setHandlerClass('access', \Drupal\mon_module\Entity\AccessControlHandler\CustomNodeAccessControlHandler::class);
    6. }

    La classe en elle même, qui étant la classe de contrôle d'accès de base (définie dans l'annotation de notre type d'entité)

    1. # mon_module/src/Entity/AccessControlHandler/CustomShoutboxAccessControlHandler.php
    2. <?php
    3.  
    4. namespace Drupal\mon_module\Entity\AccessControlHandler;
    5.  
    6. use Drupal\Core\Access\AccessResult;
    7. use Drupal\Core\Entity\EntityInterface;
    8. use Drupal\Core\Session\AccountInterface;
    9. use Drupal\shoutbox\Entity\AccessControlHandler\ShoutboxAccessControlHandler;
    10. use Drupal\shoutbox\Entity\Shoutbox;
    11. use Drupal\user\Entity\User;
    12.  
    13. class CustomShoutboxAccessControlHandler extends ShoutboxAccessControlHandler {
    14.  
    15. protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
    16. /** @var Shoutbox $entity */
    17. if($operation === 'view' && $this->testPerso()) {
    18. if (!$entity->isPublished()) {
    19. return AccessResult::allowedIfHasPermission($account, 'administer shoutbox');
    20. }
    21. if ($this->autreTest()) {
    22. return AccessResult::allowed();
    23. }
    24. return AccessResult::forbidden('Shoutbox privée');
    25. }
    26. return parent::checkAccess($entity, $operation, $account);
    27. }
    28.  
    29. }

    Ici je ne fais un contrôle d'accès que sur l'opération « view » pour la visualisation, je délègue tout le reste à la classe mère.

  • Github - transformer une pull request en patch

    Posté le Lundi 8 juillet 2019 - 12:00

    Petite astuce que beaucoup doivent déjà connaître mais que j'ai (re)découverte, il est très facile de transformer une pull request de github en patch.

    Il suffit de prendre l'url de la PR et d'ajouter .patch à la fin.

    Exemple, pour avoir le patch de https://github.com/hechoendrupal/drupal-console/pull/4013 : https://github.com/hechoendrupal/drupal-console/pull/4013.patch

    Et ce patch peut ensuite être utilisé manuellement ou dans notre fichier composer.json.

  • Drupal 8 - Utiliser les redirections de Redirect sur une page dépubliée

    Posté le Lundi 8 juillet 2019 - 08:52

    Dans le cas d'une page dé-publiée, si en tant qu'anonyme on tombe sur une erreur 403. On peut vouloir rediriger cette page temporairement vers une autre via le module redirect, mais nativement ça n'est pas pris en compte.

    Voici un petit EventSubscriber qui répond sur les erreurs 403, qui teste si une redirection existe pour le nœud courant, et dans ce cas redirige l'utilisateur.

    Note : Un administrateur ayant la permission pour voir le contenu dé-publié ne sera pas redirigé, car aucune erreur 403 ne sera lancée et donc l'event subscriber ne sera pas appelé.

    Note 2 : C'est un bout de code qui semble fonctionnel, fonctionne avec le multilingue mais qui est certainement perfectible. N'hésitez-pas à me faire vos remarques.

    1 - Déclaration de l'event subscriber :

    1. #mon_module.services.yml
    2.  
    3.   mon_module.redirector:
    4.   class: Drupal\mon_module\EventSubscriber\Redirector
    5.   tags:
    6.   - { name: event_subscriber }

    2 - Définition de l'event subscriber 

    1. # web/modules/custom/mon_module/src/EventSubscriber/Redirector.php
    2. <?php
    3.  
    4. namespace Drupal\mon_module\EventSubscriber;
    5.  
    6. use Drupal\Core\EventSubscriber\HttpExceptionSubscriberBase;
    7. use Drupal\redirect\RedirectRepository;
    8. use Drupal\node\Entity\Node;
    9. use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
    10. use Symfony\Component\HttpFoundation\RedirectResponse;
    11.  
    12. class Redirector extends HttpExceptionSubscriberBase {
    13.  
    14. /**
    15.   * {@inheritdoc}
    16.   */
    17. protected function getHandledFormats() {
    18. return ['html'];
    19. }
    20.  
    21. public function on403(GetResponseForExceptionEvent $event) {
    22. if ($event->getRequest()->attributes->get('node') !== NULL) {
    23. $nid = \Drupal::routeMatch()->getRawParameter('node');
    24. $langcode = \Drupal::languageManager()->getCurrentLanguage()->getId();
    25. /** @var RedirectRepository $redirectRepository */
    26. $redirectRepository = \Drupal::service('redirect.repository');
    27. $node = Node::load($nid);
    28. if ($node !== NULL && $node->hasTranslation($langcode) && $translation = $node->getTranslation($langcode)) {
    29. if (!$translation->isPublished()) {
    30. $alias = \Drupal::service('path.alias_manager')->getAliasByPath('/node/' . $nid);
    31. $redirection = $redirectRepository->findMatchingRedirect($alias, [], $langcode);
    32. if($redirection) {
    33. $event->setResponse(new RedirectResponse($redirection->getRedirectUrl()->toString(), $redirection->getStatusCode()));
    34. }
    35. }
    36. }
    37. }
    38. }
    39.  
    40. }

     

  • Drupal 8 - Surcharger la classe de formulaire d'un terme de taxonomie

    Posté le Vendredi 5 juillet 2019 - 10:22

    Hier, nous avons vu comment surcharger le formulaire de création / modification d'un nœud, voici aujourd'hui comment faire la même chose mais pour un terme de taxonomie.

    Cela se passe encore en deux étapes.

    1 - Altération du type d'entité

    1. # mon_module.module
    2. function mon_module_entity_type_alter(array &$entity_types) {
    3. $entity_types['taxonomy_term']->setFormClass('default', Drupal\mon_module\Entity\Form\CustomTermForm::class);
    4. }

    2 - Classe du formulaire

    1. # web/modules/mon_module/src/Entity/Form/CustomTermForm.php
    2. <?php
    3.  
    4. namespace Drupal\mon_module\Entity\Form;
    5.  
    6. use Drupal\Core\Form\FormStateInterface;
    7. use Drupal\taxonomy\TermForm;
    8.  
    9. class CustomTermForm extends TermForm {
    10. public function form(array $form, FormStateInterface $form_state) {
    11. $form = parent::form($form, $form_state);
    12. /** @var \Drupal\taxonomy\Entity\Term $term */
    13. $term = $this->entity;
    14. if($term->getVocabularyId() === 'mon_vocabulaire') {
    15. // À vous de jouer
    16. }
    17. return $form;
    18. }
    19.  
    20. }

     

  • Drupal 8 - Surcharger la classe de formulaire d'un nœud

    Posté le Jeudi 4 juillet 2019 - 10:17
    Dernière mise à jour le Jeudi 4 juillet 2019 - 11:36

    Pour modifier le formulaire de création d'un nœud sous drupal 8, on peut utiliser le bon vieux HOOK_form_alter(), mais on peut aussi faire quelque chose de plus « propre » en altérant le type d'entité pour redéfinir son formulaire.

    Cela se passe en deux étapes.

    1 - Altération du type d'entité

    1. # mon_module.module
    2. function mon_module_entity_type_alter(array &$entity_types) {
    3. $entity_types['node']->setFormClass('default', \Drupal\mon_module\Entity\Form\NodeCustomForm::class);
    4. $entity_types['node']->setFormClass('edit', \Drupal\mon_module\Entity\Form\NodeCustomForm::class);
    5. }

    2 - Classe du formulaire

    1. # web/modules/mon_module/src/Entity/Form/NodeCustomForm.php
    2. <?php
    3.  
    4. namespace Drupal\mon_module\Entity\Form;
    5.  
    6. use Drupal\Core\Form\FormStateInterface;
    7. use Drupal\node\NodeForm;
    8.  
    9. class NodeCustomForm extends NodeForm {
    10.  
    11. public function form(array $form, FormStateInterface $form_state) {
    12. $form = parent::form($form, $form_state);
    13. // Faite votre magie ici
    14. /** @var \Drupal\node\Entity\Node $node */
    15. $node = $this->entity;
    16. return $form;
    17. }
    18.  
    19. }

    Cette classe étant la classe normale, nous avons donc juste à appliquer nos modifications à l'intérieur.

    Le problème de cette solution : on ne peut pas avoir deux modules qui surchargent la classe, à moins d'étendre la première dans la seconde.

  • Drupal 8 - rendre un formulaire dans un template

    Posté le Mercredi 5 juin 2019 - 09:36
    Dernière mise à jour le Mercredi 5 juin 2019 - 10:48

    La form api de drupal est très puissante, mais pour jouer avec le markup html avec les #prefix et #suffix peut s'avérer rapidement complexe en plus d'être un peu sale au niveau du code.

    Dans drupal 8 il est possible de facilement utiliser un template pour un formulaire. Pour cela il faut se baser sur le nom machine du formulaire.

    Cela fonctionne pour nos formulaires custom, mais aussi pour les formulaires des modules tiers ou du core. Je vais ici utiliser un template pour le formulaire user_form qui correspond au formulaire de modification du compte utilisateur. Le nom machine de ce formulaire est user_form.

    Définition du template :

    Fichier : mon_module.module

    1. function mon_module_theme() {
    2. $theme = [];
    3. $theme['user_form'] = [
    4. 'render element' => 'form',
    5. 'template' => 'user-form',
    6. ];
    7. return $theme;
    8. }

    J'utilise comme clé de thème le nom machine du formulaire.

    Je peux ensuite créer dans le dossier templates de mon thème le fichier user-form.html.twig : (attention au _ remplacé par un -)

    1. <div>
    2. <p>Test</p>
    3. {{ form }}
    4. <div>

    On peut rendre des champs « manuellement », mais il ne faut pas oublier de rendre le formulaire form à la fin : 

    1. <div>
    2. <p>Test</p>
    3. <div class="col-sm-6">
    4. {{ form.mon_champ_1 }}
    5. </div>
    6. <div class="col-sm-6">
    7. {{ form.mon_champ_2 }}
    8. </div>
    9. {{ form | without('mon_champ_1', 'mon_champ_2') }}
    10. <div>

     

  • Drupal 8 - Créer un Event, le lancer et l'intercepter

    Posté le Mardi 4 juin 2019 - 11:55

    Dans Drupal 8, le principe des hooks a été remplacé par un système d'évènement qui est lancé et peut être intercepté, cela se passe en 3 étapes :

    1. Création de l'évènement (classe étendant la classe Event)
    2. Lancer l'évènement
    3. Interception de l'évènement (Classe étendant l'interface EventSubscriberInterface)

    Pour cette évènement, nous allons prendre le contexte de mon site de pronostics sportifs. Je veux lancer un évènement quand un utilisateur fait ses pronostics

    Création de l'évènement

    Fichier : mon_module/src/Event/UserBetEvent.php

    1. <?php
    2.  
    3. namespace Drupal\mon_module\Event;
    4.  
    5. use Drupal\mespronos\Entity\Day;
    6. use Drupal\user\UserInterface;
    7. use Symfony\Component\EventDispatcher\Event;
    8.  
    9. class UserBetEvent extends Event {
    10.  
    11. const EVENT_NAME = 'mespronos_user_bet';
    12.  
    13. /**
    14.   * The user account.
    15.   *
    16.   * @var \Drupal\user\UserInterface
    17.   */
    18. public $account;
    19.  
    20. /**
    21.   * The Day the user has bet on
    22.   *
    23.   * @var Day
    24.   */
    25. public $day;
    26.  
    27. public function __construct(UserInterface $account, Day $day) {
    28. $this->account = $account;
    29. $this->day = $day;
    30. }
    31.  
    32. }

    Cette classe est relativement simple, on défini les attributs que l'on veut rendre disponibles lors de l'interception de cet évènement, ici, l'objet User de l'utilisateur qui aura pronostiqué et la journée ($day) de compétition sur laquelle il aura fait ses pronostics.

    Dispatch de l'évènement

    Le code suivant est à placer là où vous souhaiter lancer l'évènement, dans mon cas il s'agit de la méthode submit de mon formulaire de pronostics :

    1. $event = new UserBetEvent($user, $day);
    2. $event_dispatcher = \Drupal::service('event_dispatcher');
    3. $event_dispatcher->dispatch(UserBetEvent::EVENT_NAME, $event);

    Évidement, il ne faut pas oublier de passer les paramètres que l'on a défini dans le constructeur de notre évènement (ici $user et $day)

    Interception de l'évènement

    Définition du subscriber

    Fichier : mon_autre_module/mon_autre_module.services.yml

    1. mon_autre_module.mespronos_user_bet:
    2.   class: 'Drupal\mon_autre_module\EventSubscriber\UserBetSubscriber'
    3.   tags:
    4.   - { name: 'event_subscriber' }

    Code du subscriber

    Fichier : mon_autre_module/src/EventSubscriber/UserBetSubscriber.php

    1. <?php
    2.  
    3. namespace Drupal\mon_autre_module\EventSubscriber;
    4.  
    5. use Drupal\mespronos\Event\UserBetEvent;
    6. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
    7.  
    8. class UserBetSubscriber implements EventSubscriberInterface {
    9.  
    10. public function onBet(UserBetEvent $event) {
    11. // On peut récuperer les attributs de l'évènement
    12. $user = $event->account;
    13. $day = $event->day;
    14.  
    15. // À vous de faire ce que vous voulez ici
    16. }
    17.  
    18. public static function getSubscribedEvents() {
    19. // Définition du ou des évènements que l'on écoute et méthode à executer
    20. return [
    21. UserBetEvent::EVENT_NAME => 'onBet',
    22. ];
    23. }
    24.  
    25. }

     

  • Drupal 8 - rejouer une fonction d'update

    Posté le Mardi 28 mai 2019 - 09:26

    Drupal tient un registre des versions des modules installés, ces versions correspondent au dernier numéro du hook_update exécuté du module.

    Si par exemple vous venez de lancer le hook 8301 du module field_group et que vous souhaitez le relancer, alors il faudra passer le module en version 8300.

    Voila comment faire avec drush :

    1. drush ev "drupal_set_installed_schema_version('field_group', 8300)"

     

  • Drupal 8 - Exemple d'utilisation simple du cache

    Posté le Mercredi 15 mai 2019 - 12:18

    Drupal 8 propose un système de cache très puissant et à plusieurs niveaux.

    Ici nous allons voir comment stocker simplement le résultat d'une requête en cache afin de ne pas avoir à la lancer la requête SQL à chaque appel.

    Commençons par définir notre « conteneur » de cache dans le fichier mon_module.services.yml :

    1. cache.mon_module:
    2.   class: Drupal\Core\Cache\CacheBackendInterface
    3.   tags:
    4.   - { name: cache.bin }
    5.   factory: cache_factory:get
    6.   arguments: [mon_module]

    mon_module sera le nom de notre conteneur de cache.

    Cela permettra de distinguer les données que nous mettrons dedans et de ne pas écraser d'autres caches d'autres modules. Si vous utilisez le cache en base de données (par défaut) vous verrez qu'une nouvelle table cache_mon_module a été créée.

    Ensuite voici un exemple de lecture du cache, et d'écriture si la donnée n'est pas présente :

    1. public function getVersion() {
    2. // On teste si la clé « database.version » est présente dans le conteneur de cache « mon_module »
    3. if ($results = \Drupal::cache('mon_module')->get('database.version')) {
    4. // Si c'est le cas, les données stockées sont dans l'attribut « data »
    5. return $results->data;
    6. }
    7. // Sinon on effectue la requête désirée
    8. $version = $this->connection->select('version', 'v')->fields('v', ['version'])->execute()->fetch();
    9. // Et on met la valeur en cache
    10. \Drupal::cache('mon_module')->set('database.version', $version->version);
    11.  
    12. return $version->version;
    13. }

    Il est possible aussi de donner date d'expiration afin que cette clé de cache ne soit plus valable une fois cette date passée :

    1. // cache valable 1 h (3600 secondes)
    2. \Drupal::cache('mon_module')->set('database.version', $version->version, date('U') + 3600);