MediaWiki  master
MediaWiki\Rest\Handler\LatestPageContentHandler Class Reference
Inheritance diagram for MediaWiki\Rest\Handler\LatestPageContentHandler:
Collaboration diagram for MediaWiki\Rest\Handler\LatestPageContentHandler:

Public Member Functions

 __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

 constructMetadata (Title $titleObject, RevisionRecord $revision)
 
 getLatestRevision ()
 
 getTitle ()
 
 isAccessible ( $titleObject)
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler
 getConditionalHeaderUtil ()
 Get a ConditionalHeaderUtil object. More...
 
 getETag ()
 The subclass should override this to provide an ETag for the current request. More...
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getLastModified ()
 The subclass should override this to provide the maximum last modified timestamp for the current request. 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...
 

Protected Attributes

Config $config
 
PermissionManager $permissionManager
 
RevisionLookup $revisionLookup
 
TitleFormatter $titleFormatter
 
User $user
 

Private Attributes

RevisionRecord bool $latestRevision
 
Title bool $titleObject
 

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

Definition at line 16 of file LatestPageContentHandler.php.

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ constructMetadata()

◆ getLatestRevision()

◆ getParamSettings()

MediaWiki\Rest\Handler\LatestPageContentHandler::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.

Stable to override

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

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 113 of file LatestPageContentHandler.php.

◆ getTitle()

◆ isAccessible()

MediaWiki\Rest\Handler\LatestPageContentHandler::isAccessible (   $titleObject)
protected

◆ needsWriteAccess()

MediaWiki\Rest\Handler\LatestPageContentHandler::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 109 of file LatestPageContentHandler.php.

Member Data Documentation

◆ $config

Config MediaWiki\Rest\Handler\LatestPageContentHandler::$config
protected

◆ $latestRevision

RevisionRecord bool MediaWiki\Rest\Handler\LatestPageContentHandler::$latestRevision
private

◆ $permissionManager

PermissionManager MediaWiki\Rest\Handler\LatestPageContentHandler::$permissionManager
protected

◆ $revisionLookup

RevisionLookup MediaWiki\Rest\Handler\LatestPageContentHandler::$revisionLookup
protected

◆ $titleFormatter

TitleFormatter MediaWiki\Rest\Handler\LatestPageContentHandler::$titleFormatter
protected

◆ $titleObject

◆ $user

User MediaWiki\Rest\Handler\LatestPageContentHandler::$user
protected

Definition at line 31 of file LatestPageContentHandler.php.


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