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

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

Public Member Functions
	getRevisionMetadata ()
	Guaranteed to return a concrete revision result if the request headers match the latest revision, e.g. More...
	getStatusCode ()
	Returns the status code if the request headers match the latest revision, e.g. More...

Static Public Member Functions
static	newConditionMetResult (LatestItemRevisionMetadataResult $revisionMetadata, int $statusCode)
static	newConditionUnmetResult ()

Private Member Functions
	__construct (?LatestItemRevisionMetadataResult $revisionMetadata, ?int $statusCode)

Private Attributes
LatestItemRevisionMetadataResult	$revisionMetadata
int	$statusCode

Detailed Description

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheckResult::__construct ( ?LatestItemRevisionMetadataResult  $revisionMetadata, ?int  $statusCode  )

private

Member Function Documentation

getRevisionMetadata()

Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheckResult::getRevisionMetadata

(

)

Guaranteed to return a concrete revision result if the request headers match the latest revision, e.g.

when sending an If-None-Match header containing the latest revision ID. Returns null if there was no match.

getStatusCode()

Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheckResult::getStatusCode

(

)

Returns the status code if the request headers match the latest revision, e.g.

304 when sending an If-None-Match header containing the latest revision ID. Returns null if there was no match.

newConditionMetResult()

static Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheckResult::newConditionMetResult ( LatestItemRevisionMetadataResult  $revisionMetadata, int  $statusCode  )

static

newConditionUnmetResult()

static Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheckResult::newConditionUnmetResult ( )

static

Member Data Documentation

$revisionMetadata

LatestItemRevisionMetadataResult Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheckResult::$revisionMetadata

private

$statusCode

int Wikibase\Repo\RestApi\RouteHandlers\Middleware\RequestPreconditionCheckResult::$statusCode

private

---

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

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