FrameBeurk documentation
4. Organisation
Le schéma ci-dessous représente l’organisation des différents fichiers sur le serveur.
4.1. A la racine du site
- Les 5 points d’entrées, l’interpréteur, le fichier .htaccess destiné au paramétrage du serveur Apache (si c’est celui qui est utilisé).
- Le dossier « modules » contient le bootstrap, le fichier de configuration du site, la couche de communication avec la DB, ainsi qu’un sous-répertoire par module installé.
- « ressources » contient les fichiers qui seront réclamé par le navigateur. Ce dossier doit donc être défini en « allow » dans les directives du serveur http (contrairement aux autres répertoires qui seront en « deny »).
- « imports » contient les éventuel fichiers php ou html -indépendants de modules, qui seront inclus dans le code de la page avant envoi.
- « patrons » contient un sous-répertoire par patron installé.
4.2. Dans chaque répertoire de module
- Le fichier de configuration du module, appelé explicitement par le fichier de configuration du site. C’est le seul fichier obligatoire du module.
- Le fichier de fonctions de service du module, à paramétrer dans la configuration pour qu’il soit chargé par le bootstrap.
- Le fichier helpers. Les helpers sont des fonctions communes d’aide à la génération du code html.
- Les contrôleurs apportés par le module.
- Les widgets réalisant des affichages particuliers.
- Le dossier « _sql » contient le(s) script(s) de génération en base de données des objets nécessaires au fonctionnement du module.
- Le dossier « _js » contient le Javascript utile au module. Le fichier est un fichier php qui sera interprété, notamment pour résoudre le tissage des fonctions Javascript, avant envoi au navigateur (par le point d’entrée js.php).
- Le dossier « _css » contient autant de fichier css que de styles connus du module. Comme pour le Javascrit, les fichiers sont des fichiers php qui seront interprété avant envoi au navigateur (par le point d’entrée css.php).
- Un répertoire par type d’entité.
4.3. Dans chaque répertoire d’entité
- Le fichier helpers pour les fonctions d’affichage des vues de l’entité.
- Le fichier modele mutualise le cas échéant les requêtes d’accès à la base de données pour cette entité.
- Le répertoire « Maj » contient un fichier par action Maj possible sur l’entité.
- Le répertoire « Vue » contient un fichier par action Vue possible sur l’entité.
4.4. Dans chaque répertoire de patron
- Le fichier patron pour une page html.
- Eventuellement, entête et enqueue du patron html sont dans des fichiers séparés.
- Le patron pour le code html d’une vue renvoyée par Ajax.
- Le patron pour un fil Rss.
- Le répertoire « _css » contient un fichier css pour chaque style connu du patron, et si besoin un fichier de fonction permettant de générer du code particulier (par exemple pour les boutons, les images à encoder dans le css…).
- Le dossier « _js » contient le Javascript utile à la gestion de la page par le navigateur.