Règles de codage - Historique des versions

Antgal : /* Protection des variables de sorties */

2009-11-02T15:49:05Z

‎Protection des variables de sorties

Paul : /* HTML / CSS */

2008-11-05T08:52:45Z

‎HTML / CSS

Paul : /* Fonction de traduction */

2008-11-05T08:52:09Z

‎Fonction de traduction

Paul : /* Base de données */

2008-11-05T08:51:41Z

‎Base de données

Paul : /* Base de données */

2008-11-05T08:50:54Z

‎Base de données

Paul : /* Protection des variables de sorties */

2008-11-05T08:50:23Z

‎Protection des variables de sorties

Paul : /* Les fichiers */

2008-11-05T08:48:48Z

‎Les fichiers

Paul : /* Les fichiers */

2008-07-11T09:34:51Z

‎Les fichiers

Paul : /* Uploads */

2008-07-11T09:33:50Z

‎Uploads

Paul : /* Les fichiers */

2008-07-11T09:32:53Z

‎Les fichiers

@@ Ligne 143 : / Ligne 143 : @@
 *: <code>bab_toHtml($str, $option = BAB_HTML_ENTITIES)</code>
 *: où $option est une combinaison ( OR ) des valeurs suivantes :
-** <code>BAB_HTML_ALL</code>		: BAB_HTML_P & BAB_HTML_BR & BAB_HTML_LINKS & BAB_HTML_ENTITIES</li>
+** <code>BAB_HTML_ALL</code>		: BAB_HTML_P & BAB_HTML_BR & BAB_HTML_LINKS & BAB_HTML_ENTITIES
-** <code>BAB_HTML_ENTITIES</code>	: special characters will be replaced with html entities</li>
+** <code>BAB_HTML_ENTITIES</code>	: special characters will be replaced with html entities
-** <code>BAB_HTML_AUTO</code>	: the paragraphs tags will be added only if the text contein some text line-breaks</li>
+** <code>BAB_HTML_AUTO</code>	: the paragraphs tags will be added only if the text contein some text line-breaks
-** <code>BAB_HTML_P</code>		: double line breaks will be replaced by html paragraphs, if there is no double line breaks, all the text will be in one paragraph</li>
+** <code>BAB_HTML_P</code>		: double line breaks will be replaced by html paragraphs, if there is no double line breaks, all the text will be in one paragraph
-** <code>BAB_HTML_BR</code>			: Line-breaks will be replaced by html line breaks</li>
+** <code>BAB_HTML_BR</code>			: Line-breaks will be replaced by html line breaks
-** <code>BAB_HTML_LINKS</code>		: url and email adress will be replaced by links</li>
+** <code>BAB_HTML_LINKS</code>		: url and email adress will be replaced by links
-** <code>BAB_HTML_JS</code>			: ' and " are encoded for javascript strings</li>
+** <code>BAB_HTML_JS</code>			: ' and " are encoded for javascript strings
-** <code>BAB_HTML_REPLACE</code>		: Replace ovidentia macro $XXX() a utiliser uniquement our du texte en provenance de l'éditeur WYSIWYG</li>
+** <code>BAB_HTML_REPLACE</code>		: Replace ovidentia macro $XXX() a utiliser uniquement our du texte en provenance de l'éditeur WYSIWYG
 * '''Vers la base de données''' :

@@ Ligne 246 : / Ligne 246 : @@
 Pour utiliser d'autres styles, il faut créer des feuilles de style supplémentaires à l'intérieur du répertoire style du noyau et inclure le fichier par php :
-<pre>
+<source lang="php">
 $babBody->addStyleSheet('toto.css');
-</pre>
+</source>
 ===Uploads===

@@ Ligne 197 : / Ligne 197 : @@
 ===Fonction de traduction===
-Toutes les chaînes de langage doivent être en anglais et traduites en utilisant la fonction '''bab_translate()''':
+Toutes les chaînes de langage doivent être en anglais et traduites en utilisant la fonction <code>bab_translate()</code>:
-<pre>
+<source lang="php">
 bab_translate("Hello world");
-</pre>
+</source>
 ===Debug===

@@ Ligne 163 : / Ligne 163 : @@
 * '''Variable global babDB''' :
 *: Utiliser toujours la variable global <code>$babDB</code> pour interroger la base de données.
-*: Ne pas utiliser <code>$GLOBALS['babDB']</code> mais explicitement déclarer la variable globale, comme ceci
+*: Ne pas utiliser <code>$GLOBALS['babDB']</code> mais explicitement déclarer la variable globale, comme ceci :
-*: '''global $babDB;'''
+*: <source lang="php">global $babDB;</source>
 * '''Insert''':

@@ Ligne 162 : / Ligne 162 : @@
 ===Base de données ===
 * '''Variable global babDB''' :
-*: Utiliser toujours la variable global '''$babDB''' pour interroger la base de données.
+*: Utiliser toujours la variable global <code>$babDB</code> pour interroger la base de données.
-*: Ne pas utiliser '''$GLOBALS['babDB']''' mais explicitement déclarer la variable globale, comme ceci
+*: Ne pas utiliser <code>$GLOBALS['babDB']</code> mais explicitement déclarer la variable globale, comme ceci
 *: '''global $babDB;'''

@@ Ligne 141 : / Ligne 141 : @@
 * '''Vers le navigateur''' :
 *: Les variables à destination du navigateur doivent être protégées, utiliser la fonction :
-*: '''''bab_toHtml($str, $option = BAB_HTML_ENTITIES)'''''
+*: <code>bab_toHtml($str, $option = BAB_HTML_ENTITIES)</code>
 *: où $option est une combinaison ( OR ) des valeurs suivantes :
-** BAB_HTML_ALL		: BAB_HTML_P & BAB_HTML_BR & BAB_HTML_LINKS & BAB_HTML_ENTITIES</li>
+** <code>BAB_HTML_ALL</code>		: BAB_HTML_P & BAB_HTML_BR & BAB_HTML_LINKS & BAB_HTML_ENTITIES</li>
-** BAB_HTML_ENTITIES	: special characters will be replaced with html entities</li>
+** <code>BAB_HTML_ENTITIES</code>	: special characters will be replaced with html entities</li>
-** BAB_HTML_AUTO		: the paragraphs tags will be added only if the text contein some text line-breaks</li>
+** <code>BAB_HTML_AUTO</code>	: the paragraphs tags will be added only if the text contein some text line-breaks</li>
-** BAB_HTML_P		: double line breaks will be replaced by html paragraphs, if there is no double line breaks, all the text will be in one paragraph</li>
+** <code>BAB_HTML_P</code>		: double line breaks will be replaced by html paragraphs, if there is no double line breaks, all the text will be in one paragraph</li>
-** BAB_HTML_BR			: Line-breaks will be replaced by html line breaks</li>
+** <code>BAB_HTML_BR</code>			: Line-breaks will be replaced by html line breaks</li>
-** BAB_HTML_LINKS		: url and email adress will be replaced by links</li>
+** <code>BAB_HTML_LINKS</code>		: url and email adress will be replaced by links</li>
-** BAB_HTML_JS			: ' and " are encoded for javascript strings</li>
+** <code>BAB_HTML_JS</code>			: ' and " are encoded for javascript strings</li>
-** BAB_HTML_REPLACE		: Replace ovidentia macro $XXX() a utiliser uniquement our du texte en provenance de l'éditeur WYSIWYG</li>
+** <code>BAB_HTML_REPLACE</code>		: Replace ovidentia macro $XXX() a utiliser uniquement our du texte en provenance de l'éditeur WYSIWYG</li>
 * '''Vers la base de données''' :
 **Quel que soit le type, placer toujours les données entre apostrophes.
-*: Exemple: '''select * from table where id='2''''
+*: Exemple: <code>select * from table where id='2'</code>
 **Toujours utiliser db_escape_string() pour protéger les variables passées dans les requêtes SQL.
 *:Exemple : select id from table where id_user=\''''''.$babDB->db_escape_string($var).'''''\';

@@ Ligne 17 : / Ligne 17 : @@
 Dans la mesure du possible, le nom du fichier doit refléter la fonctionnalité gérée. D'une manière générale:
-* Si le fichier est un fichier destiné à l'administration, il doit commencer par '''« adm »''' et doit être placé dans le répertoire '''« admin »''' de la distribution.
+* Si le fichier est un fichier destiné à l'administration, il doit commencer par <code>« adm »</code> et doit être placé dans le répertoire '''« admin »''' de la distribution.
-* Si le fichier est un fichier destiné à être inclu, le nom doit finir par '''« incl »''' et doit être placé dans le sous-répertoire '''« utilit »''' de la distribution. Ces fichiers ne doivent contenir que des déclarations (fonctions, classes, ...). Ils ne doivent en aucun cas contenir du code qui sera exécuté par inclusion uniquement.
+* Si le fichier est un fichier destiné à être inclu, le nom doit finir par <code>« incl »</code> et doit être placé dans le sous-répertoire '''« utilit »''' de la distribution. Ces fichiers ne doivent contenir que des déclarations (fonctions, classes, ...). Ils ne doivent en aucun cas contenir du code qui sera exécuté par inclusion uniquement.
 * Le nom ne doit pas contenir des lettres majuscules.
 * Le copyright et les références à Ovidentia et à CANTICO doivent apparaître au début de chaque fichier.
-* Pour délimiter le code PHP, l'utilisation des tags '''<?php .... ?>''' est obligatoire. L'utilisation des tags '''<? ...?>''' est interdite.
+* Pour délimiter le code PHP, l'utilisation des tags <code><?php .... ?></code> est obligatoire. L'utilisation des tags <code><? ...?></code> est interdite.
 * Le fichier doit inclure le fichier base.php
 * Le code à exécuter doit se situer en fin de fichier.

@@ Ligne 28 : / Ligne 28 : @@
 <source lang="php">
 //-------------------------------------------------------------------------
 // OVIDENTIA http://www.ovidentia.org

@@ Ligne 253 : / Ligne 253 : @@
 Pour être compatible avec la directive open_basedir, il ne faut jamais ouvrir un fichier dans le répertoire temporaire. Utilisez plutôt ce code à la place :
-<pre>
+<source lang="php">
 include_once $babInstallPath."utilit/uploadincl.php";
 $cphoto = bab_getUploadedFileContent('photof');
-</pre>
+</source>
 ceci permet de récupérer le contenu du fichier en passant par un fichier temporaire intermédiaire.

@@ Ligne 25 : / Ligne 25 : @@
 * Le code à exécuter doit se situer en fin de fichier.
 *:Le début ne doit contenir que des déclarations, des fonctions ou des classes.
-<pre>
-/************************************************************************
- * OVIDENTIA http://www.ovidentia.org                                   *
+<source lang="php">
-  ************************************************************************
+//-------------------------------------------------------------------------
-  * Copyright (c) 2003 by CANTICO ( http://www.cantico.fr )              *
+// OVIDENTIA http://www.ovidentia.org
-...
+// Ovidentia is free software; you can redistribute it and/or modify
-************************************************************************/
+// it under the terms of the GNU General Public License as published by
 include_once 'base.php';
 include ...
 // function
@@ Ligne 43 : / Ligne 61 : @@
-</pre>
+</source>
 === Les accolades===