MediaWiki REL1_32
ProfilerStub Class Reference

Stub profiler that does nothing. More...

Inheritance diagram for ProfilerStub:
Collaboration diagram for ProfilerStub:

Public Member Functions

 close ()
 Close opened profiling sections.
 
 getFunctionStats ()
 Get the aggregated inclusive profiling data for each method.
 
 getOutput ()
 Returns a profiling output to be stored in debug file.
 
 logData ()
 Log the data to some store or even the page output.
 
 logDataPageOutputOnly ()
 Output current data to the page output if configured to do so.
 
 scopedProfileIn ( $section)
 Mark the start of a custom profiling frame (e.g.
 
- Public Member Functions inherited from Profiler
 __construct (array $params)
 
 getContentType ()
 Get the content type sent out to the client.
 
 getContext ()
 Gets the context for this Profiler.
 
 getProfileID ()
 
 getTemplated ()
 Was this call as templated or not.
 
 getTransactionProfiler ()
 
 profileIn ( $functionname)
 
 profileOut ( $functionname)
 
 scopedProfileOut (SectionProfileCallback &$section=null)
 
 setContext ( $context)
 Sets the context for this Profiler.
 
 setProfileID ( $id)
 
 setTemplated ( $t)
 Mark this call as templated or not.
 

Additional Inherited Members

- Static Public Member Functions inherited from Profiler
static instance ()
 Singleton.
 
static replaceStubInstance (Profiler $profiler)
 Replace the current profiler with $profiler if no non-stub profiler is set.
 
- Protected Attributes inherited from Profiler
IContextSource $context = null
 Current request context.
 
array $params = []
 All of the params passed from $wgProfiler.
 
string bool $profileID = false
 Profiler ID for bucketing data.
 
bool $templated = false
 Whether MediaWiki is in a SkinTemplate output context.
 
TransactionProfiler $trxProfiler
 

Detailed Description

Stub profiler that does nothing.

Definition at line 29 of file ProfilerStub.php.

Member Function Documentation

◆ close()

ProfilerStub::close ( )

Close opened profiling sections.

Reimplemented from Profiler.

Definition at line 40 of file ProfilerStub.php.

◆ getFunctionStats()

ProfilerStub::getFunctionStats ( )

Get the aggregated inclusive profiling data for each method.

The percent time for each time is based on the current "total" time used is based on all methods so far. This method can therefore be called several times in between several profiling calls without the delays in usage of the profiler skewing the results. A "-total" entry is always included in the results.

When a call chain involves a method invoked within itself, any entries for the cyclic invocation should be be demarked with "@". This makes filtering them out easier and follows the xhprof style.

Returns
array List of method entries arrays, each having:
  • name : method name
  • calls : the number of invoking calls
  • real : real time elapsed (ms)
  • real : percent real time
  • cpu : CPU time elapsed (ms)
  • cpu : percent CPU time
  • memory : memory used (bytes)
  • memory : percent memory used
  • min_real : min real time in a call (ms)
  • max_real : max real time in a call (ms)
Since
1.25

Reimplemented from Profiler.

Definition at line 34 of file ProfilerStub.php.

◆ getOutput()

ProfilerStub::getOutput ( )

Returns a profiling output to be stored in debug file.

Returns
string

Reimplemented from Profiler.

Definition at line 37 of file ProfilerStub.php.

◆ logData()

ProfilerStub::logData ( )

Log the data to some store or even the page output.

Since
1.25

Reimplemented from Profiler.

Definition at line 43 of file ProfilerStub.php.

◆ logDataPageOutputOnly()

ProfilerStub::logDataPageOutputOnly ( )

Output current data to the page output if configured to do so.

Exceptions
MWException
Since
1.26

Reimplemented from Profiler.

Definition at line 46 of file ProfilerStub.php.

◆ scopedProfileIn()

ProfilerStub::scopedProfileIn (   $section)

Mark the start of a custom profiling frame (e.g.

DB queries). The frame ends when the result of this method falls out of scope.

Parameters
string$section
Returns
ScopedCallback|null
Since
1.25

Reimplemented from Profiler.

Definition at line 30 of file ProfilerStub.php.


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