Planète

Drupal 8 améliore grandement la manière de gérer le fil d'Ariane (ou breadcrumbs en Anglais). Dans ce post nous allons voir comment définir un fil d'Ariane pour les contenus d'un type particulier.

Ici nous considérerons que :

• Le type de contenu s'appellera "Témoignage", son nom machine sera "temoignage"
• Mon module s'apelle "temoignages_module"
• J'ai une page de listing définie par un controller dont la route sera temoignages.page_listing.

Ces éléments seront à adapter en fonction de vos besoins.

Définitions du service

S'il n'existe pas, créer le fichier temoignages_module.services.yml et ajouter le contenu suivant :

services:
  temoignages_module.breadcrumb.temoignage:
    class: Drupal\temoignages_module\Breadcrumb\TemoignagesBreadcrumb
    tags:
      - { name: breadcrumb_builder, priority: 100 }

Implémentation du service

Toujours dans le module, créer le fichier "TemoignagesBreadcrumb.php" dans le dossier : src/Breadcrumb du module temoignages_module, et y coller le contenu suivant :

<?php

namespace Drupal\temoignages_module\Breadcrumb;

use Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Link;
use Drupal\Core\Breadcrumb\Breadcrumb;

class TemoignagesBreadcrumb implements BreadcrumbBuilderInterface {

  public function applies(RouteMatchInterface $route_match) {
    if ($route_match->getCurrentRouteMatch()->getRouteName() == 'entity.node.canonical') {
      $node = $route_match->getParameter('node');
      if ($node->getType() == 'temoignage') {
        return TRUE;
      }
    }
    return FALSE;
  }

  public function build(RouteMatchInterface $route_match) {
    $breadcrumb = new Breadcrumb();
    $breadcrumb->addCacheContexts(['route']);
    $links = [];
    $links[] = Link::createFromRoute(t('Home'), '<front>');
    $links[] = Link::createFromRoute(t('Tous les témoignages'), 'temoignages_module.page_listing');
    return $breadcrumb->setLinks($links);
  }
}

En détails

La première méthode applies doit retourner TRUE ou FALSE en fonction de si on est dans un cas ou notre breadcrumb personnalisé doit être appliqué.

Je vérifie pour commencer que je suis en train de visualiser une node :

$route_match->getCurrentRouteMatch()->getRouteName() == 'entity.node.canonical'

Si c'est le cas, je récupère cette node et si elle est bien du type "temoignage" je retourne TRUE

      $node = $route_match->getParameter('node');
      if ($node->getType() == 'temoignage') {
        return TRUE;
      }

Sinon je retourne FALSE.

Enfin, la méthode build, comme son nom l'indique construit le fil d'Ariane, qui consiste en fait en un tableau de liens.

Je commence par mettre un tag de cache à mon fil d'Ariane en lui disant qu'il dépend de la route.

$breadcrumb->addCacheContexts(['route']);

Je construis ensuite mon tableau de liens, qui en sera constitué de deux, le premier vers la page d'accueil et le second vers ma page de listing :

    $links = [];
    $links[] = Link::createFromRoute(t('Home'), '<front>');
    $links[] = Link::createFromRoute(t('Tous les témoignages'), 'temoignages_module.page_listing');
    return $breadcrumb->setLinks($links);

Et... c'est tout, plus qu'à reconstruire le cache et vous pourrez vérifier que votre fil d'Ariane fonctionne bien

Vous trouverez plus d'exemple dans les sources de mon module de pronostics : https://github.com/mespronos/mespronos/tree/8.x-1.x/src/Breadcrumb, pour la définitions des services liés, c'est ici : https://github.com/mespronos/mespronos/blob/8.x-1.x/mespronos.services.yml.

Quand l'on travaille avec Drupal, on a rapidement besoin d'avoir un thème personnalisé ne serai-ce que pour y stocker ses templates custom et ses feuilles de styles.

Personnellement, j'ai l'habitude de faire un thème "front" et un thème "back" car j'ai souvent besoin de personnaliser le rendu de l'interface d'administration pour qu'elle convienne au mieux à mes clients.

Drupal 8 comme Drupal 7 utilise la notion de thème "parent", c'est à dire que si mon thème custom a comme parent (comme base_theme) le thème bartik, alors il reprendra toutes ses propriétés (templates, css, js...), et l'on pourra surcharger ce qui nous intéresse.

Il existe des thèmes "starter kit", on peut citer Zen (https://www.drupal.org/project/zen) par exemple qui est un des plus connu. Il s'agit en fait d'un thème parent qui propose un thème starterkit tout configuré que l'on peut ensuite personnaliser en fonction de nos besoins.

On peut aussi évidement faire ses propres thèmes custom. À noter que si vous ne prenez pas comme thème parent Bartik ou Zen, il faudra quand même prendre le thème "classy" comme parent.

Comment créer son theme ?

On va partir sur le nom de theme suivant "Mon Site Front" : on va commencer par créer le dossier mon_site_front dans le dossier /themes/custom (on pourrait le mettre directement dans /themes, mais comme pour les modules c'est une bonne pratique de différentier les élément personnalisé (custom) des éléments téléchargés (qui seront eux dans un sous-dossier "contrib").

La définition d'un thème passe, comme pour un module par un fichier mon_site_front.info.yml, en voici son contenu :

name: Mon Site Front
type: theme
description: Mon theme de demonstration
package: MonSite
core: 8.x
base theme: bartik

On doit aussi créer un fichier mon_site_front.theme, vide, qui pourra contenir plus tard nos fonction de preprocess et différents hooks.

J'ai ici pris comme thème de base "Bartik".

Une fois cela fait on passe dans le menu d'administration "Apparence" pour activer notre thème et le définir comme thème par défaut :

Pour faire un thème d'administration custom cette fois on va prendre comme base thème "Seven" :

name: Mon Site Back
type: theme
description: Mon theme de demonstration Backoffice
package: MonSite
core: 8.x
base theme: seven

Cette fois dans le menu Apparence, on devra installer le thème puis le définir comme thème d'administration :

Un thème d’administration que je trouve très sympa et qui me sert de thème parent est Adminimal (https://www.drupal.org/project/adminimal_theme).

Drupal Console permet aussi de générer des thème, via la commande drupal generate:theme, et il demande de quel thème parent notre thème custom doit hériter.

Vous pouvez retrouver les maigres sources de ce post sur github :

• Thème front : https://github.com/kgaut/drupal8-exemple-theme-mon_site_front
• Thème back : https://github.com/kgaut/drupal8-exemple-theme-mon_site_back

Quand on fait des modifications sur un site Drupal on doit parfois récupérer une base de production afin d'avoir toute la configuration ainsi que les contenus à jour.

Ensuite généralement on désactive le cache, active le module devel...

Mettant en pratique l'adage comme quoi un développeur préfère passer deux heures à automatiser une tache qui ne lui prendrait que 30 secondes s'il l'effectuait manuellement, j'ai fais un script drush en ce sens.

Ce script propose deux nouvelles fonctions à appeler directement avec drush :

• deprod : pour passer un site en mode "développement" : activation de devel, stage_file_proxy, désactivation de l’agrégation des fichiers css et js, désactivation des caches, affichage des message d'erreurs, désactivation des modules google analytics et piwik
• reprod : pour passer un site en mode "production" : exactement l'inverse de plus haut

Ce script est interactif, pour chaque action, il vous demandera s'il doit l'effectuer ou non :

Vous pouvez aussi activer le mode "YOLO" avec le paramètre -y pour effectuer toutes les actions :

Ce script est sur github : https://github.com/kgaut/drupal-snippets/blob/7.x-1.x/Drush/deprod.drush.inc.

Pour l'installer, il faut copier le fichier directement dans votre dossier .drush qui doit être dans votre dossier "home" (ou documents sous windows).

Ensuite pour l'utiliser :

drush @alias deprod

// ou

drush @alias reprod

// pour tout activer / désactiver : 

drush @alias deprod -y

// ou

drush @alias reprod -y

Ce script pour l'instant fonctionne plus avec Drupal 7, je vais l'améliorer pour qu'il puisse interagir correctement avec Drupal 8.

Je suis prenneur de toute suggestion ou idée d'amélioration.

Open Source Summit est la fusion de 2 événements (Solutions linux et l'Open world forum) et se déroulera le 18 et 19 novembre 2015 au DOCK PULLMANN à La Plaine St-Denis (Paris)

Ces 2 anciens événements, l'association Drupal France et Francophonie (DrupalFR) était présent et c'est dans la logique que nous serons présent.

Ce rendez-vous se découpe de différentes manières, avec des conférences, des ateliers, et une partie exposition. Le dernier espace sera coupé en 2 parties avec une partie professionnel et une autre partie village associatif.

Conférence :
Vous pourrez trouver 2 conférences de ces membres :

• Léon Cros : Génie collaboratif - Organisation, enjeux et impacts - le 16 novembre - Salle Barcelone (Ingénie logiciel libre)
• Christophe Villeneuve : Les tests de sécurité - le 17 Novembre - Salle Pay-Bas (DevOPS)

Stand :
L'Association Drupal France et Francophonie (DRUPALFR) sera dans la partie village associatif et recherche des bonnes volontés pour venir nous aider à tenir le stand pour parler de Drupal et aussi venir nous voir.

• Si vous souhaitez venir nous rendre visite, vous serez les bienvenus.
• Si vous voulez tenir le stand avec moi, nous mettons à disposition un Doodle si vous souhaitez venir nous aider (par demi journée)

Formulaire de présence :
http://doodle.com/poll/iz7veniub9wsdhw8

Horaire du salon

• Mercredi 18 novembre : 8h30-19h00
• Jeudi 19 novembre: 8h30-18h00

Lieu du salon

DOCK PULLMANN
50, av. du Président Wilson
93200 La Plaine St-Denis

Pour venir : http://www.opensourcesummit.paris/Informations+pratiques_154_160.html

Demander un badge pour entrée http://www.opensourcesummit.paris/preinscription_3559_p.html

Responsable et contact pour le stand : Christophe Villeneuve

Plus nous serons nombreux, moins de temps vous serez bloqué.