Convention de codage de Dotclear

Que vous développiez un plugin, vouliez corriger un bug ou simplement ajouter une fonctionnalité, le suivi de ces quelques règles est nécessaire.

Tout le code de Dotclear doit fonctionner avec cette configuration de PHP :

• short_open_tag = Off
• allow_call_time_pass_reference = Off
• error_reporting = E_ALL | E_STRICT
• display_error = On
• register_globals = Off
• magic_quotes_gpc = Off
• allow_url_fopen = Off

Le code doit fonctionner avec PHP 5.2 minimum.

ini_set('display_errors',true);
error_reporting(E_ALL | E_STRICT);

Utilisez une indentation en tabulations vraies (pas en espaces). La largeur courante (et pratique) d'une tabulation est de 5 espaces dans le code de Dotclear.

Il est par ailleurs conseillé de ne pas dépasser 70 caractères dans les lignes.

Les structures de contrôle sont les instructions if, switch, for, while, foreach, etc. Vous devez laisser un espace entre le mot clé de l'instruction et la condition. La position des accolades est à votre discrétion.

<?php
if (condition1 && condition1) {
     action;
}
 
foreach ($tableau as $k => $v)
{
     action;
     action;
}
?>

Les fonctions sont appelées sans aucun espace entre le nom de la fonction, les parenthèses et les paramètres. Par exemple :

<?php
maFonction($var1,$var2);
?>

Si la fonction est retournée dans une variable, on mettra au moins un espace de part et d'autre du signe égal. Par exemple :

<?php
$var = maFonction($var1);
?>

Les accolades de la fonction sont placées sous le nom de celle-ci et le code est indenté d'un niveau. Par exemple :

<?php
maFonction($var1,$var2=0)
{
     return $var1+$var2;
}
?>

Les commentaires d'une ligne sont fréquemment faits avec le signe #, moins avec les //. Les commentaires de plusieurs lignes seront faits avec le style /* commentaire */

La désactivation d'une portion de code par un commentaire sera faite avec le code /* //*/, de cette manière, il suffit d'ajouter un / pour désactiver le commentaire. Par exemple :

<?php
/*
code();
//*/
?>

Un fichier est inclus dans un autre relativement au premier. Cela est obligatoire. Par exemple :

<?php
require dirname(__FILE__).'/../../fichier.php';
?>

Le code PHP est toujours délimité par <?php ?> et non la version abrégée <? ?>. Ceci est obligatoire. La forme <?= ?> est bien entendu proscrite.

Les classes sont toujours nommées avec des lettres non accentuées. Les mots sont séparés par des majuscules et le nom de la classe commence par une minuscule. Par exemple :

<?php
class maClasse
{
//...
}
?>

Les noms de fonctions suivent les même règles que les classes.

Les noms des variables doivent avoir un sens. Les mots sont séparés par des _. Par exemple :

<?php
$ma_variable = 'texte';
$var = 'texte...';
?>

Dotclear se conforme au maximum à HTTP ce qui implique de suivre un certain nombre de règles.

Tout changement d'état (dans la base de données ou ailleurs) doit obligatoirement passer par une requête HTTP de type POST.

Par ailleurs, toute requête de ce type doit envoyer un champ nommé "xd_nonce" contenant un identifiant permettant d'assurer la légitimité de celle-ci.

Il est donc nécessaire de passer ce champ à tout formulaire de type POST. Par exemple :

<form action="foo.php" method="post">
<p>....</p>
<p><?php echo $core->formNonce(); ?></p>
</form>

L'appel à la méthode $core→formNonce() insère automatique un champ caché contenant la valeur du nonce dans le formulaire.

Enfin, ce qui est valable pour les soumissions de formulaire l'est également pour les requêtes faites via XML HTTP Request (Ajax) de type POST. Dotclear fournit une variable javascript contenant le nonce : dotclear.nonce.

Exemple de requête ajax avec le nonce :

params = {
  xd_check: dotclear.nonce,
  p: "param"
};
 
$.post(url,params,function() {
	...
});

Veillez à valider le code XHTML de votre thème ou plugin. Il est possible de valider du XHTML même s'il n'est pas accessible (par exemple dans l'administration) grâce à l'extension Web Developer pour Mozilla Firefox.

Pour qu'un plugin ou un thème qui accède à la base de données puisse fonctionner sur tous les blogs, il faut qu'il soit testé avec les bases de données MySQL et PostgreSQL (PGSQL). Si vous ne pouvez effectuer de tests avec un de ces types de base de données, demandez de l'aide sur le forum.