HumHub Documentation (unofficial)

ModuleManager extends Component
in package

Application

ModuleManager handles all installed modules.

Constants

EVENT_AFTER_FILTER_MODULES = 'afterFilterModules'
EVENT_AFTER_MODULE_DISABLE = 'afterModuleDisabled'
EVENT_AFTER_MODULE_ENABLE = 'afterModuleEnabled'
EVENT_BEFORE_MODULE_DISABLE = 'beforeModuleDisabled'
EVENT_BEFORE_MODULE_ENABLE = 'beforeModuleEnabled'

Properties

$behaviors : array<string|int, Behavior>
$createBackup : bool: Create a backup on module folder deletion
$overwriteModuleBasePath : array<string|int, mixed>: List of module paths that should be overwritten Key - module id, Value - absolute path to module folder
$preventDuplicatedModules : bool
$coreModules : array<string|int, mixed>: List of core module classes.
$enabledModules : array<string|int, mixed>: List of all enabled module ids
$modules : array<string|int, mixed>: List of all modules This also contains installed but not enabled modules.
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canRemoveModule() : bool: Checks if the module can be removed
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
disable() : mixed: Disables a module
disableModules() : mixed
enable() : mixed: Enables a module
enableModules() : mixed
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
filterModules() : array<string|int, Module>: Filter modules by keyword and by additional filters from module event
filterModulesByKeyword() : array<string|int, Module>: Filter modules by keyword
flushCache() : mixed: Flushes module manager cache
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getEnabledModules() : array<string|int, mixed>: Returns all enabled modules and supportes further options as [[getModules()]].
getModule() : Module|object|null: Returns a module instance by id
getModules() : array<string|int, mixed>: Returns all modules (also disabled modules).
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasModule() : bool: Checks if a moduleId exists, regardless it's enabled or not
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Module Manager init
isCoreModule() : bool: Returns weather or not the given module id belongs to an core module.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
register() : mixed: Registers a module
registerBulk() : mixed: Registers a module to the manager This is usually done by config.php in modules root folder.
removeModule() : string|null: Removes a module
trigger() : mixed: Triggers an event.
registerEventHandlers() : void
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.
checkRequirements() : mixed: Check module requirements

EVENT_AFTER_FILTER_MODULES


    public
        mixed
    EVENT_AFTER_FILTER_MODULES
    = 'afterFilterModules'

EVENT_AFTER_MODULE_DISABLE


    public
        mixed
    EVENT_AFTER_MODULE_DISABLE
    = 'afterModuleDisabled'

EVENT_AFTER_MODULE_ENABLE


    public
        mixed
    EVENT_AFTER_MODULE_ENABLE
    = 'afterModuleEnabled'

EVENT_BEFORE_MODULE_DISABLE


    public
        mixed
    EVENT_BEFORE_MODULE_DISABLE
    = 'beforeModuleDisabled'

EVENT_BEFORE_MODULE_ENABLE


    public
        mixed
    EVENT_BEFORE_MODULE_ENABLE
    = 'beforeModuleEnabled'

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$createBackup

Create a backup on module folder deletion


    public
        bool
    $createBackup
     = true

$overwriteModuleBasePath

List of module paths that should be overwritten Key - module id, Value - absolute path to module folder


    public
        array<string|int, mixed>
    $overwriteModuleBasePath
     = []

$preventDuplicatedModules


    public
        bool
    $preventDuplicatedModules
     = true

Prevent registration of several different modules with the same id.

$coreModules

List of core module classes.


    protected
        array<string|int, mixed>
    $coreModules
     = []

the core module class names

$enabledModules

List of all enabled module ids


    protected
        array<string|int, mixed>
    $enabledModules
     = []

$modules

List of all modules This also contains installed but not enabled modules.


    protected
        array<string|int, mixed>
    $modules
     = []

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.


    public
                    __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

Initializes the object with the given configuration $config.
Call [[init()]].

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters

$name : string: the property name

Return values

mixed —

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.


    public
                    __isset(string $name) : bool

This method will check in the following order and act accordingly:

a property defined by a setter: return whether the property is set
a property of a behavior: return whether the property is set
return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value to be null
a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters

$name : string: the property name

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

behaviors()

Returns a list of behaviors that this component should behave as.


    public
                    behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values

array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canRemoveModule()

Checks if the module can be removed


    public
                    canRemoveModule(string $moduleId) : bool

Parameters

$moduleId : string

Return values

bool

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

disable()

Disables a module


    public
                    disable(Module $module) : mixed

Parameters

$module : Module

disableModules()


    public
                    disableModules([array<string|int, mixed> $modules = [] ]) : mixed

Parameters

$modules : array<string|int, mixed> = []

enable()

Enables a module


    public
                    enable(Module $module) : mixed

Parameters

$module : Module

enableModules()


    public
                    enableModules([mixed $modules = [] ]) : mixed

Parameters

$modules : mixed = []

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.


    public
                    ensureBehaviors() : mixed

filterModules()

Filter modules by keyword and by additional filters from module event


    public
                    filterModules(array<string|int, Module>|null $modules[, array<string|int, mixed>|ArrayAccess $filters = [] ]) : array<string|int, Module>

Parameters

$modules : array<string|int, Module>|null
$filters : array<string|int, mixed>|ArrayAccess = []: = ['keyword' => 'search term']

Return values

array<string|int, Module>

filterModulesByKeyword()

Filter modules by keyword


    public
                    filterModulesByKeyword(array<string|int, Module>|null $modules[, null|string $keyword = null ]) : array<string|int, Module>

Parameters

$modules : array<string|int, Module>|null: list of modules, defaulting to installed non-core modules
$keyword : null|string = null

Return values

array<string|int, Module>

flushCache()

Flushes module manager cache


    public
                    flushCache() : mixed

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getEnabledModules()

Returns all enabled modules and supportes further options as [[getModules()]].


    public
                    getEnabledModules([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

Parameters

$options : array<string|int, mixed> = []

Return values

array<string|int, mixed>

getModule()

Returns a module instance by id


    public
                    getModule(string $id[, bool $throwOnMissingModule = true ]) : Module|object|null

Parameters

$id : string: Module Id
$throwOnMissingModule : bool = true: true - to throw exception, false - to return null

Return values

Module|object|null

getModules()

Returns all modules (also disabled modules).


    public
                    getModules([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

Note: Only modules which extends \humhub\components\Module will be returned.

Parameters

$options : array<string|int, mixed> = []

options (name => config) The following options are available:

includeCoreModules: boolean, return also core modules (default: false)
returnClass: boolean, return classname instead of module object (default: false)
enabled: boolean, returns only enabled modules (core modules only when combined with includeCoreModules)

Return values

array<string|int, mixed>

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

the class has a method with the specified name
an attached behavior has a method with the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasModule()

Checks if a moduleId exists, regardless it's enabled or not


    public
                    hasModule(string $id) : bool

Parameters

$id : string

Return values

bool

hasProperty()

Returns a value indicating whether a property is defined for this component.


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Module Manager init


    public
                    init() : mixed

Loads all enabled moduleId's from database

isCoreModule()

Returns weather or not the given module id belongs to an core module.


    public
                    isCoreModule(mixed $id) : bool

Parameters

$id : mixed

Return values

bool

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].
$append : bool = true: whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

register()

Registers a module


    public
                    register(string $basePath[, array<string|int, mixed>|null $config = null ]) : mixed

Parameters

$basePath : string: the module's base path
$config : array<string|int, mixed>|null = null: the module configuration (config.php)

registerBulk()

Registers a module to the manager This is usually done by config.php in modules root folder.


    public
                    registerBulk(array<string|int, mixed> $configs) : mixed

Parameters

$configs : array<string|int, mixed>

removeModule()

Removes a module


    public
                    removeModule(string $moduleId[, bool $disableBeforeRemove = true ]) : string|null

Parameters

$moduleId : string
$disableBeforeRemove : bool = true

Return values

string|null

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

registerEventHandlers()


    protected
                    registerEventHandlers(string $basePath, array<string|int, mixed> &$config) : void

Parameters

$basePath : string
$config : array<string|int, mixed>

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

checkRequirements()

Check module requirements


    private
                    checkRequirements(Module $module) : mixed

Parameters

$module : Module

ModuleManager extends Component in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

EVENT_AFTER_FILTER_MODULES

Tags

EVENT_AFTER_MODULE_DISABLE

Tags

EVENT_AFTER_MODULE_ENABLE

Tags

EVENT_BEFORE_MODULE_DISABLE

Tags

EVENT_BEFORE_MODULE_ENABLE

Tags

Properties

$behaviors read-only

$createBackup

$overwriteModuleBasePath

$preventDuplicatedModules

$coreModules

$enabledModules

$modules

$_behaviors

$_events

$_eventWildcards

Tags

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

behaviors()

Return values

canGetProperty()

Parameters

Tags

Return values

canRemoveModule()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

ModuleManager extends Component
in package

Application