MediaWiki
master
|
Public Member Functions | |
__construct (ContributionsLookup $contributionsLookup, UserNameUtils $userNameUtils) | |
![]() | |
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... | |
getAuthority () | |
Get the current acting authority. 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, Authority $authority, 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... | |
![]() | |
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... | |
postValidationSetup () | |
The handler can override this to do any necessary setup after validate() has been called. 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 | |
![]() | |
const | PARAM_SOURCE = 'rest-param-source' |
(string) ParamValidator constant to specify the source of the parameter. More... | |
Definition at line 15 of file AbstractContributionHandler.php.
MediaWiki\Rest\Handler\AbstractContributionHandler::__construct | ( | ContributionsLookup | $contributionsLookup, |
UserNameUtils | $userNameUtils | ||
) |
ContributionsLookup | $contributionsLookup | |
UserNameUtils | $userNameUtils |
Definition at line 39 of file AbstractContributionHandler.php.
References MediaWiki\Rest\Handler\AbstractContributionHandler\$contributionsLookup, and MediaWiki\Rest\Handler\AbstractContributionHandler\$userNameUtils.
|
protected |
Returns the user who's contributions we are requesting.
Either me (requesting user) or another user.
LocalizedHttpException |
Definition at line 58 of file AbstractContributionHandler.php.
References MediaWiki\Rest\Handler\getAuthority(), and MediaWiki\Rest\Handler\getValidatedParams().
Referenced by MediaWiki\Rest\Handler\ContributionsCountHandler\execute(), and MediaWiki\Rest\Handler\UserContributionsHandler\execute().
|
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 47 of file AbstractContributionHandler.php.
References MediaWiki\Rest\Handler\getConfig().
|
protected |
Definition at line 20 of file AbstractContributionHandler.php.
Referenced by MediaWiki\Rest\Handler\AbstractContributionHandler\__construct().
|
protected |
User is requesting their own contributions.
Definition at line 28 of file AbstractContributionHandler.php.
|
protected |
Definition at line 33 of file AbstractContributionHandler.php.
Referenced by MediaWiki\Rest\Handler\AbstractContributionHandler\__construct().
|
protected |
Hard limit results to 20 contributions.
Definition at line 23 of file AbstractContributionHandler.php.
Referenced by MediaWiki\Rest\Handler\UserContributionsHandler\getParamSettings().