Planète Kgaut

Par kgaut
Kevin Gautreau

Drupal 8 - Migrate - Aide mémoire

Afficher la liste des destinations de migration :

drupal debug<span class="sy0">:</span>plugin migrate<span class="sy0">.</span>destination

 

Par kgaut
Kevin Gautreau

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

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

 

Par kgaut
Kevin Gautreau

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

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é.

Par kgaut
Kevin Gautreau

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

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.

Par kgaut
Kevin Gautreau

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

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

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

files<span class="br0">[</span><span class="br0">]</span> <span class="sy0">=</span> MonModuleLatestRisk<span class="sy0">.</span>php

Dans MonModuleLatestRisk.php : La logique de calcul du champ

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

 

Par kgaut
Kevin Gautreau

Drupal 8 - Créer un filtre de texte

À la demande d'un client je devais ajouter un attribut « target="_blank" » sur tous les liens sortant du site.

J'ai pour cela créé un filtre de texte que j'ai appliqué à un format de texte.

Voici le fichier mon_module/src/Plugin/Filter/UrlTargetBlankFilter.php

  1. namespace Drupal\mon_module\Plugin\Filter;
  2.  
  3. use Drupal\filter\FilterProcessResult;
  4. use Drupal\filter\Plugin\FilterBase;
  5.  
  6. /**
  7.  * @Filter(
  8.  * id = "url_target_blank_filter",
  9.  * title = @Translation("Url Target Blank"),
  10.  * description = @Translation("Add « target=_blank » to all urls"),
  11.  * type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE,
  12.  * )
  13.  */
  14. class UrlTargetBlankFilter extends FilterBase {
  15.  
  16. public function process($text, $langcode) {
  17. $regex = "/(\\b[^]*href=['\"]?http[^]+)>/is";
  18. $subst = "$1 target=\"_blank\" rel=\"noopener\">";
  19. $result = preg_replace($regex, $subst, $text);
  20. return new FilterProcessResult($result);
  21. }
  22. }

À noter : j'ai aussi ajouté l'attribut rel="noopener" comme suggéré par Simon Georges.

Par kgaut
Kevin Gautreau

Le programme du drupalcamp Paris 2019 est disponible

Le drupalcamp est l'évènement Drupal en France rassemblant l'ensemble de la communauté francophone. L'évènement est organisé par une équipe de bénévole et est porté par l'association Drupal France et Francophonie.

Cette année, le drupalcamp revient à Paris et se tiendra les 15, 16 et 17 février 2019 à l'espace St-Martin en plein cœur de Paris.

Nous venons de terminer le programme des conférences, et il est consultable directement sur le site de l'évènement : https://paris2019.drupal.fr/programme.

Cette années, trois tracks en parallèle : Business / Expertise / Découverte.

Comme d'habitude aux drupalcamp, le dimanche sera consacré a des ateliers, des sprints de développement et de traduction.

La billetterie est toujours ouverte, n'hésitez-pas à prendre vos places dès maintenant : https://paris2019.drupal.fr/billetterie.

Pour vous tenir au courant sur l'évènement les infos principales sont données sur le compte twitter @drupalcampfr.

 

Par kgaut
Kevin Gautreau

Drupal 8 - Supprimer toutes les entités d'un certain type

Dans mon_module.install :

  1. /**
  2.  * Remove all products
  3.  */
  4. function mon_module_update_8001() {
  5. $toDelete = \Drupal::entityQuery('product')->execute();
  6. foreach ($toDelete as $item) {
  7. $item = \Drupal\clearblue\Entity\Product::load($item);
  8. $item->delete();
  9. }
  10. }

 

Par kgaut
Kevin Gautreau

Drupal 8 - Supprimer un type d'entité

Dans mon_module.install :

  1. /**
  2.  * Remove Product entity type
  3.  */
  4. function mon_module_update_8001() {
  5. $entity_type = 'product';
  6. $entity_update_manager = \Drupal::entityDefinitionUpdateManager();
  7. $entity_type = $entity_update_manager->getEntityType(entity_type);
  8. $entity_update_manager->uninstallEntityType($entity_type);
  9. }

 

Par kgaut
Kevin Gautreau

Drupal 8 - Ajouter une propriété à un type d'entité config

Voici comment altérer un type d'entité config pour lui ajouter une propriété.

Dans le cas présent, nous allons modifier le type d'entité ConfigurableLanguage afin de lui ajouter un champ google_analytics, pour avoir par exemple un code de tracking différent pour chaque langue.

Commençons par définir les nouveaux formulaire concernant pour l'édition et la création de langue :

modules/custom/mon_module/mon_module.module

  1. function mon_module_entity_type_alter(array &$entity_types) {
  2. $entity_types['configurable_language']->setFormClass('add', \Drupal\mon_module\Entity\Form\LanguageCustomAddForm::class);
  3. $entity_types['configurable_language']->setFormClass('edit', \Drupal\mon_module\Entity\Form\LanguageCustomEditForm::class);
  4. }

 

Ci dessous, le contenu des formulaires qui héritent directement des formulaires de base qu'ils supplantent.

modules/custom/mon_module/src/Entity/Form/LanguageCustomAddForm.php

  1.  
  2. namespace Drupal\mon_module\Entity\Form;
  3.  
  4. use Drupal\Core\Form\FormStateInterface;
  5. use Drupal\language\Form\LanguageAddForm;
  6.  
  7. class LanguageCustomAddForm extends LanguageAddForm {
  8. use LanguageCustomTrait;
  9.  
  10. public function form(array $form, FormStateInterface $form_state) {
  11. $form = parent::form($form, $form_state);
  12. $this->getFormCustomFields($form);
  13. return $form;
  14. }
  15.  
  16. }

 

modules/custom/mon_module/src/Entity/Form/LanguageCustomEditForm.php

  1.  
  2. namespace Drupal\mon_module\Entity\Form;
  3.  
  4. use Drupal\Core\Form\FormStateInterface;
  5. use Drupal\language\Form\LanguageEditForm;
  6.  
  7. class LanguageCustomEditForm extends LanguageEditForm {
  8. use LanguageCustomTrait;
  9.  
  10. public function form(array $form, FormStateInterface $form_state) {
  11. $form = parent::form($form, $form_state);
  12. $this->getFormCustomFields($form);
  13. return $form;
  14. }
  15.  
  16. }

 

Enfin, afin d'éviter la répétition de code, je passe par un trait qui contient mes customisations.

Ce trait est appelé dans les classes ci-dessous via l'appel : $this->getFormCustomFields($form);

Ce trait, fait deux choses, dans la méthode getFormCustomFields() il altère le formulaire pour ajouter le champs qui nous intéresse, et via l'appel à la méthode customEntityBuilder(), l'enregistrement de ce champ est effectué.

modules/custom/mon_module/src/Entity/Form/LanguageCustomTrait.php

  1.  
  2. namespace Drupal\mon_module\Entity\Form;
  3.  
  4. use Drupal\Core\Form\FormStateInterface;
  5. use Drupal\language\ConfigurableLanguageInterface;
  6.  
  7. trait LanguageCustomTrait {
  8.  
  9. public function getFormCustomFields(&$form) {
  10. /* @var $language \Drupal\language\ConfigurableLanguageInterface */
  11. $language = $this->entity;
  12.  
  13. $form['google_analytics'] = [
  14. '#title' => t('ID Google Analytics'),
  15. '#type' => 'textfield',
  16. '#default_value' => $language->getThirdPartySetting('mon_module', 'google_analytics')
  17. ];
  18. $form['#entity_builders'][] = '::customEntityBuilder';
  19. }
  20.  
  21. function customEntityBuilder($entity_type, ConfigurableLanguageInterface $language, &$form, FormStateInterface $form_state) {
  22. if ($form_state->getValue('google_analytics')) {
  23. $language->setThirdPartySetting('mon_module', 'google_analytics', $form_state->getValue('google_analytics'));
  24. return;
  25. }
  26. $language->unsetThirdPartySetting('mon_module', 'google_analytics');
  27. }
  28.  
  29. }

évidement, pensez à modifier toutes les occurrences de mon_module par le nom machine de votre module.

Merci à Alexandre Mallet aka @woprrr pour la piste

Pages