Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler Class Reference

Inheritance diagram for Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler:

Collaboration diagram for Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler:

Public Member Functions
	__construct (MiddlewareHandler $middlewareHandler, PatchItem $useCase, ItemSerializer $serializer, ResponseFactory $responseFactory)
	run (... $args)
	runUseCase (string $itemId)
	getSupportedRequestTypes ()
	validate (Validator $restValidator)
	getParamSettings ()
	getBodyParamSettings ()
	checkPreconditions ()
	Preconditions are checked via PreconditionMiddleware.

Static Public Member Functions
static	factory ()

Private Member Functions
	newSuccessHttpResponse (PatchItemResponse $useCaseResponse)
	getUsername ()

Private Attributes
const	ITEM_ID_PATH_PARAM = 'item_id'
const	PATCH_BODY_PARAM = 'patch'
const	TAGS_BODY_PARAM = 'tags'
const	BOT_BODY_PARAM = 'bot'
const	COMMENT_BODY_PARAM = 'comment'
MiddlewareHandler	$middlewareHandler
PatchItem	$useCase
ItemSerializer	$serializer
ResponseFactory	$responseFactory

Detailed Description

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::__construct	(	MiddlewareHandler	$middlewareHandler,
		PatchItem	$useCase,
		ItemSerializer	$serializer,
		ResponseFactory	$responseFactory )

Member Function Documentation

checkPreconditions()

Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::checkPreconditions

(

)

Preconditions are checked via PreconditionMiddleware.

factory()

static Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::factory ( )

static

getBodyParamSettings()

Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::getBodyParamSettings

(

)

getParamSettings()

Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::getParamSettings

(

)

getSupportedRequestTypes()

Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::getSupportedRequestTypes

(

)

getUsername()

Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::getUsername ( )

private

newSuccessHttpResponse()

Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::newSuccessHttpResponse ( PatchItemResponse $useCaseResponse )

private

run()

Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::run

(

$args

)

Parameters

mixed

...$args

runUseCase()

Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::runUseCase

(

string

$itemId

)

validate()

Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::validate

(

Validator

$restValidator

)

Member Data Documentation

$middlewareHandler

MiddlewareHandler Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::$middlewareHandler

private

$responseFactory

ResponseFactory Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::$responseFactory

private

$serializer

ItemSerializer Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::$serializer

private

$useCase

PatchItem Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::$useCase

private

BOT_BODY_PARAM

const Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::BOT_BODY_PARAM = 'bot'

private

COMMENT_BODY_PARAM

const Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::COMMENT_BODY_PARAM = 'comment'

private

ITEM_ID_PATH_PARAM

const Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::ITEM_ID_PATH_PARAM = 'item_id'

private

PATCH_BODY_PARAM

const Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::PATCH_BODY_PARAM = 'patch'

private

TAGS_BODY_PARAM

const Wikibase\Repo\RestApi\RouteHandlers\PatchItemRouteHandler::TAGS_BODY_PARAM = 'tags'

private

---

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

• repo/rest-api/src/RouteHandlers/PatchItemRouteHandler.php