MediaWiki  master
MediaWiki\Rest\Handler\PageSourceHandler Class Reference

Handler class for Core REST API Page Source endpoint. More...

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

Public Member Functions

 run (string $title)
 
- Public Member Functions inherited from MediaWiki\Rest\Handler\LatestPageContentHandler
 __construct (Config $config, PermissionManager $permissionManager, RevisionLookup $revisionLookup, TitleFormatter $titleFormatter)
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. More...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
- 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 ()
 
 getPageContent (string $slotRole, RevisionRecord $revision)
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler\LatestPageContentHandler
 constructMetadata (Title $titleObject, RevisionRecord $revision)
 
 getLatestRevision ()
 
 getTitle ()
 
 isAccessible ( $titleObject)
 
- 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...
 
 hasRepresentation ()
 The subclass should override this to indicate whether the resource exists. 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

 getRole ()
 

Private Attributes

const MAX_AGE_200 = 5
 

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...
 
- Protected Attributes inherited from MediaWiki\Rest\Handler\LatestPageContentHandler
Config $config
 
PermissionManager $permissionManager
 
RevisionLookup $revisionLookup
 
TitleFormatter $titleFormatter
 
User $user
 

Detailed Description

Handler class for Core REST API Page Source endpoint.

Definition at line 17 of file PageSourceHandler.php.

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 95 of file PageSourceHandler.php.

References MediaWiki\Rest\Handler\LatestPageContentHandler\$latestRevision, Revision\RevisionRecord\getId(), MediaWiki\Rest\Handler\LatestPageContentHandler\getLatestRevision(), MediaWiki\Rest\Handler\LatestPageContentHandler\getTitle(), and MediaWiki\Rest\Handler\LatestPageContentHandler\isAccessible().

◆ getLastModified()

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 109 of file PageSourceHandler.php.

References MediaWiki\Rest\Handler\LatestPageContentHandler\getLatestRevision().

◆ getPageContent()

MediaWiki\Rest\Handler\PageSourceHandler::getPageContent ( string  $slotRole,
RevisionRecord  $revision 
)
protected
Parameters
string$slotRole
RevisionRecord$revision
Returns
TextContent $content
Exceptions
LocalizedHttpExceptionslot content is not TextContent or Revision/Slot is inaccessible

Definition at line 31 of file PageSourceHandler.php.

References $content, CONTENT_MODEL_TEXT, Revision\RevisionRecord\getId(), Revision\RevisionRecord\getSlot(), and Wikimedia\Message\MessageValue\new().

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

◆ getRole()

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

Definition at line 21 of file PageSourceHandler.php.

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

◆ run()

Member Data Documentation

◆ MAX_AGE_200

const MediaWiki\Rest\Handler\PageSourceHandler::MAX_AGE_200 = 5
private

Definition at line 18 of file PageSourceHandler.php.


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