MediaWiki Class Reference

Classes
class	MediaWikiServices
class	OutputHandler

Public Member Functions
	__construct (IContextSource $context=null)
	getTitle ()
	getAction ()
	run ()
	doPreOutputCommit (callable $postCommitWork=null)
	doPostOutputShutdown ($mode= 'normal')
	restInPeace ($mode= 'fast', $blocksHttpClient=true)
	triggerJobs ()

Static Public Member Functions
static	preOutputCommit (IContextSource $context, callable $postCommitWork=null)
static	emitBufferedStatsdData (IBufferingStatsdDataFactory $stats, Config $config)

Detailed Description

The MediaWiki class is the helper class for the index.php entry point.

Constructor & Destructor Documentation

MediaWiki::__construct

(

IContextSource

$context = null

)

Parameters

IContextSource | null

$context

Member Function Documentation

MediaWiki::doPostOutputShutdown

(

$mode = 'normal'

)

This function does work that can be done after the user gets the HTTP response so they don't block on it

This manages deferred updates, job insertion, final commit, and the logging of profiling data

Parameters

string

$mode

Use 'fast' to always skip job running

Since

1.26

PhpUnusedLocalVariableInspection

PhpUnusedLocalVariableInspection

MediaWiki::doPreOutputCommit

(

callable

$postCommitWork = null

)

See Also

MediaWiki::preOutputCommit()

Parameters

callable

$postCommitWork

[default: null]

Since

1.26

static MediaWiki::emitBufferedStatsdData ( IBufferingStatsdDataFactory  $stats, Config  $config  )

static

Send out any buffered statsd data according to sampling rules

Parameters

IBufferingStatsdDataFactory	$stats
Config	$config

Exceptions

ConfigException

Since

1.31

MediaWiki::getAction

(

)

Returns the name of the action that will be executed.

Returns

string Action

MediaWiki::getTitle

(

)

Get the Title object that we'll be acting on, as specified in the WebRequest

Returns

Title

static MediaWiki::preOutputCommit ( IContextSource  $context, callable  $postCommitWork = null  )

static

This function commits all DB changes as needed before the user can receive a response (in case commit fails)

Parameters

IContextSource	$context
callable	$postCommitWork	[default: null]

Since

1.27

MediaWiki::restInPeace	(		$mode = 'fast',
			$blocksHttpClient = true
	)

Ends this task peacefully

Parameters

string	$mode	Use 'fast' to always skip job running
bool	$blocksHttpClient	Whether this blocks an HTTP response to a client

MediaWiki::run

(

)

Run the current MediaWiki instance; index.php just calls this

MediaWiki::triggerJobs

(

)

Potentially open a socket and sent an HTTP request back to the server to run a specified number of jobs. This registers a callback to cleanup the socket once it's done.

---

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

• /home/hwfunc/workspace/leonid/BlueSpiceDoc-composer/mediawiki-master/includes/MediaWiki.php