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


constructor timerobject [line 86]

timerobject timerobject( )

Constructor

This initializes the timerobject and sets the default precision of results to two decimal places




[ Top ]

method getElapsedTime [line 170]

float getElapsedTime( )

Gets the elapsed time

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




Tags:

return:  Elasped time in seconds formatted to degree of precision specified


[ Top ]

method restart [line 153]

void restart( )

Restarts the timer

Same as startTimer excepts this clears everything out first




[ Top ]

method setPercision [line 110]

void setPercision( $num_dec_places)

Deprecated - use setPrecision instead



Tags:

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


Parameters:

   $num_dec_places  

[ Top ]

method setPrecision [line 99]

void setPrecision( int $num_dec_places)

Set precision on timer results

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




Parameters:

int   $num_dec_places   Number of significant digits

[ Top ]

method startTimer [line 120]

void startTimer( )

Starts the timer



[ Top ]

method stopTimer [line 134]

float stopTimer( )

Stops the timer



Tags:

return:  elapsed time to degree of precision specified


[ Top ]


Documentation generated on Thu, 24 May 2012 02:09:21 -0400 by phpDocumentor 1.4.3