Debug class

Provides methods useful for debugging or development.

Currently only provides timer capability.

This file is licensed under the MIT license

$timer = Debug::startTimer();
execute_some_code();
$elapsed = Debug::stopTimer($timer);

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
Debug::backtrace()
array string

Return a backtrace array that is simpler and more PW-specific relative to PHP’s debug_backtrace

 
Debug::getAll()
array

Get all active timers in array with timer name (key) and start time (value)

 
Debug::getSavedTimer(string $key)
string

Return the time recorded in the saved timer $key

 
Debug::getSavedTimers()
array

Return all saved timers in associative array indexed by key

 
Debug::removeAll()
None

Remove all active timers

 
Debug::removeSavedTimer(string $key)
None

Remove a previously saved timer

 
Debug::removeSavedTimers()
None

Remove all saved timers

 
Debug::removeTimer(string $key)
None

Remove a timer completely

 
Debug::resetTimer(string $key)
string int

Reset a timer so that it starts timing again from right now

 
Debug::saveTimer(string $key)
bool string

Save the current time of the given timer which can be later retrieved with getSavedTimer($key)

 
Debug::startTimer()
string

Start a new timer

 
Debug::stopTimer()
string

Get elapsed time for given timer and stop

 
Debug::timer()
string int

Measure time between two events

 
Debug::timerSetting(string $key)
mixed

Get or set timer setting

 
Debug::toStr($value)
string

Dump any variable to a debug string

 

API reference based on ProcessWire core version 3.0.252