[INFO] Validation des MODs pour phpBB 2.0.x

[Edouard]

Toutes les informations contenues ici sont à lire en priorité avant de proposer un MOD dans le forum de Développement Béta.

» Sommaire

[>>] Règlement général
[>>] Normes à respecter
[>>] Conseils et astuces
_____________________________________

L'équipe des MODs de phpBB-Fr est actuellement composée des membres suivants:

• ErnadoO (Moderateur de groupe)
• ABDev
• Vlad Tepesch

[Edouard]

» Règlement

Voici les regles générales desquelles vous devez absoument prendre connaissance.

Article 1 : Seule l'équipe des MODs est habilitée à la validation d'un MOD. L'équipe des MODs se reserve également le droit d'ajouter, modifier ou supprimer des éléments de ce reglement.

Article 2 : Seul l'auteur d'un MOD peut proposer celui ci dans ce forum. L'équipe des MODs le testera ensuite, puis soumettra sa validation à un vote.

Article 3 : Pour une meilleure organisation, tous les MODs proposés dans ce forum devront être présentés de la même manière. Le titre du sujet devra être: [X.Y.Z] Nom du MOD ( Voir plus loin pour la signification de X.Y.Z ) et devra contenir les informations suivantes:


Code: Tout sélectionner

[list][*][b]MOD Titre:[/b]
[*][b]MOD Auteur:[/b] Nom auteur < Mail > Site
[*][b]MOD Traduction:[/b]
[*][b]Sujet officiel phpBB.com:[/b] lien ou n/a

[*][b]MOD Description:[/b]
[*][b]MOD Version:[/b]
[*][b]Compatibilité EasyMOD:[/b] [color=darkred]Oui/Non[/color]

[*][b]Niveau d'installation:[/b] [color=darkblue]Facile/Moyen/Difficile[/color]
[*][b]Temps d'installation:[/b] en minutes
[*][b]Téléchargements:[/b] [url=http://www.lien_vers_votre_mod.com/]Ici[/url]

[*][b]Captures d'écran:[/b]
[list]
[*]n/a
[/list]
[*][b]Démonstrations:[/b]
[list]
[*]lien(s) menant vers une démo du MOD
[/list]
[*][b]Notes:[/b]
[list]la notice d'installation de ce mod se trouve dans [b]chemin[/b]
[/list]
[/list]



Article 4 : Un membre de l'équipe des MODs vous annoncera si votre MOD a été accepté ou non dans le sujet du MOD en question. Pour être validé, le MOD doit obligatoirement être dans une version stable.

Article 5 : Tous les MODs proposés doivent également respecter les normes énoncées dans la suite du réglement. Sous peine de voir le sujet du MOD vérouillé.

[Edouard]

» Normes à respecter

Général

Organisation des fichiers : Le MOD doit être contenu dans une archive .zip ayant pour nom, celui du MOD_X.Y.Z. L'archive doit contenir un dossier pour chaque langue dans laquelle le MOD est traduit. Dans chacun de ces dossier doit se trouver le fichier install.txt contenant les instructions d'installation du MOD ( voir point suivant ), et un dossier root/ contenant les fichiers à copier.

Template des MODs : Le fichier d'installation doit être présenté de manière très précise. Un tutorial sur le template officiel des MODs existe ici.

Version du MOD : Afin de pouvoir suivre facilement l'évolution de vos MODs, il est demandé d'utiliser un système de numérotation des versions de façon similaire à phpBB. phpBB utilise des versions de type X.Y.Z :


X doit être incrémenté si vous recodez votre MOD, ou si les changements qu'il subit sont très important.
Y doit être incrémenté si vous rajoutez une fonctionnalité à votre MOD.
Z doit être incrémenté si vous corrigez une erreur dans votre MOD.
Utilisez cette notation à bon escient et ne vous amusez pas à incrémenter la version à chaque bug très mineur corrigé, comme une faute d'orthographe, préférez corriger plusieurs bugs en une seule étape. La première version de votre MOD peut être 1.0.0 ou 0.0.1 selon votre préférence. Par contre, vous devrez ensuite suivre la notation d'incrémentation à chaque mise-à-jour.

Code

Les MODs doivent obligatoirement être codés sous la dernière version disponible de phpBB et sous le template de base: SubSilver.

DBAL ( Database Abstraction Layer ) : Le MOD doit utiliser la classe db de phpBB. Ce qui permettra de rendre votre MOD compatible avec tous les types de base de données. Par exemple, pour executer une requête SQL, il ne faudra pas utiliser la fonction PHP:


Code: Tout sélectionner

mysql_query();


Mais la méthode de la classe db, soit:


Code: Tout sélectionner

$db->sql_query();


Le principe est le même pour toutes les autres fonctions.

Template : Le MOD doit également utiliser le système de template de phpBB. Ce qui permettra de rendre compatible votre MOD avec tous les thèmes existants pour phpBB. Les fichiers PHP ne doivent donc contenir qu'un minimum de code HTML.
Pour plus d'information sur le système de template, merci de lire le chapitre 3 du tutorial sur la création d'un MOD.

Langues : Le MOD doit utiliser le système de langues de phpBB. Cela permettra à votre MOD d'être traductible dans différentes langues. Les seuls fichier qui pourront donc contenir du texte à afficher sont les fichier lang_*.php ( situés dans le dossier language/lang_* ). Les variables contenant les textes sont appellées "clés de langue". Elles sont donc à déclarer dans les fichier lang comme dit plus haut, et sont bien sûr ensuite utilisable comme n'importe quelle variable depuis tous les fichiers du script.
Du texte est cependant accepté pour les messages d'erreurs.

URLs : Pour créer des URLs vous devez obligatoirement utiliser la variable $phpbb_root_path et la fonction append_sid();. Ce qui permettra de générer des URLs en fonction du chemin de la page actuelle ( $phpbb_root_path ) et de la session de l'utilisateur ( au cas où les cookies ne sont pas utilisés ). Les URLs ne devront donc quasiment jamais être directement dans vos fichier .tpl.

Sécurité : Pour finir, votre MOD doit être le plus sécurisé possible. Pour cela, il existe quelques méthodes "de base".
Tout d'abord, il est important de sécuriser toutes les variables de formulaires grâce à intval() ( contenu numérique ), et htmlspecialchars() ( caracteres html "sensibles" remplacés ).
Ensuite, chaque nouvelle page créée du MOD, doit contenir:


Code: Tout sélectionner

define('IN_PHPBB', true);


Pour prévoir les attaques exterieures.
Enfin, une dernière chose très importantes, est d'éviter les injections SQL. Pour cela, il faut par exemple utiliser la fonction addslashes() et:


Code: Tout sélectionner

str_replace("\'", "''", $var)


( $var a remplacer par la variable à sécuriser ).

[Edouard]

» Conseils et astuces

Optimisation : Essayez d'optimiser un maximum votre code. Tant au niveau des requêtes SQL, qu'au niveau du reste du code ( boucles, fonctions etc. ).

Variables de template : Comme expliqué dans les normes à respecter, vous devez absolument utiliser des variables de template pour afficher des données, textes, URLs etc.
Il existe cependant une syntaxe spécifique à phpBB pour nommer ces variables. Voici les différents suffixes / préfixes possibles des variables de template ainsi que leur contexte d'utilisation.

U_ : Utilisé pour les variables contenant une URL.
S_ : Utilisé pour les variables de formulaire.
L_ : Utilisé pour les variables de langue.
T_ : Utilisé pour les variables de thème.
_IMG : Utilisé pour les variables contenant une image.