Cette partie de la documentation n'est pas à destination des utilisateurs de Coppermine, mais uniquement pour les développeurs. Il n'y a pas d'aide pour ces chapitres, ils sont livrés tels quels.
Les utilisateurs finaux qui veulent modifier leur copie de Coppermine, sont encouragés à suivre ces règles eux aussi.
Comme Coppermine est un travail d'équipe, les membres de l'équipe qui contribuent doivent s'assurer que le code reste facile à lire, à comprendre et à maintenir. C'est pourquoi il y a ici un certain nombre de règles qu'il faut respecter lorsque l'on travaille sur le code source de Coppermine. Bien que cette partie de la documentation soit pour les membres de l'équipe de développement de Coppermine, les utilisateurs qui souhaitent contribuer avec leur code de quelque manière que ce soit sont priés de répéter ces règles autant que possible (si vous les comprenez totalement).
Les règles de codage de cette page ne sont pas gravées dans le marbre - si vous (en tant que membre de l'équipe de développement) trouvez pendant le développement, qu'une de ces règles doit être révisée ou changée, commencez un sujet sur le forum de discussion dédié au développement (dev board) pour en discuter.
$pic_title = 'My picture'; $album = 'lastup'; $update_time = true;Bon exemple:
$pic_title = 'My picture'; $album = 'lastup'; $update_time = true;
$foo = array('one', 'two', 'three'); $bar = array( 'one' => 1, 'two' => 3, 'three' => 3 ); $multi = array('first' => 'one', 'second' => array('2'), 'third' => array('foo' => 'bar', 'hello' => 'world'));Bons exemples:
$foo = array( 'one', 'two', 'three', ); $bar = array( 'one' => 1, 'two' => 2, 'three' => 3, ); $multi = array( 'first' => 'one', 'second' => array('2'), // Comme il n'y a qu'une valeur dans le tableau, il peut être déclaré dans la même ligne 'third' => array( 'foo' => 'bar', 'hello' => 'world', ), );
$foo_array["bla"] = "whatever";Bon:
$foo_array['bla'] = 'whatever';
$bla_array['foo Bar'] = 'some string';Bon:
$bla_array['foo_bar'] = 'some string';
cela inclue if, for, while, switch.
if ($foo = 'bar') { echo 'Hello world'; }Mauvais exemple:
if ($foo = 'bar') { echo 'Hello world'; }Bon exemple:
if ($foo = 'bar') { echo 'Hello world'; }Bon exemple:
if ($foo = 'bar') { echo 'Hello world'; }
<?php function fooFunction($arg1, $arg2 = '') { if (condition) { statement; } return $val; } ?>
Lorsqu'il y a plus d'une ligne d'HTML à afficher, la syntaxe Heredoc doit être utilisée au lieu de suspendre le processus PHP pour le rependre ensuite.
Bon:
// PHP content here if ($foo == $bar) { print <<< EOT <h1>Hello {$bla}</h1> EOT; }
Mauvais:
// PHP content here if ($foo == $bar) { ?> <h1>Hello <?php echo $bla; ?></h1> <?php }
Pour afficher une fin de ligne dans la sortie HTML, utilisez la syntaxe heredoc ou utilisez la variable $LINEBREAK au lieu de coder des fins de lignes en dur dans le code.
N'oubliez pas de rendre la variable $LINEBREAK globale dans les fonctions.
Bon:
echo '<h1>Hello world</h1>' . $LINEBREAK; echo '<p>foo bar</p>'; }
Mauvais:
echo "<h1>Hello world</h1>\n"; echo '<p>foo bar</p>'; }
Les balises HTML dépréciées comme <font> ne doivent pas être introduites dans Coppermine sans qu'il n'y ait une raison valide et documentée de faire de la sorte.
Les balises populaires comme <b> et <i> sont considérées comme dépréciées. Du fait de leur popularité, les navigateurs les supporteront certainement encore pendant un certain temps. Néanmoins, il y a de meilleures alternatives. Pour <b>, la balise de remplacement est <strong>. Pour <i>, la balise de remplacement est <em>. Si possible, utilisez ces balises de remplacement aussi bien pour les sorties générées par Coppermine que pour la documentation.
Les règles principales de cette page ont été esquissées par Dr. Tarique Sani comme un sous-ensemble de lignes directrices de codage PEAR. Les sorties HTML et la section concernant la base de donnée sont basées sur un sujet crée par Unknown W. Brackets Simplemachines.
Mauvais exemple | Bon exemple |
---|---|
Cliquez sur les mots à côté des boutons radio pour voir la différence ! |