{"id":207,"date":"2022-05-12T09:36:53","date_gmt":"2022-05-12T07:36:53","guid":{"rendered":"http:\/\/www.4amics.com\/x.perez\/?p=207"},"modified":"2022-05-12T09:36:55","modified_gmt":"2022-05-12T07:36:55","slug":"codeigniter-4-modular-sas","status":"publish","type":"post","link":"https:\/\/www.4amics.com\/x.perez\/2022\/05\/codeigniter-4-modular-sas\/","title":{"rendered":"CodeIgniter 4 Modular SAS"},"content":{"rendered":"\n

This is a Structure Application Starter, to be used as base for any project<\/p>\n\n\n\n

What is CodeIgniter Modular ?<\/h2>\n\n\n\n

CodeIgniter is a PHP full-stack web framework that is light, fast, flexible, and secure. More information can be found at the official site<\/a>.<\/p>\n\n\n\n

The “Modular Structure” allows to separate each module from other, having each one, controllers, database, filters, libraries, languages, models, routes, validations and views.<\/p>\n\n\n\n

Modules<\/th>Module<\/th>Structure<\/th><\/tr><\/thead>
Modules\/<\/td>Home\/<\/td>Config<\/td><\/tr>
<\/td><\/td>Controllers<\/td><\/tr>
<\/td><\/td>Language<\/td><\/tr>
<\/td><\/td>Views<\/td><\/tr>
<\/td><\/td><\/td><\/tr>
Modules\/<\/td>Users\/<\/td>Config<\/td><\/tr>
<\/td><\/td>Controllers<\/td><\/tr>
<\/td><\/td>Database<\/td><\/tr>
<\/td><\/td>Filters<\/td><\/tr>
<\/td><\/td>Language<\/td><\/tr>
<\/td><\/td>Libraries<\/td><\/tr>
<\/td><\/td>Models<\/td><\/tr>
<\/td><\/td>Validation<\/td><\/tr>
<\/td><\/td>Views<\/td><\/tr>
<\/td><\/td><\/td><\/tr>
Modules\/<\/td>Utils\/<\/td>Config<\/td><\/tr>
<\/td><\/td>Controllers<\/td><\/tr>
<\/td><\/td>Language<\/td><\/tr>
<\/td><\/td>Libraries<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

This repository holds a composer-installable app starter, with jQuery, Bootstrap4, and Login\/Register fully working module examples It has been built from the development repository<\/a>.<\/p>\n\n\n\n

More information about the plans for version 4 can be found in the announcement<\/a> on the forums.<\/p>\n\n\n\n

The user guide corresponding to this version of the framework can be found here<\/a>.<\/p>\n\n\n\n

<\/a>Installation & updates<\/h2>\n\n\n\n

Go to a browsable directory (Example: c:\\xampp\\htdocs)<\/p>\n\n\n\n

composer create-project xxperez\/codeigniter4modular<\/pre>\n\n\n\n
then<\/p>\n\n\n\n
cd codeigniter4modular<\/pre>\n\n\n\n
<\/a>Updates<\/h2>\n\n\n\n
Whenever there is a new release of the framework:<\/p>\n\n\n\n
composer update<\/pre>\n\n\n\n
When updating, check the release notes to see if there are any changes you might need to apply to your app<\/code> folder. The affected files can be copied or merged from vendor\/codeigniter4\/framework\/app<\/code>.<\/p>\n\n\n\n
<\/a>Setup<\/h2>\n\n\n\n
Go to Codeigniter4Modular directory.<\/p>\n\n\n\n
cd codeigniter4modular<\/pre>\n\n\n\n
Copy env<\/code> to .env<\/code>:<\/p>\n\n\n\n
copy env .env<\/pre>\n\n\n\n
Edit .env, and tailor for your app, specifically the baseURL and default database settings:<\/p>\n\n\n\n
app.baseURL = 'http:\/\/localhost\/codeigniter4modular\/public'\n\ndatabase.default.hostname = localhost\ndatabase.default.database = database\ndatabase.default.username = username\ndatabase.default.password = password\ndatabase.default.DBDriver = MySQLi\ndatabase.default.port = 3306<\/pre>\n\n\n\n
After database configuration, run migrate to ensure the table users are created:<\/p>\n\n\n\n
php spark migrate -all<\/pre>\n\n\n\n
<\/a>Modular configuration<\/h2>\n\n\n\n
Add this lines to your .env, and adapt as necessary. The example files have english and spanish translations:<\/p>\n\n\n\n
#--------------------------------------------------------------------\n# LANGUAGE\n#--------------------------------------------------------------------\napp.defaultLocale = 'en'\napp.supportedLocales = ['en','es','fr','de']\napp.negotiateLocale = true\napp.appTimezone = 'America\/Chicago'<\/pre>\n\n\n\n
Now, you can test the app, browse your installed directory, click on “Login” in the main page.<\/p>\n\n\n\n
http:\/\/localhost\/codeigniter4modular<\/a><\/p>\n\n\n\n
<\/a>More about modular configuration<\/h3>\n\n\n\n
All modules will reside under \/Modules, but can be allocated elsewhere. When your create a module, edit \/app\/Config\/Autoload.php and add your module to the PSR4, to be able to be found.<\/p>\n\n\n\n
\tpublic $psr4 = [\n            APP_NAMESPACE => APPPATH, \/\/ For custom app namespace\n            'Config'      => APPPATH . 'Config',\n            APP_NAMESPACE.'\\Controllers' => APPPATH.'Controllers',\n            'Dashboard' => APPPATH . '..\/Modules\\Dashboard' ,\n            'Users' => APPPATH . '..\/Modules\\Users' ,\n\t];<\/pre>\n\n\n\n
Each filter you declare inside a module, must to be aliased in app\/Config\/Filters.php to be able to be used inside a rule.<\/p>\n\n\n\n
\tpublic $aliases = [\n\t\t'csrf'     => \\CodeIgniter\\Filters\\CSRF::class,\n\t\t'toolbar'  => \\CodeIgniter\\Filters\\DebugToolbar::class,\n\t\t'honeypot' => \\CodeIgniter\\Filters\\Honeypot::class,\n\t\t'auth' => \\Users\\Filters\\AuthFilter::class,\n\t\t'noauth' => \\Users\\Filters\\NoAuthFilter::class,\n\t];<\/pre>\n\n\n\n
Each validation you declare inside a module, must to be set in the ruleSets variable in app\/Config\/Validation.php.<\/p>\n\n\n\n
\tpublic $ruleSets = [\n\t\t\\CodeIgniter\\Validation\\Rules::class,\n\t\t\\CodeIgniter\\Validation\\FormatRules::class,\n\t\t\\CodeIgniter\\Validation\\FileRules::class,\n\t\t\\CodeIgniter\\Validation\\CreditCardRules::class,\n\t\t\\Users\\Validation\\UserRules::class,\n\t];<\/pre>\n\n\n\n
<\/a>Modular libraries<\/h3>\n\n\n\n
Libraries within a module are used to define functions that lightweight the controllers. If you prefer to use validations inside a module library, you will need to access requests and validation objects directly:<\/p>\n\n\n\n
        $request = \\Config\\Services::request();\n        $validation = \\Config\\Services::validation();\n        $validation->setRules($rules, $errors);\n        $validation->withRequest($request)->run();\n        $validationErrors = $validation->getErrors();<\/pre>\n\n\n\n
<\/a>Modular creation<\/h3>\n\n\n\n
To create new modules, you can use spark module:create option, from base directory. For example, to create a module named ‘Customers’:<\/p>\n\n\n\n
php spark module:create Customers<\/pre>\n\n\n\n
Module create options: -f ModuleDir (other than App\/Modules) -c FCLMVO (Create only con[F]ig, [C]ontroller, [L]ibrary, [M]odel, [V]iew, [O]ther dirs)<\/p>\n\n\n\n
php spark module:create Customers -c FCMV<\/pre>\n\n\n\n
<\/a>Important Change with index.php<\/h2>\n\n\n\n
index.php<\/code> is no longer in the root of the project! It has been moved inside the public<\/em> folder, for better security and separation of components.<\/p>\n\n\n\n
This means that you should configure your web server to “point” to your project’s public<\/em> folder, and not to the project root. A better practice would be to configure a virtual host to point there. A poor practice would be to point your web server to the project root and expect to enter public\/…<\/em>, as the rest of your logic and the framework are exposed.<\/p>\n\n\n\n
Please<\/strong> read the user guide for a better explanation of how CI4 works! The user guide updating and deployment is a bit awkward at the moment, but we are working on it!<\/p>\n\n\n\n
<\/a>Repository Management<\/h2>\n\n\n\n
We use Github issues, in our main repository, to track BUGS<\/strong> and to track approved DEVELOPMENT<\/strong> work packages. We use our forum<\/a> to provide SUPPORT and to discuss FEATURE REQUESTS.<\/p>\n\n\n\n
This repository is a “distribution” one, built by our release preparation script. Problems with it can be raised on our forum, or as issues in the main repository.<\/p>\n\n\n\n
<\/a>Server Requirements<\/h2>\n\n\n\n
PHP version 7.2 or higher is required, with the following extensions installed:<\/p>\n\n\n\n