Wikibase\Repo\Api\CreateRedirect Class Reference

API module for creating entity redirects. More...

Inheritance diagram for Wikibase\Repo\Api\CreateRedirect:

Collaboration diagram for Wikibase\Repo\Api\CreateRedirect:

Public Member Functions
	__construct (ApiMain $mainModule, $moduleName, EntityIdParser $idParser, ApiErrorReporter $errorReporter, ItemRedirectCreationInteractor $interactor, PermissionManager $permissionManager)
	execute ()
	isWriteMode ()
	needsToken ()
	mustBePosted ()

Protected Member Functions
	getAllowedParams ()
	getExamplesMessages ()

Private Member Functions
	createRedirect (EntityId $fromId, EntityId $toId, $bot, ApiResult $result)
	handleRedirectCreationException (RedirectCreationException $ex)

Private Attributes
	$idParser
	$errorReporter
	$interactor
	$permissionManager

Detailed Description

API module for creating entity redirects.

Copyright

GPL-2.0-or-later

Author

Daniel Kinzler

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\Api\CreateRedirect::__construct	(	ApiMain	$mainModule,
			$moduleName,
		EntityIdParser	$idParser,
		ApiErrorReporter	$errorReporter,
		ItemRedirectCreationInteractor	$interactor,
		PermissionManager	$permissionManager
	)

See also

ApiBase::__construct

Parameters

ApiMain	$mainModule
string	$moduleName
EntityIdParser	$idParser
ApiErrorReporter	$errorReporter
ItemRedirectCreationInteractor	$interactor
PermissionManager	$permissionManager

Member Function Documentation

createRedirect()

Wikibase\Repo\Api\CreateRedirect::createRedirect ( EntityId  $fromId, EntityId  $toId,   $bot, ApiResult  $result  )

private

Parameters

EntityId	$fromId
EntityId	$toId
bool	$bot	Whether the edit should be marked as bot
ApiResult	$result	The result object to report the result to.

Exceptions

RedirectCreationException

execute()

Wikibase\Repo\Api\CreateRedirect::execute

(

)

getAllowedParams()

Wikibase\Repo\Api\CreateRedirect::getAllowedParams ( )

protected

getExamplesMessages()

Wikibase\Repo\Api\CreateRedirect::getExamplesMessages ( )

protected

handleRedirectCreationException()

Wikibase\Repo\Api\CreateRedirect::handleRedirectCreationException ( RedirectCreationException  $ex )

private

Parameters

RedirectCreationException

$ex

Exceptions

ApiUsageException

always

isWriteMode()

Wikibase\Repo\Api\CreateRedirect::isWriteMode

(

)

mustBePosted()

Wikibase\Repo\Api\CreateRedirect::mustBePosted

(

)

needsToken()

Wikibase\Repo\Api\CreateRedirect::needsToken

(

)

Member Data Documentation

$errorReporter

Wikibase\Repo\Api\CreateRedirect::$errorReporter

private

$idParser

Wikibase\Repo\Api\CreateRedirect::$idParser

private

$interactor

Wikibase\Repo\Api\CreateRedirect::$interactor

private

$permissionManager

Wikibase\Repo\Api\CreateRedirect::$permissionManager

private

---

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

• repo/includes/Api/CreateRedirect.php