Class humhub\modules\activity\Module

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

Activity BaseModule

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$resourcesPath humhub\modules\activity\Module
$weeklySummaryDay integer Day to send weekly summaries on daily cron run (0 = Sunday, 6 = Saturday) humhub\modules\activity\Module

Public Methods

Hide inherited methods

MethodDescriptionDefined 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
getConfigurableActivities() Returns all configurable Activitiess humhub\modules\activity\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\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

Hide inherited methods

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

Property Details

$resourcesPath public property
public $resourcesPath 'resources'
$weeklySummaryDay public property

Day to send weekly summaries on daily cron run (0 = Sunday, 6 = Saturday)

Method Details

getConfigurableActivities() public static method (available since version 1.2)

Returns all configurable Activitiess

public static humhub\modules\activity\interfaces\ConfigurableActivityInterface[] getConfigurableActivities ( )
return humhub\modules\activity\interfaces\ConfigurableActivityInterface[]

A list of configurable activities