skip to main | skip to sidebar
Code 18
Manuel du savoir-faire à l'usage des geeks et des curieux
RSS
  • Accueil
  • Le web au Québec
  • Liens
  • Twitter
  • Facebook
  • À propos

dimanche 24 février 2013

Anatomie de base d'un module Drupal 7

Publié par Infinite Loop, à 08 h 40 0 commentaire

Dans Drupal, un module est composé de code qui permet d'enrichir le noyau en ajoutant ou en réécrivant des fonctionnalités. En général, face à un nouveau besoin, on privilégiera dans l'ordre :

  1. La recherche d'une contribution existante parmi plus de 20 000 modules
  2. L'altération d'un module existant par extension
  3. L'écriture d'un tout nouveau module

Où sont les modules ?
  • Ceux du noyau se trouvent dans /modules/
  • Les modules installés provenant des contributions se trouvent dans /sites/all/modules/
De quoi est composé un module ?

Essentiellement, de deux fichiers partageant le même nom et portant les extensions .info et .module. C'est le strict minimum pour avoir quelque chose de fonctionnel mais on trouve généralement plusieurs autres fichiers à l'intérieur du répertoire.

Fichier .info

Il s'agit d'un fichier texte qui décrit le module sous la forme clé-valeur. Son contenu est lu et interprété dans le but faire des vérifications au moment de l'installation :
name = Exemple 1
description = "Description du module"
package = Code 18
core = 7.x
files[] = code18.module
dependencies[] = block
...
Où :
  • name contient le nom textuel du module qui apparaîtra dans la liste des modules et lorsqu'il est référencé.
  • description décrit simplement ce que fait le module.
  • package représente le regroupement logique dans lequel le module doit être classé (voir à droite).
  • core indique la compatibilité avec le noyau de Drupal (ici les versions de Drupal 7).
  • files[] permet d'inclure un fichier externe nécessaire au module.
  • dependencies[] indique que le module courant possède une dépendance à un autre module qui doit aussi être installé pour qu'il fonctionne. Le nom du module dépendant à inscrire est simplement le nom de son fichier .module ou .info, sans l'extension.
  • Et plusieurs autres caractéristiques avancées (page de configuration, attachement de fichiers JavaScript et CSS).
 Aperçu des métadonnées provenant du fichier .info dans la liste des modules
Fichier .module

Avant d'écrire quoi que ce soit dans un fichier .module, il est impératif de bien comprendre le concept du hook. Les hooks permettent d'intervenir à différentes étapes dans l'exécution du code de sorte à pouvoir altérer et enrichir une fonctionnalité existante de façon à répondre à nos besoins sans avoir à réécrire le code original (ne modifiez jamais directement un module provenant d'une contribution!). Au contraire, on redéfinit uniquement ce qu'on a besoin en utilisant les hooks mis à notre disposition.

Dans la documentation, la liste des hooks disponibles indique une notation générique du type hook_init() où le préfixe hook doit être remplacé par le nom de notre module. Par exemple, si on crée un module qu'on nomme code18, on écrira des fonctions à l'intérieur de notre fichier code18.module :
  • code18_init()
  • code18_permission()
  • code18_menu()
  • code18_help()
  • code18_form_alter()
Pour qu'un module soit utile, il devra compter au moins une fonction, aussi simple soit-elle.

Fichier README.txt

Contient l'information nécessaire pour comprendre le fonctionnement et les impacts du module.

Fichier .install

Optionnellement, un module pourrait inclure un fichier .install qui contiendrait des fonctions PHP implémentant les hooks _install() et _uninstall() qui, respectivement, ajouterait des champs nécessaires au fonctionnement du module et ferait le ménage pour garder le système propre lors de sa désinstallation.

Il y a plus encore mais pour l'instant, retenez uniquement ceci, le but de ce billet étant d'offrir un aperçu de la base pour avoir un minimum de compréhension face à une première expérience. Dans le prochain billet, je ferai une démonstration plus concrète pour mettre le tout en pratique.


Tags: Drupal

0 réponse à "Anatomie de base d'un module Drupal 7"


Publier un commentaire

Message plus récent Messages plus anciens Accueil
S'abonner à : Publier des commentaires (Atom)
    Suivre @code18 sur Twitter

    Catégories

    • Apache (21)
    • Citations (167)
    • Club Vidéo (24)
    • Coffre à outils (56)
    • CSS (8)
    • Curiosités (117)
    • Design Pattern (2)
    • Drupal (8)
    • Easter Eggs (22)
    • Extensions Firefox (20)
    • GIMP (7)
    • Histoire (21)
    • HTML (32)
    • Humour (57)
    • Intégration (34)
    • iPod (12)
    • JavaScript (110)
    • Jeu de combat (6)
    • Le coin du geek (128)
    • Liens (12)
    • Linux (56)
    • Livres (78)
    • Lois et principes (46)
    • Marché des saveurs (26)
    • Mathématique (18)
    • Mobile (5)
    • Montréal (32)
    • Musique (112)
    • Pancartes et écriteaux (16)
    • Perl (8)
    • Pérou (1)
    • PHP (130)
    • PostgreSQL (44)
    • Programmation (105)
    • Saviez-vous que (55)
    • Sécurité (22)
    • SEO (5)
    • SQL Server (22)
    • Vieilles publicités (6)
    • Virtualisation (8)
    • Voyages (1)
    • Zend Framework (26)

    Divers

    Archives

    • ►  2015 (6)
      • ►  août 2015 (1)
      • ►  juillet 2015 (1)
      • ►  février 2015 (3)
      • ►  janvier 2015 (1)
    • ►  2014 (8)
      • ►  décembre 2014 (1)
      • ►  novembre 2014 (1)
      • ►  octobre 2014 (1)
      • ►  août 2014 (2)
      • ►  juillet 2014 (2)
      • ►  janvier 2014 (1)
    • ▼  2013 (53)
      • ►  décembre 2013 (2)
      • ►  novembre 2013 (1)
      • ►  octobre 2013 (3)
      • ►  septembre 2013 (2)
      • ►  août 2013 (5)
      • ►  juillet 2013 (3)
      • ►  juin 2013 (5)
      • ►  mai 2013 (3)
      • ►  avril 2013 (7)
      • ►  mars 2013 (7)
      • ▼  février 2013 (11)
        • Ajouter une liste pré-construite d'options dans un...
        • Anatomie de base d'un module Drupal 7
        • Deux modules Drupal pratiques pour l'interface d'a...
        • Initier un nouvel employé
        • Drupal 7 : mécanique interne de la maintenance
        • Citation no. 159 sur la politesse
        • Installation Drupal et XAMPP
        • Drupal pour débutants
        • Calicem capulus
        • La méthode Google : que ferait Google à votre place ?
        • Les craintes de mon patron suite à ma démission
      • ►  janvier 2013 (4)
    • ►  2012 (105)
      • ►  décembre 2012 (8)
      • ►  novembre 2012 (5)
      • ►  octobre 2012 (4)
      • ►  septembre 2012 (1)
      • ►  août 2012 (8)
      • ►  juillet 2012 (7)
      • ►  juin 2012 (7)
      • ►  mai 2012 (10)
      • ►  avril 2012 (13)
      • ►  mars 2012 (15)
      • ►  février 2012 (15)
      • ►  janvier 2012 (12)
    • ►  2011 (146)
      • ►  décembre 2011 (14)
      • ►  novembre 2011 (11)
      • ►  octobre 2011 (12)
      • ►  septembre 2011 (13)
      • ►  août 2011 (15)
      • ►  juillet 2011 (17)
      • ►  juin 2011 (18)
      • ►  mai 2011 (15)
      • ►  avril 2011 (9)
      • ►  mars 2011 (7)
      • ►  février 2011 (3)
      • ►  janvier 2011 (12)
    • ►  2010 (398)
      • ►  décembre 2010 (29)
      • ►  novembre 2010 (28)
      • ►  octobre 2010 (32)
      • ►  septembre 2010 (34)
      • ►  août 2010 (22)
      • ►  juillet 2010 (35)
      • ►  juin 2010 (42)
      • ►  mai 2010 (36)
      • ►  avril 2010 (37)
      • ►  mars 2010 (34)
      • ►  février 2010 (32)
      • ►  janvier 2010 (37)
    • ►  2009 (430)
      • ►  décembre 2009 (32)
      • ►  novembre 2009 (34)
      • ►  octobre 2009 (33)
      • ►  septembre 2009 (37)
      • ►  août 2009 (37)
      • ►  juillet 2009 (39)
      • ►  juin 2009 (38)
      • ►  mai 2009 (37)
      • ►  avril 2009 (35)
      • ►  mars 2009 (37)
      • ►  février 2009 (32)
      • ►  janvier 2009 (39)
    • ►  2008 (84)
      • ►  décembre 2008 (34)
      • ►  novembre 2008 (39)
      • ►  octobre 2008 (11)

    Abonnés

Copyright © All Rights Reserved. Code 18 | Converted into Blogger Templates by Theme Craft