1. Documentation
  2. API
  3. Backend
  4. Controllers
  5. Users

Backend\Controllers\Users

Overview

Users controller for backend users

Extends

Public Properties

public array $implement

Extensions implemented by this controller.

public array $formConfig

FormController configuration.

public array $listConfig

ListController configuration.

public array $requiredPermissions

Permissions required to view this page.

public string $bodyClass

HTML body tag class

public string $settingsItemCode

settingsItemCode determines the settings code

Show inherited public properties

Inherited Public Properties

Protected Properties

There are no protected properties in the class.

Show inherited protected properties

Inherited Protected Properties

Public Methods

public __construct()

public __construct(): void

public formBeforeCreate()

public formBeforeCreate($model): void

public formBeforeSave()

public formBeforeSave($model): void

public formExtendFields()

public formExtendFields($form): void

formExtendFields adds available permission fields to the User form. Mark default groups as checked for new Users.

public formExtendModel()

public formExtendModel($model): void

public formExtendQuery()

public formExtendQuery($query): void

formExtendQuery extends the form query to prevent non-superusers from accessing superusers at all

public listExtendQuery()

public listExtendQuery($query): void

listExtendQuery extends the list query to hide superusers if the current user is not a superuser themselves

public listFilterExtendScopes()

public listFilterExtendScopes($filterWidget): void

listFilterExtendScopes prevents non-superusers from even seeing the is_superuser filter

public listInjectRowClass()

public listInjectRowClass($record, $definition = null): void

listInjectRowClass strikes out deleted records

public myaccount()

public myaccount(): void

myaccount controller

public myaccount_onSave()

public myaccount_onSave(): void

myaccount_onSave proxies the update onSave event

public update()

public update($recordId, $context = null): void

update controller

public update_onRestore()

public update_onRestore($recordId): void

update_onRestore handles restoring users

Show inherited public methods

Inherited Public Methods

Protected Methods

protected applyRankPermissionsToQuery()

protected applyRankPermissionsToQuery($query): void

protected getRankedRoleOptions()

protected getRankedRoleOptions(): void

getRoleOptions returns available role options

Show inherited protected methods

Inherited Protected Methods