> Introduction

Cette page est destinée aux futurs développeurs de PHPUTIL. Elle explique les règles importantes à observer avant de sa lancer dans un nouveau module ou suggérer des modifications d'un module existant. Si ces règles n'étaient pas respectées, nous ne pourrions pas accepter votre code.

> Standards de codage

Les modules PHPUTIL s'appuie grandement sur la bibliothèque PEAR. Cette bibliothèque de classes est une volonté officielle de l'équipe de PHP. Elle n'est pas très fournie mais elle est cependant codée de façon quasi-parfaite. Elle implémente les briques essentielles (accès base de données, authentification, gestion des erreurs...)

Les modules PHPUTIL devront donc être codés sur le même modèle. Les noms de fonctions et les commentaires devront donc être en anglais et suivrent scrupuleusement les standards de codage de PEAR sauf concernant l'en-tête des fichiers sources qui pour les modules PHPUTIL devra être :

            
/*
 * PHPUTIL / Nom du module
 *
 * (c) annee, auteurs
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
            
        

La qualité et la conception devront en outre être irréprochables de manière à ce que l'on puisse prétendre à l'intégration de nos classes dans PEAR (bien que ce ne soit pas le but initial du projet).

> Idées directrices de PEAR

Vous ne pourrez échapper à l'examen attentif des différents packages de PEAR mais voici les quelques idées et grands principes que vous devrez utiliser :

• Utiliser systématiquement de la programmation objet (classes...)
• Utiliser le système de gestions des erreurs de PEAR (cf. manuel).
• Séparer le contenu du containeur : le stockage, la lecture... des données est confié à une classe quasi indépendante (containeur) différente selon le mode de stockage choisi (fichier XML, base de données...). Etudiez le package DB de PEAR pour un exemple pratique.
• (...)

A cela, il faut bien sûr rajouter les idées directrices du projet PHPUTIL lui même que vous pourrez trouver dans la présentation de PHPUTIL.

> Avant de vous lancer...

Avant de vous lancer dans des développements longs et complexes, prenez contact avec les développeurs de PHPUTIL. Pour ce faire, inscrivez-vous à la liste de diffusion 'phputil-develop' sur la page du projet PHPUTIL sur SourceForge.

> Pour plus d'infos ?

Pour plus d'infos, vous pouvez consultez :

• La liste des différents modules PHPUTIL
• La "RoadMap" (travail en cours et perspectives)
• La page du projet sur SourceForge (pour vous inscrire à la liste de diffusion des développeurs...)