class Modules

The module registry service.

Properties

protected array $viewMixins The view mixins of every module for every view.
protected array $controllerMixins The controller mixins of every module.
protected array $apidocPaths Additional source paths to generate the API documentation from.

Methods

__construct()

Create a new instance.

register(string $module, array $assets)

Register module assets in one step.

registerViewMixin(string $module, string $view)

Registers a new view mixin of a module for a view.

addMixin($module, $view) deprecated

No description

array
getViewMixins(string $view)

Returns all mixins for a view that were registered by modules.

getMixins($view) deprecated

No description

registerControllerMixin(string $module, string $controller, callable $mixin)

Registers a new controller mixin of a module.

array
getControllerMixins(string $controller)

Returns all mixins for a controller that were registered by modules.

array
callControllerMixins(string $controller, array $args)

Call all controller mixins registered for a certain controller.

array
getInstalledModules()

Returns information about all installed BIIGLE modules

array
getApidocPaths()

Get the registered apidoc paths of the modules.

Details

at line 37
__construct()

Create a new instance.

at line 50
register(string $module, array $assets)

Register module assets in one step.

Parameters

string $module Module name
array $assets

at line 76
registerViewMixin(string $module, string $view)

Registers a new view mixin of a module for a view.

Parameters

string $module name of the module
string $view name of the view (may be nested in another mixin using the dot notation: e.g. dashboard.projects)

at line 86
addMixin($module, $view) deprecated

deprecated In favor of the more descriptive registerViewMixin.

Parameters

$module
$view

at line 97
array getViewMixins(string $view)

Returns all mixins for a view that were registered by modules.

Parameters

string $view name of the view

Return Value

array

at line 105
getMixins($view) deprecated

deprecated In favor of the more descriptive getViewMixins.

Parameters

$view

at line 117
registerControllerMixin(string $module, string $controller, callable $mixin)

Registers a new controller mixin of a module.

Parameters

string $module name of the module
string $controller Name of the controller
callable $mixin Callback for the controller mixin

at line 128
array getControllerMixins(string $controller)

Returns all mixins for a controller that were registered by modules.

Parameters

string $controller name of the controller

Return Value

array

at line 140
array callControllerMixins(string $controller, array $args)

Call all controller mixins registered for a certain controller.

Parameters

string $controller
array $args

Return Value

array

at line 158
array getInstalledModules()

Returns information about all installed BIIGLE modules

Return Value

array

at line 172
array getApidocPaths()

Get the registered apidoc paths of the modules.

Return Value

array