Class humhub\modules\space\Module

Inheritancehumhub\modules\space\Module » humhub\components\Module » yii\base\Module
Available since version0.5

SpaceModule provides all space related classes & functions.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$controllerNamespace humhub\modules\space\Module
$disableFollow boolean Defines if the space following is disabled or not. humhub\modules\space\Module
$globalAdminCanAccessPrivateContent boolean Allow global admins (super admin) access to private content also when no member humhub\modules\space\Module
$maximumSpaceUrlLength integer Maximum space url length humhub\modules\space\Module
$minimumSpaceUrlLength integer Minimum space url length humhub\modules\space\Module
$resourcesPath string The path for module resources (images, javascripts) Also module related assets like README. humhub\components\Module
$useUniqueSpaceNames boolean Do not allow multiple spaces with the same name humhub\modules\space\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() humhub\modules\space\Module
getNotifications() Returns a list of notification classes this module provides. humhub\modules\space\Module
getPermissions() Returns a list of permission objects this module provides. humhub\modules\space\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

$controllerNamespace public property
public $controllerNamespace 'humhub\modules\space\controllers'
$disableFollow public property (available since version 1.2)

Defines if the space following is disabled or not.

public boolean $disableFollow false
$globalAdminCanAccessPrivateContent public property

Allow global admins (super admin) access to private content also when no member

$maximumSpaceUrlLength public property (available since version 1.3)

Maximum space url length

$minimumSpaceUrlLength public property (available since version 1.3)

Minimum space url length

$useUniqueSpaceNames public property

Do not allow multiple spaces with the same name

Method Details

getName() public method

public void getName ( )
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