MediaWiki\Rest\Handler\PageSourceHandler Class Reference

Handler class for Core REST API Page Source endpoint with the following routes: More...

Inherits MediaWiki\Rest\SimpleHandler.

Collaboration diagram for MediaWiki\Rest\Handler\PageSourceHandler:

Public Member Functions
	__construct (TitleFormatter $titleFormatter, RedirectStore $redirectStore, PageRestHelperFactory $helperFactory)
	getParamSettings ()
	Fetch ParamValidator settings for parameters.
	needsWriteAccess ()
	Indicates whether this route requires write access.
	run ()
Public Member Functions inherited from MediaWiki\Rest\SimpleHandler
	execute ()
	Execute the handler.
Public Member Functions inherited from MediaWiki\Rest\Handler
	applyCacheControl (ResponseInterface $response)
	Apply cache control to enforce privacy.
	applyConditionalResponseHeaders (ResponseInterface $response)
	Apply verifier headers to the response, per RFC 7231 §7.2.
	checkPreconditions ()
	Check the conditional request headers and generate a response if appropriate.
	checkSession ()
	Check the session (and session provider)
	getAuthority ()
	Get the current acting authority.
	getBodyValidator ( $contentType)
	Fetch the BodyValidator.
	getConfig ()
	Get the configuration array for the current route.
	getPath ()
	Returns the path this handler is bound to, including path variables.
	getRequest ()
	Get the current request.
	getResponseFactory ()
	Get the ResponseFactory which can be used to generate Response objects.
	getSession ()
	Get the Session.
	getValidatedBody ()
	Fetch the validated body.
	getValidatedParams ()
	Fetch the validated parameters.
	init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session)
	Initialise with dependencies from the Router.
	needsReadAccess ()
	Indicates whether this route requires read rights.
	requireSafeAgainstCsrf ()
	Indicates whether this route can be accessed only by session providers safe vs csrf.
	validate (Validator $restValidator)
	Validate the request parameters/attributes and body.

Protected Member Functions
	getETag ()
	Returns an ETag representing a page's source.
	getLastModified ()
	hasRepresentation ()
	postValidationSetup ()
	The handler can override this to do any necessary setup after validate() has been called.
Protected Member Functions inherited from MediaWiki\Rest\Handler
	getConditionalHeaderUtil ()
	Get a ConditionalHeaderUtil object.
	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata.
	getHookRunner ()
	Get a HookRunner for running core hooks.
	getRouter ()
	Get the Router.
	getRouteUrl ( $pathParams=[], $queryParams=[])
	Get the URL of this handler's endpoint.
	postInitSetup ()
	The handler can override this to do any necessary setup after init() is called to inject the dependencies.
	urlEncodeTitle ( $title)
	URL-encode titles in a "pretty" way.

Additional Inherited Members
Public Attributes inherited from MediaWiki\Rest\Handler
trait	PageRedirectHandlerTrait
	Important: this trait should be used for implementations of the Handler class.
const	PARAM_SOURCE = 'rest-param-source'
	(string) ParamValidator constant to specify the source of the parameter.

Detailed Description

Handler class for Core REST API Page Source endpoint with the following routes:

• /page/{title}
• /page/{title}/bare

Definition at line 21 of file PageSourceHandler.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Rest\Handler\PageSourceHandler::__construct	(	TitleFormatter	$titleFormatter,
		RedirectStore	$redirectStore,
		PageRestHelperFactory	$helperFactory )

Definition at line 33 of file PageSourceHandler.php.

References MediaWiki\Rest\Handler\Helper\PageRestHelperFactory\newPageContentHelper().

Member Function Documentation

getETag()

MediaWiki\Rest\Handler\PageSourceHandler::getETag ( )

protected

Returns an ETag representing a page's source.

The ETag assumes a page's source has changed if the latest revision of a page has been made private, un-readable for another reason, or a newer revision exists.

Returns

string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 121 of file PageSourceHandler.php.

getLastModified()

MediaWiki\Rest\Handler\PageSourceHandler::getLastModified ( )

protected

Returns

string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 128 of file PageSourceHandler.php.

getParamSettings()

MediaWiki\Rest\Handler\PageSourceHandler::getParamSettings

(

)

Fetch ParamValidator settings for parameters.

Every setting must include self::PARAM_SOURCE to specify which part of the request is to contain the parameter.

Can be used for validating parameters inside an application/x-www-form-urlencoded or multipart/form-data POST body (i.e. parameters which would be present in PHP's $_POST array). For validating other kinds of request bodies, override getBodyValidator().

Stability: stable

to override

Returns

array[] Associative array mapping parameter names to ParamValidator settings arrays

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 140 of file PageSourceHandler.php.

hasRepresentation()

MediaWiki\Rest\Handler\PageSourceHandler::hasRepresentation ( )

protected

Returns

bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 147 of file PageSourceHandler.php.

needsWriteAccess()

MediaWiki\Rest\Handler\PageSourceHandler::needsWriteAccess

(

)

Indicates whether this route requires write access.

The handler should override this if the route does not need to write to the database.

This should return true for routes that may require synchronous database writes. Modules that do not need such writes should also not rely on primary database access, since only read queries are needed and each primary DB is a single point of failure.

Stability: stable

to override

Returns

bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 136 of file PageSourceHandler.php.

postValidationSetup()

MediaWiki\Rest\Handler\PageSourceHandler::postValidationSetup ( )

protected

The handler can override this to do any necessary setup after validate() has been called.

This gives the handler an opportunity to do initialization based on parameters before pre-execution calls like getLastModified() or getETag().

Stability: stable

to override

Since

1.36

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 43 of file PageSourceHandler.php.

References MediaWiki\Rest\Handler\getAuthority(), and MediaWiki\Rest\Handler\getValidatedParams().

run()

MediaWiki\Rest\Handler\PageSourceHandler::run

(

)

Returns

Response

Exceptions

LocalizedHttpException

Definition at line 62 of file PageSourceHandler.php.

---

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

• includes/Rest/Handler/PageSourceHandler.php