XHPROF_ENABLE(3) 1 XHPROF_ENABLE(3)
xhprof_enable - Start xhprof profiler
SYNOPSIS
void xhprof_enable ([int $flags], [array $options])
DESCRIPTION
Start xhprof profiling.
PARAMETERS
o $flags
- Optional flags to add additional information to the profiling. See the XHprof constants for further information about these
flags, e.g., XHPROF_FLAGS_MEMORY to enable memory profiling.
o $options
- An array of optional options, namely, the 'ignored_functions' option to pass in functions to be ignored during profiling.
RETURN VALUES
NULL
CHANGELOG
+--------+---------------------------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+---------------------------------------------+
| 0.9.2 | |
| | |
| | The optional $options parameter was added. |
| | |
+--------+---------------------------------------------+
EXAMPLES
Example #1
xhprof_enable(3) examples
<?php
// 1. elapsed time + memory + CPU profiling; and ignore built-in (internal) functions
xhprof_enable(XHPROF_FLAGS_NO_BUILTINS | XHPROF_FLAGS_CPU | XHPROF_FLAGS_MEMORY);
// 2. elapsed time profiling; ignore call_user_func* during profiling
xhprof_enable(
0,
array('ignored_functions' => array('call_user_func',
'call_user_func_array')));
// 3. elapsed time + memory profiling; ignore call_user_func* during profiling
xhprof_enable(
XHPROF_FLAGS_MEMORY,
array('ignored_functions' => array('call_user_func',
'call_user_func_array')));
?>
SEE ALSO
xhprof_disable(3), xhprof_sample_enable(3), memory_get_usage(3), getrusage(3).
PHP Documentation Group XHPROF_ENABLE(3)
