Jingga/Developer-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Developer-Guide.git synced 2026-01-11 20:38:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
4c1af984b4
Developer-Guide/components/modules.md

13 KiB
Raw Blame History

Modules

The following directory structure should roughly visualize how modules are strucured. The purpose of the different sub-directories and their files will be covered in the following sections.

  • {UniqueModuleName}
    • Admin
      • Install
        • Navigation.install.json
        • Navigation.php
      • Routes
        • Web
          • Backend.php
      • Update
        • yourUpdateFiles.???
      • Activate.php
      • Deactivate.php
      • Installer.php
      • Uninstall.php
      • Update.php
    • Img
      • modulePreviewImage.jpg
    • Models
      • YourPhPModels.php
      • YourJavaScriptModels.js
    • Theme
      • Backend
        • Css
          • yourCss_1.0.0.css
          • yourScss_1.0.0.scss
        • Img
          • yourTemplateImages.jpg
        • Lang
          • en.lang.php
          • Navigation.en.lang.php
        • your_template_files.tpl.php
    • Views
      • YourPhpViews.php
      • YourJavaScriptViews.js
    • Controller.php
    • Controller.js
    • info.json

All modules are located inside the /Modules directory and their directory name has to be the module name itself without whitespaces.

Admin

The admin directory contains the install directory as well as the install, delete, update, activate and deactivate script assoziated with this module. The install directory contains installation files required for other modules. The above example contains the two required files for providing navigation information to the navigation module so that the navigation module can display this module in the navigation bar. The navigation installation file as well as all other module installation files must have the same name as the navigation module and will be automatically called on installation if defined in the info.json file.

The content of the navigation install file highly depends on the module and should be documented in the according module. The additional json file is also required by the navigation module for the installation process. How many additional files and how they have to be structured/named should all be documented in the module documentation. If your module doesn't provide any navigation links or in general doesn't use any other modules, your install directory will be empty.

Some modules can be used without requiring any additional installations it all depends on how the other modules got implemented. Thats also why many modules don't offer any integration at all and are almost stand-alone without the possibility to get extended.

Installer.php

In contrast to the install file for other moduels this file has to follow more strict standards. The following example shows you the bare minimum requirements of a installation file:

<?php
namespace Modules\Navigation\Admin;

use phpOMS\DataStorage\Database\DatabaseType;
use phpOMS\DataStorage\Database\Pool;
use phpOMS\Module\InfoManager;
use phpOMS\Module\InstallerAbstract;

class Installer extends InstallerAbstract
{
    public static function install(Pool $dbPool, InfoManager $info)
    {
        parent::install($dbPool, $info);

        switch ($dbPool->get('core')->getType()) {
            case DatabaseType::MYSQL:
                /* Your database setup goes here */
                break;
        }
    }
}

If your application doesn't need to implement any database tables for itself the switch statement can be omitted. From the directory structur at the beginning we can however see that some modules accept information form other modules. The following example shows how the navigation module is accepting information during the installation of other modules:

public static function installExternal(Pool $dbPool, array $data)
{
    /* What do you want to do with the data provided by $data? */
}

Other modules have to create a Navigation.php file inside the install directory with the following method:

public static function install(Pool $dbPool)
{
    $navData = json_decode(file_get_contents(__DIR__ . '/Navigation.install.json'), true);

    $class = '\\Modules\\Navigation\\Admin\\Installer';
    $class::installExternal($dbPool, $navData);
}

How the receiving module (e.g. Navigation) is accepting information depends on the module itself. The module documentation will also state how the content of the install(...) method has to look like. At the same time if you write a module and are accepting information from other modules during their installation you have to document very well how they have to provide these information. Very often however it will not be necessary to let other modules pass these information during installation and only do this during runtime.

The navigation module is a good example of passing navigation links during installation. The navigation module could request the link information during runtime this would mean that all modules would have to be initialized for every request since the navigation module doesn't know if these modules are providing links or not. By providing these information during the installation, the navigation module can store these information in a database table and query these information for every page request without initializing all modules or performing some file readings.

Update.php

Uninstall.php

Activate.php

Deactivate.php

Routes

In the routes directory all application routes are stored. These routing files get used during the installation process of every module and are stored in an application specific routing file. The first directory level contains the directories of the application type Web, Socket and Console. Inside these directories the routing files for the applications are stored by the name of the application e.g. Backend.php. The routing files themselves look like this:

<?php

use phpOMS\Router\RouteVerb;

return [
    '^.*/backend/admin/settings/general.*$' => [
        [
            'dest' => '\Modules\Admin\Controller:viewSettingsGeneral', 
            'verb' => RouteVerb::GET,
        ],
    ],

    '^.*/api/admin/module/status.*$' => [
        [
            'dest' => '\Modules\Admin\Controller:apiModuleStatusGet',
            'verb' => RouteVerb::GET,
        ],
        [
            'dest' => '\Modules\Admin\Controller:apiModuleStatusUpdate',
            'verb' => RouteVerb::SET,
        ],
    ],
];

The routes are defined via regex. One uri can have multiple destinations depending on the request type/verb. It's also possible to have multiple destinations for the same verb in case other views need to be loaded for the same uri (e.g. view injection in order to extend modules).

Img

All module specific images (not theme specific images). E.g. Module preview images showing when searching for modules.

Models

All models and data mapper classes should be stored in here (PHP & JS). How to create a data mapper for a model is described in the data mapper chapter. All JavaScript files need to be provided unoptimized (not minified or concatenated).

Theme

The Theme directory contains the current theme for every page this module supports. If a module only supports the backend application there will only be a Backend directory containing the theme for the backend.

Css

Every page has its own CSS directory. This application only allows the use of SASS/SCSS as preprocessor. All sass/scss files need to be provided as well as the processed CSS files. Make sure to update the version number in the Controller.php file. CSS files need to be minimized and if it makes sense concatenated.

Img

This directory contains all images for this page.

Lang

The Lang directory contains all language files for this application. Usually there is one language file for the page which will be loaded automatically wherever the module gets loaded (this language file has to exist).

A language file should have the following naming convention:

{ISO 639-1}.lang.php
{UniqueModuleName}.{ISO 639-1}.lang.php

The content of the language file is straight forward:

<?php return [ 
    '{UniqueModuleName}' => [
        'StringID' => 'Your localized string',
        ...
    ]
];

All other language files are optional and usually are only required by other modules. The navigation module for example requires an extra language file for the navigation elements. This however should be specified in the modules you want to make use of.

Views

Controller.php

Controller.js

info.json

The info.json file contains general module information used during installation as well for identification and display in the module database.

{
    "name": {
        "id": {UniqueModuleId_INT},
        "internal": "{UniqueModuleId_STR}",
        "external": "{Readable module name}"
    },
    "version": "{Version}",
    "requirements": {
        "phpOMS": "{Version}",
        "phpOMS-db": "{Version}"
    },
    "creator": {
        "name": "{Creator name/organization}",
        "website": "{Creator website}"
    },
    "description": "{Module description}",
    "directory": "{UniqueModuleId_STR}",
    "dependencies": {},
    "providing": {
        "Navigation": "{Version}"
    },
    "load": [
        {
            "pid": [
                "{SHA1_Uri_hash}"
            ],
            "type": 4,
            "for": "Content",
            "file": "{UniqueModuleId_STR}",
            "from": "{UniqueModuleId_STR}"
        },
        {
            "pid": [
                "{SHA1_Uri_hash}"
            ],
            "type": 5,
            "from": "{UniqueModuleId_STR}",
            "for": "{UniqueModuleId_For_STR}",
            "file": "{UniqueModuleId_For_STR}"
        },
        {
            "pid": [
                "{SHA1_Uri_hash}"
            ],
            "type": 5,
            "for": "Content",
            "file": "{UniqueModuleId_STR}",
            "from": "{UniqueModuleId_STR}"
        }
    ]
}

Name

The name category contains the names used for internel as well as external identification. Both id and internal are globally unique between all modules and is assigned generated by Orange Management. The id can also be used by other modules which need integer identification of modules. The id has the form xxxxx00000 which means, that modules don't only occupy a singl id but a range of ids. This can be usefull for other modules where additional module specifc information need to be assigned (e.g. Navigation module). The external name is the name the creator of the module can give the module. This is the name that will be used during searches for modules and shown to customers.

Version

The version is automatically incremented by Orange Management. The version might be used by other modules in order to require a specific version of a module. Versions must follow the following format:

major.minor.build = 2.512.19857

Requirements

The requirements are used in order to specify core specific requirements such as the database requirements, framework requirements, third party library regirements as well as potential local software requirements.

Creator

In the creator category it's possible to specify the name of the creator and the website of the creator. Multiple creators are not possible.

Description

In the description a markdown description can be specified which will be shown in the module overview. This can be used in order to describe the users what the purpose of this module is and how it workds.

Directory

The directory is the directory name of the module which is usually the unique string representation of the module. This is the directory in the modules folder where the module files will be located.

Dependencies

Often modules depend on other modules, these dependencies can be defined in the dependencies. The keys contain the unique string representation of the required modules and the value contains the version that is required.

Providing

In the providing category modules can specify other modules they intend to extend if they are installed. The keys contain the unique string representation of the module which is getting extended and the value contains the version of the module that is supposed to get extended.

Load

The load category contains all the files (controllers, language files) that need to be loaded during the application setup for a specific request uri.

PID

The pid (page identifier) is a sha1 hash of the uri where the file is supposed to be loaded. The pid needs to be defined in the following matter (e.g. http://127.0.0.1/en/app/path/sub&some=thing):

sha1('apppath');

The result of the example hash would result in loading all specified files for requests containing '/app/path'. This also includes requests to any subdirectories.

Type

The type contains the type of the file that needs to be loaded.

  • 5 = Navigation language file
  • 4 = Module controller

For

The for contains the unique module string representation the file is loaded for. This could be the own module or a thrid party module.

From

The fromcontains the unique module string representation the file is loaded from. This is the internal module name from the top of the info.json file.

File

The file contains the name of the file to be loaded. No path or extension is required nor allowed.