Création d'un module simple - Développement d'un module de base
From Joomla! Documentation
Ceci est une série de plusieurs articles expliquant la façon de développer un module pour Joomla! Version 
. Vous pouvez naviguer dans les articles de cette série à l'aide du menu déroulant.
Commencez par l'Introduction puis naviguez dans les articles de cette série en utilisant soit les boutons de navigation situés en bas des articles, soit le menu droit (Les articles de cette série).
Les modules sont des extensions légères et flexibles. Ils sont utilisés pour de petites parties de page qui sont généralement moins complexes et peuvent être visibles à travers les différents composants.
Vous pouvez voir de nombreux exemples de modules dans une installation standard de Joomla : - menus - dernières actualités - formulaire de connexion - et bien d'autres.
Ce didacticiel vous explique comment créer un simple module Hello World. Grâce à lui, vous apprendrez la structure de fichiers de base d'un module. Cette structure de base peut ensuite être étendue afin de créer des modules plus élaborés.
Structure de fichier
Quatre fichiers de base sont utilisées dans le modèle standard de développement de modules :
mod_helloworld.php- Ce fichier est le point d'entrée principale pour le module. Il va effectuer toute routine d'initialisation nécessaire, appeler les routines helper pour collecter les données nécessaires et inclure le template à afficher pour le rendu du module.
mod_helloworld.xml- Ce fichier contient les informations sur le module. Il définit les fichiers à installer par l'installateur Joomla! et spécifie les paramètres de configuration du module.
helper.php- Ce fichier contient la classe helper qui est utilisée pour procéder à la récupération des informations à afficher dans le module (généralement à partir de la base de données ou d'une autre source).
tmpl/default.php- C'est le template du module. Ce fichier va prendre les données recueillies par mod_helloworld.php et générer le code HTML à afficher sur la page.
Création de mod_helloworld.php
Le fichier mod_helloworld.php va effectuer trois tâches :
- inclure le fichier helper.php qui contient la classe à utiliser pour recueillir les données nécessaires,
- invoquer la méthode de classe helper appropriée pour récupérer les données,
- inclure le template pour afficher le rendu.
La classe helper est définie dans notre fichier helper.php. Ce fichier comporte une déclaration require_once :
require_once dirname(__FILE__) . '/helper.php';
require_once est utilisé car nos fonctions helper sont définies dans une classe, et nous souhaitons que cette classe ne soit définie qu'une seule fois.
Notre classe helper n'a pas encore été définie, mais lorsqu'elle le sera, elle contiendra une méthode : getHello(). Pour notre exemple de base, il n'est pas vraiment nécessaire de le faire - le message “Hello, World” que cette méthode retourne pourrait simplement être inclus dans le template. Nous utilisons une classe helper ici afin de démontrer cette technique de base.
Pour l'instant, notre module n'utilise pas de paramètres, mais nous allons tout de même les passer par la méthode helper de sorte qu'ils puissent être utilisés ultérieurement si nous décidions d'étendre les fonctionnalités de notre module.
La méthode de classe helper est appelée de la manière suivante :
$hello = modHelloWorldHelper::getHello($params);
Terminer le fichier mod_helloworld.php
Le fichier mod_helloworld.php complet se présente ainsi :