ProfilerInterface

Interface for Profilers containing a sequence of ProfilePointInterface.

since

1.0

Methods

getName

Get the name of this profiler.

getName() : string
since

1.0

Response

stringThe name of this profiler.

getPoint

Get the point identified by the given name.

getPoint(string $name, mixed $default = null) : \Joomla\Profiler\ProfilePointInterface|mixed
since

1.0

Arguments

$name

stringThe name of the point.

$default

mixedThe default value if the point hasn't been marked.

Response

\Joomla\Profiler\ProfilePointInterface|mixedThe profile point or the default value.

getPoints

Get the points in this profiler (in the order they were marked).

getPoints() : array<mixed,\Joomla\Profiler\ProfilePointInterface>
since

1.0

Response

array<mixed,\Joomla\Profiler\ProfilePointInterface>An array of points in this profiler.

getRenderer

Get the currently used renderer in this profiler.

getRenderer() : \Joomla\Profiler\ProfilerRendererInterface
since

1.0

Response

\Joomla\Profiler\ProfilerRendererInterfaceThe renderer.

hasPoint

Check if the profiler has marked the given point.

hasPoint(string $name) : boolean
since

1.0

Arguments

$name

stringThe name of the point.

Response

booleanTrue if the profiler has marked the point, false otherwise.

mark

Mark a profile point with the given name.

mark(string $name) : \Joomla\Profiler\ProfilerInterface
since

1.0

throws

\InvalidArgumentExceptionIf a point with that name already exists.

Arguments

$name

stringThe profile point name.

Response

\Joomla\Profiler\ProfilerInterfaceThis method is chainable.

render

Render the profiler.

render() : string
since

1.0

Response

stringThe rendered profiler.

setRenderer

Set the renderer to render this profiler.

setRenderer(\Joomla\Profiler\ProfilerRendererInterface $renderer) : \Joomla\Profiler\ProfilerInterface
since

1.0

Arguments

$renderer

\Joomla\Profiler\ProfilerRendererInterfaceThe renderer.

Response

\Joomla\Profiler\ProfilerInterfaceThis method is chainable.