Language strings used by the class

Only contains language strings which *may* be used in the output. Except for subtotal, they can be overruled by setting optional parameters when calling the related methods.

The only other language strings in this class are error messages and those are hard coded in English for obvious reasons.

• see: script_timer::add_markers()
• see: script_timer::end_timer()

Default precision for output of results

Can be overruled by setting the $precision parameter in the get_output() method

• link: http://www.php.net/function.round
• see: script_timer::get_output()

Variable which contains the setting used for $add_subtotals in the end_timer() method.

Sum of the timings taken (so far)

Whether this is a string or float depends on whether the bcmath extension is loaded.

Add breakpoint microtime markers which were recorded outside of this class

Typical use: when you start your script, you first validate and normalize some data before including any classes. If you want to also time this first part of the script (i.e. before this class was instantiated), you will need to record some breakpoints yourself.

Record those breakpoints like this:

$marker_array[] = array( microtime(), 'marker name', 'optional script name' );

Using this method, you can then later (once the class is instantiated) add those recorded times to the class object.

If you use this method, call this (straight) after you instantiate the class and before recording additional markers using the set_marker() method.

This method will start the timer automatically. Do not call the start_timer() method.

This method will (optionally) auto-add an extra marker for the script part between the last marker passed and the call to this method. You can optionally set your own $marker_name (and - again optionally - $script_name) for this extra marker.
If you choose not to add the extra marker, the timing for the next marker will be corrected for the processing time taken by this method call.

• see: script_timer::set_marker()
• see: script_timer::start_timer()

• array $marker_array: multi-dimentional array using the following structure

  array(
       [0] =>    array(
           [0] =>    string    recorded microtime
           [1] =>    string    breakpoint marker name
           [2] =>    string    [optional] script name
       ),
       [1]    =>    array( ....),
       .....
   );
  

• string $start_time: [optional] recorded microtime for start of script timing If not passed, the microtime of the first record in the array will be used as start time and the first record will have an elapsed time of 0.
• bool $add_marker_for_interim: [optional] whether or not to add a marker for the time passed between the last marker in the array and the call to this method. Defaults to true.
  If set to false, the next marker will measure the time between the last marker and itself including the call to this method, though largely - but not completely - corrected for the time this method takes to run.
• string $marker_name: [optional] name for the (optional) interim marker, default to the markername in $lang_strings['interim_marker']
• string $script_name: [optional] name for the script / group for the (optional) interim marker, defaults to null (i.e. no script / group name)

Retrieve the timer output either as a html string or directly printed to screen

Please refer to end_timer() for information on how (and why) to set the optional $add_subtotals, $marker_name and $script_name parameters

• return: returns the html string or true if output to screen was successful
• see: script_timer::end_timer()

• bool $display: [optional] whether to return the output to the screen or as a string
  false returns a html string
  true prints the results to screen
  Defaults to false.
• int $precision: [optional] output precision of microtime values
  Defaults to $output_precision
• string $encoding: [optional] character encoding for the html output
  Defaults to $output_encoding
• bool $add_subtotals: [optional] only used if the timer was not previously stopped
• string $marker_name: [optional] only used if the timer was not previously stopped
• string $script_name: [optional] only used if the timer was not previously stopped

Record the time for a breakpoint in your script

Sets the marker for the breakpoint called $marker_name

If you use/include a lot of scripts in your page, you may want to set the optional parameter $script_name to record in which script the breakpoint resides.
Obviously you can also use $script_name to group sequential related parts of your script.
If you use the $script_name variable, you can then receive subtotals per script (group) in your timer results.

• see: script_timer::add_markers()
• see: script_timer::start_timer()

• string $marker_name: name for your breakpoint so you recognize it later
• string $script_name: [optional] name of the current script or group
• bool $pause_timer: [optional] pause the timer after setting this marker Defaults to false, i.e. don't pause the timer.

Unpause the timer

• see: script_timer::set_marker()