PHP Class yii\debug\Panel

Since: 2.0
Author: Qiang Xue ([email protected])
Inheritance: extends yii\base\Component
Datei anzeigen Open project: yiisoft/yii2-debug Class Usage Examples

Public Properties

Property Type Description
$actions 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 data associated with panel
$id panel unique identifier. It is set automatically by the container module.
$module Module
$tag request data set identifier.

Public Methods

Method Description
getDetail ( ) : string
getName ( ) : string
getSummary ( ) : string
getTraceLine ( array $options ) : string Returns a trace line
getUrl ( null | array $additionalParams = null ) : string
load ( mixed $data ) Loads data into the panel
save ( ) : mixed Saves data to be later used in debugger detail view.

Method Details

getDetail() public method

public getDetail ( ) : string
return string content that is displayed in debugger detail view

getName() public method

public getName ( ) : string
return string name of the panel

getSummary() public method

public getSummary ( ) : string
return string content that is displayed at debug toolbar

getTraceLine() public method

Returns a trace line
Since: 2.0.7
public getTraceLine ( array $options ) : string
$options array The array with trace
return string the trace line

getUrl() public method

public getUrl ( null | array $additionalParams = null ) : string
$additionalParams null | array Optional additional parameters to add to the route
return string URL pointing to panel detail view

load() public method

Loads data into the panel
public load ( mixed $data )
$data mixed

save() public method

This method is called on every page where debugger is enabled.
public save ( ) : mixed
return mixed data to be saved

Property Details

$actions public_oe property

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.
public $actions

$data public_oe property

data associated with panel
public $data

$id public_oe property

panel unique identifier. It is set automatically by the container module.
public $id

$module public_oe property

public Module,yii\debug $module
return Module

$tag public_oe property

request data set identifier.
public $tag