Introduction
Voici un schéma récapitulant la structure de chaque page produite par PHPBoost.
Nous allons maintenant voir comment inclure ces fichiers et les opérations que nous avons à faire.
Structure d'une page
Voici le code entier qui permet de charger l'environnement du portail.
Code PHP :
<?php //Licence /*################################################## * page.php * ------------------- * begin : Date de création du fichier * copyright : (C) 2007 Nom du/des développeur(s) * email : email du/des développeur(s) * * ################################################### * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ###################################################*/ //Chargement des fonctions include_once('../kernel/begin.php'); //Fichiers langue include_once('lang/' . $CONFIG['lang'] . '/module_' . $CONFIG['lang '] . '.php'); //Titre de la page define('TITLE', $titre_de_la_page); //Chargement du CSS éventuel define('ALTERNATIVE_CSS', 'wiki'); //Inclusion du header include_once('../kernel/header.php'); ## Contenu de la page, script de votre module ## //Footer include_once('../kernel/footer.php'); ?>
Voici des explications de chaque ligne :
- Licence: si vous souhaitez publier votre module il est conseillé de choisir une licence et d'adapter vos fichiers à cette licence (ici c'est un extrait de la licence GPL sous laquelle PHPBoost est distribué).
- Chargement des fonctions: l'environnement général du portail est chargé (classes de base du framework, fonctions courantes, sessions). Avant cela tout ce que vous pourrez trouver dans la documentation ne fonctionnera pas, c'est une étape indispensable.
- Inclusion du fichier langues: tout est détaillé dans la partie langues.
- Titre de la page: Cette opération est nécessaire. Il s'agit du titre de la page qui apparaîtra dans le nom de la fenêtre de votre navigateur. Aussi ce titre est très important pour le référencement: il doit être explicite et simple. De plus il est conseillé de le rendre dynamique: il doit s'adapter à chaque page, par exemple sur un forum il doit contenir le nom du sujet que vous lisez.
- Chargement d'un CSS alternatif: il s'agit du CSS additionnel décrit dans la partie installation. Si vous désirez charger un CSS propre à votre module, vous devez définir la constante comme montré dans l'exemple et donner son nom (il se situe dans le dossier templates2 de votre module). Cette ligne est facultative: ignorez la si vous vous contentez des classes CSS du noyau.
- Header: ici se fait l'affichage et l'exécution des mini-modules. Le chargement du CSS et la déclaration du titre sont exécutées dans ce fichier. Si vous ne désirez pas afficher tout ceci (par exemple dans une fenêtre de type pop-up), vous devez inclure le fichier header_no_display.php, qui contient les mêmes fonctions sans l'affichage.
- Footer: de la même façon que le header, le footer permet de boucler votre page. Les balises de la page sont fermées, la connexion à la base de données est coupée, des opérations indispensables à ne pas oublier. Vous pouvez inclure footer_no_display.php afin de faire ces opérations sans rien afficher.
La barre d'arborescence
La barre d'arborescence permet de se repérer dans le site. Elle représente des liens vers les diff