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 the backing store for all ProfilerOutput instances that have one.
	logDataPageOutputOnly ()
	Log the data to the script/request output for all ProfilerOutput instances that do so.
	scopedProfileIn ( $section)
	Mark the start of a custom profiling frame (e.g.
Public Member Functions inherited from Profiler
	__construct (array $params)
	getAllowOutput ()
	Whether appending profiles is allowed.
	getContentType ()
	Get the Content-Type for deciding how to format appended profile output.
	getContext ()
	getProfileID ()
	getTransactionProfiler ()
	scopedProfileOut (SectionProfileCallback &$section=null)
	setAllowOutput ()
	Enable appending profiles to standard output.
	setContext ( $context)
	setProfileID ( $id)

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.
LoggerInterface	$logger
array	$params = []
	All of the params passed from $wgProfiler.
string bool	$profileID = false
	Profiler ID for bucketing data.
TransactionProfiler	$trxProfiler

Detailed Description

Stub profiler that does nothing.

Definition at line 26 of file ProfilerStub.php.

Member Function Documentation

close()

ProfilerStub::close

(

)

Close opened profiling sections.

Reimplemented from Profiler.

Definition at line 39 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 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 31 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 35 of file ProfilerStub.php.

logData()

ProfilerStub::logData

(

)

Log the data to the backing store for all ProfilerOutput instances that have one.

Since

1.25

Reimplemented from Profiler.

Definition at line 42 of file ProfilerStub.php.

logDataPageOutputOnly()

ProfilerStub::logDataPageOutputOnly

(

)

Log the data to the script/request output for all ProfilerOutput instances that do so.

Exceptions

MWException

Since

1.26

Reimplemented from Profiler.

Definition at line 45 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 27 of file ProfilerStub.php.

---

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

• includes/profiler/ProfilerStub.php