1. class
  2. Biigle
  3. \
  4. Services
  5. \
  6. Modules

Modules

class Modules

The module registry service.

Properties

protectedarray $viewMixins The view mixins of every module for every view.
protectedarray $controllerMixins The controller mixins of every module.
protectedarray $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 line38
__construct()

Create a new instance.

at line51
register(string$module,array$assets)

Register module assets in one step.

Parameters

string $module Module name
array $assets

at line77
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 line87
addMixin($module,$view)deprecated

deprecated In favor of the more descriptive registerViewMixin.

Parameters

$module
$view

at line98
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 line106
getMixins($view)deprecated

deprecated In favor of the more descriptive getViewMixins.

Parameters

$view

at line118
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 line129
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 line141
array callControllerMixins(string$controller,array$args)

Call all controller mixins registered for a certain controller.

Parameters

string $controller
array $args

Return Value

array

at line159
array getInstalledModules()

Returns information about all installed BIIGLE modules

Return Value

array

at line173
array getApidocPaths()

Get the registered apidoc paths of the modules.

Return Value

array