[Bradabra-devfr] organisation des sources Bradabra

[Jean-Charles L. <jc...@ry...>]

à l'attention des french bradabra coderz
(best viewed with monospace fonts)

juste un petit post pour expliquer l'organisation
des dossiers de bradabra, je ne sais pas si ça
correspond bien aux normes mais bon...

/archives
   aucune source ne doit y être présente, c'est un répertoire réservé à
   l'utilisateur.

/config
   correspond à la page de configuration de bradabra.

/images
   bah... hé ! :)

/include
   (ce répertoire étant important, je vais étudier son listing complet)
   config_user.php
     il s'agit des valeurs que l'utilisateur final devra affecter lorsqu'il
     installera bradabra.
   db.php
     ce fichier se compose de 2 sous-parties :
     - description complète de la hierarchie de la BDD.
       quand vous rajoutez une table ou même une colonne, vous devrez la
       reporter dans cette classification avec ses propriétés spécifiques.
       cela permet un minimum d'automatisation...
     - un jeu de fonction permettant de se servir de la classification en
       question. ces fonctions regroupent les requêtes les plus souvent
       utilisées pour coder bradabra.
   db_connect.php
     ce fichier est inclu dans tous les fichiers sources, il ouvre simplement
     une session auprès du SGBD.
   defines.php
     c'est un fourre-tout de defines, mais un fourre-tout classé ! :)
     mettez-y tout ce qui ne va pas ailleurs.
   functions.php
     se sont des fonctions d'ordre générale.
     se fichier est un peu du même acabit que defines.php mais pour les
     fonctions.
   functions_arch.php
     un jeu de fonctions dédiées à la gestion E/S des archives, en l'occurence
     les archives XML.
   functions_js.php
     même idée que functions_arch.php mais ce sont cette fois-ci des fonctions
     JavaScript stockées sous forme de chaines PHP permettant ainsi leur
     inclusion à l'aide de la fonction Include_JS() définie dans functions.php
     je crois.
   includes.php
     fichier générique permettant de ne faire qu'un seul include à partir des
     autres fichiers sources.
     ATTENTION à l'ordre des includes !
   lang.php
     tableaux de traduction des langues...
   login_check.php
     ce fichier permet l'authentification de la session/utilisateur, si c'est
     le cas, il charge ensuite tout ce qui est options de l'utilisateur et
     options générales.
   sql.php
     une espèce de bibliothèque SQL (un peu à l'ancienne ma foie quand je vois
     ce qu'on peu faire avec des classes en PHP, cf daCode : www.dacode.org)
   style.php
     c'est un peu un dérivé de templates-fait-maison-à-la-con...
     avec du recul maintenant, je me dis que l'idéal serait vraiment
     d'implanter un moteur de templates.

/install
   ce répertoire ne sert logiquement qu'à l'installation de bradabra après il
   doit pouvoir être supprimable.

/modules
   correspond aux modules de bradabra, pour l'instant on y trouve :
   archives/
     le module de gestion des archives
   browser/
     un mini moteur de recherche dans les archives je crois
   contacts/
     un module pour la gestion des contacts
   convert/
     un convertisseur de devises
   invoices/
     un module de génération de factures
   items/
     un module de gestion de stock
   quotations/
     module de génération de devis qui est pour l'instant sensiblement le même
     que celui des factures.


j'éspère que c'est compréhensible, et désolé pour
les fautes mais j'ai fait brûlé le clavier.

@+
JC