Class yii\httpclient\debug\HttpClientPanel

Inheritanceyii\httpclient\debug\HttpClientPanel » yii\debug\Panel » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2-httpclient/blob/master/debug/HttpClientPanel.php

Debugger panel that collects and displays HTTP requests performed.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined 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\httpclient\debug\HttpClientPanel
$httpClient array yii\httpclient\debug\HttpClientPanel
$id string Panel unique identifier. yii\debug\Panel
$methods array yii\httpclient\debug\HttpClientPanel
$module yii\debug\Module yii\debug\Panel
$name string Name of the panel yii\httpclient\debug\HttpClientPanel
$summary string Content that is displayed at debug toolbar yii\httpclient\debug\HttpClientPanel
$tag string Request data set identifier. yii\debug\Panel
$types array yii\httpclient\debug\HttpClientPanel
$url string URL pointing to panel detail view yii\debug\Panel

Public Methods

Hide inherited methods

MethodDescriptionDefined 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
calculateTimings() Calculates given request profile timings. yii\httpclient\debug\HttpClientPanel
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\httpclient\debug\HttpClientPanel
getHttpClient() yii\httpclient\debug\HttpClientPanel
getMethods() Returns array request methods yii\httpclient\debug\HttpClientPanel
getName() yii\httpclient\debug\HttpClientPanel
getSummary() yii\httpclient\debug\HttpClientPanel
getTraceLine() Returns a trace line yii\debug\Panel
getTypes() Returns array request types yii\httpclient\debug\HttpClientPanel
getUrl() 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\httpclient\debug\HttpClientPanel
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\httpclient\debug\HttpClientPanel
setHttpClient() yii\httpclient\debug\HttpClientPanel
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getModels() Returns an array of models that represents logs of the current request. yii\httpclient\debug\HttpClientPanel
getRequestMethod() Returns HTTP request method. yii\httpclient\debug\HttpClientPanel
getRequestType() Returns request type. yii\httpclient\debug\HttpClientPanel
getTotalRequestTime() Returns total request time. yii\httpclient\debug\HttpClientPanel

Property Details

$detail public read-only property

Content that is displayed in debugger detail view

public string getDetail ( )
$httpClient public property
public yii\httpclient\Client getHttpClient ( )
public void setHttpClient ( $httpClient )
$methods public read-only property
public array getMethods ( )
$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 ( )
$types public read-only property
public array getTypes ( )

Method Details

calculateTimings() public method

Calculates given request profile timings.

public array calculateTimings ( )
return array

Timings [token, category, timestamp, traces, nesting level, elapsed time]

getDetail() public method

public string getDetail ( )
return string

Content that is displayed in debugger detail view

getHttpClient() public method

public yii\httpclient\Client getHttpClient ( )
getMethods() public method

Returns array request methods

public array getMethods ( )
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 ( )
return array

Models

getName() public method

public string getName ( )
return string

Name of the panel

getRequestMethod() protected method

Returns HTTP request method.

protected string getRequestMethod ( $timing )
$timing string

Timing procedure string

return string

Request method such as GET, POST, PUT, etc.

getRequestType() protected method

Returns request type.

protected string getRequestType ( $category )
$category string
return string

Request type such as 'normal', 'batch'

getSummary() public method

public string getSummary ( )
return string

Content that is displayed at debug toolbar

getTotalRequestTime() protected method

Returns total request time.

protected integer getTotalRequestTime ( $timings )
$timings array
return integer

Total time

getTypes() public method

Returns array request types

public array getTypes ( )
init() public method

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 ( )
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

setHttpClient() public method

public void setHttpClient ( $httpClient )
$httpClient array