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 - 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);

     

  • Drupal - Drush - Appeler un script php et lui passer un argument

    Posté le Mardi 14 mai 2019 - 07:24

    Il est possible via drush d’exécuter un script php et de profiter de toute l'API de drupal pour effectuer des traitements (création / suppression de contenu, modification, import de traductions...)

    On utilise pour cela la commande drush php-script en lui passant le chemin vers le script relatif à la racine de drupal :

    1. # Exemple d'appel d'un script
    2. drush @alias php-script ../scripts/process/import-translations.php

    Mais il est aussi possible de passer des arguments à ce script :

    1. #Je passe ici le chemin vers le fichier à importer
    2. drush @alias php-script ../scripts/process/import-translations.php --file=../files/translations/imports/2019-05-14-translations.csv

    Et voici comment le récupérer dans notre script drush :

    1. # Récupération du paramètre file
    2. $file = drush_get_option('file');

    À noter que l'on peut aussi fournir une valeur par défaut :

    1. # ici, si --lang n'est pas passé lors de l'appel du script
    2. # alors $lang prendra la valeur « en »
    3.  
    4. $lang = drush_get_option('lang', 'en');

     

    Tags

  • Drupal 8 - Se connecter à une base de données tierce

    Posté le Lundi 13 mai 2019 - 13:52

    Outre la base de données « classique » de drupal, il est aussi possible de se connecter à une autre base de données.

    Pour cela dans le fichier de settings il faut définir les identifiants :

    1. $databases['seconde_db'] = $databases['default'];
    2. $databases['seconde_db']['default']['host'] = 'HOST_SECONDE_DB';
    3. $databases['seconde_db']['default']['database'] = 'SECONDE_DB';
    4. $databases['seconde_db']['default']['username'] = 'USER_SECONDE_DB';
    5. $databases['seconde_db']['default']['password'] = 'PASSWORD_SECONDE_DB';

    Ensuite dans le code de notre drupal on peut sélectionner cette seconde base de données :

    1. # On sélectionne la base secondaire
    2. Database::setActiveConnection('seconde_db');

    Pour ensuite effectuer les requêtes que l'on souhaite, via la database API de drupal.

    Attention à la fin ne pas oublier de rebasculer sur la base de données par défaut afin de ne pas casser tout le drupal :

    1. # On bascule sur la base de données par défaut
    2. Database::setActiveConnection();

     

  • Optimiser les tâches lourdes de composer avec Drupal

    Posté le Dimanche 12 mai 2019 - 18:37

    Une petite dépendance à ajouter à son composer.json qui permet d'économiser pas mal de ram lors des taches lourdes de composer (update notamment)

    1. composer require zaporylie/composer-drupal-optimizations:^1.1

    Simplement en supprimant des anciens tags des package de symfony, cela peut diviser par deux la mémoire vive nécessaire.

    Plus d'informations : https://github.com/zaporylie/composer-drupal-optimizations

     

  • Gitlab CI - Ne lancer une tâche que lorsque que certains fichiers sont modifiés

    Posté le Samedi 4 mai 2019 - 13:09

    J’utilise énormément la partie « CI » de Gitlab pour déployer automatiquement les sites et applications web que je gère.

    Lors d’une formation sur le sujet, nous avons avec mon stagiaire mis en place une condition à l’exécution d’une tâche (job). Le but était de ne lancer la tache gulp en charge de générer les fichiers CSS et javascript uniquement si un des fichiers sources (sass ou js) était modifié, et non plus à chaque déploiement.

    Voici la définition de la tâche en question dans le fichier .gitlab-ci.yaml

    1. prod_generate_assets:
    2.   image: node:10.15.2
    3.   script:
    4. - npm install -g gulp
    5. - npm install --silent
    6. - gulp build
    7. - ...
    8.   only:
    9.   refs:
    10. - master
    11.   changes:
    12. - web/themes/custom/**/*.scss
    13. - web/themes/custom/**/*.js
    14.   except:
    15.   refs:
    16. - schedules
    17.   stage : postdeploy

    Ainsi avec la directive changes, cette tâche ne sera lancée que si un fichier *.scss ou *.js est modifié dans un des thèmes du dossier custom.

    Un petit bonjour à Adrien, si tu tombes sur ces lignes !

     

  • Drupal 8 - Créer un fichier avec le « résultat » d'un template

    Posté le Samedi 27 avril 2019 - 11:35

    Voici comment écrire un fichier dans drupal 8 :

    1. $sitemaps_path = 'public://sitemaps/';
    2. // création du dossier
    3. if(file_prepare_directory($sitemaps_path, FILE_CREATE_DIRECTORY)) {
    4. // écriture du fichier (s'il existe, on le remplace)
    5. file_save_data($content, $sitemaps_path . 'sitemap.xml', FILE_EXISTS_REPLACE);
    6. }
    7. else {
    8. \Drupal::logger('sitemap')->error(t('Problem creating the folder @folder', ['@folder' => $sitemaps_path]));
    9. }

    Imaginons que l'on veuille écrire dans un fichier le contenu d'un renderable array voici comment l'on définit $content :

    1. $datas = [
    2. '#theme' => 'xml_sitemap',
    3. '#urls' => [
    4. ['title' => 'test'],
    5. ['title' => 'test 2'],
    6. ],
    7. ];
    8.  
    9. // Ici si on ne peut pas utiliser l'injection de dépendance, on pourrait remplacer la ligne suivante par :
    10. // \Drupal::service('renderer')->renderPlain($datas);
    11. $content = $this->renderer->renderPlain($datas);

     

  • Drupal 8 - Template - Spécifier un thème spécifique

    Posté le Samedi 27 avril 2019 - 11:21

    Quand un template est appelé via un « reder array », le template va être cherché en priorité dans le thème actif, puis dans le module qui déclare ce template.

    Dans certains cas, cela peut poser problème : Si un template peut-être appelé dans un contexte back ou front, les thèmes sont la plupart du temps différents. La solution de feignant pourrait être de dupliquer ce template dans les deux thèmes. Mais c'est évidement pas une bonne solution.

    Dans la déclaration du template on peut spécifier où trouver le template en question :

    1. $themes['xml_sitemap'] = [
    2. '#template' => 'xml-sitemap',
    3. 'path' => drupal_get_path('theme', 'mon_theme_back') . '/templates',
    4. 'variables' => [
    5. 'urls' => [],
    6. ],
    7. ];

    Ainsi peut importe si mon template est appelé depuis le front ou depuis le back ça sera toujours le fichier :

    themes/custom/mon_theme_back/templates/xml-sitemap.html.twig qui sera utilisé.

  • Drupal 8 - Entité - Champ de base « texte long avec résumé »

    Posté le Jeudi 11 avril 2019 - 08:42

    Voici comment ajouter un champ texte formaté avec résumé à un type d'entité :

    1. $fields['synospis'] = BaseFieldDefinition::create('text_with_summary')
    2. ->setLabel(t('Synopsis'))
    3. ->setSetting('text_processing', TRUE)
    4. ->setDisplayConfigurable('view', TRUE)
    5. ->setDisplayConfigurable('form', TRUE)
    6. ->setTranslatable(TRUE);

    À noter que j'ai maintenant pris l'habitude de ne plus configurer les options d'affichage en mode formulaire et front dans mon type d'entité, mais je le fais directement en backoffice du site.

    Voir des exemples d'affichages sur un texte long.

  • Drupal 7 - Créer un champ calculé pour Views

    Posté le Jeudi 14 mars 2019 - 19:01

    (et oui des fois on doit retourner sous drupal 7)

    Voici comment créer un champ calculé pour un type d'entité (ici Node) qui sera accessible comme n'importe quel champ dans views.

    Dans mon_module.module :

    1. function mon_module_views_api($module = NULL, $api = NULL) {
    2. return ['api' => '3.0'];
    3. }

    Dans mon_module.views.inc : définition des champs

    1. <?php
    2. function mon_module_views_data() {
    3. $data = array();
    4.  
    5. $data['node']['risk'] = [
    6. 'title' => t('Country latest risk'), // Titre visible dans views
    7. 'help' => t('Country latest risk description'), // Description visible dans views
    8. 'field' => [
    9. 'handler' => 'MonModuleLatestRisk', // Nom de la classe qui "rendra" notre champ calculé
    10. ],
    11. ];
    12.  
    13. return $data;
    14. }

    Dans mon_module.info : ne pas oublier de lister notre fichier qui contiendra notre classe

    files[] = MonModuleLatestRisk.php

    Dans MonModuleLatestRisk.php : La logique de calcul du champ

    1. <?php
    2. class MonModuleLatestRisk extends views_handler_field {
    3.  
    4. function render($values) {
    5. // Logique de "calcul" de notre champ
    6. // À noter que $values contient l'ensembles des champs sélectionnés (qu'ils soient exclus de l'affichage ou non) dans notre vue
    7. if(isset($values->field_field_country_scenarios[0]['raw'])) {
    8. return $values->field_field_country_scenarios[0]['raw']['entity']->field_description['und'][0]['value'];
    9. }
    10. return null;
    11. }
    12.  
    13. function query() {
    14. // laisser vide
    15. }
    16. }