Class humhub\modules\space\modules\manage\Module
Inheritance | humhub\modules\space\modules\manage\Module » humhub\components\Module » yii\base\Module |
---|---|
Available since version | 0.21 |
Manage module is responsible to managing spaces (Space Admin)
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$controllerNamespace | humhub\modules\space\modules\manage\Module | ||
$resourcesPath | string | The path for module resources (images, javascripts) Also module related assets like README. | humhub\components\Module |
Public Methods
Method | Description | Defined By |
---|---|---|
afterUpdate() | Called right after the module update. | humhub\components\Module |
beforeUpdate() | Called right before the module is updated. | humhub\components\Module |
disable() | Disables a module | humhub\components\Module |
enable() | Enables this module | humhub\components\Module |
getActivityClasses() | Returns a list of activity class names this modules provides. | humhub\components\Module |
getAssetClasses() | Returns a list of asset class names this modules provides. | humhub\components\Module |
getAssetPath() | humhub\components\Module | |
getAssetsUrl() | Get Assets Url | humhub\components\Module |
getConfigUrl() | URL to the module's configuration action | humhub\components\Module |
getDescription() | Returns modules description provided by module.json file | humhub\components\Module |
getImage() | Returns image url for this module
Place your modules image in |
humhub\components\Module |
getName() | Returns modules name provided by module.json file | humhub\components\Module |
getNotifications() | Returns a list of notification classes this module provides. | humhub\components\Module |
getPermissions() | Returns a list of permission objects this module provides. | humhub\components\Module |
getPublishedUrl() | Returns the url of an asset file and publishes all module assets if the file is not published yet. | humhub\components\Module |
getVersion() | Returns modules version number provided by module.json file | humhub\components\Module |
hasNotifications() | Determines whether the module has notification classes or not | humhub\components\Module |
init() | humhub\components\Module | |
isPublished() | Checks if a specific asset file has already been published | humhub\components\Module |
migrate() | Execute all not applied module migrations | humhub\components\Module |
publishAssets() | Publishes the basePath/resourcesPath (assets) module directory if existing. | humhub\components\Module |
update() | This method is called after an update is performed. | humhub\components\Module |
Protected Methods
Method | Description | Defined By |
---|---|---|
getModuleInfo() | Reads module.json which contains basic module information and returns it as array | humhub\components\Module |