| Fully Qualified Name: | CodeIgniter\Debug\Toolbar\Collectors\Timers |
| Extends: | BaseCollector |
Timers collector
| Name | Description | Defined By |
|---|---|---|
| cleanPath() | Clean Path | BaseCollector |
| display() | Returns the data of this collector to be formatted in the toolbar | BaseCollector |
| getAsArray() | Return settings as an array. | BaseCollector |
| getBadgeValue() | Gets the "badge" value for the button. | BaseCollector |
| getTitle() | Gets the Collector's title. | BaseCollector |
| getTitleDetails() | Returns any information that should be shown next to the title. | BaseCollector |
| getVarData() | Gets a collection of data that should be shown in the 'Vars' tab. | BaseCollector |
| hasLabel() | Does this collector have a label? | BaseCollector |
| hasTabContent() | Does this collector need it's own tab? | BaseCollector |
| hasTimelineData() | Does this collector have information for the timeline? | BaseCollector |
| hasVarData() | Does this Collector have data that should be shown in the 'Vars' tab? | BaseCollector |
| icon() | Returns the HTML to display the icon. Should either be SVG, or a base-64 encoded. | BaseCollector |
| isEmpty() | Does this collector have any data collected? | BaseCollector |
| timelineData() | Grabs the data for the timeline, properly formatted, or returns an empty array. | BaseCollector |
Clean Path
This makes nicer looking paths for the error output.
| Parameter Name | Type | Description |
|---|---|---|
| $file | string |
Returns: string
Returns the data of this collector to be formatted in the toolbar
Returns: array|string
Return settings as an array.
Returns: array
Gets the "badge" value for the button.
Returns: null
Gets the Collector's title.
| Parameter Name | Type | Description |
|---|---|---|
| $safe | bool |
Returns: string
Returns any information that should be shown next to the title.
Returns: string
Gets a collection of data that should be shown in the 'Vars' tab.
The format is an array of sections, each with their own array of key/value pairs:
$data = [
'section 1' => [
'foo' => 'bar,
'bar' => 'baz'
],
'section 2' => [
'foo' => 'bar,
'bar' => 'baz'
],
];
Returns: null
Does this collector have a label?
Returns: bool
Does this collector need it's own tab?
Returns: bool
Does this collector have information for the timeline?
Returns: bool
Does this Collector have data that should be shown in the 'Vars' tab?
Returns: bool
Returns the HTML to display the icon. Should either be SVG, or a base-64 encoded.
Recommended dimensions are 24px x 24px
Returns: string
Does this collector have any data collected?
If not, then the toolbar button won't get shown.
Returns: bool
Grabs the data for the timeline, properly formatted, or returns an empty array.
Returns: array