This is Hierarchical model–view–controller (HMVC) project starter using CodeIgniter4 framework. By HMVC architecture, I hope we could make scalable web application.
- PHP 7.2 or above
- Composer version 1.10 or above
- intl PHP extension (for formatting currency, number and date/time, see CodeIgniter4 Docs )
- xdebug PHP extension (for testing purpose only, optional)
- php_sqlite3 PHP extension (for testing purpose only, very optional)
- Run
composer create-project mufidjamaluddin/codeigniter4-hmvc
, rename folder codeigniter4-hmvc, goto folder inside. - Configure the app by change the
env
file. - Run
php spark serve
for run the app.
- Create module folder in app/Modules folder (example: app/Module/YourModule).
- Create Config, Controllers, and Models folder in your module path (example: see existing Admin and Land module)
- Create new Controller file and add your methods and test cases in tests folder
- Update module routes by run
php spark route:update
for create/change all module routes ORphp spark route:update -m YourModule
for create/change only one module. - Run
composer test
for run your test cases (optional, see CodeIgniter4 Docs or PHPUnit Docs )
Always run php spark route:update
after create or change module, controller, or controller methods except if you want to configure module route manually.
Parameters: '-n' = Set module namespace (default App\Modules) '-i' = Set route with /index path without parameter (true/false, default true) '-m' = Set route one module name to be create/update (app/Modules/YourModuleName) '-f' = Set module folder inside app path (default Modules)
Usage command php spark route:update -i false -m YourModule
You can run all of your test cases by run composer test
You can get all command prompt list by run php spark list
and composer command in composer.json > scripts.
By default, there is the structure of Codeigniter4-HMVC.
app
\Modules
\{YourModule}
\Config
Routes.php
\Controllers
BaseController.php
{YourController}.php
\Models
{YourModel}.php
\Views
\template
{YourTemplate}.php
\{your view module folder}
{Your View}.php
...
\tests
\unit
...
\integration
\Modules
\{YourModule}
{YourController}.php
...
You can structuring your module freely, because CodeIgniter4 use PSR4. If you want to change the structure of Routes.php in Config Module folder or the structure of Module Controllers, you must change app/Config/Routes.php in HMVC Routing section and modify RouteUpdate.php in app/Commands folder.
You can contribute for extend CodeIgniter4 capabilities or add command prompt for development use by fork this repository. After that, you can make pull request.