UserPanel

Type

Class

Namespace

craft\debug

Inherits

craft\debug\UserPanel » yii\debug\panels\UserPanel (opens new window) » yii\debug\Panel (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)

Implements

yii\base\Configurable (opens new window)

Since

3.0.0

Debugger panel that collects and displays user info.

.

View source (opens new window)

Public Properties

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

Protected Properties

Property	Description
error (opens new window)	yii\debug\FlattenException (opens new window), null (opens new window) – Error while saving the panel

Public Methods

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

save()

Saves data to be later used in debugger detail view.

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

View source (opens new window)

Returns

mixed – Data to be saved

Protected Methods

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