startpl/t2cms-module

The module example for t2cms

1.0.0 2020-04-14 10:38 UTC

Apache-2.0

• Koperdog

README

You can use this module as template

Module development features

File structure:

my-module
├─ backend
|  ├── Module.php
|  └── config
|      └── main.php 
├── frontend
|   ├── Module.php
|   └── config
|       └── main.php 
├── common
|   ├── Module.php
|   └── config
|       └── main.php 
├── module_info.php
└── ModuleInstall.php

Each part of your module (backend/frontend/common) is a regular yii2 module.

All parts are optional, you can only implement a backend or frontend, or only a common.

if you use composer:

• Your composer.json must contain type: "t2cms-module"

File Descriptions

module_info.php

<?php
return [
    'url'         => 'example-module', // module url
    'namespace'   => 'startpl\\t2cms\\moduleExample',
    'name'        => 'example module',
    'description' => 'The module example',
    'version'     => '1.0.0',
    'fa_icon'     => 'envelope', // fontawesome
    'author'      => 'Your Name'
];

name	Description
'url' => 'example-module'	Module url (frontend - /example-module, backend - /admin/module/example-module)
'namespace' => 'startpl\\t2cms\\exampleModule'	Module namespace

ModuleInstall.php

ModuleInstall class must implement [t2cms\module\interfaces\IModuleInstall] interface

and must contain follow methods:

• install(): bool
• uninstall(): bool
• activate(): bool
• deactivate(): bool
• update(): bool