Merge pull request #6 from Simpletine/v1.1.0

Update v1.0.0 to v1.1.0

Author: Simpletine

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+## v1.1.0 - 2024-07-13
+
+### Changes
+- Renamed command `make:module` to `module:create` for better consistency
+
+### Features
+- Added module `config` folder for management of routes within configs ([#5](https://github.com/Simpletine/CodeIgniter4-HMVC/issues/5))
+- `module:controller`: Create a controller in a specified module ([#4](https://github.com/Simpletine/CodeIgniter4-HMVC/issues/4))
+- `module:model`: Create a model in a specified module ([#3](https://github.com/Simpletine/CodeIgniter4-HMVC/issues/3))
+- `module:copy`: Copy an existing module and rename key elements ([#2](https://github.com/Simpletine/CodeIgniter4-HMVC/issues/2))
+
+## v1.0.0 - 2024-06-22
+
+- Initial release
+- Implemented `php spark make:module blogs` command for creating new modules called `blogs`

CONTRIBUTE.md

@@ -1,18 +1,47 @@
-# Codeigniter4-HMVC
+# Codeigniter 4 HMVC 
 
-[![Official Website](https://img.shields.io/badge/Official_Website-Visit-yellow)](https://simpletine.com)  
-[![YouTube Channel](https://img.shields.io/badge/YouTube_Channel-Subscribe-FF0000)](https://www.youtube.com/channel/UCRuDf31rPyyC2PUbsMG0vZw) 
+[![Official Website](https://img.shields.io/badge/Official_Website-Visit-yellow)](https://simpletine.com)   [![YouTube Channel](https://img.shields.io/badge/YouTube_Channel-Subscribe-FF0000)](https://www.youtube.com/channel/UCRuDf31rPyyC2PUbsMG0vZw) 
 
 ### Prerequisites
 1. PHP 7.4 or above
 2. Composer required
 2. CodeIgniter 4.4.8
 
 ### Installation Guide
-For the guideline, see the [documentation](/INSTALLING.md) 
+
+Clone project to your project root folder
+```bash
+composer create-project simpletine/codeigniter4-hmvc ci4_hmvc --stability=dev
+```
+Or
+```bash
+git clone https://github.com/Simpletine/CodeIgniter4-HMVC.git ci4_hmvc
+```
+Then
+```bash
+cd ci4_hmvc
+``` 
+
+Copy some require file to root folder (Upgrading to v4.4.8)
+```bash
+composer update
+cp vendor/codeigniter4/framework/public/index.php public/index.php
+cp vendor/codeigniter4/framework/spark spark
+```
+
+Copy `env` file
+```bash
+cp env .env
+```
+
+Run the app, using different port, add options `--port=9000`
+```bash
+php spark serve
+```
+
 
 ---
-## Generate New Module 
+## Module Commands
 ```bash
 php spark make:module [module] 
 ```
@@ -25,20 +54,20 @@ php spark make:module blogs
 
 ###  Result Directory
     App 
-    ├── Config       
-    │   └── Routes.php (Added group called blogs)
     ├── Modules      
     │   └── Blogs
+    │       ├──  Config
+    │           └──  Routes.php
     │       ├──  Controllers
     │           └──  Blogs.php
     │       ├──  Models
-    │           └──  BlogsModel.php
+    │           └──  Blogs.php
     │       └──  Views
     │           └──  index.php
     └── ...  
 
 ### Route Group
-After generate `Blogs` Module, add a route group for the module at `App\Config\Routes.php`
+After generate `Blogs` Module, the routes group for the module at `Modules\Config\Routes.php`
 ```php
 $routes->group(
     'blogs', ['namespace' => '\Modules\Blogs\Controllers'], function ($routes) {
@@ -58,7 +87,4 @@ public $psr4 = [
     "Blogs" => APPPATH . "Modules/Blogs", // Example 
     // ...
 ];
-```
----
-### Contribute
-To contribute to this repository and extend its architectural capabilities or you find an issue, follow these [steps](/CONTRIBUTE.md)
+```

INSTALLING.md

@@ -0,0 +1,141 @@
+<?php
+
+namespace App\Commands;
+
+use CodeIgniter\CLI\BaseCommand;
+use CodeIgniter\CLI\CLI;
+
+/**
+ * Generates a controller in the specified module.
+ */
+class ModuleController extends BaseCommand
+{
+    /**
+     * The Command's Group
+     *
+     * @var string
+     */
+    protected $group = 'SimpleTine';
+
+    /**
+     * The Command's Name
+     *
+     * @var string
+     */
+    protected $name = 'module:controller';
+
+    /**
+     * The Command's Description
+     *
+     * @var string
+     */
+    protected $description = 'Generate a controller into a module';
+
+    /**
+     * The Command's Usage
+     *
+     * @var string
+     */
+    protected $usage = 'module:controller <module> <file>';
+
+    /**
+     * The Command's Arguments
+     *
+     * @var array
+     */
+    protected $arguments = [
+        'module' => 'The name of the existing module directory',
+        'file' => 'The name of the file to create',
+    ];
+
+    /**
+     * The Command's Options
+     *
+     * @var array
+     */
+    protected $options = [];
+
+    /**
+     * Execute the command.
+     *
+     * @param array $params
+     */
+    public function run(array $params)
+    {
+        helper('inflector');
+
+        $directoryMainFolder = 'Modules';
+        if (!is_dir(APPPATH . $directoryMainFolder)) {
+            if (mkdir(APPPATH . $directoryMainFolder, 0755, true)) {
+                CLI::write('Modules Folder created', 'green');
+            } else {
+                CLI::error('Modules Folder creation failed. Please create a new folder (Modules) inside APP or try again.');
+                return;
+            }
+        }
+
+        $directoryName = array_shift($params);
+        $fileName = array_shift($params);
+
+        if (!$directoryName || !$fileName) {
+            CLI::error('Both module name and file name are required.');
+            return;
+        }
+
+        $moduleDirectory = "$directoryMainFolder/$directoryName";
+        if (!is_dir(APPPATH . $moduleDirectory)) {
+            mkdir(APPPATH . $moduleDirectory, 0755, true);
+            CLI::write('Module folder created - ' . APPPATH . $moduleDirectory, 'green');
+        }
+
+        $controllerDirectory = APPPATH . $moduleDirectory . '/Controllers';
+        if (!is_dir($controllerDirectory)) {
+            mkdir($controllerDirectory, 0755, true);
+        }
+
+        $namespace = str_replace('/', '\\', $moduleDirectory);
+        $className = pascalize($fileName);
+        $controllerTemplate = $this->getTemplate(
+            'controller.new.tpl.php',
+            [
+                '{namespace}' => "$namespace\\Controllers",
+                '{useModelStatement}' => "$namespace\\Models\\$className",
+                '{useStatement}' => 'App\Controllers\BaseController',
+                '{class}' => $className,
+                '{modelClass}' => $className,
+                '{extends}' => 'BaseController',
+                '{directoryName}' => $directoryName,
+            ]
+        );
+
+        $controllerPath = APPPATH . $moduleDirectory . "/Controllers/$className.php";
+        file_put_contents($controllerPath, $controllerTemplate);
+
+        CLI::write("Controller '$className' created in module '$directoryName'.", 'green');
+    }
+
+    /**
+     * Get the template content with placeholders replaced.
+     *
+     * @param string $templateFile
+     * @param array $placeholders
+     * @return string
+     */
+    protected function getTemplate(string $templateFile, array $placeholders): string
+    {
+        $templatePath = APPPATH . 'Commands/Views/' . $templateFile;
+
+        if (!file_exists($templatePath)) {
+            CLI::write('Template file not found: ' . $templateFile, 'red');
+            return '';
+        }
+
+        $templateContent = file_get_contents($templatePath);
+
+        foreach ($placeholders as $placeholder => $value) {
+            $templateContent = str_replace($placeholder, $value, $templateContent);
+        }
+
+        return str_replace('<@php', '<?php', $templateContent);
+    }
+}