Timers
extends BaseCollector
in package
Timers collector
Table of Contents
Properties
- $hasLabel : bool
- Whether this collector needs to display a label or not.
- $hasTabContent : bool
- Whether this collector needs to display content in a tab or not.
- $hasTimeline : bool
- Whether this collector has data that can be displayed in the Timeline.
- $hasVarData : bool
- Whether this collector has data that should be shown in the Vars tab.
- $title : string
- The 'title' of this Collector.
Methods
- cleanPath() : string
- This makes nicer looking paths for the error output.
- display() : array<string|int, mixed>|string
- Returns the data of this collector to be formatted in the toolbar
- getAsArray() : array<string|int, mixed>
- Return settings as an array.
- getBadgeValue() : int|null
- Gets the "badge" value for the button.
- getTitle() : string
- Gets the Collector's title.
- getTitleDetails() : string
- Returns any information that should be shown next to the title.
- getVarData() : array<string|int, mixed>|null
- Gets a collection of data that should be shown in the 'Vars' tab.
- hasLabel() : bool
- Does this collector have a label?
- hasTabContent() : bool
- Does this collector need it's own tab?
- hasTimelineData() : bool
- Does this collector have information for the timeline?
- hasVarData() : bool
- Does this Collector have data that should be shown in the 'Vars' tab?
- icon() : string
- Returns the HTML to display the icon. Should either be SVG, or a base-64 encoded.
- isEmpty() : bool
- Does this collector have any data collected?
- timelineData() : array<string|int, mixed>
- Grabs the data for the timeline, properly formatted, or returns an empty array.
- formatTimelineData() : array<string|int, mixed>
- Child classes should implement this to return the timeline data formatted for correct usage.
Properties
$hasLabel
Whether this collector needs to display a label or not.
protected
bool
$hasLabel
= false
$hasTabContent
Whether this collector needs to display content in a tab or not.
protected
bool
$hasTabContent
= false
$hasTimeline
Whether this collector has data that can be displayed in the Timeline.
protected
bool
$hasTimeline
= true
$hasVarData
Whether this collector has data that should be shown in the Vars tab.
protected
bool
$hasVarData
= false
$title
The 'title' of this Collector.
protected
string
$title
= 'Timers'
Used to name things in the toolbar HTML.
Methods
cleanPath()
This makes nicer looking paths for the error output.
public
cleanPath(string $file) : string
Use the dedicated clean_path() function.
Parameters
- $file : string
Return values
stringdisplay()
Returns the data of this collector to be formatted in the toolbar
public
display() : array<string|int, mixed>|string
Return values
array<string|int, mixed>|stringgetAsArray()
Return settings as an array.
public
getAsArray() : array<string|int, mixed>
Return values
array<string|int, mixed>getBadgeValue()
Gets the "badge" value for the button.
public
getBadgeValue() : int|null
Return values
int|nullgetTitle()
Gets the Collector's title.
public
getTitle([bool $safe = false ]) : string
Parameters
- $safe : bool = false
Return values
stringgetTitleDetails()
Returns any information that should be shown next to the title.
public
getTitleDetails() : string
Return values
stringgetVarData()
Gets a collection of data that should be shown in the 'Vars' tab.
public
getVarData() : array<string|int, mixed>|null
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' ], ];
Return values
array<string|int, mixed>|nullhasLabel()
Does this collector have a label?
public
hasLabel() : bool
Return values
boolhasTabContent()
Does this collector need it's own tab?
public
hasTabContent() : bool
Return values
boolhasTimelineData()
Does this collector have information for the timeline?
public
hasTimelineData() : bool
Return values
boolhasVarData()
Does this Collector have data that should be shown in the 'Vars' tab?
public
hasVarData() : bool
Return values
boolicon()
Returns the HTML to display the icon. Should either be SVG, or a base-64 encoded.
public
icon() : string
Recommended dimensions are 24px x 24px
Return values
stringisEmpty()
Does this collector have any data collected?
public
isEmpty() : bool
If not, then the toolbar button won't get shown.
Return values
booltimelineData()
Grabs the data for the timeline, properly formatted, or returns an empty array.
public
timelineData() : array<string|int, mixed>
Return values
array<string|int, mixed>formatTimelineData()
Child classes should implement this to return the timeline data formatted for correct usage.
protected
formatTimelineData() : array<string|int, mixed>