include/SugarXHprof/xhprof_lib/utils/xhprof_runs.php
inherited
Classes
\XHProfRuns_Default
XHProfRuns_Default is the default implementation of the iXHProfRuns interface for saving/fetching XHProf runs.
It stores/retrieves runs to/from a filesystem directory specified by the "xhprof.output_dir" ini parameter.
- Parent(s)
- \iXHProfRuns
- Author
- Kannan
Properties
$dir= ''''
''Details- Type
- n/a
$suffix= ''xhprof''
'xhprof'Details- Type
- n/a
Methods
__construct(
$dir
=
null
)
:
void| Name | Type | Description |
|---|---|---|
| $dir |
file_name(
$run_id, $type
)
:
void| Name | Type | Description |
|---|---|---|
| $run_id | ||
| $type |
gen_run_id(
$type
)
:
void| Name | Type | Description |
|---|---|---|
| $type |
get_run(
$run_id, $type, $run_desc
)
:
void| Name | Type | Description |
|---|---|---|
| $run_id | ||
| $type | ||
| $run_desc |
list_runs(
)
:
voidsave_run(
$xhprof_data, $type, $run_id
=
null
)
:
void| Name | Type | Description |
|---|---|---|
| $xhprof_data | ||
| $type | ||
| $run_id |
\iXHProfRuns
iXHProfRuns interface for getting/saving a XHProf run.
Clients can either use the default implementation, namely XHProfRuns_Default, of this interface or define their own implementation.
- Children
- \XHProfRuns_Default
- Author
- Kannan
Methods
get_run(
$run_id, $type, $run_desc
)
:
voidReturns XHProf data given a run id ($run) of a given type ($type).
Also, a brief description of the run is returned via the $run_desc out parameter.
| Name | Type | Description |
|---|---|---|
| $run_id | ||
| $type | ||
| $run_desc |
save_run(
$xhprof_data, $type, $run_id
=
null
)
:
voidSave XHProf data for a profiler run of specified type ($type).
The caller may optionally pass in run_id (which they promise to be unique). If a run_id is not passed in, the implementation of this method must generated a unique run id for this saved XHProf run.
Returns the run id for the saved XHProf run.
| Name | Type | Description |
|---|---|---|
| $xhprof_data | ||
| $type | ||
| $run_id |