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

Public Member Functions

 __construct (GetPropertyDescription $useCase, MiddlewareHandler $middlewareHandler, ResponseFactory $responseFactory)
 
 needsWriteAccess ()
 
 run (... $args)
 
 runUseCase (string $propertyId, string $languageCode)
 
 getParamSettings ()
 
 checkPreconditions ()
 Preconditions are checked via PreconditionMiddleware.
 

Static Public Member Functions

static factory ()
 

Private Member Functions

 newSuccessHttpResponse (GetPropertyDescriptionResponse $useCaseResponse)
 
 setEtagFromRevId (Response $response, int $revId)
 

Private Attributes

const PROPERTY_ID_PATH_PARAM = 'property_id'
 
const LANGUAGE_CODE_PATH_PARAM = 'language_code'
 
GetPropertyDescription $useCase
 
MiddlewareHandler $middlewareHandler
 
ResponseFactory $responseFactory
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ checkPreconditions()

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

Preconditions are checked via PreconditionMiddleware.

◆ factory()

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

◆ getParamSettings()

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

◆ needsWriteAccess()

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

◆ newSuccessHttpResponse()

Wikibase\Repo\RestApi\RouteHandlers\GetPropertyDescriptionRouteHandler::newSuccessHttpResponse ( GetPropertyDescriptionResponse $useCaseResponse)
private

◆ run()

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

◆ runUseCase()

Wikibase\Repo\RestApi\RouteHandlers\GetPropertyDescriptionRouteHandler::runUseCase ( string $propertyId,
string $languageCode )

◆ setEtagFromRevId()

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

Member Data Documentation

◆ $middlewareHandler

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

◆ $responseFactory

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

◆ $useCase

GetPropertyDescription Wikibase\Repo\RestApi\RouteHandlers\GetPropertyDescriptionRouteHandler::$useCase
private

◆ LANGUAGE_CODE_PATH_PARAM

const Wikibase\Repo\RestApi\RouteHandlers\GetPropertyDescriptionRouteHandler::LANGUAGE_CODE_PATH_PARAM = 'language_code'
private

◆ PROPERTY_ID_PATH_PARAM

const Wikibase\Repo\RestApi\RouteHandlers\GetPropertyDescriptionRouteHandler::PROPERTY_ID_PATH_PARAM = 'property_id'
private

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