Inherited by MediaWiki\Rest\Handler\SitemapIndexHandler, and MediaWiki\Rest\Handler\SitemapPageHandler.

Collaboration diagram for MediaWiki\Rest\Handler\SitemapHandlerBase:

Public Member Functions
	execute ()
	Execute the handler.This is called after parameter validation. The return value can either be a Response or any type accepted by ResponseFactory::createFromReturnValue().To automatically construct an error response, execute() should throw a \MediaWiki\Rest\HttpException. Such exceptions will not be logged like a normal exception.If execute() throws any other kind of exception, the exception will be logged and a generic 500 error page will be shown. Stability: stable to override Returns mixed

	getResponseHeaderSettings ()
	Fetch the settings array mapping response headers to their descriptions and schemas.Subclasses that return other headers should extend this function. Subclasses that use Response headers not defined in the ResponseHeaders class can hardcode the headers names as keys in this function as well. Stability: stable to override Returns array[] List of Response headers as constants from ResponseHeaders class

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.

	applyDeprecationHeader (ResponseInterface $response)
	Apply Deprecation header per RFC 9745.

	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.

	getBodyParamSettings ()
	Fetch ParamValidator settings for body fields.

	getBodyValidator ( $contentType)
	Fetch the BodyValidator.

	getConfig ()
	Get the configuration array for the current route.

	getHeaderParamSettings ()
	Fetch ParamValidator settings for request headers.

	getOpenApiSpec (string $method)
	Returns an OpenAPI Operation Object specification structure as an associative array.

	getParamSettings ()
	Fetch ParamValidator settings for parameters.

	getPath ()
	Returns the path this handler is bound to relative to the module prefix.

	getRequest ()
	Get the current request.

	getResponseFactory ()
	Get the ResponseFactory which can be used to generate Response objects.

	getSession ()
	Get the Session.

	getSupportedPathParams ()
	Get a list of parameter placeholders present in the route's path as returned by getPath().

	getSupportedRequestTypes ()
	Returns the content types that should be accepted by parseBodyData().

	getValidatedBody ()
	Fetch the validated body.

	getValidatedParams ()
	Fetch the validated parameters.

	initContext (Module $module, string $path, array $routeConfig, array $openApiSpec=[])
	Injects information about the handler's context in the Module.

	initForExecute (RequestInterface $request)
	Initialise for execution based on the given request.

	initServices (Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer)
	Inject service objects.

	initSession (Session $session)
	Inject session information.

	needsReadAccess ()
	Indicates whether this route requires read rights.

	needsWriteAccess ()
	Indicates whether this route requires write access to the wiki.

	parseBodyData (RequestInterface $request)
	Returns the parsed body of the request.

	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
	__construct (Config $config, protected LanguageConverterFactory $languageConverterFactory, protected Language $contLang, private PermissionManager $permissionManager,)

	generateResponseSpec (string $method)
	Returns an OpenAPI Responses Object specification structure as an associative array.

	getOffset ( $indexId, $pageId)

	getResponseExample ()

	getResponseSchema ()

	getXml ()

Protected Member Functions inherited from MediaWiki\Rest\Handler
	detectExtraneousBodyFields (Validator $restValidator)
	Subclasses may override this to disable or modify checks for extraneous body fields.

	getConditionalHeaderUtil ()
	Get a ConditionalHeaderUtil object.

	getDeprecatedDate ()
	Returns the timestamp at which this was or will be deprecated, or null if none.

	getETag ()
	The subclass should override this to provide an ETag for the current state of the requested resource.

	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata.

	getHookRunner ()
	Get a HookRunner for running core hooks.

	getJsonLocalizer ()
	Get a JsonLocalizer object.

	getLastModified ()
	The subclass should override this to provide the maximum last modified timestamp of the requested resource.

	getModule ()
	Get the Module this handler belongs to.

	getRequestBodySchema (string $mediaType)
	Returns a content schema per the OpenAPI spec.

	getRequestSpec (string $method)
	Returns an OpenAPI Request Body Object specification structure as an associative array.

	getResponseBodySchema (string $method)
	Returns an OpenAPI Schema Object specification structure as an associative array.

	getResponseBodySchemaFileName (string $method)
	Returns the absolute path of a JSON file containing an OpenAPI Schema Object specification structure describing the response body.

	getRouter ()

	getRouteUrl ( $pathParams=[], $queryParams=[])
	Get the URL of this handler's endpoint.

	hasRepresentation ()
	The subclass should override this to indicate whether the resource exists.

	isDeprecated ()
	Indicates whether this is deprecated.

	postInitSetup ()
	The handler can override this to do any necessary setup after the init functions are called to inject dependencies.

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

	urlEncodeTitle ( $title)
	URL-encode titles in a "pretty" way.

Protected Attributes
bool	$enabled

int	$expiry

int	$indexSize

int	$sitemapSize

Additional Inherited Members
Public Attributes inherited from MediaWiki\Rest\Handler
const	KNOWN_PARAM_SOURCES = Validator::KNOWN_PARAM_SOURCES

const	OPENAPI_DESCRIPTION_KEY = 'description'

const	PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION

const	PARAM_SOURCE = Validator::PARAM_SOURCE

Detailed Description

Definition at line 17 of file SitemapHandlerBase.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\SitemapHandlerBase::__construct	(	Config	$config,
		protected LanguageConverterFactory	$languageConverterFactory,
		protected Language	$contLang,
		private PermissionManager	$permissionManager )

protected

Definition at line 26 of file SitemapHandlerBase.php.

References MediaWiki\Config\Config\get(), and MediaWiki\MainConfigNames\SitemapApiConfig.

Member Function Documentation

◆ execute()

MediaWiki\Rest\Handler\SitemapHandlerBase::execute ( )

Execute the handler.This is called after parameter validation. The return value can either be a Response or any type accepted by ResponseFactory::createFromReturnValue().To automatically construct an error response, execute() should throw a \MediaWiki\Rest\HttpException. Such exceptions will not be logged like a normal exception.If execute() throws any other kind of exception, the exception will be logged and a generic 500 error page will be shown.

Stability: stable: to override

Returns: mixed

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 61 of file SitemapHandlerBase.php.

References MediaWiki\Rest\HeaderParser\HttpDate\format(), MediaWiki\Rest\Handler\getLastModified(), and MediaWiki\Rest\Handler\getResponseFactory().

◆ generateResponseSpec()

MediaWiki\Rest\Handler\SitemapHandlerBase::generateResponseSpec ( string $method )

protected

Returns an OpenAPI Responses Object specification structure as an associative array.

See also: https://swagger.io/specification/#responses-object

By default, this will contain basic information response for status 200, 400, and 500. The getResponseBodySchema() method is used to determine the structure of the response for status 200.

Subclasses may override this to provide additional information about the structure of responses.

Parameters

string $method The HTTP method to produce a spec for ("get", "post", etc).

Stability: stable: to override

Returns: array

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 49 of file SitemapHandlerBase.php.

◆ getOffset()

MediaWiki\Rest\Handler\SitemapHandlerBase::getOffset	(		$indexId,
			$pageId )

protected

Parameters

int	$indexId
int	$pageId

Returns: int

Definition at line 45 of file SitemapHandlerBase.php.

◆ getResponseExample()

MediaWiki\Rest\Handler\SitemapHandlerBase::getResponseExample ( )

abstractprotected

Reimplemented in MediaWiki\Rest\Handler\SitemapIndexHandler, and MediaWiki\Rest\Handler\SitemapPageHandler.

◆ getResponseHeaderSettings()

MediaWiki\Rest\Handler\SitemapHandlerBase::getResponseHeaderSettings ( )

Fetch the settings array mapping response headers to their descriptions and schemas.Subclasses that return other headers should extend this function. Subclasses that use Response headers not defined in the ResponseHeaders class can hardcode the headers names as keys in this function as well.

Stability: stable: to override

Returns: array[] List of Response headers as constants from ResponseHeaders class

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 85 of file SitemapHandlerBase.php.

References MediaWiki\Rest\Handler\getResponseHeaderSettings().

◆ getResponseSchema()

MediaWiki\Rest\Handler\SitemapHandlerBase::getResponseSchema ( )

abstractprotected

Reimplemented in MediaWiki\Rest\Handler\SitemapIndexHandler, and MediaWiki\Rest\Handler\SitemapPageHandler.

◆ getXml()

MediaWiki\Rest\Handler\SitemapHandlerBase::getXml ( )

abstractprotected

Reimplemented in MediaWiki\Rest\Handler\SitemapIndexHandler, and MediaWiki\Rest\Handler\SitemapPageHandler.

Member Data Documentation

◆ $enabled

bool MediaWiki\Rest\Handler\SitemapHandlerBase::$enabled

protected

Definition at line 18 of file SitemapHandlerBase.php.

◆ $expiry

int MediaWiki\Rest\Handler\SitemapHandlerBase::$expiry

protected

Definition at line 24 of file SitemapHandlerBase.php.

◆ $indexSize

int MediaWiki\Rest\Handler\SitemapHandlerBase::$indexSize

protected

Definition at line 20 of file SitemapHandlerBase.php.

◆ $sitemapSize

int MediaWiki\Rest\Handler\SitemapHandlerBase::$sitemapSize

protected

Definition at line 22 of file SitemapHandlerBase.php.

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

includes/Rest/Handler/SitemapHandlerBase.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ generateResponseSpec()

◆ getOffset()

◆ getResponseExample()

◆ getResponseHeaderSettings()

◆ getResponseSchema()

◆ getXml()

Member Data Documentation

◆ $enabled

◆ $expiry

◆ $indexSize

◆ $sitemapSize