CodeIgniter v3.0.0 API
\

\CI_Benchmark

Benchmark Class

This class enables you to mark points and calculate the time difference between them. Memory consumption can also be displayed.

Summary

Methods
Properties
Constants
mark()
elapsed_time()
memory_usage()
$marker
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$marker

$marker : array

List of all benchmark markers

Type

array

Methods

mark()

mark(string  $name) : void

Set a benchmark marker

Multiple calls to this function can be made so that several execution points can be timed.

Parameters

string $name

Marker name

elapsed_time()

elapsed_time(string  $point1 = '', string  $point2 = '', integer  $decimals = 4) : string

Elapsed time

Calculates the time difference between two marked points.

If the first parameter is empty this function instead returns the {elapsed_time} pseudo-variable. This permits the full system execution time to be shown in a template. The output class will swap the real value for this variable.

Parameters

string $point1

A particular marked point
string $point2

A particular marked point
integer $decimals

Number of decimal places

Returns

string —

Calculated elapsed time on success, an '{elapsed_string}' if $point1 is empty or an empty string if $point1 is not found.

memory_usage()

memory_usage() : string

Memory Usage

Simply returns the {memory_usage} marker.

This permits it to be put it anywhere in a template without the memory being calculated until the end. The output class will swap the real value for this variable.

Returns

string —

'{memory_usage}'