Module

Interface for system module.

abstract class Module

Copyright: 2015-2016 Appertly

License: Apache-2.0

Instance Methods

Public
Returns	Signature and Description
`ImmMap`<`string`,`mixed`>	`getConfig`() Gets static configuration settings.
`ImmMap`<`string`,`string`>	`getMeta`() Gets the module metadata.
`void`	`setupBackend`(`Builder $builder`, `Properties $properties`) Allows the module to register classes in the backend container.
`void`	`setupFrontend`(`Builder $builder`, `Properties $properties`) Allows the module to register classes in the frontend container.

Method Details

getConfig

public function getConfig()

Gets static configuration settings.

Returns
Type	Description
`ImmMap`<`string`,`mixed`>	The module configuration settings

getMeta

abstract public function getMeta()

Gets the module metadata.

This array should contain at the very least the keys name, version, author, and description. Feel free to add any additional fields you like, such as license, or copyright.

Returns
Type	Description
`ImmMap`<`string`,`string`>	A Map of the module metadata

setupBackend

public function setupBackend(Builder $builder, Properties $properties)

Allows the module to register classes in the backend container.

This method must only invoke the eager, lazy, and proto methods. It should not attempt to build the container.

Parameters
Name	Type	Description
`$builder`	`Builder`	The backend dependency injection container
`$properties`	`Properties`	The configuration settings

setupFrontend

public function setupFrontend(Builder $builder, Properties $properties)

Allows the module to register classes in the frontend container.

This method must only invoke the eager, lazy, and proto methods. It should not attempt to build the container.

Parameters
Name	Type	Description
`$builder`	`Builder`	The frontend dependency injection container
`$properties`	`Properties`	The configuration settings