Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheck Class Reference

Wrapper around an ItemRevisionMetadataRetriever and ConditionalHeaderUtil to check whether a request meets the preconditions for a certain response code. More...

Collaboration diagram for Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheck:

Public Member Functions
	__construct (ItemRevisionMetadataRetriever $metadataRetriever, callable $getItemIdFromRequest, ConditionalHeaderUtil $conditionalHeaderUtil)
	checkPreconditions (RequestInterface $request)

Static Public Member Functions
static	getItemIdPrefixFromStatementId (string $statementId)
	Convenience function to use with the $getItemIdFromRequest callable and dealing with statement IDs. More...

Private Member Functions
	getStatusCodeFromRequestAndMetadata (RequestInterface $request, LatestItemRevisionMetadataResult $revisionMetadata)

Private Attributes
ItemRevisionMetadataRetriever	$metadataRetriever
	$getItemIdFromRequest
ConditionalHeaderUtil	$conditionalHeaderUtil

Detailed Description

Wrapper around an ItemRevisionMetadataRetriever and ConditionalHeaderUtil to check whether a request meets the preconditions for a certain response code.

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheck::__construct	(	ItemRevisionMetadataRetriever	$metadataRetriever,
		callable	$getItemIdFromRequest,
		ConditionalHeaderUtil	$conditionalHeaderUtil
	)

Member Function Documentation

checkPreconditions()

Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheck::checkPreconditions

(

RequestInterface

$request

)

getItemIdPrefixFromStatementId()

static Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheck::getItemIdPrefixFromStatementId ( string  $statementId )

static

Convenience function to use with the $getItemIdFromRequest callable and dealing with statement IDs.

getStatusCodeFromRequestAndMetadata()

Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheck::getStatusCodeFromRequestAndMetadata ( RequestInterface  $request, LatestItemRevisionMetadataResult  $revisionMetadata  )

private

Returns

int|null The status code to return without processing the request further, or null to continue processing the request.

Member Data Documentation

$conditionalHeaderUtil

ConditionalHeaderUtil Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheck::$conditionalHeaderUtil

private

$getItemIdFromRequest

Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheck::$getItemIdFromRequest

private

$metadataRetriever

ItemRevisionMetadataRetriever Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheck::$metadataRetriever

private

---

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

• repo/rest-api/src/RouteHandlers/Middleware/RequestPreconditionCheck.php