\CodeIgniter\Debug\Toolbar\CollectorsFiles

getTitle()

getTitle(boolean  $safe = false) : string

Gets the Collector's title.

Parameters

Returns

getTitleDetails()

getTitleDetails() : string

Returns any information that should be shown next to the title.

Returns

hasTabContent()

hasTabContent() : boolean

Does this collector need it's own tab?

Returns

hasLabel()

hasLabel() : boolean

Does this collector have a label?

Returns

hasTimelineData()

hasTimelineData() : boolean

Does this collector have information for the timeline?

Returns

timelineData()

timelineData() : array

Grabs the data for the timeline, properly formatted, or returns an empty array.

Returns

hasVarData()

hasVarData() : boolean

Does this Collector have data that should be shown in the 'Vars' tab?

Returns

getVarData()

getVarData() : null

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

display()

display() : array

Returns the data of this collector to be formatted in the toolbar

Returns

cleanPath()

cleanPath(string  $file) : string

Clean Path

This makes nicer looking paths for the error output.

Parameters

Returns

getBadgeValue()

getBadgeValue() : integer

Displays the number of included files as a badge in the tab button.

Returns

isEmpty()

isEmpty() : boolean

Does this collector have any data collected?

If not, then the toolbar button won't get shown.

Returns

icon()

icon() : string

Display the icon.

Icon from https://icons8.com - 1em package

Returns

getAsArray()

getAsArray() : array

Return settings as an array.

Returns

formatTimelineData()

formatTimelineData() : array

Child classes should implement this to return the timeline data formatted for correct usage.

Timeline data should be formatted into arrays that look like:

[ 'name' => 'Database::Query', 'component' => 'Database', 'start' => 10 // milliseconds 'duration' => 15 // milliseconds ]

Returns