Docs4dev
Docs
yii / 2.0 / yii-debug-panels-userpanel.html

Class yii\debug\panels\UserPanel

All Classes | Properties | Methods
Inheritance yii\debug\panels\UserPanel » yii\debug\Panel » yii\base\Component » yii\base\Object
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

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 yii\base\Component
$data mixed Data associated with panel yii\debug\Panel
$detail string Content that is displayed in debugger detail view 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 yii\debug\panels\UserPanel
$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 yii\debug\panels\UserPanel
$tag string Request data set identifier. yii\debug\Panel
$url string URL pointing to panel detail view yii\debug\Panel
$userDataProvider yii\data\DataProviderInterface 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 yii\debug\panels\UserPanel

Public 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\Object
__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\Object
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
getName() yii\debug\panels\UserPanel
getSummary() yii\debug\panels\UserPanel
getTraceLine() Returns a trace line yii\debug\Panel
getUrl() yii\debug\Panel
getUserDataProvider() Get model for GridView -> DataProvider yii\debug\panels\UserPanel
getUsersFilterModel() Get model for GridView -> FilterModel yii\debug\panels\UserPanel
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
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
trigger() Triggers an event. yii\base\Component

Protected Methods

Method Description Defined By
dataToString() Converts mixed data to string yii\debug\panels\UserPanel
identityData() Returns the array that should be set on yii\widgets\DetailView::$model yii\debug\panels\UserPanel

Property Details

$detail public read-only property

Content that is displayed in debugger detail view

public string getDetail ( )

$filterColumns public property (available since version 2.0.10)

Allowed columns for GridView.

See also http://www.yiiframework.com/doc-2.0/yii-grid-gridview.html#$columns-detail.

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

$name public read-only property

Name of the panel

public string getName ( )

$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']]

See also http://www.yiiframework.com/doc-2.0/guide-security-authorization.html.

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

$summary public read-only property

Content that is displayed at debug toolbar

public string getSummary ( )

$userDataProvider public read-only property 

public yii\data\DataProviderInterface getUserDataProvider ( )

$userSwitch public property (available since version 2.0.10)

Object of switching users

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

$usersFilterModel public read-only property 

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

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 ( )

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

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 mixed

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 ( )

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

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-debug-panels-userpanel.html