Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: timerobject

Source Location: /system/classes/timer.class.php

Class Overview


This class is used to time program execution. This is particularly handy for performance trouble shooting.


Author(s):

  • Tony Bibbs

Methods



Class Details

[line 56]
This class is used to time program execution. This is particularly handy for performance trouble shooting.



Tags:

author:  Tony Bibbs


[ Top ]


Class Methods


method getElapsedTime [line 162]

string getElapsedTime( )

Gets the elapsed time

This returns the elapsed time with the proper number of significant digits




Tags:

return:  Elapsed time in seconds formatted to degree of precision specified
access:  public


[ Top ]

method restart [line 145]

void restart( )

Restarts the timer

Same as startTimer excepts this clears everything out first




Tags:

access:  public


[ Top ]

method setPercision [line 102]

void setPercision( $num_dec_places)

Deprecated - use setPrecision instead



Tags:

see:  timerobject::setPrecision()
deprecated:  since Geeklog 1.6.0
access:  public


Parameters:

   $num_dec_places  

[ Top ]

method setPrecision [line 91]

void setPrecision( int $num_dec_places)

Set precision on timer results

This sets how many significant digits get sent back when elapsedTime is called




Tags:

access:  public


Parameters:

int   $num_dec_places   Number of significant digits

[ Top ]

method startTimer [line 112]

void startTimer( )

Starts the timer



Tags:

access:  public


[ Top ]

method stopTimer [line 126]

float stopTimer( )

Stops the timer



Tags:

return:  elapsed time to degree of precision specified
access:  public


[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:56:15 +0000 by phpDocumentor 1.4.3