Class humhub\modules\marketplace\Module

Inheritancehumhub\modules\marketplace\Module » humhub\components\Module » yii\base\Module
Available since version1.4

The Marketplace modules contains all the capabilities to interact with the offical HumHub marketplace.

The core functions are the ability to easily install or update modules from the remote module directory.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$controllerNamespace humhub\modules\marketplace\Module
$enabled boolean humhub\modules\marketplace\Module
$isCoreModule humhub\modules\marketplace\Module
$modulesPath string Path to store marketplace modules If the param 'moduleMarketplacePath' is set this value will be used. humhub\modules\marketplace\Module
$resourcesPath string The path for module resources (images, javascripts) Also module related assets like README. humhub\components\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
getLicence() humhub\modules\marketplace\Module
getName() Returns modules name provided by module.json file humhub\modules\marketplace\Module
getNotifications() Returns a list of notification classes this module provides. humhub\components\Module
getOnlineModuleManager() humhub\modules\marketplace\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\modules\marketplace\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\marketplace\controllers'
$enabled public property
public boolean $enabled true
$isCoreModule public property
public $isCoreModule true
$modulesPath public property

Path to store marketplace modules If the param 'moduleMarketplacePath' is set this value will be used.

public string $modulesPath '@app/modules'

Method Details

getLicence() public method

public humhub\modules\marketplace\models\Licence getLicence ( )
getName() public method

Returns modules name provided by module.json file

public string getName ( )
return string

Name

getOnlineModuleManager() public method

public humhub\modules\marketplace\components\OnlineModuleManager getOnlineModuleManager ( )
init() public method

public void init ( )