Class yii\debug\Panel
Panel is a base class for debugger panel classes. It defines how data should be collected, what should be displayed at debug toolbar and on debugger details view.
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\Panel |
| $id | string | Panel unique identifier. | yii\debug\Panel |
| $module | yii\debug\Module | yii\debug\Panel | |
| $name | string | Name of the panel | yii\debug\Panel |
| $summary | string | Content that is displayed at debug toolbar | yii\debug\Panel |
| $tag | string | Request data set identifier. | yii\debug\Panel |
| $url | string | URL pointing to panel detail view | yii\debug\Panel |
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\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 |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| 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\Panel | |
| getError() | yii\debug\Panel | |
| getName() | yii\debug\Panel | |
| getSummary() | yii\debug\Panel | |
| getTraceLine() | Returns a trace line | yii\debug\Panel |
| getUrl() | yii\debug\Panel | |
| 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\base\Object |
| isEnabled() | Is the panel enabled? | yii\debug\Panel |
| 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\Panel |
| setError() | yii\debug\Panel | |
| trigger() | Triggers an event. | yii\base\Component |
Property Details
Array of actions to add to the debug modules default controller. This array will be merged with all other panels actions property. See yii\base\Controller::actions() for the format.
Data associated with panel
Content that is displayed in debugger detail view
Error while saving the panel
public void setError ( yii\debug\FlattenException $error )
Panel unique identifier. It is set automatically by the container module.
Name of the panel
Content that is displayed at debug toolbar
Request data set identifier.
URL pointing to panel detail view
Method Details
| public string getDetail ( ) | ||
| return | string | Content that is displayed in debugger detail view |
|---|---|---|
| public yii\debug\FlattenException|null getError ( ) |
| public string getName ( ) | ||
| return | string | Name of the panel |
|---|---|---|
| public string getSummary ( ) | ||
| return | string | Content that is displayed at debug toolbar |
|---|---|---|
Returns a trace line
| public string getTraceLine ( $options ) | ||
| $options | array | The array with trace |
| return | string | The trace line |
|---|---|---|
| public string getUrl ( $additionalParams = null ) | ||
| $additionalParams | null|array | Optional additional parameters to add to the route |
| return | string | URL pointing to panel detail view |
|---|---|---|
| public boolean hasError ( ) |
Is the panel enabled?
| public boolean isEnabled ( ) |
Loads data into the panel
| public void load ( $data ) | ||
| $data | mixed | |
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 |
|---|---|---|
| public void setError ( yii\debug\FlattenException $error ) | ||
| $error | yii\debug\FlattenException | |