Previous articles:
- ➡️ [Section 11. Base Module](/docs/11-module-base)
- ➡️ [Section 12. Free Module](/docs/12-module-free)
- ➡️ [Section 13. Geo Module](/docs/13-module-geo)
# SLOT-H: Creating a Module
A module in the system is a self-contained functional block that loads automatically when a specific structure is present. To create a new module, simply add a folder to the `Modules` directory.
---
## Module Registration
Before creating the module structure, it must be registered in the system kernel.
In the `Application/Crud.php` file, add a constant with the module name:
```php
const MODULE_BLOG = 'Blog';
```
Enable the module in the active modules list:
```php
public static $_modules = [
Crud::MODULE_BASE => true,
Crud::MODULE_FREE => true,
Crud::MODULE_GEO => true,
Crud::MODULE_BLOG => true
];
```
##Basic Module Structure
A minimal module consists of three required files:
Bootstrap.php - defines the module name and guest access
Crud.php - describes access rights and controllers
Preloader.php - performs preloading (authentication, permission checks)
Additional folders are added as needed:
Controllers - module controllers
Models - data models and DbTables
Views - templates for each project
Public - CSS and JS for each project
##Example: Creating a Blog Module
###1. Bootstrap.php
```php
localized name
*/
public static function getNames()
{
return [
self::INDEX_PERMISSION => 'Blog main page',
];
}
/**
* Controller ID mapping (for permission system).
*
* @var array
*/
public static $_ids = [
self::INDEX_CONTROLLER => null,
];
/**
* List of controllers and their permission codes.
*
* @var array
*/
public static $_controllers = [
self::INDEX_CONTROLLER => self::INDEX_PERMISSION,
];
/**
* List of modules and their permissions.
*
* @var array
*/
public static $_modules = [
\Application\Crud::MODULE_BLOG => self::MODULE_PERMISSION
];
/**
* Access rules for module actions.
*
* @var array
*/
public static $_rules = [
self::MODULE_PERMISSION => [
self::INDEX_PERMISSION => [
Cr::INDEX_ACTION => Cr::READ_RULE
],
],
];
}
````
###3. Preloader.php
```php
currentPrivate = \Modules\Base\Models\DbTables\PersonPrivate::checkAuth()) {
// Load user data
$view->currentPerson = $view->currentPrivate->linkPersonId();
$view->currentProtected = $view->currentPerson->lotsPersonProtectedInBaseByPersonId();
// Sync user preferences from cookies to database
$this->checkPersonUpdates($view->currentPerson, $view->currentProtected);
// Set user permissions
$view->currentPerson->setPersonPermissions();
// Enable translation mode if user has localization permission
if ($view->currentPerson->checkRules(db\Rule::RULE_LOCALIZATION_CODE) && isset($_COOKIE[Cr::LOCALIZATION_COOKIE]) && $_COOKIE[Cr::LOCALIZATION_COOKIE] > 0) {
\Config\CC::$_adminLocale = [];
}
}
}
}
````
###4. Adding a Controller
Controllers are created in the Controllers folder. Each controller inherits from the system's base controller.
```php
_actions = [];
}
/**
* Index action.
*/
public function indexAction()
{
$this->setViewPath()
->_view->setLayoutFree()
->append(['posts' => db\Post::getAll($this->_page)]);
}
}
````
###5. Adding Models
Models are created in the Models folder. A DbTable class describing the table is required for database operations.
####5.1 DbTables/Post.php
```php
[],
self::POST_TEXT => [self::FP_TYPE => self::TYPE_TEXT],
self::POST_AUTHOR => [self::FP_TYPE => self::TYPE_STRING],
self::POST_TIME => [self::FP_TYPE => self::TYPE_INT],
];
}
````
####5.2 Models/Post.php
```php
/ folder. Each project can have its own views.
####6.1 Example: Views/Project_1/Index/index.phtml
```php
addEnvironment();
?>
```
####6.2 Adding Static Files
CSS and JS files are created in the folders:
Public/css/Project_//index.css
Public/js/Project_//index.js
Complete Module Structure
```text
Modules/Blog/
├── Bootstrap.php
├── Crud.php
├── Preloader.php
├── Controllers/
│ └── Index.php
├── Models/
│ ├── DbTables/
│ │ └── Post.php
│ └── Post.php
├── Public/
│ ├── css/
│ │ └── Project_1/
│ │ └── Index/
│ │ └── index.css
│ └── js/
│ └── Project_1/
│ └── Index/
│ └── index.js
└── Views/
└── Project_1/
└── Index/
└── index.phtml
```
##Completion
After creating all classes and files, run the autoloader generator:
```bash
php Application/Tools/createAutoloader.php
```
The module becomes available in the system. You can now proceed to customize the view appearance and styles - they do not affect the module's functionality.
##Module Removal
To remove a module, simply delete its folder from Modules and disable it (remove it from the Application/Crud.php class). The system will automatically stop loading it.
Important: when removing a module, you must also delete its tables from the database if they were created - don't leave database clutter!
---
##What's next?
- ➡️ [Section 15. Database Structure](/docs/15-database-diagram)
- ➡️ [Section 16. ORM Principles](/docs/16-orm-principles)
- ➡️ [Section 17. Working Methods](/docs/17-orm-methods)