yii\debug\panels\DumpPanel - Yii2 类参考手册

Class yii\debug\panels\DumpPanel

Inheritanceyii\debug\panels\DumpPanel » yii\debug\Panel » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.1.0

Dump panel that collects and displays debug messages (Logger::LEVEL_TRACE).

Public Properties

隐藏继承的属性 Hide inherited 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
$categories array The message categories to filter by. yii\debug\panels\DumpPanel
$data mixed Data associated with panel yii\debug\Panel
$depth integer Maximum depth that the dumper should go into the variable yii\debug\panels\DumpPanel
$detail string Content that is displayed in debugger detail view yii\debug\panels\DumpPanel
$highlight boolean Whether the result should be syntax-highlighted yii\debug\panels\DumpPanel
$id string Panel unique identifier. yii\debug\Panel
$module yii\debug\Module yii\debug\Panel
$name string Name of the panel yii\debug\panels\DumpPanel
$summary string Content that is displayed at debug toolbar yii\debug\panels\DumpPanel
$tag string Request data set identifier. yii\debug\Panel
$url string URL pointing to panel detail view yii\debug\Panel
$varDumpCallback callable Callback that replaces the built-in var dumper. yii\debug\panels\DumpPanel

Protected Properties

隐藏继承的属性 Hide inherited properties

属性Property类型 Type简介 Description定义在 Defined By
$error yii\debug\FlattenException|null Error while saving the panel yii\debug\Panel

Public Methods

隐藏继承的方法 Hide inherited 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
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\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\DumpPanel
getError() yii\debug\Panel
getName() yii\debug\panels\DumpPanel
getSummary() yii\debug\panels\DumpPanel
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\BaseObject
isEnabled() Checks whether this panel is 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\panels\DumpPanel
setError() yii\debug\Panel
trigger() Triggers an event. yii\base\Component
varDump() Called by save() to format the dumped variable. yii\debug\panels\DumpPanel

Protected Methods

隐藏继承的方法 Hide inherited methods

方法 Method简介 Description定义在 Defined By
getLogMessages() Gets messages from log target and filters according to their categories and levels. yii\debug\Panel
getModels() Returns an array of models that represents logs of the current request. yii\debug\panels\DumpPanel

属性详情 Property Details

$categories public property

The message categories to filter by. If empty array, it means all categories are allowed

public array $categories = ['application']
$depth public property

Maximum depth that the dumper should go into the variable

public integer $depth 10
$detail public read-only property

Content that is displayed in debugger detail view

public string getDetail ( )
$highlight public property

Whether the result should be syntax-highlighted

public boolean $highlight true
$name public read-only property

Name of the panel

public string getName ( )
$summary public read-only property

Content that is displayed at debug toolbar

public string getSummary ( )
$varDumpCallback public property (available since version 2.1.3)

Callback that replaces the built-in var dumper. The signature of this function should be: function (mixed $data, DumpPanel $panel)

public callable $varDumpCallback null

方法详情 Method Details

getDetail() public method

public string getDetail ( )
return string

Content that is displayed in debugger detail view

getModels() protected method

Returns an array of models that represents logs of the current request.

Can be used with data providers, such as \yii\data\ArrayDataProvider.

protected array getModels ( $refresh false )
$refresh boolean

If need to build models from log messages and refresh them.

return array

Models

getName() public method

public string getName ( )
return string

Name of the panel

getSummary() public method

public string getSummary ( )
return string

Content that is displayed at debug toolbar

save() public method

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

varDump() public method (available since version 2.1.3)

Called by save() to format the dumped variable.

public void varDump ( $var )
$var