SAND-framework/data/doc-prince-book-generation/doc/sand/Contents/01.e.i Comprendre SAND pour ajouter une nouvelle page.md

SAND est nommé pour l'acronyme récursif (Simplement [AND et] un Autre Nouveau Dossier)

Tout d'abord, avant même de vouloir ajouter de nouvelles pages, je vais vous présenter la structure, ainsi vous comprendrez où se trouvent les fichiers nécessaires afin d'ajouter une simple page Hello_World

Comment est architecturé le framework SAND ?

La racine de SAND contient les dossiers suivant :

• application : dossier contenant différents fichiers, propre à l’application et au framework dont on détaillera le contenu plus bas.

  1. class : dossier contenant les fichiers propres au framework. Ne doit pas être modifié.

  2. config : dossier contenant les fichiers de configuration, normalement lors de la récupération du dépôt, les fichiers sont a renommer et a ancrer avec les bonnes valeurs

  3. include : dossier de développement contient :

     1. actions : dossier contenant les actions réutilisables dans les vues de l’application

     2. conduits : dossier contenant le contrôleur qui est conduit par le routage symfony, ici utilisé exclusivement pour générer des réponses AJAX

     3. controlleurs : dossier contenant les contrôleurs de l’applications, nous verrons plus tard le modèles MVC propre au framework, mais il faut savoir que les controlleurs contiennent les accès en bdd de la page correspondant à son nom

     4. modeles :dossier contenant les modèles de l’application, il faut savoir que les modèles ont l’extension .model et contiennent les variable propres à la page, comme le title, la description ou plus récemment le fil d’ariane

     5. vues : dossier contenant les fichiers blade ou twig utilisé dans les pages, les actions et les conduits dont voici le détail :

        1. cache : dossier contenant les fichiers de cache généré par le moteur de rendu

        2. layout : dossier contenant les différents layouts des pages

        3. system : dossier contenant le/les layout(s) système(s)

        4. view : dossier contenant toutes les vues de l’application, une convention de nommage peut être établie suivant le domaine de l’application, par exemple, toutes les vues des actions doivent commencer par action et toutes les vues des conduits doivent commencer par le nom du conduit duquel ils sont appelés

  4. logs : dossier contenant les logs générer par l’application, une classe dédiée aux logs est contenue dans le framework

  5. modules : dossier contenant les modules de l’application, il faut savoir que le framework peut contenir des applications modulaires, genre des applications symfony, wordpress, etc… toutes applications externe php peut avec un peu de doigté peut être intégré à une application, typiquement on peut intégrer un module de dépôt git genre gitlist à l’application que l’on est en train de développer.

  6. objets : dossier contenant les objets de session du framework, ce dossier peut être modifié par l’utilisateur, il contient des classes qui sont utilisé dans le cadre de la gestion de session, par exemple l’authentification CAS

  7. traitements : dossier contenant les traitements de formulaire selon le respect du pattern PRG (Post Redirect Get)

• console : dossier contenant les commandes console propres au framework et à l’application*

  1. command : dossier contenant les commandes console du framework et de l’application

  2. skel : dossier contenant les squelettes utilisés lors des appels console

• data : dossier contenant des données qui sont chargé par l’applications ou le framework

  1. docs : dossier contenant la documentation de l’application

  2. domain : dossier contenant les classes propres à la manipulation du domaine visé par l’application, ces classes peuvent être testées unitairement par PHPUnit

  3. output : dossier contenant les sorties des commandes console de l’applications, ce peut être des logs ou des fichiers de traitement

• public : dossier contenant la racine publique de l’application, le serveur apache doit pointer sur ce dossier pour que le reste ne soit pas accessible, il contient tous les assets (css, js) de l’application ainsi que le fichier index.php et .htaccess redirigant toutes les requêtes vers l’index.

• tests : dossier contenant les fichiers de tests unitaire ou fonctionnels

et :

• vendor : dossier créé par composer lors de la récupération des paquets nécessaire à l’application, contient aussi l’autoloader de l’application généré à la volée par composer

• node_modules : dossier créé par npm lors de la récupération des paquets pouvant être nécessaire à l’application

Comment ajouter une nouvelle page nommé hello_world ?

Voilà vous êtes prêt, lancez donc la SANDcommande suivante depuis la racine

php console/bin.php page:add

puis répondez aux questions en donnant un nom tel que hello_world, et... trois(3) nouveaux fichiers sont apparus dans application/include : au sein de controlleurs, modeles et vues/view

Ouvrez les et regardez, votre nouvelle page est accessible sur http://my-new-sand-project.dev.local/hello_world