API de xoops
Une API (Application Programming Interface), que l'on peut traduire
par Interface de Programmation d'Application, est une bibliothêque
de classes et de fonctions à destination du développeur.
L'application développée - un module dans le cas de
xoops - est ainsi rendue indépendante de différents paramêtres
tels que la base de données, le navigateur ou l'OS du serveur.
La programmation est également facilitée puisqu'il devient
inutile de coder ce qui l'est déjà dans cette API. Enfin
une meilleure perennité de l'application - du module - est assurée,
car en cas d'évolution de Php p.ex. l'API intégrera les
modifications nécessaires, et en principe évitera d'avoir
à modifier le module. Ce guide a pour but de fournir une documentation sur les différentes
classes et fonctions de Xoops, sous une forme synthétique.
Vous ne trouverez pas d'explications détaillées, mais l'essentiel
à connaitre pour l'utilisation de ces fonctions ou méthodes
de classe avec :
- un bref descriptif
- les paramêtres requis ou optionnels
- des exemples chaque fois que possible
Convention de notation
Les fonctions seront représentées de la maniêre suivante
getFirstChild (int $sel_id, [string $order = ''])
Avec entre paranthêses, le(s) paramêtre(s) à
tranmettre, entre crochets lorsqu'ils sont optionnels chaque paramêtre
étant précédé du type de donnée.
Ce guide sera complété progressivement
et si vous souhaitez apporter votre contribution à sa rédaction,
vous serez les bienvenus. Il vous sera seulement demandé de respecter
la mise en forme pour des question d'homogénéité
des documents.
Classes de Xoops |
|
xoopsDB |
Accês à la base de données |
xoopsList |
Différentes listes disponibles (langues, pays, etc.) |
xoopsMailer |
Envoi de mail |
xoopsMediaUploader |
Upload de fichiers |
xoopsModule |
Gestion des modules |
xoopsObject |
Classe de base pour la création de classes dérivées |
xoopsPageNav |
Pour la création d'une navigation entre pages |
xoopsTree |
Gestion de catégories/sous-catégories |
xoopsTpl |
Classe dérivée de la classe Smarty pour l'affichage
par templates |
xoopsUser |
Gestion des utilisateurs |
|
|
Fichiers |
|
functions.php |
Fonctions utilisables par tout module |
xoops_version.php |
Fichier de définition des caractéristiques
du module
|
|
|
Formulaires |
|
Classes de formulaire |
Création du formulaire |
Eléments de formulaire
(1) |
Eléments hidden, text, label, button, file, etc. |
Eléments de formulaire
(2) |
Eléments radio, checbox et select |
|
|
|