Class humhub\modules\admin\Module

Inheritancehumhub\modules\admin\Module » humhub\components\Module » yii\base\Module

Admin Module

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$allowUserImpersonate boolean Allow admins to impersonate other users humhub\modules\admin\Module
$controllerNamespace humhub\modules\admin\Module
$dailyCheckForNewVersion boolean Check daily for new HumHub version humhub\modules\admin\Module
$defaultReloadableScripts array List of script urls which should not be cached on the client side humhub\modules\admin\Module
$defaultRoute humhub\modules\admin\Module
$isCoreModule humhub\modules\admin\Module
$resourcesPath string The path for module resources (images, javascripts) Also module related assets like README. humhub\modules\admin\Module
$showDashboardIncompleteSetupWarning boolean Show incomplete setup warning on the dashboard for admins humhub\modules\admin\Module

Public Methods

Hide inherited methods

MethodDescriptionDefined By
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 /module_image.png humhub\components\Module
getName() Returns modules name provided by module.json file humhub\modules\admin\Module
getNotifications() Returns a list of notification classes this module provides. humhub\modules\admin\Module
getPermissions() Returns a list of permission objects this module provides. humhub\modules\admin\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

Hide inherited methods

MethodDescriptionDefined By
getModuleInfo() Reads module.json which contains basic module information and returns it as array humhub\components\Module

Property Details

$allowUserImpersonate public property

Allow admins to impersonate other users

$controllerNamespace public property
public $controllerNamespace 'humhub\modules\admin\controllers'
$dailyCheckForNewVersion public property

Check daily for new HumHub version

$defaultReloadableScripts public property (available since version 1.4)

List of script urls which should not be cached on the client side

public array $defaultReloadableScripts = ['https://platform.twitter.com/widgets.js']
$defaultRoute public property
public $defaultRoute 'index'
$isCoreModule public property
public $isCoreModule true
$resourcesPath public property

The path for module resources (images, javascripts) Also module related assets like README.md and module_image.png should be placed here.

public string $resourcesPath 'resources'
$showDashboardIncompleteSetupWarning public property (available since version 1.3.2)

Show incomplete setup warning on the dashboard for admins

Method Details

getName() public method

Returns modules name provided by module.json file

public string getName ( )
return string

Name

getNotifications() public method

Returns a list of notification classes this module provides.

public array getNotifications ( )
return array

List of notification classes

getPermissions() public method

Returns a list of permission objects this module provides.

If a content container is provided, the method should only return applicable permissions for the given container. This function should also make sure the module is installed on the given container in case the permission only affects installed features.

public array getPermissions ( $contentContainer null )
$contentContainer humhub\modules\content\components\ContentContainerActiveRecord

Optional contentcontainer

return array

List of permissions