Class JProfiler

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

Package: Joomla\Platform\Profiler
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/profiler/profiler.php

Methods summary

`public`	# `__construct( string $prefix = '' )` Constructor Constructor Parameters `$prefix` `string` - $prefix Prefix for mark messages Since 11.1
`public static JProfiler`	# `getInstance( string $prefix = '' )` Returns the global Profiler object, only creating it if it doesn't already exist. Returns the global Profiler object, only creating it if it doesn't already exist. Parameters `$prefix` `string` - $prefix Prefix used to distinguish profiler objects. Returns `JProfiler` - The Profiler object. Since 11.1
`public string`	# `mark( string $label )` Output a time mark Output a time mark Parameters `$label` `string` - $label A label for the time mark Returns `string` Since 11.1
`public static float`	# `getmicrotime( )` Get the current time. Get the current time. Deprecated 12.3 (Platform) & 4.0 (CMS) - Use PHP's microtime(1) Returns `float` - The current time Since 11.1
`public integer`	# `getMemory( )` Get information about current memory usage. Get information about current memory usage. Deprecated 12.3 (Platform) & 4.0 (CMS) - Use PHP's native memory_get_usage() Returns `integer` - The memory usage Since 11.1 Link PHP_MANUAL#memory_get_usage
`public array`	# `getMarks( )` Get all profiler marks. Get all profiler marks. Returns an array of all marks created since the Profiler object was instantiated. Marks are objects as per `JProfiler::mark()`. Returns `array` - Array of profiler marks Since 11.1
`public array`	# `getBuffer( )` Get all profiler mark buffers. Get all profiler mark buffers. Returns an array of all mark buffers created since the Profiler object was instantiated. Marks are strings as per `JProfiler::mark()`. Returns `array` - Array of profiler marks Since 11.1
`public mixed`	# `setStart( float $startTime = 0, integer $startMem = 0 )` Sets the start time. Sets the start time. Parameters `$startTime` `float` - $startTime Unix timestamp in microseconds for setting the Profiler start time. `$startMem` `integer` - $startMem Memory amount in bytes for setting the Profiler start memory. Returns `mixed` - $this For chaining Since 12.1

Magic methods summary

Properties summary

`protected integer`	`$start`	# The start time. The start time. Since 12.1
`protected string`	`$prefix`	# The prefix to use in the output The prefix to use in the output Since 12.1
`protected array`	`$buffer`	# The buffer of profiling messages. The buffer of profiling messages. Since 12.1
`protected array`	`$marks`	# The profiling messages. The profiling messages. Since 12.1
`protected float`	`$previousTime`	# The previous time marker The previous time marker Since 12.1
`protected float`	`$previousMem`	# The previous memory marker The previous memory marker Since 12.1
`protected static array`	`$instances`	# JProfiler instances container. JProfiler instances container. Since 11.3

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JProfiler

Methods summary

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Deprecated

Returns

Since

Deprecated

Returns

Since

Link

Returns

Since

Returns

Since

Parameters

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since