CI_Benchmark Class Reference

List of all members.

Public Member Functions
	mark ($name)
	Set a benchmark marker.
	elapsed_time ($point1= '', $point2= '', $decimals=4)
	Calculates the time difference between two marked points.
	memory_usage ()
	Memory Usage.
Public Attributes
	$marker = array()

---

Detailed Description

Definition at line 30 of file Benchmark.php.

---

Member Function Documentation

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

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.

public

Parameters:

	string	a particular marked point
	string	a particular marked point
	integer	the number of decimal places

Returns:

mixed

Definition at line 67 of file Benchmark.php.

        {
                if ($point1 == '')
                {
                        return '{elapsed_time}';
                }

                if ( ! isset($this->marker[$point1]))
                {
                        return '';
                }

                if ( ! isset($this->marker[$point2]))
                {
                        $this->marker[$point2] = microtime();
                }
        
                list($sm, $ss) = explode(' ', $this->marker[$point1]);
                list($em, $es) = explode(' ', $this->marker[$point2]);

                return number_format(($em + $es) - ($sm + $ss), $decimals);
        }

CI_Benchmark::mark

(

$

name

)

Set a benchmark marker.

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

public

Parameters:

string

$name name of the marker

Returns:

void

Definition at line 46 of file Benchmark.php.

        {
                $this->marker[$name] = microtime();
        }

CI_Benchmark::memory_usage

(

)

Memory Usage.

This function returns the {memory_usage} pseudo-variable. 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.

public

Returns:

string

Definition at line 103 of file Benchmark.php.

        {
                return '{memory_usage}';
        }

---

Member Data Documentation

CI_Benchmark::$marker = array()

Definition at line 32 of file Benchmark.php.

---

The documentation for this class was generated from the following file:

• Benchmark.php