Class humhub\modules\admin\controllers\ModuleController

Inheritancehumhub\modules\admin\controllers\ModuleController » humhub\modules\admin\components\Controller » humhub\components\Controller » yii\web\Controller
Available since version0.5

Module Controller controls all third party modules in a humhub installation.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$actionTitlesMap array Page titles humhub\components\Controller
$adminOnly boolean If true only allows access for system admins else the access is restricted by getAccessRules() humhub\modules\admin\controllers\ModuleController
$loggedInOnly humhub\modules\admin\components\Controller
$pageTitle string Title of the rendered page humhub\components\Controller
$prependActionTitles boolean Append page title humhub\components\Controller
$subLayout null|string The name of the sub layout to be applied to this controller's views. humhub\modules\admin\components\Controller

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$access string Defines the ControllerAccess class for this controller responsible for managing access rules humhub\components\Controller

Public Methods

Hide inherited methods

MethodDescriptionDefined By
actionDisable() Disables a module humhub\modules\admin\controllers\ModuleController
actionEnable() Enables a module humhub\modules\admin\controllers\ModuleController
actionFlush() Flushes the assets for a given module humhub\modules\admin\controllers\ModuleController
actionIndex() humhub\modules\admin\controllers\ModuleController
actionInfo() Returns more information about an installed module. humhub\modules\admin\controllers\ModuleController
actionList() humhub\modules\admin\controllers\ModuleController
actionRemove() Removes a module humhub\modules\admin\controllers\ModuleController
actionSetAsDefault() Sets default enabled/disabled on User or/and Space Modules humhub\modules\admin\controllers\ModuleController
appendPageTitle() Append a page title. humhub\components\Controller
beforeAction() humhub\components\Controller
behaviors() humhub\modules\admin\components\Controller
forcePostRequest() Throws HttpException in case the request is not an post request, otherwise returns true. humhub\components\Controller
getAccess() humhub\components\Controller
getAccessRules() Returns access rules for the standard access control behavior humhub\modules\admin\controllers\ModuleController
htmlRedirect() Create Redirect for AJAX Requests which output goes into HTML content. humhub\components\Controller
init() humhub\modules\admin\controllers\ModuleController
prependPageTitle() Prepend a page title. humhub\components\Controller
redirect() humhub\components\Controller
renderAjaxContent() humhub\components\Controller
renderContent() Renders a static string by applying the layouts (sublayout + layout. humhub\components\Controller
renderModalClose() Closes a modal humhub\components\Controller
setActionTitles() Set a map that indicates what page title should be shown for the currently active action. humhub\components\Controller
setJsViewStatus() Sets some ui state as current controller/module and active topmenu. humhub\components\Controller
setPageTitle() Set the page title. humhub\components\Controller

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
forbidden() humhub\components\Controller

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_INIT \yii\base\Event An event raised on init a controller. humhub\components\Controller

Property Details

$adminOnly public property

If true only allows access for system admins else the access is restricted by getAccessRules()

public boolean $adminOnly false

Method Details

actionDisable() public method

Disables a module

public void actionDisable ( )
throws \yii\web\HttpException
actionEnable() public method

Enables a module

public void actionEnable ( )
throws \yii\web\HttpException
actionFlush() public method

Flushes the assets for a given module

public void actionFlush ( )
actionIndex() public method

public void actionIndex ( )
actionInfo() public method

Returns more information about an installed module.

public string actionInfo ( )
throws \yii\web\HttpException
actionList() public method

public void actionList ( )
actionRemove() public method

Removes a module

public void actionRemove ( )
throws \yii\web\HttpException
actionSetAsDefault() public method

Sets default enabled/disabled on User or/and Space Modules

public void actionSetAsDefault ( )
throws \yii\web\HttpException
getAccessRules() public method

Returns access rules for the standard access control behavior

public array getAccessRules ( )
return array

The access permissions

init() public method

public void init ( )