MediaWiki Class Reference

Backwards compatibility shim for use by extensions that created a MediaWiki object just in order to call doPostOutputShutdown(). More...

Inherits MediaWiki\MediaWikiEntryPoint.

Collaboration diagram for MediaWiki:

Public Member Functions
	__construct (?IContextSource $context=null, ?EntryPointEnvironment $environment=null)
	doPostOutputShutdown ()
	Overwritten to make public, for backwards compatibility.
	restInPeace ()
	Overwritten to make public, for backwards compatibility.
Public Member Functions inherited from MediaWiki\MediaWikiEntryPoint
	__construct (IContextSource $context, EntryPointEnvironment $environment, MediaWikiServices $mediaWikiServices)
	enableOutputCapture ()
	Enable capturing of the current output buffer.
	getCapturedOutput ()
	Stop capturing and return all output.
	getRequestPathSuffix ( $basePath)
	If the request URL matches a given base path, extract the path part of the request URL after that base, and decode escape sequences in it.
	run ()
	Main app life cycle: Calls doSetup(), execute(), prepareForOutput(), and postOutputShutdown().

Static Public Member Functions
static	preOutputCommit (IContextSource $context)
	This function commits all DB and session changes as needed before the client can receive a response (in case DB commit fails) and thus also before the response can trigger a subsequent related request by the client.
Static Public Member Functions inherited from MediaWiki\MediaWikiEntryPoint
static	emitBufferedStats (StatsFactory $statsFactory)
	Send out any buffered stats according to sampling rules.

Protected Member Functions
	execute ()
Protected Member Functions inherited from MediaWiki\MediaWikiEntryPoint
	commitMainTransaction ()
	This function commits all DB and session changes as needed before the client can receive a response (in case DB commit fails) and thus also before the response can trigger a subsequent related request by the client.
	commitOutputBuffer ()
	Ends the current output buffer, appending its content to the parent buffer.
	disableModDeflate ()
	discardAllOutput ()
	Discards all buffered output, down to the capture buffer level.
	discardOutputBuffer ()
	doPrepareForOutput ()
	Prepare for sending the output.
	doSetup ()
	Perform any setup needed before execute() is called.
	drainOutputBuffer ()
	Returns the content of the current output buffer and clears it.
	enterPostSendMode ()
	Disables all output to the client.
	exit (int $code=0)
	fastCgiFinishRequest ()
	Calls fastcgi_finish_request if possible.
	flushOutputBuffer ()
	Flush buffered output to the client.
	getBlockManager ()
	getConfig (string $key)
	getContext ()
	getDBLoadBalancerFactory ()
	getEnv (string $name)
	Returns the value of an environment variable.
	getIni (string $name)
	Returns the value of an ini option.
	getJobQueueGroupFactory ()
	getJobRunner ()
	getMessageCache ()
	getOutputBufferLength ()
	getOutputBufferLevel ()
	Returns the output buffer level.
	getOutputBufferStatus ()
	getReadOnlyMode ()
	getRequest ()
	getRequestURL ()
	Returns the current request's path and query string (not a full URL), like PHP's built-in $_SERVER['REQUEST_URI'].
	getResponse ()
	getServerInfo (string $key, $default=null)
	getServiceContainer ()
	Returns the main service container.
	getSpecialPageFactory ()
	getStatsdDataFactory ()
	getStatsFactory ()
	getStatusCode ()
	getUrlUtils ()
	handleTopLevelError (Throwable $e)
	Report a top level error.
	hasFastCgi ()
	header (string $header, bool $replace=true, int $status=0)
	inPostSendMode ()
	Whether enterPostSendMode() has been called.
	isCli ()
	outputResponsePayload ( $content)
	Print a response body to the current buffer (if there is one) or the server (otherwise)
	postOutputShutdown ()
	Forces the response to be sent to the client and then does work that can be done after the user gets the HTTP response, so they don't block on it.
	prepareForOutput ()
	Prepare for sending the output.
	print ( $data)
	schedulePostSendJobs ()
	If enabled, after everything specific to this request is done, occasionally run jobs.
	setIniOption (string $name, $value)
	setup ()
	Perform any setup needed before execute() is called.
	shouldDoHttpRedirect ()
	Check if an HTTP->HTTPS redirect should be done.
	startOutputBuffer (?callable $callback=null)
	Adds a new output buffer level.
	status (int $code)
	triggerAsyncJobs ( $n, LoggerInterface $runJobsLogger)
	triggerError (string $message, int $level=E_USER_NOTICE)
	Triggers a PHP runtime error.
	triggerSyncJobs ( $n)

Additional Inherited Members
Protected Attributes inherited from MediaWiki\MediaWikiEntryPoint
EntryPointEnvironment	$environment

Detailed Description

Backwards compatibility shim for use by extensions that created a MediaWiki object just in order to call doPostOutputShutdown().

Deprecated

since 1.42, use MediaWikiEntryPoint instead

Definition at line 35 of file MediaWiki.php.

Constructor & Destructor Documentation

__construct()

MediaWiki::__construct	(	?IContextSource	$context = null,
		?EntryPointEnvironment	$environment = null )

Definition at line 37 of file MediaWiki.php.

References MediaWiki\MediaWikiEntryPoint\$environment, and MediaWiki\MediaWikiServices\getInstance().

Member Function Documentation

doPostOutputShutdown()

MediaWiki::doPostOutputShutdown

(

)

Overwritten to make public, for backwards compatibility.

Deprecated

since 1.42, extensions should have no need to call this.

Reimplemented from MediaWiki\MediaWikiEntryPoint.

Definition at line 72 of file MediaWiki.php.

execute()

MediaWiki::execute ( )

protected

Returns

never

Reimplemented from MediaWiki\MediaWikiEntryPoint.

Definition at line 50 of file MediaWiki.php.

preOutputCommit()

static MediaWiki::preOutputCommit ( IContextSource $context )

static

This function commits all DB and session changes as needed before the client can receive a response (in case DB commit fails) and thus also before the response can trigger a subsequent related request by the client.

Parameters

IContextSource

$context

Since

1.27

Deprecated

since 1.42, extensions should have no need to call this. Subclasses of MediaWikiEntryPoint in core should generally call prepareForOutput() instead.

Definition at line 88 of file MediaWiki.php.

restInPeace()

MediaWiki::restInPeace

(

)

Overwritten to make public, for backwards compatibility.

Deprecated

since 1.42, extensions should have no need to call this. Subclasses of MediaWikiEntryPoint in core should generally call postOutputShutdown() instead.

Reimplemented from MediaWiki\MediaWikiEntryPoint.

Definition at line 63 of file MediaWiki.php.

---

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

• includes/MediaWiki.php