Wikibase
MediaWiki Wikibase extension
Loading...
Searching...
No Matches
Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler Class Reference
+ Inheritance diagram for Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler:
+ Collaboration diagram for Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler:

Public Member Functions

 __construct (GetItemDescriptions $useCase, DescriptionsSerializer $descriptionsSerializer, ResponseFactory $responseFactory, MiddlewareHandler $middlewareHandler)
 
 needsWriteAccess ()
 
 run (... $args)
 
 runUseCase (string $itemId)
 
 getParamSettings ()
 
 checkPreconditions ()
 Preconditions are checked via PreconditionMiddleware.
 

Static Public Member Functions

static factory ()
 

Private Member Functions

 newSuccessHttpResponse (GetItemDescriptionsResponse $useCaseResponse)
 
 newRedirectHttpResponse (ItemRedirect $e)
 
 setEtagFromRevId (Response $response, int $revId)
 

Private Attributes

const ITEM_ID_PATH_PARAM = 'item_id'
 
GetItemDescriptions $useCase
 
DescriptionsSerializer $descriptionsSerializer
 
ResponseFactory $responseFactory
 
MiddlewareHandler $middlewareHandler
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::__construct ( GetItemDescriptions $useCase,
DescriptionsSerializer $descriptionsSerializer,
ResponseFactory $responseFactory,
MiddlewareHandler $middlewareHandler )

Member Function Documentation

◆ checkPreconditions()

Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::checkPreconditions ( )

Preconditions are checked via PreconditionMiddleware.

◆ factory()

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

◆ getParamSettings()

Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::getParamSettings ( )

◆ needsWriteAccess()

Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::needsWriteAccess ( )

◆ newRedirectHttpResponse()

Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::newRedirectHttpResponse ( ItemRedirect $e)
private

◆ newSuccessHttpResponse()

Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::newSuccessHttpResponse ( GetItemDescriptionsResponse $useCaseResponse)
private

◆ run()

Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::run ( $args)
Parameters
mixed...$args

◆ runUseCase()

Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::runUseCase ( string $itemId)

◆ setEtagFromRevId()

Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::setEtagFromRevId ( Response $response,
int $revId )
private

Member Data Documentation

◆ $descriptionsSerializer

DescriptionsSerializer Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::$descriptionsSerializer
private

◆ $middlewareHandler

MiddlewareHandler Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::$middlewareHandler
private

◆ $responseFactory

ResponseFactory Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::$responseFactory
private

◆ $useCase

GetItemDescriptions Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::$useCase
private

◆ ITEM_ID_PATH_PARAM

const Wikibase\Repo\RestApi\RouteHandlers\GetItemDescriptionsRouteHandler::ITEM_ID_PATH_PARAM = 'item_id'
private

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