Page tree
Skip to end of metadata
Go to start of metadata

This document describes how to implement Modules. A Module allows packages and services to be created. They define the fields requested when adding or editing packages and services, as well as handle all communication with remote servers to provision said packages and services.

Getting Started with Modules

For the purpose of this manual, the module name we'll refer to is my_module. Your module name will, of course, differ.

Module names must be unique

A user will not be able to install two module with the same name.

File Structure

Modules are fully contained within their named module directory and placed in the /installpath/components/modules/ directory. Each module is only required to contain a single class, representing the module, but the following is the recommended structure:

  • /modules/
    • my_module/
      • views/
      • language/
      • my_module.php

Install Logic

If your module requires any code to execute when installed, place that logic in your module's install() method.

/modules/my_module/my_module.php
<?php
class MyModule extends Module {

    ...

    public function install() {
        #
        # TODO: Place installation logic here
        #
    }
}
?>

Uninstall Logic

If your module required code to install, it likely requires code to uninstall. Place that logic in your module's uninstall() method.

There are two parameters passed to the uninstall() method. The first ($module_id) is the ID of the module being uninstalled. Because a module can be installed independently under different companies you may need to perform uninstall logic for a single module instance. The second parameter ($last_instance) identifies whether or not this is the last instance of this module in the system. If true, be sure to remove any remaining remnants of the module.

/modules/my_module/my_module.php
<?php 
class MyModule extends Module {

    ... 

    public function uninstall($module_id, $last_instance) {
        #
        # TODO: Place uninstallation logic here 
        #
    } 
} 
?>

Upgrade Logic

When the version of your code differs from that recorded within Blesta a user may initiate an upgrade, which will invoke your module's upgrade() method.

The $current_version is the version currently installed. That is, the version that will be upgraded from.

/modules/my_module/my_module.php
<?php
class MyModule extends Module {

    ...

    public function upgrade($current_version) {
        #
        # TODO: Place upgrade logic here
        #
    }

}
?>

Error Passing

Blesta facilitates error message passing through the use of the Input component. Simply load the Input component into your module and set any errors you encounter using Input::setErrors(). The setErrors() method accepts an array of errors. This can be a multi-dimensional array (in the case of multiple errors triggered for the same input or criteria) or a single dimensional array. The first dimension should be the name of the input that triggered the error. The second dimension, if necessary, is used to identify the type of error encountered.

/module/my_module/my_module.php
<?php
class MyModule extends Module {

    public function __construct() {
        Loader::loadComponents($this, array("Input"));
    }

    ...

    public function upgrade($current_version) {
        // Ensure new version is greater than installed version
        if (version_compare($this->version, $current_version) < 0) {
            $this->Input->setErrors(array(
                'version' => array(
                    'invalid' => "Downgrades are not allowed."
                )
            ));
            return;
        }
    }
}
?>

Module Methods

Now that we've looked at some of the basic of creating a module, let's take a look at all of the required methods each module must implement: Module Methods.

  • No labels

6 Comments

  1. Anonymous

    Please update more module documentation!

  2. Anonymous

    Please provide more documentation or examples.

  3. Anonymous

    Your missing a ) in your example function:

            public function upgrade($current_version) {

                // Ensure new version is greater than installed version

                if (version_compare($this->version, $current_version) < 0) {

                    $this->Input->setErrors(array(

                        'version' => array(

                            'invalid' => "Downgrades are not allowed."

                        )

                    ));

                    return;

                }

            }

    1. Thanks. It's now fixed.

  4. Anonymous

    Please give me more details in each function

  5. Anonymous

    Is it all the information needed to create a module?

    If not please advise when will you complete the documentation.

    Thanks.