Joomla! API

Download
Launch

JProfiler

Extends \JObject

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

This class allows for simple but smart objects with get and set methods and an internal error handler.

package

Joomla.Platform
subpackage

Error
since

11.1

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null)
inherited
since

11.1

Arguments

$properties

mixedEither and associative array or another object to set the initial properties of the object.

__toString

Magic method to convert the object to a string gracefully.

__toString() : string
inherited deprecated
since

11.1
deprecated

12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

def

Sets a default value if not alreay assigned

def(string $property, mixed $default = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

get

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

get(string $property, mixed $default = null) : mixed
inherited
since

11.1
see \JObject::getProperties()

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixedThe value of the property.

getBuffer

Get all profiler marks.

getBuffer() : array

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

Response

arrayArray of profiler marks

getError

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates if JError objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Response

arrayArray of error messages or JErrors.

getInstance

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

getInstance(string $prefix = '') : \JProfiler
static
since

11.1

Arguments

$prefix

stringPrefix used to distinguish profiler objects.

Response

\JProfilerThe Profiler object.

getMemory

Get information about current memory usage.

getMemory() : integer
link

PHP_MANUAL#memory_get_usage
since

11.1

Response

integerThe memory usage

getmicrotime

Get the current time.

getmicrotime() : float
static
since

11.1

Response

floatThe current time

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

11.1
see \JObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

mark

Output a time mark

mark(string $label) : string

The mark is returned as text enclosed in

tags with a CSS class of 'profiler'.

since

11.1

Arguments

$label

stringA label for the time mark

Response

stringMark enclosed in

tags

set

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

set(string $property, mixed $value = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setError

Add an error message.

setError(string $error) : void
inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Arguments

$error

stringError message.

setProperties

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

setProperties(mixed $properties) : boolean
inherited
since

11.1
see \JObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

toString

Converts the object to a string (the class name).

toString() : string
inherited deprecated
since

11.1
deprecated

12.1 Use magic method __toString()
see \JObject::__toString()

Response

string

Properties

_start

The start time.

since

11.1

Type(s)

integer

_prefix

The prefix to use in the output

since

11.1

Type(s)

string

_buffer

The buffer of profiling messages.

since

11.1

Type(s)

array

_previous_time

since

11.1

Type(s)

float

_previous_mem

since

11.1

Type(s)

float

_iswin

Boolean if the OS is Windows.

since

11.1

Type(s)

boolean

instances

JProfiler instances container.

static
since

11.3

Type(s)

array

_errors

An array of error messages or Exception objects.

inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Type(s)

array
  • \ \
  • \ JProfiler