Inheritance diagram for MediaWiki\Rest\Handler\UserContributionsHandler:

[legend]

Collaboration diagram for MediaWiki\Rest\Handler\UserContributionsHandler:

[legend]

Public Member Functions
	execute ()

	getParamSettings ()
	Fetch ParamValidator settings for parameters.

Public Member Functions inherited from MediaWiki\Rest\Handler\AbstractContributionHandler
	__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().

	checkPreconditions ()
	Check the conditional request headers and generate a response if appropriate.

	getAuthority ()
	Get the current acting authority.

	getBodyValidator ( $contentType)
	Fetch the BodyValidator.

	getConfig ()
	Get the configuration array for the current route.

	getRequest ()
	Get the current request.

	getResponseFactory ()
	Get the ResponseFactory which can be used to generate Response objects.

	getValidatedBody ()
	Fetch the validated body.

	getValidatedParams ()
	Fetch the validated parameters.

	init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer)
	Initialise with dependencies from the Router.

	needsReadAccess ()
	Indicates whether this route requires read rights.

	needsWriteAccess ()
	Indicates whether this route requires write access.

	validate (Validator $restValidator)
	Validate the request parameters/attributes and body.

Private Member Functions
	constructURLs (ContributionsSegment $segment)

	getContributionsList (ContributionsSegment $segment)
	Returns list of revisions.

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.

Protected Member Functions inherited from MediaWiki\Rest\Handler\AbstractContributionHandler
	getTargetUser ()
	Returns the user who's contributions we are requesting.

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

Protected Member Functions inherited from MediaWiki\Rest\Handler
	getConditionalHeaderUtil ()
	Get a ConditionalHeaderUtil object.

	getETag ()
	The subclass should override this to provide an ETag for the current request.

	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata.

	getHookRunner ()
	Get a HookRunner for running core hooks.

	getLastModified ()
	The subclass should override this to provide the maximum last modified timestamp for the current request.

	getRouter ()
	Get the Router.

	getRouteUrl ( $pathParams=[], $queryParams=[])
	Get the URL of this handler's endpoint.

	hasRepresentation ()
	The subclass should override this to indicate whether the resource exists.

	postValidationSetup ()
	The handler can override this to do any necessary setup after validate() has been called.

	urlEncodeTitle ( $title)
	URL-encode titles in a "pretty" way.

Protected Attributes inherited from MediaWiki\Rest\Handler\AbstractContributionHandler
ContributionsLookup	$contributionsLookup

bool	$me
	User is requesting their own contributions.

UserNameUtils	$userNameUtils

const	MAX_LIMIT = 20
	Hard limit results to 20 contributions.

Detailed Description

Since: 1.35

Definition at line 16 of file UserContributionsHandler.php.

Member Function Documentation

◆ constructURLs()

MediaWiki\Rest\Handler\UserContributionsHandler::constructURLs ( ContributionsSegment $segment )

private

Parameters

ContributionsSegment $segment

Returns: string[]

Definition at line 78 of file UserContributionsHandler.php.

References MediaWiki\Rest\Handler\getValidatedParams().

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

◆ execute()

MediaWiki\Rest\Handler\UserContributionsHandler::execute ( )

Returns: array|ResponseInterface

Exceptions

LocalizedHttpException

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 22 of file UserContributionsHandler.php.

References MediaWiki\Rest\Handler\UserContributionsHandler\constructURLs(), MediaWiki\Rest\Handler\getAuthority(), MediaWiki\Rest\Handler\UserContributionsHandler\getContributionsList(), MediaWiki\Rest\Handler\AbstractContributionHandler\getTargetUser(), and MediaWiki\Rest\Handler\getValidatedParams().

◆ getContributionsList()

MediaWiki\Rest\Handler\UserContributionsHandler::getContributionsList ( ContributionsSegment $segment )

private

Returns list of revisions.

Parameters

ContributionsSegment $segment

Returns: array[]

Definition at line 45 of file UserContributionsHandler.php.

References MediaWiki\Revision\ContributionsSegment\getDeltaForRevision(), MediaWiki\Revision\ContributionsSegment\getTagsForRevision(), and wfTimestamp().

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

◆ getParamSettings()

MediaWiki\Rest\Handler\UserContributionsHandler::getParamSettings ( )

Fetch ParamValidator settings for parameters.

Every setting must include self::PARAM_SOURCE to specify which part of the request is to contain the parameter.

Can be used for validating parameters inside an application/x-www-form-urlencoded or multipart/form-data POST body (i.e. parameters which would be present in PHP's $_POST array). For validating other kinds of request bodies, override getBodyValidator().

Stability: stable: to override

Returns: array[] Associative array mapping parameter names to ParamValidator settings arrays

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 100 of file UserContributionsHandler.php.

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

includes/Rest/Handler/UserContributionsHandler.php

Public Member Functions