MediaWiki  master
MediaWiki\Rest\Handler\AbstractContributionHandler Class Reference
Inheritance diagram for MediaWiki\Rest\Handler\AbstractContributionHandler:
Collaboration diagram for MediaWiki\Rest\Handler\AbstractContributionHandler:

Public Member Functions

 __construct (ContributionsLookup $contributionsLookup, UserNameUtils $userNameUtils)
 
- Public Member Functions inherited from MediaWiki\Rest\Handler
 applyConditionalResponseHeaders (ResponseInterface $response)
 Modify the response, adding Last-Modified and ETag headers as indicated the values previously returned by ETag and getLastModified(). More...
 
 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate. More...
 
 execute ()
 Execute the handler. More...
 
 getBodyValidator ( $contentType)
 Fetch the BodyValidator. More...
 
 getConfig ()
 Get the configuration array for the current route. More...
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. More...
 
 getRequest ()
 Get the current request. More...
 
 getResponseFactory ()
 Get the ResponseFactory which can be used to generate Response objects. More...
 
 getValidatedBody ()
 Fetch the validated body. More...
 
 getValidatedParams ()
 Fetch the validated parameters. More...
 
 init (Router $router, RequestInterface $request, array $config, ResponseFactory $responseFactory, HookContainer $hookContainer)
 Initialise with dependencies from the Router. More...
 
 needsReadAccess ()
 Indicates whether this route requires read rights. More...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body. More...
 

Protected Member Functions

 getTargetUser ()
 Returns the user who's contributions we are requesting. More...
 
 postInitSetup ()
 The handler can override this to do any necessary setup after init() is called to inject the dependencies. More...
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler
 getConditionalHeaderUtil ()
 Get a ConditionalHeaderUtil object. More...
 
 getETag ()
 The subclass should override this to provide an ETag for the current request. More...
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getLastModified ()
 The subclass should override this to provide the maximum last modified timestamp for the current request. More...
 
 getRouter ()
 Get the Router. More...
 
 getRouteUrl ( $pathParams=[], $queryParams=[])
 Get the URL of this handler's endpoint. More...
 
 hasRepresentation ()
 The subclass should override this to indicate whether the resource exists. More...
 
 urlEncodeTitle ( $title)
 URL-encode titles in a "pretty" way. More...
 

Protected Attributes

ContributionsLookup $contributionsLookup
 
bool $me
 User is requesting their own contributions. More...
 
UserNameUtils $userNameUtils
 
const MAX_LIMIT = 20
 Hard limit results to 20 contributions. More...
 

Additional Inherited Members

- Public Attributes inherited from MediaWiki\Rest\Handler
const PARAM_SOURCE = 'rest-param-source'
 (string) ParamValidator constant to specify the source of the parameter. More...
 

Detailed Description

Since
1.35

Definition at line 16 of file AbstractContributionHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\AbstractContributionHandler::__construct ( ContributionsLookup  $contributionsLookup,
UserNameUtils  $userNameUtils 
)
Parameters
ContributionsLookup$contributionsLookup
UserNameUtils$userNameUtils

Definition at line 40 of file AbstractContributionHandler.php.

References MediaWiki\Rest\Handler\AbstractContributionHandler\$contributionsLookup, and MediaWiki\Rest\Handler\AbstractContributionHandler\$userNameUtils.

Member Function Documentation

◆ getTargetUser()

MediaWiki\Rest\Handler\AbstractContributionHandler::getTargetUser ( )
protected

Returns the user who's contributions we are requesting.

Either me (requesting user) or another user.

Returns
UserIdentity
Exceptions
LocalizedHttpException

Definition at line 59 of file AbstractContributionHandler.php.

References RequestContext\getMain(), and MediaWiki\Rest\Handler\getValidatedParams().

Referenced by MediaWiki\Rest\Handler\ContributionsCountHandler\execute(), and MediaWiki\Rest\Handler\UserContributionsHandler\execute().

◆ postInitSetup()

MediaWiki\Rest\Handler\AbstractContributionHandler::postInitSetup ( )
protected

The handler can override this to do any necessary setup after init() is called to inject the dependencies.

Stable to override

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 48 of file AbstractContributionHandler.php.

References MediaWiki\Rest\Handler\getConfig().

Member Data Documentation

◆ $contributionsLookup

ContributionsLookup MediaWiki\Rest\Handler\AbstractContributionHandler::$contributionsLookup
protected

◆ $me

bool MediaWiki\Rest\Handler\AbstractContributionHandler::$me
protected

User is requesting their own contributions.

Definition at line 29 of file AbstractContributionHandler.php.

◆ $userNameUtils

UserNameUtils MediaWiki\Rest\Handler\AbstractContributionHandler::$userNameUtils
protected

◆ MAX_LIMIT

const MediaWiki\Rest\Handler\AbstractContributionHandler::MAX_LIMIT = 20
protected

Hard limit results to 20 contributions.

Definition at line 24 of file AbstractContributionHandler.php.

Referenced by MediaWiki\Rest\Handler\UserContributionsHandler\getParamSettings().


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