Class humhub\modules\comment\Module
| Inheritance | humhub\modules\comment\Module » humhub\components\Module » yii\base\Module |
|---|---|
| Available since version | 0.5 |
CommentModule adds the comment content addon functionalities.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $commentsBlockLoadSize | integer | humhub\modules\comment\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 |
| canComment() | Checks if given content object can be commented | humhub\modules\comment\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\modules\comment\Module |
| getNotifications() | Returns a list of notification classes this module provides. | humhub\modules\comment\Module |
| getPermissions() | Returns a list of permission objects this module provides. | humhub\modules\comment\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 |
Property Details
Method Details
Checks if given content object can be commented
| public boolean canComment ( humhub\modules\content\models\Content $content ) | ||
| $content | humhub\modules\content\models\Content | |
| return | boolean | Can comment |
|---|---|---|
Returns modules name provided by module.json file
| public string getName ( ) | ||
| return | string | Name |
|---|---|---|
Returns a list of notification classes this module provides.
| public array getNotifications ( ) | ||
| return | array | List of notification classes |
|---|---|---|
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 |
|---|---|---|