From 435e960c69d46a454669f85b1d3d3e2797b29e25 Mon Sep 17 00:00:00 2001 From: Benoit Foujols Date: Thu, 28 Mar 2024 22:05:48 +0100 Subject: [PATCH] #70 clean code --- README.md | 2 +- app/Config/routes.yaml | 1 - src/EduFramework/Commands/CreateCliCommand.php | 13 +++++++------ .../Commands/CreateControllerCommand.php | 16 ++++++++-------- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index f7ccf1a..26ad21e 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Edu-Framework est une proposition d'architecture MVC pour la création de projet - Début d'approche pour l'enseignement d'un framework (Symfony, Laravel ...) > [!NOTE] -> L'ensemble de la documentation est disponible sur le [https://studoo-app.github.io/edu-framework-doc](https://studoo-app.github.io/edu-framework-doc/starter.html) +> L'ensemble de la documentation est disponible sur le [https://studoo-app.github.io/edu-framework-doc](https://studoo-app.github.io/edu-framework-doc/) > [!IMPORTANT] > Ce framework n'est pas adapté à une utilisation en production. Il est destiné à des fins pédagogiques. diff --git a/app/Config/routes.yaml b/app/Config/routes.yaml index 8dc98d0..e69de29 100644 --- a/app/Config/routes.yaml +++ b/app/Config/routes.yaml @@ -1 +0,0 @@ -test: Controller\HomeController \ No newline at end of file diff --git a/src/EduFramework/Commands/CreateCliCommand.php b/src/EduFramework/Commands/CreateCliCommand.php index be1d78a..f7f9367 100644 --- a/src/EduFramework/Commands/CreateCliCommand.php +++ b/src/EduFramework/Commands/CreateCliCommand.php @@ -25,7 +25,7 @@ */ #[AsCommand( name: 'make:command', - description: 'Génération d une commande', + description: 'Génération command CLI', )] class CreateCliCommand extends Command { @@ -62,8 +62,8 @@ public function execute(InputInterface $input, OutputInterface $output): int /** * Fonction permettant le traitement de l'arg command-name passé à la commande - * afin de générer les différents noms et chemins nécéssaires - * @param string $arg + * afin de générer les différents noms et chemins nécessaires + * @param string $arg Nom de la commande * @return array */ private function getNamesCollection(string $arg): array @@ -80,8 +80,8 @@ private function getNamesCollection(string $arg): array /** * Fonction permettant de générer la classe PHP - * @param string $className - * @param string $nameCommand + * @param string $className Nom de la classe + * @param string $nameCommand Nom de la commande * @return void * @throws CommandAlreadyExistsException */ @@ -123,8 +123,9 @@ private function generateCommand(string $className, string $nameCommand): void self::$stdOutput->writeln([ CommandBanner::getBanner(), 'Bienvenue dans la console ' . ConfigCore::getConfig('name'), - '' + '', ]); + // Ajouter votre code ici return Command::SUCCESS; CODE); diff --git a/src/EduFramework/Commands/CreateControllerCommand.php b/src/EduFramework/Commands/CreateControllerCommand.php index f65705d..45c356d 100644 --- a/src/EduFramework/Commands/CreateControllerCommand.php +++ b/src/EduFramework/Commands/CreateControllerCommand.php @@ -56,11 +56,11 @@ public function execute(InputInterface $input, OutputInterface $output): int //Format controller-name arg $namesCollection = self::getNamesCollection($input->getArgument('controller-name')); //Generate route params in app/Config/routes.yaml - self::generateRoute($namesCollection["uri"], $namesCollection["uri"], $namesCollection["className"]); + $this->generateRoute($namesCollection["uri"], $namesCollection["uri"], $namesCollection["className"]); //Generate Controller Class - self::generateController($namesCollection["className"], $namesCollection["twigPath"]); + $this->generateController($namesCollection["className"], $namesCollection["twigPath"]); //Generation TWIG - self::generateView($namesCollection["twigDir"], $namesCollection["twigPath"]); + $this->generateView($namesCollection["twigDir"], $namesCollection["twigPath"]); //Close command message $io->success("Controller successfully generated"); return Command::SUCCESS; @@ -75,15 +75,15 @@ public function execute(InputInterface $input, OutputInterface $output): int private function getNamesCollection(string $arg): array { - $pieces = preg_split('/(?=[A-Z])/', $arg); - array_shift($pieces); + $name = preg_split('/(?=[A-Z])/', $arg); + array_shift($name); $className = ucfirst($arg)."Controller"; $uri = strtolower($arg); $twig = strtolower($arg); - if(count($pieces) > 1) { - $twig = implode("_", array_map(function ($item) {return strtolower($item);}, $pieces)); + if(count($name) > 1) { + $twig = implode("_", array_map(function ($item) {return strtolower($item);}, $name)); $uri = str_replace("_", "-", $twig); } @@ -108,7 +108,7 @@ private function generateController(string $className, string $twigPath): void mkdir(self::CONTROLLER_DIR); } - $filename = "./app/Controller/$className.php"; + $filename = self::CONTROLLER_DIR . "$className.php"; if(file_exists($filename)) { throw new ControllerAlreadyExistsException();