Introduction :

Ici nous allons voir en détail les bonnes pratiques de développement afin d'écrire du code respectant l'esprit de PHPBoost qui soit maintenable et évolutif.
Ce qui veut dire que votre code pourra subir facilement des mises à jours et qu'il suive l'évolution de PHPBoost sans que vous ayez à le modifier à chaque nouvelle version.

Je sais ce que je veux réaliser

Avant de commencer votre module, pensez à rédiger un petit cahier des charges.
C'est quoi ?

Un cahier des charges et tout simplement un dossier que vous allez rédiger sur votre module, celui-ci devra contenir tout ce qui composera votre module.

C'est à dire :

• Son rôle
• Les options
  

Bien sur d'autres éléments peuvent êtres ajoutés au cahier des charges comme, ce qu'il cible comme domaine, etc...
Je vous invite à lire ceci afin d'en savoir plus sur les cahier des charges.
Une fois que vous savez quoi réaliser et surtout comment vous y prendre, alors vous pourrez commencer.

Indenter son code ?

Indentation est est mot utilisé en programmation, dans certain langage celle-ci est obligatoire, en PHP ce n'est pas le cas.
Mais ce n'est pas pour autant qu'il faut écrire son code comme un cochon

L'indentation est la façon dont le code est écrit, un code bien indenté c'est un code facile à relire.

Un exemple avec du code simple :

Code PHP :

Mon code est bien indenté, il est lisible et facile à lire.
Et là je vais dans l'extrême, mais voici un exemple de code difficile à relire.

Code PHP :

Et encore ici en exemple nous avons un code relativement simple, imaginez un code plus compliqué avec plus de condition,etc...
Sa serait vraiment illisible sans devoir modifier toute l'indentation.
Ce sont de bonne habitude à prendre.

Autre que l'indentation, il est bien aussi de commenter son code afin de s'y retrouver si on doit le relire plus tard ou qu'une personne reprend votre code ou voir même vous aidr.
Sa va lui permettre de comprendre plus vite et plus facilement celui-ci sans avoir à l'analyser afin de le comprendre.

Dans notre exemple

Code PHP :

Nous avons commenté notre code et rien qu'en le lisant nous comprenons tout de suite à quoi il sert et ce que chaque ligne réalise.
Bien sur il n'est pas obligatoire de commenter chaque ligne, en général sont commentés les lignes de code utilisant des fonctions importées, ou tout autre code n'étant pas du code PHP simple à comprendre à première vue.

Bien se documenter

Savoir quoi réaliser c'est bien, mais faut-il encore savoir le réaliser et si tel n'est pas le cas, consulter des documentations et ne pas hésiter à poser des questions si on ne trouve pas la réponse.
Le travail ne sera pas fait à votre place, donc mettez-y un peu du votre.

Dans le cas de PHPBoost

Utiliser un maximum les fonctions offertes par le Framework de PHPBoost.
Sa vous facilitera le développement de votre module mais aussi le rendre 100% compatible avec celui-ci.