Benchmark
[ class tree: Benchmark ] [ index: Benchmark ] [ all elements ]
Packages:
Benchmark


Classes:
Benchmark_Iterate
Benchmark_Profiler
Benchmark_Timer
Files:
Iterate.php
Profiler.php
Timer.php
timer_example.php

Class: Benchmark_Timer

Source Location: /Benchmark-1.2.7/Benchmark/Timer.php

Class Overview

PEAR
   |
   --Benchmark_Timer

Provides timing and profiling information.


Author(s):

Copyright:

  • Copyright &copy; 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>

Methods

Child classes:

Benchmark_Iterate
Provides timing and profiling information.

Inherited Variables

Inherited Methods

Class Details

[line 60]
Provides timing and profiling information.

Example 1: Automatic profiling start, stop, and output.

  1.  <?php
    2. 

  2.  require_once 'Benchmark/Timer.php';
    3. 

  3.  
    4. 

  4.  $timer = new Benchmark_Timer(TRUE);
    5. 

  5.  $timer->setMarker('Marker 1');
    6. 

  6.  ?>
    7.

Example 2: Manual profiling start, stop, and output.

  1.  <?php
    2. 

  2.  require_once 'Benchmark/Timer.php';
    3. 

  3.  
    4. 

  4.  $timer = new Benchmark_Timer();
    5. 

  5.  $timer->start();
    6. 

  6.  $timer->setMarker('Marker 1');
    7. 

  7.  $timer->stop();
    8. 

  8.  
    9. 

  9.  $timer->display(); // to output html formated
    10. 

  10.  // AND/OR :
    11. 

  11.  $profiling = $timer->getProfiling(); // get the profiler info as an associative array
    12. 

  12.  ?>
    13.



[ Top ]

Method Detail

Benchmark_Timer (Constructor)   [line 91]

Benchmark_Timer Benchmark_Timer( [boolean $auto = FALSE])

Constructor.
  • Access: public

Parameters:

boolean   $auto   —   

[ Top ]

close   [line 106]

void close( )

Close method. Stop timer and display output.
  • Access: public

[ Top ]

display   [line 306]

void display( [boolean $showTotal = FALSE], [string $format = 'auto'])

Prints the information returned by getOutput().

Parameters:

boolean   $showTotal   —   Optionnaly includes total in output, default no
string   $format   —   output format (auto, plain or html), default auto

[ Top ]

getOutput   [line 220]

string getOutput( [boolean $showTotal = FALSE], [string $format = 'auto'])

Return formatted profiling information.

Parameters:

boolean   $showTotal   —   Optionnaly includes total in output, default no
string   $format   —   output format (auto, plain or html), default auto

[ Top ]

getProfiling   [line 177]

array getProfiling( )

Returns profiling information.

$profiling[x]['name'] = name of marker x $profiling[x]['time'] = time index of marker x $profiling[x]['diff'] = execution time from marker x-1 to this marker x $profiling[x]['total'] = total execution time up to marker x

  • Access: public

[ Top ]

setMarker   [line 140]

void setMarker( string $name)

Set marker.

Parameters:

string   $name   —   Name of the marker to be set.

[ Top ]

start   [line 119]

void start( )

Set "Start" marker.

[ Top ]

stop   [line 129]

void stop( )

Set "Stop" marker.

[ Top ]

timeElapsed   [line 152]

double timeElapsed( [string $start = 'Start'], [string $end = 'Stop'])

Returns the time elapsed betweens two markers.
  • Return: time elapsed between $start and $end
  • Access: public

Parameters:

string   $start   —   start marker, defaults to "Start"
string   $end   —   end marker, defaults to "Stop"

[ Top ]
Documentation generated on Fri, 22 Jun 2007 21:30:05 -0400 by phpDocumentor 1.3.2. PEAR Logo Copyright © PHP Group 2004.