Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler Class Reference

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

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

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

Static Public Member Functions
static	factory ()

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

Private Attributes
const	ITEM_ID_PATH_PARAM = 'item_id'
const	SITE_ID_PATH_PARAM = 'site_id'
const	SITELINK_BODY_PARAM = 'sitelink'
const	TAGS_BODY_PARAM = 'tags'
const	BOT_BODY_PARAM = 'bot'
const	COMMENT_BODY_PARAM = 'comment'
SetSitelink	$useCase
SiteLinkSerializer	$sitelinkSerializer
ResponseFactory	$responseFactory
MiddlewareHandler	$middlewareHandler

Detailed Description

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler::__construct	(	SetSitelink	$useCase,
		ResponseFactory	$responseFactory,
		SiteLinkSerializer	$sitelinkSerializer,
		MiddlewareHandler	$middlewareHandler )

Member Function Documentation

checkPreconditions()

Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler::checkPreconditions

(

)

Preconditions are checked via PreconditionMiddleware.

factory()

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

static

getBodyParamSettings()

Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler::getBodyParamSettings

(

)

getParamSettings()

Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler::getParamSettings

(

)

getUsername()

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

private

newSuccessHttpResponse()

Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler::newSuccessHttpResponse ( SetSitelinkResponse $useCaseResponse )

private

run()

Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler::run

(

$args

)

Parameters

mixed

...$args

runUseCase()

Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler::runUseCase	(	string	$itemId,
		string	$siteId )

validate()

Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler::validate

(

Validator

$restValidator

)

Member Data Documentation

$middlewareHandler

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

private

$responseFactory

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

private

$sitelinkSerializer

SiteLinkSerializer Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler::$sitelinkSerializer

private

$useCase

SetSitelink Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler::$useCase

private

BOT_BODY_PARAM

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

private

COMMENT_BODY_PARAM

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

private

ITEM_ID_PATH_PARAM

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

private

SITE_ID_PATH_PARAM

const Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler::SITE_ID_PATH_PARAM = 'site_id'

private

SITELINK_BODY_PARAM

const Wikibase\Repo\RestApi\RouteHandlers\SetSitelinkRouteHandler::SITELINK_BODY_PARAM = 'sitelink'

private

TAGS_BODY_PARAM

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

private

---

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

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