CMS KwsPHP - Le site clés en main - Article - Créer un module

Index des articles > Les modules > Créer un module

Créer un module

---

But du tutorial

A la fin de ce tutorial vous saurez comment créer un module pour KwsPHP. Vous saurez y afficher du texte, le personnaliser à souhait.
Nous verrons comment utiliser les variables du portail, comment y insérer du code XHTML et PHP.

Présentation

KwsPHP peut se dire ergonomique et complet grâce à l'immense bibliothèque de modules dont il dispose. Ces modules immédiatement reconnus par le moteur permettent de personnaliser votre portail en y ajoutant diverses fonctions ou tout simplement une page qui rentre dans le design. Ce sont des programmes additionnels vous permettant de gérer les informations de votre site. Vous pourrez en trouver portant sur les domaines les plus variés. Dans ce tutorial, nous apprendrons pas à pas comment créer notre propre module, comment le personnaliser. Nous commenterons toutes les étapes pour que vous compreniez bien le principe et que vous puissiez créer vos modules par la suite.

Création d'une page

Pour pouvoir créer notre page seules quelques connaissances en XHTML sont requises, le reste étant expliqué. Si vous ne connaissez pas encore suffisamment bien le XHTML nous vous conseillons un très bon site qui explique toutes les étapes pour monter son site pas à pas : http://siteduzero.com/xhtml-css/ . Ne vous inquiétez pas non plus, si vous êtes capable d'afficher un texte en (X)HTML vos connaissances seront amplement suffisantes. Pour créer notre page nous aurons besoin de deux choses :

* La syntaxe de base du module
* Le code XHTML à insérer dans notre module
* Avec du PHP ...

a/ La syntaxe de base
La syntaxe du module est simple et invariante, c'est à dire que tous les modules que nous créerons commenceront par ce code.





Les trois lignes précédées de deux slashs sont des commentaires stipulant que vous êtes le créateur du dit-module et que vous pouvez assurer un support au cas où l'on voudrait vous contacter pour x raison. Ces trois lignes sont votre signature, ne les oubliez pas
La première ligne de code en PHP commençant par un if est une protection qui oblige le visiteur à passer par l'adresse http://www.monsite.com/index.php?mod=mon-module&ac=fichier et non par l'adresse http://www.monsite.com/modules/mon-module/fichier.php . Cette protection ajoutée depuis la version 1.2.3 permet d'inclure les sécurités s'exerçant sur l'index et d'être certain que le design sera intégré.
La fonction bloc_head(); définit le titre de votre page. Cette fonction permet d'informer le thème utilisé que votre page débute et que le titre de cette page sera le nom inscrit entre les parenthèses. Si toute fois vous ne voulez pas donner de nom à votre page, remplacez bloc_head() ; par open_table(); qui a la même fonction graphique.
La fonction close_table(); sans information informe le thème que la page est finie, qu'il peut refermer le bloc qu'il avait ouvert avec bloc_head();.

b/ Le code XHTML à insérer dans notre module
Maintenant que nous avons notre (solide) base, nous allons pouvoir nous atteler au plus important : le code à afficher.
Ce code est à rentrer en PHP car notre fichier est un fichier PHP. Mais ce langage est bien fait, nous pouvons afficher du code XHTML grâce à la fonction echo '' ; (voir ici pour en savoir plus sur la fonction echo) . Pour comprendre son utilisation, la meilleure des méthode est de voir un exemple : nous allons afficher un texte centré avec echo '';
En XHTML le code à insérer est <div align="center">Notre texte</div> voyons le code approprié à rentrer:





c/ Avec du PHP ...
Bien, nous avons vu que nous pouvions ajouter du XHTML (heureusement d'ailleurs) mais qu'en est il du PHP ? Nous savons que notre fichier est codé en PHP donc ... nous pouvons l'utiliser autant que nous voulons !
Pour suivre cette partie du tutorial, quelques connaissances sont de rigueur mais il n'est pas vital pour vous d'utiliser le PHP Si toute fois vous voulez concevoir des pages plus élaborées, nous vous conseillons ce site http://siteduzero.com/php/ pour apprendre le PHP à partir de 0.

Ce qui est pratique avec l'utilisation du PHP dans votre module c'est que nous pouvons réutiliser les variables du portail voire accéder à la base de données.
Par exemple, la variable $pseudo définit le pseudo du visiteur, par conséquent, s'il n'en a pas c'est qu'il n'est pas membre ou pas connecté. ( Voir plus d'infos sur les facilités de codage du portail). Ainsi nous pourrons limiter l'accès de telle ou telle page à un non-membre :





Quelques conseils

Nous vous conseillons d'indenter votre code ainsi, vous pourrez retrouver plus facilement les liens logiques entre telle et telle condition.
Par la même occasion prenez le temps d'ajouter des commentaires dans votre code. En PHP les commentaires qui s'étendent sur une ligne doivent commencer par // (dans notre code, les commentaires sont en orange).
Votre code sera plus clair et il sera beaucoup plus aisé pour vous de vous y retrouver si vous avez des erreurs - ce qu'il va arriver, je peux vous l'assurer.

Il se peut que les premières fois où vous allez coder vos propres scripts apparaissent des erreurs :

* Parse error: parse error in fichier.php on line X
* Fatal Error: Call to undefined function


a/ Parse Error
Cette erreur est la plus courante, impossible de passer à côté. Elle peut arriver selon différents cas :
- Vous n'avez pas fermé des guillemets ouverts
- Vous avez oublié le point-virgule signifiant l'arrêt du code
Quoi qu'il arrive, un éditeur de fichiers 'intelligent' du type ConTEXT ou Notepad++ vous aidera à retrouver ces erreurs.

b/ Fatal Error
Cette erreur n'est pas aussi 'fatale' qu'elle en a l'air. Elle aussi vous risquez de la rencontrer souvent pour une unique raison cette fois:
La fonction appelée ne peut être utilisée.
Ainsi echo; sortira une erreur, comme pourra le faire fputs qui elle, existe. Comment cela se fait-il ? La fonction appelée n'est pas activée. Cela arrive rarement avec des fonction de base mais avec des moins connues, cela arrive souvent (exemple: lorsque GD2 n'est pas activée).



Texte original par Ripou
Article revu le 27/08/2008