CommercePanel

Type

Class

Namespace

craft\commerce\debug

Inherits

craft\commerce\debug\CommercePanel » yii\debug\Panel » yii\base\Component » yii\base\BaseObject

Implements

yii\base\Configurable

Since

3.0.0

Debugger panel that collects and displays Commerce information.

View source

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.
cart	craft\commerce\elements\Order, null
data	mixed – Data associated with panel
detail	string – Content that is displayed in debugger detail view.
id	string – Panel unique identifier.
module	yii\debug\Module
name	string – Name of the panel.
summary	string – Content that is displayed at debug toolbar.
tag	string – Request data set identifier.
url	string – URL pointing to panel detail view.

cart

Type

craft\commerce\elements\Order, null

Default value

null

View source

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.
canSetProperty()	Returns a value indicating whether a property can be set.
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()
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.

getDetail()

View source

Returns

string – Content that is displayed in debugger detail view

getName()

View source

Returns

string – Name of the panel

getSummary()

View source

Returns

string – Content that is displayed at debug toolbar

save()

Saves data to be later used in debugger detail view.

This method is called on every page where debugger is enabled.

View source

Returns

mixed – Data to be saved

Protected Methods

Method	Description
getLogMessages()	Gets messages from log target and filters according to their categories and levels.

Events

EVENT_AFTER_DATA_PREPARE

Type

yii\base\Event

The event that is triggered after the data for the panel is prepared.

use craft\commerce\debug\CommercePanel;
use craft\commerce\events\CommerceDebugPanelDataEvent;
use yii\base\Event;

Event::on(
    CommercePanel::class,
    CommercePanel::EVENT_AFTER_DATA_PREPARE,
    function(CommerceDebugPanelDataEvent $event) {
        $event->nav[] = 'Foo';
        $event->content[] = '<strong>Bar</strong>';
    }
);

---