Class humhub\modules\installer\Module

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

InstallerModule provides an web installation interface for the applcation

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$configSteps array humhub\modules\installer\Module
$controllerNamespace humhub\modules\installer\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
afterUpdate() Called right after the module update. humhub\components\Module
beforeAction() humhub\modules\installer\Module
beforeUpdate() Called right before the module is updated. humhub\components\Module
checkDBConnection() Checks if database connections works humhub\modules\installer\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 /module_image.png humhub\components\Module
getName() Returns modules name provided by module.json file humhub\components\Module
getNextConfigStepUrl() Get Next Step humhub\modules\installer\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\modules\installer\Module
isConfigured() Checks if the application is already configured. humhub\modules\installer\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
setDatabaseInstalled() Sets application database in installed state humhub\modules\installer\Module
setInstalled() Sets application in installed state (disables installer) humhub\modules\installer\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
initConfigSteps() humhub\modules\installer\Module
sortConfigSteps() Sorts all configSteps on sort attribute humhub\modules\installer\Module

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_INIT_CONFIG_STEPS \humhub\modules\installer\on Configuration steps init humhub\modules\installer\Module

Property Details

$configSteps public property
public array $configSteps = []
$controllerNamespace public property
public $controllerNamespace 'humhub\modules\installer\controllers'

Method Details

beforeAction() public method

public void beforeAction ( $action )
$action
checkDBConnection() public method

Checks if database connections works

public boolean checkDBConnection ( )
return boolean

State of database connection

getNextConfigStepUrl() public method

Get Next Step

public void getNextConfigStepUrl ( )
init() public method

public void init ( )
initConfigSteps() protected method

protected void initConfigSteps ( )
isConfigured() public method

Checks if the application is already configured.

public void isConfigured ( )
setDatabaseInstalled() public method

Sets application database in installed state

public void setDatabaseInstalled ( )
setInstalled() public method

Sets application in installed state (disables installer)

public void setInstalled ( )
sortConfigSteps() protected method

Sorts all configSteps on sort attribute

protected void sortConfigSteps ( )

Event Details

EVENT_INIT_CONFIG_STEPS event of type \humhub\modules\installer\on

Configuration steps init