MediaWiki  master
MediaWiki\Rest\Handler\PageSourceHandler Class Reference

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

Inheritance diagram for MediaWiki\Rest\Handler\PageSourceHandler:
Collaboration diagram for MediaWiki\Rest\Handler\PageSourceHandler:

Public Member Functions

 __construct (Config $config, PermissionManager $permissionManager, RevisionLookup $revisionLookup, TitleFormatter $titleFormatter, TitleFactory $titleFactory)
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. More...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
 run ()
 
- Public Member Functions inherited from MediaWiki\Rest\SimpleHandler
 execute ()
 Execute the handler. More...
 
- Public Member Functions inherited from MediaWiki\Rest\Handler
 applyConditionalResponseHeaders (ResponseInterface $response)
 Modify the response, adding Last-Modified and ETag headers as indicated the values previously returned by ETag and getLastModified(). More...
 
 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate. More...
 
 getBodyValidator ( $contentType)
 Fetch the BodyValidator. More...
 
 getConfig ()
 Get the configuration array for the current route. More...
 
 getRequest ()
 Get the current request. More...
 
 getResponseFactory ()
 Get the ResponseFactory which can be used to generate Response objects. More...
 
 getValidatedBody ()
 Fetch the validated body. More...
 
 getValidatedParams ()
 Fetch the validated parameters. More...
 
 init (Router $router, RequestInterface $request, array $config, ResponseFactory $responseFactory, HookContainer $hookContainer)
 Initialise with dependencies from the Router. More...
 
 needsReadAccess ()
 Indicates whether this route requires read rights. More...
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body. More...
 

Protected Member Functions

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

Private Member Functions

 constructHtmlUrl (Title $title)
 
 getOutputMode ()
 

Private Attributes

PageContentHelper $contentHelper
 

Additional Inherited Members

- Public Attributes inherited from MediaWiki\Rest\Handler
const PARAM_SOURCE = 'rest-param-source'
 (string) ParamValidator constant to specify the source of the parameter. More...
 

Detailed Description

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

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

Definition at line 23 of file PageSourceHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\PageSourceHandler::__construct ( Config  $config,
PermissionManager  $permissionManager,
RevisionLookup  $revisionLookup,
TitleFormatter  $titleFormatter,
TitleFactory  $titleFactory 
)

Definition at line 28 of file PageSourceHandler.php.

References MediaWiki\Rest\Handler\$config.

Member Function Documentation

◆ constructHtmlUrl()

MediaWiki\Rest\Handler\PageSourceHandler::constructHtmlUrl ( Title  $title)
private
Parameters
Title$title
Returns
string

Definition at line 54 of file PageSourceHandler.php.

References Title\getPrefixedText(), and MediaWiki\Rest\Handler\getRouter().

Referenced by MediaWiki\Rest\Handler\PageSourceHandler\run().

◆ 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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 101 of file PageSourceHandler.php.

◆ getLastModified()

MediaWiki\Rest\Handler\PageSourceHandler::getLastModified ( )
protected
Returns
string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 108 of file PageSourceHandler.php.

◆ getOutputMode()

MediaWiki\Rest\Handler\PageSourceHandler::getOutputMode ( )
private

◆ 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().

Stable to override

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 120 of file PageSourceHandler.php.

◆ hasRepresentation()

MediaWiki\Rest\Handler\PageSourceHandler::hasRepresentation ( )
protected
Returns
bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 127 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 master database access, since only read queries are needed and each master DB is a single point of failure.

Stable to override

Returns
bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 116 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().

Stable to override

Since
1.36

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 44 of file PageSourceHandler.php.

References RequestContext\getMain(), and MediaWiki\Rest\Handler\getValidatedParams().

◆ run()

Member Data Documentation

◆ $contentHelper

PageContentHelper MediaWiki\Rest\Handler\PageSourceHandler::$contentHelper
private

Definition at line 26 of file PageSourceHandler.php.


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