UserPanel ​
- Type
- Class
- Namespace
- craft\debug
- Inherits
- craft\debug\UserPanel » yii\debug\panels\UserPanel » yii\debug\Panel » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.0.0
Debugger panel that collects and displays user info.
.
Public Properties ​
| Property | Description |
|---|---|
| actions | array – Array of actions to add to the debug modules default controller. |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| data | mixed – Data associated with panel |
| detail | string – Content that is displayed in debugger detail view. |
| displayName | string – Display Name of the debug panel. |
| filterColumns | array – Allowed columns for GridView. |
| filterModel | yii\base\Model, yii\debug\models\search\UserSearchInterface – Implements of User model with search method. |
| id | string – Panel unique identifier. |
| module | yii\debug\Module |
| name | string – Name of the panel. |
| ruleUserSwitch | array – The rule which defines who allowed to switch user identity. |
| summary | string – Content that is displayed at debug toolbar. |
| tag | string – Request data set identifier. |
| url | string – URL pointing to panel detail view. |
| user | yii\web\User, null |
| userComponent | string, yii\web\User – ID of the user component or a user object |
| userDataProvider | yii\data\DataProviderInterface |
| userSwitch | yii\debug\models\UserSwitch – Object of switching users |
| usersFilterModel | yii\base\Model, yii\debug\models\search\UserSearchInterface |
Protected Properties ​
| Property | Description |
|---|---|
| error | yii\debug\FlattenException, null – Error while saving the panel |
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() | Sets a component property to be null. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSearchUsers() | Check is available search of users |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| canSwitchUser() | Check can main user switch identity. |
| className() | Returns the fully qualified name of this class. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getDetail() | |
| getError() | |
| getName() | |
| getSummary() | |
| getTraceLine() | Returns a trace line |
| getUrl() | |
| getUser() | |
| getUserDataProvider() | Get model for GridView -> DataProvider |
| getUsersFilterModel() | Get model for GridView -> FilterModel |
| hasError() | |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| isEnabled() | Checks whether this panel is enabled. |
| load() | Loads data into the panel |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| save() | Saves data to be later used in debugger detail view. |
| setError() | |
| trigger() | 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.
Returns ​
mixed – Data to be saved
Protected Methods ​
| Method | Description |
|---|---|
| dataToString() | Converts mixed data to string |
| getLogMessages() | Gets messages from log target and filters according to their categories and levels. |
| identityData() | Returns the array that should be set on yii\widgets\DetailView::$model |