Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
XHProfRuns_Default Class Reference

XHProfRuns_Default is the default implementation of the iXHProfRuns interface for saving/fetching XHProf runs. More...

Inheritance diagram for XHProfRuns_Default:
iXHProfRuns

Public Member Functions

 __construct ($dir=null)
 
 get_run ($run_id, $type, &$run_desc)
 Returns XHProf data given a run id ($run) of a given type ($type).
 
 list_runs ()
 
 save_run ($xhprof_data, $type, $run_id=null)
 Save XHProf data for a profiler run of specified type ($type).
 

Detailed Description

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.

Author
Kannan

Member Function Documentation

◆ get_run()

XHProfRuns_Default::get_run ( $run_id,
$type,
& $run_desc )

Returns 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.

Implements iXHProfRuns.

◆ save_run()

XHProfRuns_Default::save_run ( $xhprof_data,
$type,
$run_id = null )

Save 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.

Implements iXHProfRuns.


The documentation for this class was generated from the following file: