From cbcb0eb22fc4c59a8f6cdb72e709a9164fdd966f Mon Sep 17 00:00:00 2001 From: Emmanuel ROY Date: Mon, 21 Mar 2022 16:03:31 +0100 Subject: [PATCH] Update for SAND app with APP STATE (OPEN CLOSED MAINTAINED) --- application/class/Application.php | 28 +- application/class/Browser.php | 20 +- application/class/Url.php | 16 + application/config/app-parameters.php.skel | 15 +- application/config/ldap-parameters.php | 6 + .../controlleurs/error-application-closed.php | 5 + .../error-application-maintained.php | 5 + application/include/controlleurs/error.php | 5 + .../modeles/error-application-closed.model | 6 + .../error-application-maintained.model | 6 + .../view/error-application-closed.blade.php | 165 +++++ .../error-application-maintained.blade.php | 612 ++++++++++++++++++ ... installer l'environnement du framework.md | 227 +++++++ ...t.md => 01.a. Configuration de départ.md} | 0 ...Comment est architecturé le framework.md} | 0 ...> 01.c. Comment bien utiliser les urls.md} | 0 ...nt bien utiliser les commandes console.md} | 0 ...dre SAND pour ajouter une nouvelle page.md | 80 +++ ....ii Comment ajouter une page proprement.md | 10 + .... Comment modifier proprement une page.md} | 0 ...nt fonctionnent les objets de sessions.md} | 0 ...nt faire évoluer une application SAND.md} | 0 ...acile.md => 02.a. Le controleur facile.md} | 0 ...base.md => 02.b. Le controleur de base.md} | 0 ...md => 02.c. Le controleur REST ou HTML.md} | 0 .../doc/sand/Contents/03.a. Les vues Twig.md} | 0 .../sand/Contents/03.b. Les vues Blade.md} | 0 ...> 03.c. Les vues Blade avec SPA(vuejs).md} | 0 .../04. Les Actions dans les vues.md} | 0 .../doc/sand/Contents/04.a. Les vues Twig.md | 65 -- .../doc/sand/Contents/04.b. Les vues Blade.md | 50 -- .../sand/Contents/05. Le conduit Symfony.md} | 0 .../Contents/07.a. modules - configuration.md | 30 +- ....b. modules - comment bien les utiliser.md | 11 +- .../sand/Contents/13. modules - Laravel.md | 1 + ...sifs en curl sur une API RESTFULL SAND.md} | 0 ...AND possibles dans sa prochaine version.md | 27 + ... installer l'environnement du framework.md | 227 +++++++ ...ent faire évoluer une application SAND.md | 5 - ...t.md => 01.a. Configuration de départ.md} | 0 ...Comment est architecturé le framework.md} | 0 ...> 01.c. Comment bien utiliser les urls.md} | 0 ...nt bien utiliser les commandes console.md} | 0 ...dre SAND pour ajouter une nouvelle page.md | 80 +++ ....ii Comment ajouter une page proprement.md | 10 + .... Comment modifier proprement une page.md} | 0 ...nt fonctionnent les objets de sessions.md} | 0 ...nt faire évoluer une application SAND.md} | 0 ...acile.md => 02.a. Le controleur facile.md} | 0 ...base.md => 02.b. Le controleur de base.md} | 0 ...md => 02.c. Le controleur REST ou HTML.md} | 0 data/docs/03.a. Les vues Twig.md | 229 +++++++ data/docs/03.b. Les vues Blade.md | 257 ++++++++ ...> 03.c. Les vues Blade avec SPA(vuejs).md} | 0 .../04. Les Actions dans les vues.md} | 11 +- .../05. Le conduit Symfony.md} | 2 + ...sifs en curl sur une API RESTFULL SAND.md} | 0 ...AND possibles dans sa prochaine version.md | 27 + 58 files changed, 2094 insertions(+), 144 deletions(-) create mode 100644 application/config/ldap-parameters.php create mode 100644 application/include/controlleurs/error-application-closed.php create mode 100644 application/include/controlleurs/error-application-maintained.php create mode 100644 application/include/modeles/error-application-closed.model create mode 100644 application/include/modeles/error-application-maintained.model create mode 100644 application/include/vues/view/error-application-closed.blade.php create mode 100644 application/include/vues/view/error-application-maintained.blade.php create mode 100644 data/doc-prince-book-generation/doc/sand/Contents/00. Comment installer l'environnement du framework.md rename data/doc-prince-book-generation/doc/sand/Contents/{00.a. Configuration de départ.md => 01.a. Configuration de départ.md} (100%) rename data/doc-prince-book-generation/doc/sand/Contents/{00.d. Comment est architecturé le framework.md => 01.b. Comment est architecturé le framework.md} (100%) rename data/doc-prince-book-generation/doc/sand/Contents/{00.b. Comment bien utiliser les urls.md => 01.c. Comment bien utiliser les urls.md} (100%) rename data/doc-prince-book-generation/doc/sand/Contents/{00.c. Comment bien utiliser les commandes console.md => 01.d. Comment bien utiliser les commandes console.md} (100%) create mode 100644 data/doc-prince-book-generation/doc/sand/Contents/01.e.i Comprendre SAND pour ajouter une nouvelle page.md create mode 100644 data/doc-prince-book-generation/doc/sand/Contents/01.e.ii Comment ajouter une page proprement.md rename data/doc-prince-book-generation/doc/sand/Contents/{00.e. Comment modifier proprement une page.md => 01.f. Comment modifier proprement une page.md} (100%) rename data/doc-prince-book-generation/doc/sand/Contents/{00.f. Comment fonctionnent les objets de sessions.md => 01.g. Comment fonctionnent les objets de sessions.md} (100%) rename data/doc-prince-book-generation/doc/sand/Contents/{00.g. Comment faire évoluer une application SAND.md => 01.h. Comment faire évoluer une application SAND.md} (100%) rename data/doc-prince-book-generation/doc/sand/Contents/{01. Le controleur facile.md => 02.a. Le controleur facile.md} (100%) rename data/doc-prince-book-generation/doc/sand/Contents/{02. Le controleur de base.md => 02.b. Le controleur de base.md} (100%) rename data/doc-prince-book-generation/doc/sand/Contents/{03. Le controleur REST ou HTML.md => 02.c. Le controleur REST ou HTML.md} (100%) rename data/{docs/04.a. Les vues Twig.md => doc-prince-book-generation/doc/sand/Contents/03.a. Les vues Twig.md} (100%) rename data/{docs/04.b. Les vues Blade.md => doc-prince-book-generation/doc/sand/Contents/03.b. Les vues Blade.md} (100%) rename data/doc-prince-book-generation/doc/sand/Contents/{04.c. Les vues Blade avec SPA(vuejs).md => 03.c. Les vues Blade avec SPA(vuejs).md} (100%) rename data/{docs/05. Les Actions dans les vues.md => doc-prince-book-generation/doc/sand/Contents/04. Les Actions dans les vues.md} (100%) delete mode 100644 data/doc-prince-book-generation/doc/sand/Contents/04.a. Les vues Twig.md delete mode 100644 data/doc-prince-book-generation/doc/sand/Contents/04.b. Les vues Blade.md rename data/{docs/06. Le conduit Symfony.md => doc-prince-book-generation/doc/sand/Contents/05. Le conduit Symfony.md} (100%) create mode 100644 data/doc-prince-book-generation/doc/sand/Contents/13. modules - Laravel.md rename data/doc-prince-book-generation/doc/sand/Contents/{13. Comment faire des appels récursifs en curl sur une API RESTFULL codée avec le framework.md => 17. Appels récursifs en curl sur une API RESTFULL SAND.md} (100%) create mode 100644 data/doc-prince-book-generation/doc/sand/Contents/19. Les evolutions de SAND possibles dans sa prochaine version.md create mode 100644 data/docs/00. Comment installer l'environnement du framework.md delete mode 100644 data/docs/00.f. Comment faire évoluer une application SAND.md rename data/docs/{00.a. Configuration de départ.md => 01.a. Configuration de départ.md} (100%) rename data/docs/{00.d. Comment est architecturé le framework.md => 01.b. Comment est architecturé le framework.md} (100%) rename data/docs/{00.b. Comment bien utiliser les urls.md => 01.c. Comment bien utiliser les urls.md} (100%) rename data/docs/{00.c. Comment bien utiliser les commandes console.md => 01.d. Comment bien utiliser les commandes console.md} (100%) create mode 100644 data/docs/01.e.i Comprendre SAND pour ajouter une nouvelle page.md create mode 100644 data/docs/01.e.ii Comment ajouter une page proprement.md rename data/docs/{00.e. Comment modifier proprement une page.md => 01.f. Comment modifier proprement une page.md} (100%) rename data/docs/{00.f. Comment fonctionnent les objets de sessions.md => 01.g. Comment fonctionnent les objets de sessions.md} (100%) rename data/docs/{00.g. Comment faire évoluer une application SAND.md => 01.h. Comment faire évoluer une application SAND.md} (100%) rename data/docs/{01. Le controleur facile.md => 02.a. Le controleur facile.md} (100%) rename data/docs/{02. Le controleur de base.md => 02.b. Le controleur de base.md} (100%) rename data/docs/{03. Le controleur REST ou HTML.md => 02.c. Le controleur REST ou HTML.md} (100%) create mode 100644 data/docs/03.a. Les vues Twig.md create mode 100644 data/docs/03.b. Les vues Blade.md rename data/docs/{04.c. Les vues Blade avec SPA(vuejs).md => 03.c. Les vues Blade avec SPA(vuejs).md} (100%) rename data/{doc-prince-book-generation/doc/sand/Contents/05. Les Actions dans les vues.md => docs/04. Les Actions dans les vues.md} (88%) rename data/{doc-prince-book-generation/doc/sand/Contents/06. Le conduit Symfony.md => docs/05. Le conduit Symfony.md} (94%) rename data/docs/{19. Comment faire des appels récursifs en curl sur une API RESTFULL codée avec le framework.md => 17. Appels récursifs en curl sur une API RESTFULL SAND.md} (100%) create mode 100644 data/docs/19. Les evolutions de SAND possibles dans sa prochaine version.md diff --git a/application/class/Application.php b/application/class/Application.php index 10bfe5e..a63e99f 100644 --- a/application/class/Application.php +++ b/application/class/Application.php @@ -26,8 +26,21 @@ class Application $this->url = new Url($this->http->method, $this->browser->isAppRequest()); - $dispacher = new Dispacher(); - $this->route = $dispacher->route; + switch(APP_STATE) { + case "CLOSED": + case "MAINTAINED": + $this->route = null; + break; + case "OPEN": + if(\MVC\Classe\Application::is_under_update()) { + $this->route = null; + break; + } + default: + $dispacher = new Dispacher(); + $this->route = $dispacher->route; + } + } public function launch() @@ -40,4 +53,15 @@ class Application \MVC\Object\Alert::remove(); } } + + public static function is_under_update(){ + $ajh = new \DateTime('NOW'); + $maintenance_begin = new \DateTime(MAINTENANCE_DATE_DEBUT); + $maintenance_fin = new \DateTime(MAINTENANCE_DATE_FIN); + if($maintenance_begin < $ajh && $ajh < $maintenance_fin) { + return true; + }else{ + return false; + } + } } diff --git a/application/class/Browser.php b/application/class/Browser.php index 99760ec..2971c1d 100644 --- a/application/class/Browser.php +++ b/application/class/Browser.php @@ -210,10 +210,22 @@ class Browser public function isAppRequest() { - if (preg_match('#App#', $this->user)) { - return true; - } else { - return false; + switch(APP_STATE) { + case "CLOSED": + case "MAINTAINED": + return false; + break; + case "OPEN": + if(\MVC\Classe\Application::is_under_update()) { + return false; + break; + } + default: + if (preg_match('#App#', $this->user)) { + return true; + } else { + return false; + } } } } diff --git a/application/class/Url.php b/application/class/Url.php index 2cdbede..6f9bd89 100644 --- a/application/class/Url.php +++ b/application/class/Url.php @@ -62,6 +62,22 @@ class Url unset($urlParts[1]); } + //Mise en place du statut de l'application + switch(APP_STATE){ + case "CLOSED": + $page['name'] = "error-application-closed"; + break; + case "MAINTAINED": + $page['name'] = "error-application-maintained"; + break; + case "OPEN": + if(\MVC\Classe\Application::is_under_update()) { + $page['name'] = "error-application-maintained"; + break; + } + default: + } + //vérification du nombre de parametres: $numParts = count($urlParts); //s'il n'existe pas autant de clé que de valeurs, ce peut ^etre un module symfony ou tout autre module diff --git a/application/config/app-parameters.php.skel b/application/config/app-parameters.php.skel index 6468c8d..d41d57a 100644 --- a/application/config/app-parameters.php.skel +++ b/application/config/app-parameters.php.skel @@ -1,5 +1,6 @@ +
+

:) Oops!

+

Temporairement fermée

+

L'application est de retour bientôt!

+

+ Désolé pour cette gêne mais il se trouve que l'application est fermée à ce moment ! +
+ — Le service +
+ application@localhost.fr +

+

+

+
+ +
+
+ + +@endsection \ No newline at end of file diff --git a/application/include/vues/view/error-application-maintained.blade.php b/application/include/vues/view/error-application-maintained.blade.php new file mode 100644 index 0000000..354c38f --- /dev/null +++ b/application/include/vues/view/error-application-maintained.blade.php @@ -0,0 +1,612 @@ +{{-- Vue Blade de la page d'erreur lors d'une maintenance de l'application--}} +@extends('body-nomenu') + +@section('top-css') + @parent + +@endsection + +@section('content') +
+
+

:) Oops!

+

+

Temporairement fermée pour maintenance

+ @if(\MVC\Classe\Application::is_under_update()) +
{{MAINTENANCE_MESSAGE}}
+ @endif +

+

L'application est de retour bientôt!

+

+ Désolé pour cette gêne mais il se trouve que l'application est en maintenance à ce moment ! +
+ — Le service +
+ application@localhost.fr +

+

+

+

+

+

+

+
+
+
    +
  • +
  • +
  • +
  • +
  • +
+
    +
  • +
      +
    • +
    • +
    +
      +
    • +
    • +
    +
      +
    • +
    • +
    +
      +
    • +
    • +
    +
      +
    • +
    • +
    +
      +
    • +
    • +
    +
      +
    • +
    • +
    +
      +
    • +
    • +
    +
  • +
+
    +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
+
    +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
+
    +
  • +
  • +
  • +
  • +
  • +
  • +
  • +
+
+
+
+
+ +@endsection \ No newline at end of file diff --git a/data/doc-prince-book-generation/doc/sand/Contents/00. Comment installer l'environnement du framework.md b/data/doc-prince-book-generation/doc/sand/Contents/00. Comment installer l'environnement du framework.md new file mode 100644 index 0000000..e292613 --- /dev/null +++ b/data/doc-prince-book-generation/doc/sand/Contents/00. Comment installer l'environnement du framework.md @@ -0,0 +1,227 @@ +# Comment installer le framework + +## Préambule +Tout d'abord avant de tenter quoi que soit au niveau de l'installation du framework, veuillez prendre en considération ces quatre(4) questions : + +Avez-vous installé le logiciel de virtualisation docker ? + +Avez-vous installé le logiciel de gestionnaire de version git ? + +Avez-vous installé et utilisez-vous le language php au minimum dans sa version 7.4 ? + +Avez-vous installé le logiciel de dépendances composer ? + +Si la réponse est oui à ces quatre(4) questions alors vous êtes prêt à utiliser ce framework, même si vous ne connaissez pas les frameworks php tel que laravel ou symfony. Et dans ce cas ce sera peut-être pour vous une bonne introduction aux manipulations avancées qu'il est possible de faire avec ces imposants mastodontes. + +Pour installer ces quatre(4) composantes nécessaires sous Windows je ne peut que vous donner les liens et vous inviter à consulter les quelques documentations disponible onTheWeb à ce sujet. + +Le plus simple pour installer [docker](https://docs.docker.com/) est de se rendre sur [https://hub.docker.com/](https://hub.docker.com/) et de vous créer un compte, il sera obligatoire afin d'obtenir les images docker nécessaires lors de l'installation. Puis installer docker desktop disponible sous [https://hub.docker.com/editions/community/docker-ce-desktop-windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows) + +Le plus simple pour installer [git](https://git-scm.com/doc) est de vous rendre sur [https://gitforwindows.org/](https://gitforwindows.org/) et de suivre la procédure d'installation. + +Afin de vous aider à installer [php](https://www.php.net/docs.php) facilement vous pouvez utiliser le gestionnaire fournit avec windows : `Microsoft Web Platform installer` disponible à l'adresse [https://docs.microsoft.com/en-us/iis/install/web-platform-installer/web-platform-installer-direct-downloads](https://docs.microsoft.com/en-us/iis/install/web-platform-installer/web-platform-installer-direct-downloads) , une autre manière serait de récupérer [l'archive windows de la version de php](https://windows.php.net/download) qui vous intéresse et de la placer à la racine `C:` et d'ajouter le `PATH` de l'executable `php.exe` dans les variables d'environnement, ainsi dans la console `git-bash` fourni avec git-for-windows vous pourrez commencez à utiliser php en ligne de commande... et Sandyes (le petit nom du sablier de SAND) aime la ligne de commande :) + +Enfin pour installer [composer](https://getcomposer.org/doc/) vous pouvez vous rendre sur [https://getcomposer.org/](https://getcomposer.org/) + +Voilà vous avez tout [pour commencer à jouer avec le framework](https://sourcesup.renater.fr/wiki/mvc-sand-frame/installdokerlamp) :) Enfin presque... + +Vous êtes un linuxien ? cela ne devrait pas vous poser de problèmes alors ? Si ? Dites les man-pages vous connaissez ? Si la réponse est non il vous faudra apprendre la base de tout ce qui existe du monde libre. Dans le cas contraire normalement le gestionnaire de dépendance de votre distribution doit vous permettre de faire le reste, il vous faudra alors lui demander à installer les paquets suivants : + +`php8`-full (avec nécessairement les modules ldap, gd, mysql, pdo, zip, xml, et quelques autres que j'aurais oublié lors de cette écriture nocturne) + + par exemple : ````apt install php8.0-common php8.0-mysql php8.0-ldap php8.0-xml php8.0-xmlrpc php8.0-curl php8.0-gd php8.0-imagick php8.0-cli php8.0-dev php8.0-imap php8.0-mbstring php8.0-opcache php8.0-soap php8.0-zip php8.0-intl -y```` + +`docker` +`docker-compose` + +par exemple : ````apt install docker docker-compose -y```` + +`git` + + par exemple : ````apt install git -y```` + +`composer` + + par exemple : ````apt install composer -y```` + +et gros un `apt-get install` ou un `apt install` ou un `yum install` ou un `pacman -S` ou encore `yahourt -S` vous suffira dans bien des cas. A moins que vous soyez sur une distribution spéciale que j'affectionne mais que je n'ai pas réussi à virtualiser par manque de temps [GUIX](https://guix.gnu.org/), à ce moment-là je vous laisse faire : cela ne devrai pas vous poser trop de problèmes... + +## Voyons maintenant comment installer l'environnement ainsi que le framework SAND avant de développer et de comprendre ses mécanismes + +Afin de pouvoir démarrer un projet SAND, vous devez mettre en place votre environnement de développement. Un bon IDE est déja la base nécessaire afin de programmer. Certains choisissent Eclipse, je vous conseillerais la version [PDT de Eclipse](https://www.eclipse.org/pdt/) qui est spécialisée PHP. D'autres vont vouloir programmer avec [VisualStudioCode](https://code.visualstudio.com/), qui est open source et permet grâce à ses nombreux modules de gérer à la fois `docker` et `git` tout en se concentrant sur ses lignes de programmation. Pour les plus passionnés : vous pouvez tester puis acheter une version annuelle de [PHPStorm](https://www.jetbrains.com/fr-fr/phpstorm/) ou [ZendStudio](https://www.zend.com/products/zend-studio) de puissants IDE provenant des plus grosses communautés de programmeurs PHP passionnées : ce sont les meilleurs sur le marché actuel. Aussi vous pouvez utiliser des éditeurs plus simples tels que [Sublime Text](https://www.sublimetext.com/) ou [Scite](https://www.scintilla.org/SciTE.html) ou encore [Notepad++](https://notepad-plus-plus.org/downloads/). C'est à vous de voir ce qui vous convient le mieux actuellement. + +**Entrons maintenant dans le vif du sujet :** + +Commençons par cloner le dépot docker nécessaire au framework par la commande `git clone` : + +`git clone https://anonymous@git.renater.fr/authscm/eroy5/git/mvc-sand-frame/docker-lamp.git` + +puis déplacez-vous dans le dossier www par la commande `cd` : + +`cd docker-lamp/www` + +et cloner le dépot du framework dans ce dossier sous le nom my-new-project-directory par la commande `git clone` : + +`git clone https://anonymous@git.renater.fr/authscm/eroy5/git/mvc-sand-frame/mvc-sand-frame.git my-new-sand-projet-directory` + +Voilà vous avez le nécessaire pour scruter le code du Framework et consulter les quelques documentations primales qui se trouvent dans le dossier `www/my-new-sand-projet-directory/data/docs` + + +## Comment configurer l'environnement afin de commencer à consulter l'interface de base de SAND + + +Voilà vous avez cloner les dépôts de base, mais il faut maintenant les configurer afin d'obtenir votre première page sur un navigateur. Pour cela nous allons mettre en place la configuration de docker-compose, puis faire le lien avec le dépôt du framework proprement dit. + +tout d'abord, veuillez renommer le fichier `sample.env` en `.env` qui est nécessaire afin de définir les variables environnement de `docker-compose` : + +`cd ../ mv sample.env .env` + +De base, ce fichier comporte les bonnes variables d'environnement pour lancer l'image nécessaire sur windows et linux. En ouvrant le fichier `.env`, vous avez le loisir de modifier les ports de phpmyadmin et du serveur mysql. Plus d'informations sont disponible dans le fichier `README.md` + +Je ne peut que vous conseiller d'ouvrir les fichiers `.env` et `docker-compose.yml` après avoir lu le README, et si vous êtes familier avec les lignes de commandes `bash` ce devrait être possible pour vous de comprendre la liaison intime entre ces deux fichiers. En effet, `docker-compose.yml` dépend des variables contenues dans le fichier `.env` + +Parallèlement à cela vous devez configurer le fichier `config/vhosts/default.conf` afin de pointer le dossier `my-new-project-directory` à la bonne adresse locale: + +ajouter/décommenter simplement les lignes suivantes dans ce fichier : + +`nano config/vhosts/default.conf` +```` + + ServerName my-new-sand-project.dev.local + ServerAdmin webmaster@localhost + DocumentRoot "/var/www/my-new-sand-project-directory/public" + + AllowOverride all + + +```` +vous pouvez aussi utiliser la commande suivante : + + ```` echo ' + ServerName my-new-sand-project.dev.local + ServerAdmin webmaster@localhost + DocumentRoot "/var/www/my-new-sand-project-directory/public" + + AllowOverride all + + ' >> config/vhosts/default.conf +```` + +Une fois ceci fait, ouvrez le fichier `docker-compose.yml` + +`nano docker-compose.yml` + +et ajouter/décommenter la ligne à la suite de la config des extra-hosts : + +`#- “my-new-sand-project.dev.local:127.0.0.1”` + +Voilà vous êtes presque prêt à utiliser un `[docker-lamp](https://github.com/sprintcube/docker-compose-lamp)`. J'espère néanmoins que vous avez un compte sur docker-hub connecté à votre docker-desktop si sous êtes windows... Avec Linux tout marche tout de bout en bout facilement. + +Une petite astuce sous windows cependant : afin d'utiliser les commandes que je vous ai donné sur cette page, vous devez avoir installé et lancer `git bash`. + +Une dernière chose avant de configurer les dépendances de SAND : afin que votre navigateur puisse accéder au vhost docker que nous avons configuré, il vous faut ajouter les lignes suivantes au fichier `hosts` de votre OS. +```` + 127.0.0.1 html.dev.local + 127.0.0.1 my-new-sand-project.dev.local +```` +Sous windows celui-ci se trouve dans `c:\Windows\System32\drivers\etc` et sous Linux sous `/etc` + +## Configurer SAND pour un premier lancement + + +Allez ! Vous y êtes presque : + +Afin de charger toutes les dépendances vous devez avoir `composer` d'installé. Alors déplacez-vous dans le dossier `www/my-new-project-directory` + +`cd www/my-new-sand-project-directory` + +et lancer la commande `composer update` + +Bon et maintenant ? + +Il vous faut mettre en place charger les dépendances composer dans trois autres dossiers, un pour faire du [Test Driven Development (TDD)](https://www.test-recette.fr/), un autre pour les [tests fonctionnel BeHat](https://github.com/Halleck45/livre-developpement-pilote-comportement), et enfin un dernier pour réaliser [des builds et des métriques](https://jenkins-le-guide-complet.github.io/) sur votre projet + +Suivez et exécutez ces commandes : +```` + cd tests + cd phpunit + composer update + cd ../behat + composer update + cd ../../build + composer update + cd ../ +```` +Voilà tout est prêt, enfin presque : reste à lier les variables de configuration du framework, celles-ci sont toutes dans le dossier `application/config/` : Donc à partir de là : +```` + cd application/config + mv app-parameters.php.skel app-parameters.php + mv bdd-parameters.php.skel bdd-parameters.php + mv console-parameters.php.skel console-parameters.php +```` +enfin pour finir mettons en place la configuration de l'URL locale et de la base de données Mysql propre au `docker-lamp`: + +`nano app-parameters.php` + +modifier la constante `PATH_URL` avec la valeur [http://my-new-sand-project.dev.local](http://my-new-sand-project.dev.local/) + +sauvegardez, puis + +`nano bdd-parameters.php` + +modifiez les constantes par défaut de cette manière +```` + define('DSN_BDD_DEFAULT', "mysql:host=database;dbname=docker"); + define('USER_BDD_DEFAULT', "docker"); + define('PASS_BDD_DEFAULT', "docker"); +```` +sauvegardez, puis... + +Voilà, vous êtes prêt à lancer le daemon docker ! + +## Lancer docker et accéder à l'interface de base du framework SAND-for-Universities + + +Bon normalement à partir de là, vous devriez être capable de mettre en place la base du framework à l'adresse : [http://my-new-sand-project.dev.local](http://my-new-sand-project.dev.local/) ou tout autre adresse que vous auriez précédemment préférée à celle-ci. + +Juste ouvrez votre terminal favori puis lancer la commande suivante depuis la racine contenant le fichier `docker-compose.yml` : + +`docker-compose up -d -----build` + +si tout se passe bien, vous allez assister à un build parfait et à l'affichage des lignes suivantes ; celles-ci valident que tout s'est bien déroulé : +```` +$ docker-compose up -d +[...] +Network docker-lamp_default Creating +Network docker-lamp_default Created +Container docker-lamp-database Creating +Container docker-lamp-database Created +Container docker-lamp-php80 Creating +Container docker-lamp-phpmyadmin Creating +Container docker-lamp-phpmyadmin Created +Container docker-lamp-php80 Created +Container docker-lamp-database Starting +Container docker-lamp-database Started +Container docker-lamp-php80 Starting +Container docker-lamp-phpmyadmin Starting +Container docker-lamp-phpmyadmin Started +Container docker-lamp-php80 Started +```` +Voilà ! l'installation est terminée. Rendez-vous sur [http://my-new-sand-project.dev.local](http://my-new-sand-project.dev.local/) pour admirer votre travail :) + +Dans le cas ou le build ne fonctionne pas, tentez de regarder dans le dossier `bin/php80` le fichier `DockerFile` et commentez les lignes qui posent problème par un dièse(`#`) . Un peu d'huile de mimines et le tour est joué. + +Voici maintenant quelques commandes-astuces avec `Docker` : + +`docker ps` permet de voir les conteneurs lancés actuellement + +`docker logs` permet de comprendre pourquoi un conteneur n'est pas stable en raison d'une mauvaise configuration + +`docker exec` permet d'entrer dans le conteneur et de relancer certains services, à cependant utiliser avec précaution car dès que vous réalisez un rebuild du conteneur, les modifications réalisées à l'intérieur sont effacées. + +pour `Docker-compose` maintenant : + +vous pouvez utiliser `docker-compose down` et `docker-compose kill`. + +A vous de jouer :) ! + diff --git a/data/doc-prince-book-generation/doc/sand/Contents/00.a. Configuration de départ.md b/data/doc-prince-book-generation/doc/sand/Contents/01.a. Configuration de départ.md similarity index 100% rename from data/doc-prince-book-generation/doc/sand/Contents/00.a. Configuration de départ.md rename to data/doc-prince-book-generation/doc/sand/Contents/01.a. Configuration de départ.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/00.d. Comment est architecturé le framework.md b/data/doc-prince-book-generation/doc/sand/Contents/01.b. Comment est architecturé le framework.md similarity index 100% rename from data/doc-prince-book-generation/doc/sand/Contents/00.d. Comment est architecturé le framework.md rename to data/doc-prince-book-generation/doc/sand/Contents/01.b. Comment est architecturé le framework.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/00.b. Comment bien utiliser les urls.md b/data/doc-prince-book-generation/doc/sand/Contents/01.c. Comment bien utiliser les urls.md similarity index 100% rename from data/doc-prince-book-generation/doc/sand/Contents/00.b. Comment bien utiliser les urls.md rename to data/doc-prince-book-generation/doc/sand/Contents/01.c. Comment bien utiliser les urls.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/00.c. Comment bien utiliser les commandes console.md b/data/doc-prince-book-generation/doc/sand/Contents/01.d. Comment bien utiliser les commandes console.md similarity index 100% rename from data/doc-prince-book-generation/doc/sand/Contents/00.c. Comment bien utiliser les commandes console.md rename to data/doc-prince-book-generation/doc/sand/Contents/01.d. Comment bien utiliser les commandes console.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/01.e.i Comprendre SAND pour ajouter une nouvelle page.md b/data/doc-prince-book-generation/doc/sand/Contents/01.e.i Comprendre SAND pour ajouter une nouvelle page.md new file mode 100644 index 0000000..48c7d5e --- /dev/null +++ b/data/doc-prince-book-generation/doc/sand/Contents/01.e.i Comprendre SAND pour ajouter une nouvelle page.md @@ -0,0 +1,80 @@ + +*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](http://my-new-sand-project.dev.local/hello_world) + diff --git a/data/doc-prince-book-generation/doc/sand/Contents/01.e.ii Comment ajouter une page proprement.md b/data/doc-prince-book-generation/doc/sand/Contents/01.e.ii Comment ajouter une page proprement.md new file mode 100644 index 0000000..6512c04 --- /dev/null +++ b/data/doc-prince-book-generation/doc/sand/Contents/01.e.ii Comment ajouter une page proprement.md @@ -0,0 +1,10 @@ +** Comment ajouter une page hello_world ? ** + + +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 diff --git a/data/doc-prince-book-generation/doc/sand/Contents/00.e. Comment modifier proprement une page.md b/data/doc-prince-book-generation/doc/sand/Contents/01.f. Comment modifier proprement une page.md similarity index 100% rename from data/doc-prince-book-generation/doc/sand/Contents/00.e. Comment modifier proprement une page.md rename to data/doc-prince-book-generation/doc/sand/Contents/01.f. Comment modifier proprement une page.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/00.f. Comment fonctionnent les objets de sessions.md b/data/doc-prince-book-generation/doc/sand/Contents/01.g. Comment fonctionnent les objets de sessions.md similarity index 100% rename from data/doc-prince-book-generation/doc/sand/Contents/00.f. Comment fonctionnent les objets de sessions.md rename to data/doc-prince-book-generation/doc/sand/Contents/01.g. Comment fonctionnent les objets de sessions.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/00.g. Comment faire évoluer une application SAND.md b/data/doc-prince-book-generation/doc/sand/Contents/01.h. Comment faire évoluer une application SAND.md similarity index 100% rename from data/doc-prince-book-generation/doc/sand/Contents/00.g. Comment faire évoluer une application SAND.md rename to data/doc-prince-book-generation/doc/sand/Contents/01.h. Comment faire évoluer une application SAND.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/01. Le controleur facile.md b/data/doc-prince-book-generation/doc/sand/Contents/02.a. Le controleur facile.md similarity index 100% rename from data/doc-prince-book-generation/doc/sand/Contents/01. Le controleur facile.md rename to data/doc-prince-book-generation/doc/sand/Contents/02.a. Le controleur facile.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/02. Le controleur de base.md b/data/doc-prince-book-generation/doc/sand/Contents/02.b. Le controleur de base.md similarity index 100% rename from data/doc-prince-book-generation/doc/sand/Contents/02. Le controleur de base.md rename to data/doc-prince-book-generation/doc/sand/Contents/02.b. Le controleur de base.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/03. Le controleur REST ou HTML.md b/data/doc-prince-book-generation/doc/sand/Contents/02.c. Le controleur REST ou HTML.md similarity index 100% rename from data/doc-prince-book-generation/doc/sand/Contents/03. Le controleur REST ou HTML.md rename to data/doc-prince-book-generation/doc/sand/Contents/02.c. Le controleur REST ou HTML.md diff --git a/data/docs/04.a. Les vues Twig.md b/data/doc-prince-book-generation/doc/sand/Contents/03.a. Les vues Twig.md similarity index 100% rename from data/docs/04.a. Les vues Twig.md rename to data/doc-prince-book-generation/doc/sand/Contents/03.a. Les vues Twig.md diff --git a/data/docs/04.b. Les vues Blade.md b/data/doc-prince-book-generation/doc/sand/Contents/03.b. Les vues Blade.md similarity index 100% rename from data/docs/04.b. Les vues Blade.md rename to data/doc-prince-book-generation/doc/sand/Contents/03.b. Les vues Blade.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/04.c. Les vues Blade avec SPA(vuejs).md b/data/doc-prince-book-generation/doc/sand/Contents/03.c. Les vues Blade avec SPA(vuejs).md similarity index 100% rename from data/doc-prince-book-generation/doc/sand/Contents/04.c. Les vues Blade avec SPA(vuejs).md rename to data/doc-prince-book-generation/doc/sand/Contents/03.c. Les vues Blade avec SPA(vuejs).md diff --git a/data/docs/05. Les Actions dans les vues.md b/data/doc-prince-book-generation/doc/sand/Contents/04. Les Actions dans les vues.md similarity index 100% rename from data/docs/05. Les Actions dans les vues.md rename to data/doc-prince-book-generation/doc/sand/Contents/04. Les Actions dans les vues.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/04.a. Les vues Twig.md b/data/doc-prince-book-generation/doc/sand/Contents/04.a. Les vues Twig.md deleted file mode 100644 index bcdce07..0000000 --- a/data/doc-prince-book-generation/doc/sand/Contents/04.a. Les vues Twig.md +++ /dev/null @@ -1,65 +0,0 @@ -#Les vues Twig - -Elles sont chargées dans cette ordre: - -* application/include/vues/system -* application/include/vues/layout -* application/include/vues/view - -ainsi la vue standard peut étendre de `application/include/vues/layout/body.html.twig` -```php - -{% block body %} - -
-
- - - {% if $_SESSION['alerts'] is defined %} - {% foreach $_SESSION['alerts'] as alert %} - - {% endforeach %} - {% endif %} - - {% block content %}{% endblock %} - -
-
-{% endblock %}} - -``` -qui étends de `application/include/vues/system/system.html.twig` -```php - - - - {% block head %} - {{page_title}} - - - - - - - {% block top-css %} - - - {% endblock %} - {% endblock %} - - - -{% block top-javascript %}{% endblock %} - -{% block body %}{% endblock %} - -{% block bottom-javascript %} - - -{% endblock %} - - -``` \ No newline at end of file diff --git a/data/doc-prince-book-generation/doc/sand/Contents/04.b. Les vues Blade.md b/data/doc-prince-book-generation/doc/sand/Contents/04.b. Les vues Blade.md deleted file mode 100644 index 31b602e..0000000 --- a/data/doc-prince-book-generation/doc/sand/Contents/04.b. Les vues Blade.md +++ /dev/null @@ -1,50 +0,0 @@ -#Les vues Blade - -Elles sont chargées dans cette ordre: - -* application/include/vues/system -* application/include/vues/layout -* application/include/vues/view - -ainsi la vue standard peut étendre de `application/include/vues/layout/body.blade.php` -```php -@extends('system') - -@section('body') - - @section('sidebar') - This is the master sidebar. - @show - -
- @yield('content') -
- -@endsection -``` -qui étends de `application/include/vues/system/system.blade.php` -```php - - - - {{$page_title}} - - - @section('top-css') - @endsection - - - - -@section('top-javascript') -@endsection - -@yield('body') - -@section('bottom-javascript') -@endsection - - - - -``` \ No newline at end of file diff --git a/data/docs/06. Le conduit Symfony.md b/data/doc-prince-book-generation/doc/sand/Contents/05. Le conduit Symfony.md similarity index 100% rename from data/docs/06. Le conduit Symfony.md rename to data/doc-prince-book-generation/doc/sand/Contents/05. Le conduit Symfony.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/07.a. modules - configuration.md b/data/doc-prince-book-generation/doc/sand/Contents/07.a. modules - configuration.md index 1a06eb0..8dfa5db 100644 --- a/data/doc-prince-book-generation/doc/sand/Contents/07.a. modules - configuration.md +++ b/data/doc-prince-book-generation/doc/sand/Contents/07.a. modules - configuration.md @@ -1,29 +1,37 @@ -#Comment Configurer un module Symfony ou tout autre application php +#Comment Configurer un module ou tout autre application php il vous faut instancier trois fichiers: + le modèle (.model) contenant le nom de la page qui porte le model -ici : `application/include/modeles/syf51.model` +ici : `application/include/modeles/my_module.model` ```yaml -name : syf51 +name : my_module page_title : Accueil de l'application modulaire description : zatou stra bracadabla -params : params +engine : blade +ariane : {my_module_name} +arianelink : {my_module} ``` -le controlleur (.php) contenant ce code qui doit être automatisé -ici: `application/include/controlleurs/syf51.php` +le controlleur (.php) contenant ce code +ici: `application/include/controlleurs/my_module.php` ```php $app); ``` -et déclarer le module dans `\application\modules\setup\registre.model` +le template (.blade.php) contenant ce code +ici: `application/include/vues/view/my_module.php` +```php +{{$app->load('module_type')}} +``` +aussi il vous faudra déclarer le module dans `\application\modules\setup\registre.model` par une ligne suplémentaire: ```yaml -syf51 : Application permettant de tester l'intégration d'un module avec symfony5.0.99 +my_module : Application permettant de tester l'intégration d'un module ``` -si besoin et que le module n'existe pas il vous faudras coder et modifier -le fichier `/application/class/Modular.php` voir peut-être `/application/class/ModularRegister.php` +ainsi que le dossier `\application\module\my_module` + +si besoin et que le type du module n'existe pas il vous faudra ajouter le type du module en modifiant le fichier `/application/class/Modular.php` et les méthodes `__construct` et `load` Good Luck ! \ No newline at end of file diff --git a/data/doc-prince-book-generation/doc/sand/Contents/07.b. modules - comment bien les utiliser.md b/data/doc-prince-book-generation/doc/sand/Contents/07.b. modules - comment bien les utiliser.md index 23e9e73..5b3934f 100644 --- a/data/doc-prince-book-generation/doc/sand/Contents/07.b. modules - comment bien les utiliser.md +++ b/data/doc-prince-book-generation/doc/sand/Contents/07.b. modules - comment bien les utiliser.md @@ -1 +1,10 @@ -#Comment bien utiliser les modules \ No newline at end of file +#Comment bien utiliser les modules + +Simplement vous pouvez tester les intégrations prévues dans le FrameWork avec la commande `php bin.php module:add` ainsi vous aurez le choix d'intégrer en quelques modifications à la mimine un module Symfony ou Laravel. Pour cela choisissez les paramètres de base afin que l'installation se passe bien. + +Il faut comprendre qu'un module Symfony ne peut fonctionner qu'avec un template `blade`, de même manière un module Laravel ne peut fonctionner qu'avec un template `twig`. +Basiquement toute application utilisant le système de randu `twig` doit être intégré avec un template-sand `blade` et l'inverse. + +Au niveau du sysème de routage, il faut absolument inclure le path du module, par exemple pour un module nommé 'SciFi', il faudra inclure dans les routes des controlleurs la chaine de caractères `\SciFi` devant toutes les routes de vos controlleurs. + +Il en est de même pour les autres modules : Wordpress, GitList, PhpList, Pretashop, ... ainsi que pour tous les autres modules que vous voudriez intégrer par vous-même. \ No newline at end of file diff --git a/data/doc-prince-book-generation/doc/sand/Contents/13. modules - Laravel.md b/data/doc-prince-book-generation/doc/sand/Contents/13. modules - Laravel.md new file mode 100644 index 0000000..6edc24e --- /dev/null +++ b/data/doc-prince-book-generation/doc/sand/Contents/13. modules - Laravel.md @@ -0,0 +1 @@ +#Comment ajouter un module Symfony \ No newline at end of file diff --git a/data/doc-prince-book-generation/doc/sand/Contents/13. Comment faire des appels récursifs en curl sur une API RESTFULL codée avec le framework.md b/data/doc-prince-book-generation/doc/sand/Contents/17. Appels récursifs en curl sur une API RESTFULL SAND.md similarity index 100% rename from data/doc-prince-book-generation/doc/sand/Contents/13. Comment faire des appels récursifs en curl sur une API RESTFULL codée avec le framework.md rename to data/doc-prince-book-generation/doc/sand/Contents/17. Appels récursifs en curl sur une API RESTFULL SAND.md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/19. Les evolutions de SAND possibles dans sa prochaine version.md b/data/doc-prince-book-generation/doc/sand/Contents/19. Les evolutions de SAND possibles dans sa prochaine version.md new file mode 100644 index 0000000..aaf9566 --- /dev/null +++ b/data/doc-prince-book-generation/doc/sand/Contents/19. Les evolutions de SAND possibles dans sa prochaine version.md @@ -0,0 +1,27 @@ +__Le squelette de départ d'une application ExtJS__ : sisi c'est possible avec node.js mais l'intégration d'un tel outil n'as absolument pas été commencé lors de mon CDD à l'ufc ni même pendant ma période de convalescence du 15/07/2021 au 18/12/2021 car je me refuse encore actuellement de programmer, elle est un petit peu réfléchie et semble absolument possible avec de nombreuses application reliées mais je ne possède pas toutes les compréhensions techniques nécessaires pour le faire actuellement. + +__Un moteur de wiki basé sur wikini__ : si les auteurs du wikini0.5 acceptent... + +__Un moteur d'écriture en Markdown et Yaml dans de simples fichiers contenus dans /data__ : une portion de cela a été codé et est disponible sur le github du créateur du framework. + +---- + +// +Une dalle pdo plus performante (voir accueillant un système de choix de l'ORM ou un ORM spécifique) +// + +// +Une réécriture complète du système de vue afin d'accueillir les nouvelles versions de Twig et Blade +// + +// +Un systeme REST plus capable de faire ce qui doit être fait, imitant un peu Slim +// + +// +Des améliorations au niveau de l'intégration de Bootstrap5.0 : par exemple le système de notification push +// + +// +Ainsi que d'autres petites choses au niveau des objets de session et des composants de domaine (Composants de domaines qui ne seront accessible que sur RENATER, je garde précieusement ces fichiers...) +// \ No newline at end of file diff --git a/data/docs/00. Comment installer l'environnement du framework.md b/data/docs/00. Comment installer l'environnement du framework.md new file mode 100644 index 0000000..e292613 --- /dev/null +++ b/data/docs/00. Comment installer l'environnement du framework.md @@ -0,0 +1,227 @@ +# Comment installer le framework + +## Préambule +Tout d'abord avant de tenter quoi que soit au niveau de l'installation du framework, veuillez prendre en considération ces quatre(4) questions : + +Avez-vous installé le logiciel de virtualisation docker ? + +Avez-vous installé le logiciel de gestionnaire de version git ? + +Avez-vous installé et utilisez-vous le language php au minimum dans sa version 7.4 ? + +Avez-vous installé le logiciel de dépendances composer ? + +Si la réponse est oui à ces quatre(4) questions alors vous êtes prêt à utiliser ce framework, même si vous ne connaissez pas les frameworks php tel que laravel ou symfony. Et dans ce cas ce sera peut-être pour vous une bonne introduction aux manipulations avancées qu'il est possible de faire avec ces imposants mastodontes. + +Pour installer ces quatre(4) composantes nécessaires sous Windows je ne peut que vous donner les liens et vous inviter à consulter les quelques documentations disponible onTheWeb à ce sujet. + +Le plus simple pour installer [docker](https://docs.docker.com/) est de se rendre sur [https://hub.docker.com/](https://hub.docker.com/) et de vous créer un compte, il sera obligatoire afin d'obtenir les images docker nécessaires lors de l'installation. Puis installer docker desktop disponible sous [https://hub.docker.com/editions/community/docker-ce-desktop-windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows) + +Le plus simple pour installer [git](https://git-scm.com/doc) est de vous rendre sur [https://gitforwindows.org/](https://gitforwindows.org/) et de suivre la procédure d'installation. + +Afin de vous aider à installer [php](https://www.php.net/docs.php) facilement vous pouvez utiliser le gestionnaire fournit avec windows : `Microsoft Web Platform installer` disponible à l'adresse [https://docs.microsoft.com/en-us/iis/install/web-platform-installer/web-platform-installer-direct-downloads](https://docs.microsoft.com/en-us/iis/install/web-platform-installer/web-platform-installer-direct-downloads) , une autre manière serait de récupérer [l'archive windows de la version de php](https://windows.php.net/download) qui vous intéresse et de la placer à la racine `C:` et d'ajouter le `PATH` de l'executable `php.exe` dans les variables d'environnement, ainsi dans la console `git-bash` fourni avec git-for-windows vous pourrez commencez à utiliser php en ligne de commande... et Sandyes (le petit nom du sablier de SAND) aime la ligne de commande :) + +Enfin pour installer [composer](https://getcomposer.org/doc/) vous pouvez vous rendre sur [https://getcomposer.org/](https://getcomposer.org/) + +Voilà vous avez tout [pour commencer à jouer avec le framework](https://sourcesup.renater.fr/wiki/mvc-sand-frame/installdokerlamp) :) Enfin presque... + +Vous êtes un linuxien ? cela ne devrait pas vous poser de problèmes alors ? Si ? Dites les man-pages vous connaissez ? Si la réponse est non il vous faudra apprendre la base de tout ce qui existe du monde libre. Dans le cas contraire normalement le gestionnaire de dépendance de votre distribution doit vous permettre de faire le reste, il vous faudra alors lui demander à installer les paquets suivants : + +`php8`-full (avec nécessairement les modules ldap, gd, mysql, pdo, zip, xml, et quelques autres que j'aurais oublié lors de cette écriture nocturne) + + par exemple : ````apt install php8.0-common php8.0-mysql php8.0-ldap php8.0-xml php8.0-xmlrpc php8.0-curl php8.0-gd php8.0-imagick php8.0-cli php8.0-dev php8.0-imap php8.0-mbstring php8.0-opcache php8.0-soap php8.0-zip php8.0-intl -y```` + +`docker` +`docker-compose` + +par exemple : ````apt install docker docker-compose -y```` + +`git` + + par exemple : ````apt install git -y```` + +`composer` + + par exemple : ````apt install composer -y```` + +et gros un `apt-get install` ou un `apt install` ou un `yum install` ou un `pacman -S` ou encore `yahourt -S` vous suffira dans bien des cas. A moins que vous soyez sur une distribution spéciale que j'affectionne mais que je n'ai pas réussi à virtualiser par manque de temps [GUIX](https://guix.gnu.org/), à ce moment-là je vous laisse faire : cela ne devrai pas vous poser trop de problèmes... + +## Voyons maintenant comment installer l'environnement ainsi que le framework SAND avant de développer et de comprendre ses mécanismes + +Afin de pouvoir démarrer un projet SAND, vous devez mettre en place votre environnement de développement. Un bon IDE est déja la base nécessaire afin de programmer. Certains choisissent Eclipse, je vous conseillerais la version [PDT de Eclipse](https://www.eclipse.org/pdt/) qui est spécialisée PHP. D'autres vont vouloir programmer avec [VisualStudioCode](https://code.visualstudio.com/), qui est open source et permet grâce à ses nombreux modules de gérer à la fois `docker` et `git` tout en se concentrant sur ses lignes de programmation. Pour les plus passionnés : vous pouvez tester puis acheter une version annuelle de [PHPStorm](https://www.jetbrains.com/fr-fr/phpstorm/) ou [ZendStudio](https://www.zend.com/products/zend-studio) de puissants IDE provenant des plus grosses communautés de programmeurs PHP passionnées : ce sont les meilleurs sur le marché actuel. Aussi vous pouvez utiliser des éditeurs plus simples tels que [Sublime Text](https://www.sublimetext.com/) ou [Scite](https://www.scintilla.org/SciTE.html) ou encore [Notepad++](https://notepad-plus-plus.org/downloads/). C'est à vous de voir ce qui vous convient le mieux actuellement. + +**Entrons maintenant dans le vif du sujet :** + +Commençons par cloner le dépot docker nécessaire au framework par la commande `git clone` : + +`git clone https://anonymous@git.renater.fr/authscm/eroy5/git/mvc-sand-frame/docker-lamp.git` + +puis déplacez-vous dans le dossier www par la commande `cd` : + +`cd docker-lamp/www` + +et cloner le dépot du framework dans ce dossier sous le nom my-new-project-directory par la commande `git clone` : + +`git clone https://anonymous@git.renater.fr/authscm/eroy5/git/mvc-sand-frame/mvc-sand-frame.git my-new-sand-projet-directory` + +Voilà vous avez le nécessaire pour scruter le code du Framework et consulter les quelques documentations primales qui se trouvent dans le dossier `www/my-new-sand-projet-directory/data/docs` + + +## Comment configurer l'environnement afin de commencer à consulter l'interface de base de SAND + + +Voilà vous avez cloner les dépôts de base, mais il faut maintenant les configurer afin d'obtenir votre première page sur un navigateur. Pour cela nous allons mettre en place la configuration de docker-compose, puis faire le lien avec le dépôt du framework proprement dit. + +tout d'abord, veuillez renommer le fichier `sample.env` en `.env` qui est nécessaire afin de définir les variables environnement de `docker-compose` : + +`cd ../ mv sample.env .env` + +De base, ce fichier comporte les bonnes variables d'environnement pour lancer l'image nécessaire sur windows et linux. En ouvrant le fichier `.env`, vous avez le loisir de modifier les ports de phpmyadmin et du serveur mysql. Plus d'informations sont disponible dans le fichier `README.md` + +Je ne peut que vous conseiller d'ouvrir les fichiers `.env` et `docker-compose.yml` après avoir lu le README, et si vous êtes familier avec les lignes de commandes `bash` ce devrait être possible pour vous de comprendre la liaison intime entre ces deux fichiers. En effet, `docker-compose.yml` dépend des variables contenues dans le fichier `.env` + +Parallèlement à cela vous devez configurer le fichier `config/vhosts/default.conf` afin de pointer le dossier `my-new-project-directory` à la bonne adresse locale: + +ajouter/décommenter simplement les lignes suivantes dans ce fichier : + +`nano config/vhosts/default.conf` +```` + + ServerName my-new-sand-project.dev.local + ServerAdmin webmaster@localhost + DocumentRoot "/var/www/my-new-sand-project-directory/public" + + AllowOverride all + + +```` +vous pouvez aussi utiliser la commande suivante : + + ```` echo ' + ServerName my-new-sand-project.dev.local + ServerAdmin webmaster@localhost + DocumentRoot "/var/www/my-new-sand-project-directory/public" + + AllowOverride all + + ' >> config/vhosts/default.conf +```` + +Une fois ceci fait, ouvrez le fichier `docker-compose.yml` + +`nano docker-compose.yml` + +et ajouter/décommenter la ligne à la suite de la config des extra-hosts : + +`#- “my-new-sand-project.dev.local:127.0.0.1”` + +Voilà vous êtes presque prêt à utiliser un `[docker-lamp](https://github.com/sprintcube/docker-compose-lamp)`. J'espère néanmoins que vous avez un compte sur docker-hub connecté à votre docker-desktop si sous êtes windows... Avec Linux tout marche tout de bout en bout facilement. + +Une petite astuce sous windows cependant : afin d'utiliser les commandes que je vous ai donné sur cette page, vous devez avoir installé et lancer `git bash`. + +Une dernière chose avant de configurer les dépendances de SAND : afin que votre navigateur puisse accéder au vhost docker que nous avons configuré, il vous faut ajouter les lignes suivantes au fichier `hosts` de votre OS. +```` + 127.0.0.1 html.dev.local + 127.0.0.1 my-new-sand-project.dev.local +```` +Sous windows celui-ci se trouve dans `c:\Windows\System32\drivers\etc` et sous Linux sous `/etc` + +## Configurer SAND pour un premier lancement + + +Allez ! Vous y êtes presque : + +Afin de charger toutes les dépendances vous devez avoir `composer` d'installé. Alors déplacez-vous dans le dossier `www/my-new-project-directory` + +`cd www/my-new-sand-project-directory` + +et lancer la commande `composer update` + +Bon et maintenant ? + +Il vous faut mettre en place charger les dépendances composer dans trois autres dossiers, un pour faire du [Test Driven Development (TDD)](https://www.test-recette.fr/), un autre pour les [tests fonctionnel BeHat](https://github.com/Halleck45/livre-developpement-pilote-comportement), et enfin un dernier pour réaliser [des builds et des métriques](https://jenkins-le-guide-complet.github.io/) sur votre projet + +Suivez et exécutez ces commandes : +```` + cd tests + cd phpunit + composer update + cd ../behat + composer update + cd ../../build + composer update + cd ../ +```` +Voilà tout est prêt, enfin presque : reste à lier les variables de configuration du framework, celles-ci sont toutes dans le dossier `application/config/` : Donc à partir de là : +```` + cd application/config + mv app-parameters.php.skel app-parameters.php + mv bdd-parameters.php.skel bdd-parameters.php + mv console-parameters.php.skel console-parameters.php +```` +enfin pour finir mettons en place la configuration de l'URL locale et de la base de données Mysql propre au `docker-lamp`: + +`nano app-parameters.php` + +modifier la constante `PATH_URL` avec la valeur [http://my-new-sand-project.dev.local](http://my-new-sand-project.dev.local/) + +sauvegardez, puis + +`nano bdd-parameters.php` + +modifiez les constantes par défaut de cette manière +```` + define('DSN_BDD_DEFAULT', "mysql:host=database;dbname=docker"); + define('USER_BDD_DEFAULT', "docker"); + define('PASS_BDD_DEFAULT', "docker"); +```` +sauvegardez, puis... + +Voilà, vous êtes prêt à lancer le daemon docker ! + +## Lancer docker et accéder à l'interface de base du framework SAND-for-Universities + + +Bon normalement à partir de là, vous devriez être capable de mettre en place la base du framework à l'adresse : [http://my-new-sand-project.dev.local](http://my-new-sand-project.dev.local/) ou tout autre adresse que vous auriez précédemment préférée à celle-ci. + +Juste ouvrez votre terminal favori puis lancer la commande suivante depuis la racine contenant le fichier `docker-compose.yml` : + +`docker-compose up -d -----build` + +si tout se passe bien, vous allez assister à un build parfait et à l'affichage des lignes suivantes ; celles-ci valident que tout s'est bien déroulé : +```` +$ docker-compose up -d +[...] +Network docker-lamp_default Creating +Network docker-lamp_default Created +Container docker-lamp-database Creating +Container docker-lamp-database Created +Container docker-lamp-php80 Creating +Container docker-lamp-phpmyadmin Creating +Container docker-lamp-phpmyadmin Created +Container docker-lamp-php80 Created +Container docker-lamp-database Starting +Container docker-lamp-database Started +Container docker-lamp-php80 Starting +Container docker-lamp-phpmyadmin Starting +Container docker-lamp-phpmyadmin Started +Container docker-lamp-php80 Started +```` +Voilà ! l'installation est terminée. Rendez-vous sur [http://my-new-sand-project.dev.local](http://my-new-sand-project.dev.local/) pour admirer votre travail :) + +Dans le cas ou le build ne fonctionne pas, tentez de regarder dans le dossier `bin/php80` le fichier `DockerFile` et commentez les lignes qui posent problème par un dièse(`#`) . Un peu d'huile de mimines et le tour est joué. + +Voici maintenant quelques commandes-astuces avec `Docker` : + +`docker ps` permet de voir les conteneurs lancés actuellement + +`docker logs` permet de comprendre pourquoi un conteneur n'est pas stable en raison d'une mauvaise configuration + +`docker exec` permet d'entrer dans le conteneur et de relancer certains services, à cependant utiliser avec précaution car dès que vous réalisez un rebuild du conteneur, les modifications réalisées à l'intérieur sont effacées. + +pour `Docker-compose` maintenant : + +vous pouvez utiliser `docker-compose down` et `docker-compose kill`. + +A vous de jouer :) ! + diff --git a/data/docs/00.f. Comment faire évoluer une application SAND.md b/data/docs/00.f. Comment faire évoluer une application SAND.md deleted file mode 100644 index c295971..0000000 --- a/data/docs/00.f. Comment faire évoluer une application SAND.md +++ /dev/null @@ -1,5 +0,0 @@ -#Comment faire évoluer une application écrite avec le framework SAND ? - -Tout d’abord, une fois l’application créé, toutes les ressources sont téléchargée par composer et le fichier composer.lock est garant de la stabilité des dépôts auxquels l’application fait appel. Donc normalement il ne sera pas nécessaire de faire évoluer ces ressources. - -Néanmoins passer vers une nouvelle version de php par exemple de la 5.6 à la 8 nécessite des connaissances évolué des fonctions dépréciées entre les versions de PHP. SAND framework est php 8 ready, néanmoins certaines lib comme phpCAS ne fonctionne que sur php7.3, mais celles-ci une fois installée ne changent pas au cours du temps car elles sont directement accessibles depuis le dossier vendor. diff --git a/data/docs/00.a. Configuration de départ.md b/data/docs/01.a. Configuration de départ.md similarity index 100% rename from data/docs/00.a. Configuration de départ.md rename to data/docs/01.a. Configuration de départ.md diff --git a/data/docs/00.d. Comment est architecturé le framework.md b/data/docs/01.b. Comment est architecturé le framework.md similarity index 100% rename from data/docs/00.d. Comment est architecturé le framework.md rename to data/docs/01.b. Comment est architecturé le framework.md diff --git a/data/docs/00.b. Comment bien utiliser les urls.md b/data/docs/01.c. Comment bien utiliser les urls.md similarity index 100% rename from data/docs/00.b. Comment bien utiliser les urls.md rename to data/docs/01.c. Comment bien utiliser les urls.md diff --git a/data/docs/00.c. Comment bien utiliser les commandes console.md b/data/docs/01.d. Comment bien utiliser les commandes console.md similarity index 100% rename from data/docs/00.c. Comment bien utiliser les commandes console.md rename to data/docs/01.d. Comment bien utiliser les commandes console.md diff --git a/data/docs/01.e.i Comprendre SAND pour ajouter une nouvelle page.md b/data/docs/01.e.i Comprendre SAND pour ajouter une nouvelle page.md new file mode 100644 index 0000000..48c7d5e --- /dev/null +++ b/data/docs/01.e.i Comprendre SAND pour ajouter une nouvelle page.md @@ -0,0 +1,80 @@ + +*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](http://my-new-sand-project.dev.local/hello_world) + diff --git a/data/docs/01.e.ii Comment ajouter une page proprement.md b/data/docs/01.e.ii Comment ajouter une page proprement.md new file mode 100644 index 0000000..6512c04 --- /dev/null +++ b/data/docs/01.e.ii Comment ajouter une page proprement.md @@ -0,0 +1,10 @@ +** Comment ajouter une page hello_world ? ** + + +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 diff --git a/data/docs/00.e. Comment modifier proprement une page.md b/data/docs/01.f. Comment modifier proprement une page.md similarity index 100% rename from data/docs/00.e. Comment modifier proprement une page.md rename to data/docs/01.f. Comment modifier proprement une page.md diff --git a/data/docs/00.f. Comment fonctionnent les objets de sessions.md b/data/docs/01.g. Comment fonctionnent les objets de sessions.md similarity index 100% rename from data/docs/00.f. Comment fonctionnent les objets de sessions.md rename to data/docs/01.g. Comment fonctionnent les objets de sessions.md diff --git a/data/docs/00.g. Comment faire évoluer une application SAND.md b/data/docs/01.h. Comment faire évoluer une application SAND.md similarity index 100% rename from data/docs/00.g. Comment faire évoluer une application SAND.md rename to data/docs/01.h. Comment faire évoluer une application SAND.md diff --git a/data/docs/01. Le controleur facile.md b/data/docs/02.a. Le controleur facile.md similarity index 100% rename from data/docs/01. Le controleur facile.md rename to data/docs/02.a. Le controleur facile.md diff --git a/data/docs/02. Le controleur de base.md b/data/docs/02.b. Le controleur de base.md similarity index 100% rename from data/docs/02. Le controleur de base.md rename to data/docs/02.b. Le controleur de base.md diff --git a/data/docs/03. Le controleur REST ou HTML.md b/data/docs/02.c. Le controleur REST ou HTML.md similarity index 100% rename from data/docs/03. Le controleur REST ou HTML.md rename to data/docs/02.c. Le controleur REST ou HTML.md diff --git a/data/docs/03.a. Les vues Twig.md b/data/docs/03.a. Les vues Twig.md new file mode 100644 index 0000000..2b25230 --- /dev/null +++ b/data/docs/03.a. Les vues Twig.md @@ -0,0 +1,229 @@ +#Les vues Twig + +Elles sont chargées dans cette ordre: + +* application/include/vues/system +* application/include/vues/layout +* application/include/vues/view + +ainsi la vue standard peut étendre de `application/include/vues/layout/body.html.twig` +```php + +{% extends "system.html.twig" %} + +{% block body %} + +
+ +
+
+ +
+
+ + + + + +
+
+ Vous êtes connecté en tant que {{session('user_login')}} + Se Deconnecter +
+
+ + + {%if ariane is defined %} + + {% endif %} +
+
+ + + {% if not session('alerts') == null %} + {% for alert in session('alerts') %} + + {% endfor %} + {% endif %} + + + {% block content %}{% endblock %} + +
+
+ + +
+ +
+ + +
+ +{% endblock %} + +``` +qui étends de `application/include/vues/system/system.html.twig` +```php + + + + {% block head %} + {{page_title}} + + + + + + + + + + + + + + + + + + + + + + + + + {% block topCss %} + + + {% endblock %} + {% endblock %} + + + +{% block topJavascript %}{% endblock %} + +{% block body %}{% endblock %} + +{% block bottomJavascript %} + + + +{# +SCRIPT JS permettant de ne valider qu'une seule fois un formulaire +ATTENTION tous les formulaires sont affecté +Lors d'une validation bootstrap personnalisé veuillez utilisé +la class do-resubmit sur le formulaire afin de permettre +l'activation supplémentaire du bouton. +#} + +{% endblock %} + + +``` \ No newline at end of file diff --git a/data/docs/03.b. Les vues Blade.md b/data/docs/03.b. Les vues Blade.md new file mode 100644 index 0000000..cc03da8 --- /dev/null +++ b/data/docs/03.b. Les vues Blade.md @@ -0,0 +1,257 @@ +#Les vues Blade + +Elles sont chargées dans cette ordre: + +* application/include/vues/system +* application/include/vues/layout +* application/include/vues/view + +ainsi la vue standard peut étendre de `application/include/vues/layout/body.blade.php` +```php +@extends('system') + +@section('body') + +
+ +
+
+ +
+
+ + + + + + @if(isset($authentification) && $authentification == 'yes') +
+
+ Vous êtes connecté en tant que {{$_SESSION['user_login']}} + Se Deconnecter +
+
+ @endif + + + + @if (isset($ariane)) + + @endif + + +
+
+ + + @if(isset($_SESSION['alerts'])) + @foreach($_SESSION['alerts'] as $alert) + + @endforeach + @endif + + @yield('content') + +
+
+ + +
+ +
+ + +
+ +@endsection + +``` +qui étends de `application/include/vues/system/system.blade.php` +```php + + + + + {{$page_title}} + + + + + + + + + + + + + + + + + + + + + + + + + @section('top-css') + + + @if(\MVC\Classe\Browser::get() == 'Internet Explorer') + + + @endif + @show + + + + + +@section('top-javascript') + @if(\MVC\Classe\Browser::get() == 'Internet Explorer') + + + + + + + + @endif +@show + +@yield('body') + +@section('bottom-javascript') + + + + @if(\MVC\Classe\Browser::get() !== 'Internet Explorer') + + @endif +@show + + + + +``` \ No newline at end of file diff --git a/data/docs/04.c. Les vues Blade avec SPA(vuejs).md b/data/docs/03.c. Les vues Blade avec SPA(vuejs).md similarity index 100% rename from data/docs/04.c. Les vues Blade avec SPA(vuejs).md rename to data/docs/03.c. Les vues Blade avec SPA(vuejs).md diff --git a/data/doc-prince-book-generation/doc/sand/Contents/05. Les Actions dans les vues.md b/data/docs/04. Les Actions dans les vues.md similarity index 88% rename from data/doc-prince-book-generation/doc/sand/Contents/05. Les Actions dans les vues.md rename to data/docs/04. Les Actions dans les vues.md index d0b8cd2..3ec6902 100644 --- a/data/doc-prince-book-generation/doc/sand/Contents/05. Les Actions dans les vues.md +++ b/data/docs/04. Les Actions dans les vues.md @@ -53,14 +53,17 @@ class DefaultAction extends Action } ``` -avec cet accès dans la vue: +avec cet accès dans une vue blade: ```php -{{\MVC\Classe\ControlleurAction::inserer('default',[])}} {{\MVC\Classe\ControlleurAction::inserer('default.default',[4,5,6])}} -{{\MVC\Classe\ControlleurAction::inserer('default.variableSlug',['var1','var2'])}} - {{\MVC\Classe\ControlleurAction::inserer('default.makeHttp11',[])}} ``` +ou avec cet accès dans une vue twig: +```php +{{ action('default.defaultTwig',[4,5,6]) }} +{{ action('default.makeHttp11',[]) }} +``` + il faut absolument que l'action retourne du texte soit par la la méthode `render` soit par un `système de tampon` \ No newline at end of file diff --git a/data/doc-prince-book-generation/doc/sand/Contents/06. Le conduit Symfony.md b/data/docs/05. Le conduit Symfony.md similarity index 94% rename from data/doc-prince-book-generation/doc/sand/Contents/06. Le conduit Symfony.md rename to data/docs/05. Le conduit Symfony.md index 096d454..abd5c27 100644 --- a/data/doc-prince-book-generation/doc/sand/Contents/06. Le conduit Symfony.md +++ b/data/docs/05. Le conduit Symfony.md @@ -5,6 +5,8 @@ un controlleur similaire a Symfony qui est dénomé ici Conduit car il prend en paramètre une route défini dans le fichier routing.yml. Cette fonctionnalité permet de choisir la route indépendamment du moteur. +Elle est utlie aussi pour créer des appels Curl et Ajax. + il faut instancier le fichier `application/config/files/routing.yml` avec la route de base et les routes que vous voulez conduire, par exemple: ```yml diff --git a/data/docs/19. Comment faire des appels récursifs en curl sur une API RESTFULL codée avec le framework.md b/data/docs/17. Appels récursifs en curl sur une API RESTFULL SAND.md similarity index 100% rename from data/docs/19. Comment faire des appels récursifs en curl sur une API RESTFULL codée avec le framework.md rename to data/docs/17. Appels récursifs en curl sur une API RESTFULL SAND.md diff --git a/data/docs/19. Les evolutions de SAND possibles dans sa prochaine version.md b/data/docs/19. Les evolutions de SAND possibles dans sa prochaine version.md new file mode 100644 index 0000000..aaf9566 --- /dev/null +++ b/data/docs/19. Les evolutions de SAND possibles dans sa prochaine version.md @@ -0,0 +1,27 @@ +__Le squelette de départ d'une application ExtJS__ : sisi c'est possible avec node.js mais l'intégration d'un tel outil n'as absolument pas été commencé lors de mon CDD à l'ufc ni même pendant ma période de convalescence du 15/07/2021 au 18/12/2021 car je me refuse encore actuellement de programmer, elle est un petit peu réfléchie et semble absolument possible avec de nombreuses application reliées mais je ne possède pas toutes les compréhensions techniques nécessaires pour le faire actuellement. + +__Un moteur de wiki basé sur wikini__ : si les auteurs du wikini0.5 acceptent... + +__Un moteur d'écriture en Markdown et Yaml dans de simples fichiers contenus dans /data__ : une portion de cela a été codé et est disponible sur le github du créateur du framework. + +---- + +// +Une dalle pdo plus performante (voir accueillant un système de choix de l'ORM ou un ORM spécifique) +// + +// +Une réécriture complète du système de vue afin d'accueillir les nouvelles versions de Twig et Blade +// + +// +Un systeme REST plus capable de faire ce qui doit être fait, imitant un peu Slim +// + +// +Des améliorations au niveau de l'intégration de Bootstrap5.0 : par exemple le système de notification push +// + +// +Ainsi que d'autres petites choses au niveau des objets de session et des composants de domaine (Composants de domaines qui ne seront accessible que sur RENATER, je garde précieusement ces fichiers...) +// \ No newline at end of file