JProfiler

class JProfiler extends JObject


Located at : UKNOWVA_ROOT/libraries/joomla/error/profiler.php

Utility class to assist in the process of benchmarking the execution of sections of code to understand where time is being spent.

Methods

JObject
__construct(string $prefix = '')

Constructor

string
__toString()

Magic method to convert the object to a string gracefully.

from JObject
mixed
def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

from JObject
mixed
get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

from JObject
array
getProperties(boolean $public = true)

Returns an associative array of object properties.

from JObject
string
getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

from JObject
array
getErrors()

Return all errors, if any.

from JObject
mixed
set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

from JObject
boolean
setProperties(mixed $properties)

Set the object properties based on a named array/hash.

from JObject
void
setError(string $error)

Add an error message.

from JObject
string
toString() deprecated

No description

from JObject
static JProfiler
getInstance(string $prefix = '')

Returns the global Profiler object, only creating it if it doesn't already exist.

string
mark(string $label)

Output a time mark

static float
getmicrotime()

Get the current time.

integer
getMemory()

Get information about current memory usage.

array
getBuffer()

Get all profiler marks.

Details

at line 70
JObject __construct(string $prefix = '')

Constructor

Parameters

string $prefix Prefix for mark messages

Return Value

JObject

in JObject at line 56
string __toString()

Magic method to convert the object to a string gracefully.

Return Value

string The classname.

in JObject at line 70
mixed def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed

in JObject at line 88
mixed get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed The value of the property.

See also

getProperties()

in JObject at line 107
array getProperties(boolean $public = true)

Returns an associative array of object properties.

Parameters

boolean $public If true, returns only the public properties.

Return Value

array

See also

get()

in JObject at line 133
string getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

Parameters

integer $i Option error index.
boolean $toString Indicates if JError objects should return their error message.

Return Value

string Error message

in JObject at line 165
array getErrors()

Return all errors, if any.

Return Value

array Array of error messages or JErrors.

in JObject at line 180
mixed set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

Parameters

string $property The name of the property.
mixed $value The value of the property to set.

Return Value

mixed Previous value of the property.

in JObject at line 198
boolean setProperties(mixed $properties)

Set the object properties based on a named array/hash.

Parameters

mixed $properties Either an associative array or another object.

Return Value

boolean

See also

set()

in JObject at line 222
void setError(string $error)

Add an error message.

Parameters

string $error Error message.

Return Value

void

in JObject at line 235
string toString() deprecated

deprecated 12.1 Use magic method __toString()

Return Value

string

See also

__toString()

at line 87
static JProfiler getInstance(string $prefix = '')

Returns the global Profiler object, only creating it if it doesn't already exist.

Parameters

string $prefix Prefix used to distinguish profiler objects.

Return Value

JProfiler The Profiler object.

at line 114
string mark(string $label)

Output a time mark

The mark is returned as text enclosed in

tags with a CSS class of 'profiler'.

Parameters

string $label A label for the time mark

Return Value

string Mark enclosed in
tags

at line 153
static float getmicrotime()

Get the current time.

Return Value

float The current time

at line 168
integer getMemory()

Get information about current memory usage.

Return Value

integer The memory usage

at line 201
array getBuffer()

Get all profiler marks.

Returns an array of all marks created since the Profiler object was instantiated. Marks are strings as per {@link JProfiler::mark()}.

Return Value

array Array of profiler marks