Module administratorJoomla!1.6 prévoit de pouvoir ajouter facilement des modules de type "Icônes d'accès rapide" à des fonctions essentielles de l'interface d'administration.

Il suffit pour cela de créer le code HTML approprié et de les placer dans la position 'icon'.

Ils apparaîtront alors sur la page d'accueil de l'interface d'administration dans une boîte déroulante comme le montre la figure.

Exemple de modules icones


Le fichier d'entrée du module est celui qui est appelé par Joomla! au moment de l'affichage du module. Son nom est éponyme au module, ce qui dans ce cas est

mod_dictionary_icons.php
Il est généralement composé de 4 étapes:

  • vérification de l'appel du fichier par Joomla!
  • inclusion du fichier de soutien du module
  • récupération des informations à afficher
  • affichage des informations en requérant le fichier de présentation du module

Ce qui se traduit dans le cas présent par

// No direct access to this file
defined('_JEXEC') or die('Restricted access');
 
// Include the helper functions only once
require_once dirname(__FILE__) . '/helper.php';
 
// Ask the helper class to get the list of icons
$list = modDictionaryIconsHelper::getList($params);
 
// Display the module using the layout parameter which is 'default' by default
require JModuleHelper::getLayoutPath('mod_dictionary_icons', $params->get('layout', 'default'));
 

Le fichier de soutien d'un module est responsable du calcul des informations à afficher. Il comporte au moins deux étapes:

  • vérification de l'appel du fichier par Joomla!
  • définition d'une classe PHP éponyme au nom du module suivi de Helper. Ce qui dans le cas présent est
    modDictionaryIconsHelper
    Ce nommage est une convention choisie par les développeurs de Joomla! afin d'assurer l'unicité des noms de classes.

Ce fichier contient généralement des méthodes renvoyant les données qui seront affichées par un fichier de présentation. Dans le cas présent, nous avons deux méthodes:

  • getButtons qui renvoie une référence au tableau des icônes à afficher. Le renvoi par référence peut permettre à un plugin de modifier son contenu.
  • getList qui renvoie la liste des icônes à afficher en fonction des droits de l'utilisateur

<p>Les paramètres du module sont définis dans le fichier <strong>XML</strong> d'installation. Le paramètre <tt>automatic_title</tt> est utilisé par les <i>templates</i> d'administration de Joomla! pour générer des titres automatiques en fonction de la langue de l'utilisateur. En premier lieu, le système vérifie si la classe de soutien du module possède une méthode <tt>getTitle</tt> et le cas échéant l'appelle pour obtenir le titre du module en fonction des paramètres, sinon la clé de langage nommé <tt>MOD_<i>NAME</i>_TITLE</tt> est utilisée pour afficher le titre du module.</p>

<p>Si le module est placé en position <tt>icon</tt>, Joomla! crée automatiquement un ensemble de boîtes déroulantes permettant de basculer d'un module à l'autre. Le code <strong>PHP</strong> permettant de générer cet effet est contenu dans 2 fichiers:
<ul>
  <li><tt>/administrator/templates/bluestork/cpanel.php</tt>. Ce fichier choisit d'afficher les modules en position <tt>icon</tt> en utilisant le style <tt>sliders</tt></li>
  <li><tt>/administrator/templates/bluestork/html/modules.php</tt>. Ce fichier définit la façon d'afficher les modules avec le style <tt>sliders</tt> au moyen de la fonction <tt>modChrome_sliders</tt></li>
</ul>
  Ce mécanisme est reproduit à l'identique pour le <i>template</i> <tt>hathor</tt>

</p>

<p>Le fichier de présentation situé dans <tt>tmpl/default.php</tt> affiche une liste d'icônes cliquables. Joomla! recherche dans les fichiers medias du <i>template</i> les images nécessaires à leur affichage au moyen de l'appel
echo
    JHtml::_(
        'image',
        $button->image,
        JText::_($button->text),
        array('title' => JText::_($button->text)),
        true
    );
 
</p>
<hr class="system-pagebreak" title="Script d'installation" alt="Script" />
<p>Le fichier <strong>XML</strong> définit une balise <tt>scriptfile</tt> permettant de préciser le fichier <strong>PHP</strong> utilisé lors de l'installation, la mise à jour ou la désinstallation de l'extension. Dans le cas présent, lors de la première installation, le module est publié en position <tt>icon</tt> en dernière position en forçant le paramètre <tt>automatic_title</tt> à être vrai.</p>

  • Paquet contenant toutes les extension
  • Composant de gestion des définitions
  • Module d'affichage des définitions récentes
  • Module d'affichage d'un arbre de catégories
  • Module de cheminement pour les catégories
  • Module de cheminement alphabétique
  • Module administrateur d'icônes rapides
  • Plugin de lien automatique par étiquette adéquate