Class yii\debug\panels\UserPanel

All Classes | Properties | Methods

Inheritance	yii\debug\panels\UserPanel » yii\debug\Panel » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable
Available since version	2.0.8
Source Code	https://github.com/yiisoft/yii2-debug/blob/master/panels/UserPanel.php

Debugger panel that collects and displays user data.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$actions	array	Array of actions to add to the debug modules default controller.	yii\debug\Panel
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component. This property is read-only.	yii\base\Component
$data	mixed	Data associated with panel	yii\debug\Panel
$detail	string	Content that is displayed in debugger detail view. This property is read-only.	yii\debug\Panel
$displayName	string	Display Name of the debug panel.	yii\debug\panels\UserPanel
$filterColumns	array	Allowed columns for GridView.	yii\debug\panels\UserPanel
$filterModel	yii\base\Model\|yii\debug\models\search\UserSearchInterface	Implements of User model with search method.	yii\debug\panels\UserPanel
$id	string	Panel unique identifier.	yii\debug\Panel
$module	yii\debug\Module		yii\debug\Panel
$name	string	Name of the panel. This property is read-only.	yii\debug\Panel
$ruleUserSwitch	array	The rule which defines who allowed to switch user identity.	yii\debug\panels\UserPanel
$summary	string	Content that is displayed at debug toolbar. This property is read-only.	yii\debug\Panel
$tag	string	Request data set identifier.	yii\debug\Panel
$url	string	URL pointing to panel detail view. This property is read-only.	yii\debug\Panel
$user	yii\web\User\|null		yii\debug\panels\UserPanel
$userComponent	string\|yii\web\User	ID of the user component or a user object	yii\debug\panels\UserPanel
$userDataProvider	yii\data\DataProviderInterface	This property is read-only.	yii\debug\panels\UserPanel
$userSwitch	yii\debug\models\UserSwitch	Object of switching users	yii\debug\panels\UserPanel
$usersFilterModel	yii\base\Model\|yii\debug\models\search\UserSearchInterface	This property is read-only.	yii\debug\panels\UserPanel

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
$error	yii\debug\FlattenException\|null	Error while saving the panel	yii\debug\Panel

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSearchUsers()	Check is available search of users	yii\debug\panels\UserPanel
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
canSwitchUser()	Check can main user switch identity.	yii\debug\panels\UserPanel
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getDetail()		yii\debug\panels\UserPanel
getError()		yii\debug\Panel
getName()		yii\debug\panels\UserPanel
getSummary()		yii\debug\panels\UserPanel
getTraceLine()	Returns a trace line	yii\debug\Panel
getUrl()		yii\debug\Panel
getUser()		yii\debug\panels\UserPanel
getUserDataProvider()	Get model for GridView -> DataProvider	yii\debug\panels\UserPanel
getUsersFilterModel()	Get model for GridView -> FilterModel	yii\debug\panels\UserPanel
hasError()		yii\debug\Panel
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the object.	yii\debug\panels\UserPanel
isEnabled()	Checks whether this panel is enabled.	yii\debug\panels\UserPanel
load()	Loads data into the panel	yii\debug\Panel
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
save()	Saves data to be later used in debugger detail view.	yii\debug\panels\UserPanel
setError()		yii\debug\Panel
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
dataToString()	Converts mixed data to string	yii\debug\panels\UserPanel
getLogMessages()	Gets messages from log target and filters according to their categories and levels.	yii\debug\Panel
identityData()	Returns the array that should be set on yii\widgets\DetailView::$model	yii\debug\panels\UserPanel

Property Details

$displayName public property (available since version 2.1.4)

Display Name of the debug panel.

public string $displayName = 'User'

$filterColumns public property (available since version 2.0.10)

Allowed columns for GridView.

public array $filterColumns = []

$filterModel public property (available since version 2.0.10)

Implements of User model with search method.

public yii\base\Model|yii\debug\models\search\UserSearchInterface $filterModel = null

$ruleUserSwitch public property (available since version 2.0.10)

The rule which defines who allowed to switch user identity. Access Control Filter single rule. Ignore: actions, controllers, verbs. Settable: allow, roles, ips, matchCallback, denyCallback. By default deny for everyone. Recommendation: can allow for administrator or developer (if implement) role: ['allow' => true, 'roles' => ['admin']]

public array $ruleUserSwitch = ['allow' => false]

$user public read-only property (available since version 2.0.13)

public yii\web\User|null getUser ( )

$userComponent public property (available since version 2.0.13)

ID of the user component or a user object

public string|yii\web\User $userComponent = 'user'

$userDataProvider public property

This property is read-only.

public yii\data\DataProviderInterface $userDataProvider = null

$userSwitch public property (available since version 2.0.10)

Object of switching users

public yii\debug\models\UserSwitch $userSwitch = null

$usersFilterModel public property

This property is read-only.

public yii\base\Model|yii\debug\models\search\UserSearchInterface $usersFilterModel = null

Method Details

canSearchUsers() public method

Check is available search of users

public boolean canSearchUsers ( )

canSwitchUser() public method

Check can main user switch identity.

public boolean canSwitchUser ( )
throws	yii\base\InvalidConfigException

dataToString() protected method

Converts mixed data to string

protected string dataToString ( $data )
$data	mixed

getDetail() public method

public string getDetail ( )
return	string	Content that is displayed in debugger detail view

getName() public method

public string getName ( )
return	string	Name of the panel

getSummary() public method

public string getSummary ( )
return	string	Content that is displayed at debug toolbar

getUser() public method (available since version 2.0.13)

public yii\web\User\|null getUser ( )
throws	yii\base\InvalidConfigException

getUserDataProvider() public method

Get model for GridView -> DataProvider

public yii\data\DataProviderInterface getUserDataProvider ( )

getUsersFilterModel() public method

Get model for GridView -> FilterModel

public yii\base\Model\|yii\debug\models\search\UserSearchInterface getUsersFilterModel ( )

identityData() protected method

Returns the array that should be set on yii\widgets\DetailView::$model

protected array identityData ( $identity )
$identity	yii\web\IdentityInterface

init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )
throws	yii\base\InvalidConfigException

isEnabled() public method (available since version 2.0.10)

Checks whether this panel is enabled.

public boolean isEnabled ( )
return	boolean	Whether this panel is enabled.

save() public method

Saves data to be later used in debugger detail view.

This method is called on every page where debugger is enabled.

public mixed save ( )
return	mixed	Data to be saved