Nous allons voir à travers cet article, les bases de la création d'un module.
Dans un premier temps, il va falloir créer un dossier à la racine de PHPBoost contenant tous les fichiers du module.
Le choix du dossier est important puisqu'il sera l'identifiant du module mais sera également présent dans les différentes urls.
Il est préférable de choisir un nom anglais pour rester cohérent avec le reste de PHPBoost.
Par exemple pour un module dictionnaire, il conviendrait parfaitement de choisir dictionary.
Le fichier config.ini contient toutes les informations relatives au module à l'exception de son nom, sa description et les liens de l'administration.
Il faut le créer à la racine du module.
Celui-ci doit contenir au minimum les informations suivantes :
Code INI :
D'autres choix sont disponible :
Code INI :
Dans le dossier de votre module, il nous faut créer un dossier nommé lang.
Celui-ci contiendra autant de dossier que de langues.
Exemple : Si l'on souhaite rendre disponible la langue anglaise pour notre module, il nous faut créer un dossier english.
Pour la langue française, c'est french.
Dans un premier temps, nous allons créer un dossier nommé french dans le dossier lang.
Ensuite nous allons créer un fichier nommé desc.ini dans le dossier french.
Celui-ci doit contenir :
Code INI :
Il y a deux types d'image pour notre module :
- le_nom_du_dossier_de_votre_module_mini.png qui doit être une image de 16 pixels de large et de long.
- le_nom_du_dossier_de_votre_module.png qui doit être une image de 32 pixels de large et de long.
A ce stade là, notre module sera visible dans l'ajout d'un module dans l'administration.
Créer le dossier du module
Dans un premier temps, il va falloir créer un dossier à la racine de PHPBoost contenant tous les fichiers du module.
Le choix du dossier est important puisqu'il sera l'identifiant du module mais sera également présent dans les différentes urls.
Il est préférable de choisir un nom anglais pour rester cohérent avec le reste de PHPBoost.
Par exemple pour un module dictionnaire, il conviendrait parfaitement de choisir dictionary.
Créer le fichier de configuration : config.ini
Le fichier config.ini contient toutes les informations relatives au module à l'exception de son nom, sa description et les liens de l'administration.
Il faut le créer à la racine du module.
Celui-ci doit contenir au minimum les informations suivantes :
Code INI :
author="Auteur du module" author_mail="Adresse email de l'auteur" author_website="Lien vers la page de l'auteur" version="Version du module" date="Date de création sous forme : 27/10/11" compatibility="Version minimum de PHPBoost compatible avec le module. Exemple : 4.0" admin_main_page="Chemin vers la page d'administration principale du module" admin_menu="Choix du menu dans l'administration où le menu doit apparaître. Nous avez le choix : index|administration|tools|members|content|modules" home_page="Chemin vers la page principale du module"
D'autres choix sont disponible :
Code INI :
php_version="Version de PHP minimum pour exécuter le module. Exemple : 5.2.1" repository="Lien vers le fichier XML de mise à jour s'il y en a un" contribution_interface="Chemin vers la page de contribution du module"
Créer le fichier de description : desc.ini
Dans le dossier de votre module, il nous faut créer un dossier nommé lang.
Celui-ci contiendra autant de dossier que de langues.
Exemple : Si l'on souhaite rendre disponible la langue anglaise pour notre module, il nous faut créer un dossier english.
Pour la langue française, c'est french.
Dans un premier temps, nous allons créer un dossier nommé french dans le dossier lang.
Ensuite nous allons créer un fichier nommé desc.ini dans le dossier french.
Celui-ci doit contenir :
Code INI :
name="Le nom de votre module" desc="La description de votre module" admin_links=""
Les images des modules
Il y a deux types d'image pour notre module :
- le_nom_du_dossier_de_votre_module_mini.png qui doit être une image de 16 pixels de large et de long.
- le_nom_du_dossier_de_votre_module.png qui doit être une image de 32 pixels de large et de long.
A ce stade là, notre module sera visible dans l'ajout d'un module dans l'administration.