Wikibase\Repo\RestApi\RouteHandlers\SetItemDescriptionRouteHandler Class Reference

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

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

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

Static Public Member Functions
static	factory ()

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

Private Attributes
const	ITEM_ID_PATH_PARAM = 'item_id'
const	LANGUAGE_CODE_PATH_PARAM = 'language_code'
const	DESCRIPTION_BODY_PARAM = 'description'
const	TAGS_BODY_PARAM = 'tags'
const	BOT_BODY_PARAM = 'bot'
const	COMMENT_BODY_PARAM = 'comment'
SetItemDescription	$useCase
ResponseFactory	$responseFactory
MiddlewareHandler	$middlewareHandler

Detailed Description

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\RestApi\RouteHandlers\SetItemDescriptionRouteHandler::__construct	(	SetItemDescription	$useCase,
		ResponseFactory	$responseFactory,
		MiddlewareHandler	$middlewareHandler )

Member Function Documentation

checkPreconditions()

Wikibase\Repo\RestApi\RouteHandlers\SetItemDescriptionRouteHandler::checkPreconditions

(

)

Preconditions are checked via PreconditionMiddleware.

factory()

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

static

getBodyParamSettings()

Wikibase\Repo\RestApi\RouteHandlers\SetItemDescriptionRouteHandler::getBodyParamSettings

(

)

getParamSettings()

Wikibase\Repo\RestApi\RouteHandlers\SetItemDescriptionRouteHandler::getParamSettings

(

)

getUsername()

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

private

newSuccessHttpResponse()

Wikibase\Repo\RestApi\RouteHandlers\SetItemDescriptionRouteHandler::newSuccessHttpResponse ( SetItemDescriptionResponse $useCaseResponse )

private

run()

Wikibase\Repo\RestApi\RouteHandlers\SetItemDescriptionRouteHandler::run

(

$args

)

Parameters

mixed

...$args

runUseCase()

Wikibase\Repo\RestApi\RouteHandlers\SetItemDescriptionRouteHandler::runUseCase	(	string	$itemId,
		string	$languageCode )

validate()

Wikibase\Repo\RestApi\RouteHandlers\SetItemDescriptionRouteHandler::validate

(

Validator

$restValidator

)

Member Data Documentation

$middlewareHandler

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

private

$responseFactory

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

private

$useCase

SetItemDescription Wikibase\Repo\RestApi\RouteHandlers\SetItemDescriptionRouteHandler::$useCase

private

BOT_BODY_PARAM

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

private

COMMENT_BODY_PARAM

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

private

DESCRIPTION_BODY_PARAM

const Wikibase\Repo\RestApi\RouteHandlers\SetItemDescriptionRouteHandler::DESCRIPTION_BODY_PARAM = 'description'

private

ITEM_ID_PATH_PARAM

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

private

LANGUAGE_CODE_PATH_PARAM

const Wikibase\Repo\RestApi\RouteHandlers\SetItemDescriptionRouteHandler::LANGUAGE_CODE_PATH_PARAM = 'language_code'

private

TAGS_BODY_PARAM

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

private

---

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

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