Class yii\debug\panels\UserPanel
| 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
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $error | yii\debug\FlattenException|null | Error while saving the panel | yii\debug\Panel |
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\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
| 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
Display Name of the debug panel.
Allowed columns for GridView.
See also http://www.yiiframework.com/doc-2.0/yii-grid-gridview.html#$columns-detail.
Implements of User model with search method.
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.
ID of the user component or a user object
Object of switching users
Method Details
Check is available search of users
| public boolean canSearchUsers ( ) |
Check can main user switch identity.
| public boolean canSwitchUser ( ) | ||
| throws | yii\base\InvalidConfigException | |
|---|---|---|
Converts mixed data to string
| protected string dataToString ( $data ) | ||
| $data | mixed | |
| public string getDetail ( ) | ||
| return | string | Content that is displayed in debugger detail view |
|---|---|---|
| public string getName ( ) | ||
| return | string | Name of the panel |
|---|---|---|
| public string getSummary ( ) | ||
| return | string | Content that is displayed at debug toolbar |
|---|---|---|
| public yii\web\User|null getUser ( ) | ||
| throws | yii\base\InvalidConfigException | |
|---|---|---|
Get model for GridView -> DataProvider
| public yii\data\DataProviderInterface getUserDataProvider ( ) |
Get model for GridView -> FilterModel
| public yii\base\Model|yii\debug\models\search\UserSearchInterface getUsersFilterModel ( ) |
Returns the array that should be set on yii\widgets\DetailView::$model
| protected array identityData ( $identity ) | ||
| $identity | yii\web\IdentityInterface | |
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 | |
|---|---|---|
Checks whether this panel is enabled.
| public boolean isEnabled ( ) | ||
| return | boolean | Whether this panel is enabled. |
|---|---|---|
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 |
|---|---|---|