__construct() public method

Constructor.

afterAction() public method

This method is invoked right after an action within this module is executed.

The method will trigger the EVENT_AFTER_ACTION event. The return value of the method will be used as the action return value.

If you override this method, your code should look like the following:

public function afterAction($action, $result)
{
    $result = parent::afterAction($action, $result);
    // your custom code here
    return $result;
}

beforeAction() public method

This method is invoked right before an action within this module is executed.

The method will trigger the EVENT_BEFORE_ACTION event. The return value of the method will determine whether the action should continue to run.

In case the action should not run, the request should be handled inside of the beforeAction code by either providing the necessary output or redirecting the request. Otherwise the response will be empty.

If you override this method, your code should look like the following:

public function beforeAction($action)
{
    if (!parent::beforeAction($action)) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the action
}

createController() public method

Creates a controller instance based on the given route.

The route should be relative to this module. The method implements the following algorithm to resolve the given route:

1. If the route is empty, use $defaultRoute;
2. If the first segment of the route is a valid module ID as declared in $modules, call the module's createController() with the rest part of the route;
3. If the first segment of the route is found in $controllerMap, create a controller based on the corresponding configuration found in $controllerMap;
4. The given route is in the format of abc/def/xyz. Try either abc\DefController or abc\def\XyzController class within the controller namespace.

If any of the above steps resolves into a controller, it is returned together with the rest part of the route which will be treated as the action ID. Otherwise, false will be returned.

createControllerByID() public method

Creates a controller based on the given controller ID.

The controller ID is relative to this module. The controller class should be namespaced under $controllerNamespace.

Note that this method does not check $modules or $controllerMap.

defaultVersion() protected method (available since version 2.0.11)

Returns default module version.

Child class may override this method to provide more specific version detection.

getBasePath() public method

Returns the root directory of the module.

It defaults to the directory containing the module class file.

getControllerPath() public method

Returns the directory that contains the controller classes according to $controllerNamespace.

Note that in order for this method to return a value, you must define an alias for the root namespace of $controllerNamespace.

getInstance() public static method

Returns the currently requested instance of this module class.

If the module class is not currently requested, null will be returned. This method is provided so that you access the module instance from anywhere within the module.

getLayoutPath() public method

Returns the directory that contains layout view files for this module.

getModule() public method

Retrieves the child module of the specified ID.

This method supports retrieving both child modules and grand child modules.

See also hasModule().

getModules() public method

Returns the sub-modules in this module.

getUniqueId() public method

Returns an ID that uniquely identifies this module among all modules within the current application.

Note that if the module is an application, an empty string will be returned.

getVersion() public method (available since version 2.0.11)

Returns current module version.

If version is not explicitly set, defaultVersion() method will be used to determine its value.

getViewPath() public method

Returns the directory that contains the view files for this module.

hasModule() public method

Checks whether the child module of the specified ID exists.

This method supports checking the existence of both child and grand child modules.

init() public method

Initializes the module.

This method is called after the module is created and initialized with property values given in configuration. The default implementation will initialize $controllerNamespace if it is not set.

If you override this method, please make sure you call the parent implementation.

runAction() public method

Runs a controller action specified by a route.

This method parses the specified route and creates the corresponding child module(s), controller and action instances. It then calls yii\base\Controller::runAction() to run the action with the given parameters. If the route is empty, the method will use $defaultRoute.

setAliases() public method

Defines path aliases.

This method calls Yii::setAlias() to register the path aliases. This method is provided so that you can define path aliases when configuring a module.

[
    '@models' => '@app/models', // an existing alias
    '@backend' => __DIR__ . '/../backend',  // a directory
]

setBasePath() public method

Sets the root directory of the module.

This method can only be invoked at the beginning of the constructor.

setInstance() public static method

Sets the currently requested instance of this module class.

setLayoutPath() public method

Sets the directory that contains the layout files.

setModule() public method

Adds a sub-module to this module.

setModules() public method

Registers sub-modules in the current module.

Each sub-module should be specified as a name-value pair, where name refers to the ID of the module and value the module or a configuration array that can be used to create the module. In the latter case, Yii::createObject() will be used to create the module.

If a new sub-module has the same ID as an existing one, the existing one will be overwritten silently.

The following is an example for registering two sub-modules:

[
    'comment' => [
        'class' => 'app\modules\comment\CommentModule',
        'db' => 'db',
    ],
    'booking' => ['class' => 'app\modules\booking\BookingModule'],
]

setVersion() public method (available since version 2.0.11)

Sets current module version.

function (Module $module) {
    //return string
}

setViewPath() public method

Sets the directory that contains the view files.