Class humhub\modules\admin\components\Controller

Inheritancehumhub\modules\admin\components\Controller » humhub\components\Controller » yii\web\Controller
Subclasseshumhub\modules\activity\controllers\AdminController, humhub\modules\admin\controllers\ApprovalController, humhub\modules\admin\controllers\AuthenticationController, humhub\modules\admin\controllers\GroupController, humhub\modules\admin\controllers\IndexController, humhub\modules\admin\controllers\InformationController, humhub\modules\admin\controllers\LoggingController, humhub\modules\admin\controllers\ModuleController, humhub\modules\admin\controllers\PendingRegistrationsController, humhub\modules\admin\controllers\SettingController, humhub\modules\admin\controllers\SpaceController, humhub\modules\admin\controllers\UserController, humhub\modules\admin\controllers\UserProfileController, humhub\modules\ldap\controllers\AdminController, humhub\modules\marketplace\controllers\BrowseController, humhub\modules\marketplace\controllers\LicenceController, humhub\modules\marketplace\controllers\PurchaseController, humhub\modules\marketplace\controllers\UpdateController, humhub\modules\notification\controllers\AdminController

Base controller for administration section

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\components\Controller
$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
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\components\Controller
htmlRedirect() Create Redirect for AJAX Requests which output goes into HTML content. humhub\components\Controller
init() humhub\modules\admin\components\Controller
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 true
$loggedInOnly public property
public $loggedInOnly true
$subLayout public property

The name of the sub layout to be applied to this controller's views. This property mainly affects the behavior of \humhub\modules\admin\components\render().

public null|string $subLayout "@humhub/modules/admin/views/layouts/main"

Method Details

behaviors() public method

public void behaviors ( )
getAccessRules() public method

Returns access rules for the standard access control behavior

See also humhub\components\behaviors\AccessControl.

public array getAccessRules ( )
return array

The access permissions

init() public method

public void init ( )