Wikibase\Lexeme\MediaWiki\Api\EditFormElements Class Reference

Inheritance diagram for Wikibase\Lexeme\MediaWiki\Api\EditFormElements:

Collaboration diagram for Wikibase\Lexeme\MediaWiki\Api\EditFormElements:

Public Member Functions
	__construct (ApiMain $mainModule, string $moduleName, EntityRevisionLookup $entityRevisionLookup, MediaWikiEditEntityFactory $editEntityFactory, EditFormElementsRequestParser $requestParser, SummaryFormatter $summaryFormatter, FormSerializer $formSerializer, ApiHelperFactory $apiHelperFactory, EntityStore $entityStore)
	execute ()
	PhanTypeMismatchArgument
	isWriteMode ()
	isInternal ()
	As long as this codebase is in development and APIs might change any time without notice, we mark all as internal.
	needsToken ()
	mustBePosted ()

Static Public Member Functions
static	factory (ApiMain $mainModule, string $moduleName, ApiHelperFactory $apiHelperFactory, SerializerFactory $baseDataModelSerializerFactory, MediaWikiEditEntityFactory $editEntityFactory, EntityIdParser $entityIdParser, EntityStore $entityStore, Store $store, SummaryFormatter $summaryFormatter)

Protected Member Functions
	getAllowedParams ()
	getExamplesMessages ()

Private Member Functions
	saveForm (Form $form, string $summary, int $baseRevisionId, array $params)
	generateResponse (Form $form, EditEntityStatus $status, array $params)
	getRevIdForWhenUserWasLastToEdit (int $latestRevisionId, int $baseRevId, EntityId $entityId)
	Returns $latestRevisionId if all of edits since $baseRevId are done by the same user, otherwise returns $baseRevId.

Private Attributes
const	LATEST_REVISION = 0
EntityRevisionLookup	$entityRevisionLookup
MediaWikiEditEntityFactory	$editEntityFactory
EditFormElementsRequestParser	$requestParser
SummaryFormatter	$summaryFormatter
FormSerializer	$formSerializer
ResultBuilder	$resultBuilder
ApiErrorReporter	$errorReporter
EntityStore	$entityStore

Detailed Description

Copyright

GPL-2.0-or-later

Constructor & Destructor Documentation

__construct()

Wikibase\Lexeme\MediaWiki\Api\EditFormElements::__construct	(	ApiMain	$mainModule,
		string	$moduleName,
		EntityRevisionLookup	$entityRevisionLookup,
		MediaWikiEditEntityFactory	$editEntityFactory,
		EditFormElementsRequestParser	$requestParser,
		SummaryFormatter	$summaryFormatter,
		FormSerializer	$formSerializer,
		ApiHelperFactory	$apiHelperFactory,
		EntityStore	$entityStore )

Member Function Documentation

execute()

Wikibase\Lexeme\MediaWiki\Api\EditFormElements::execute

(

)

PhanTypeMismatchArgument

factory()

static Wikibase\Lexeme\MediaWiki\Api\EditFormElements::factory ( ApiMain $mainModule, string $moduleName, ApiHelperFactory $apiHelperFactory, SerializerFactory $baseDataModelSerializerFactory, MediaWikiEditEntityFactory $editEntityFactory, EntityIdParser $entityIdParser, EntityStore $entityStore, Store $store, SummaryFormatter $summaryFormatter )

static

generateResponse()

Wikibase\Lexeme\MediaWiki\Api\EditFormElements::generateResponse ( Form $form, EditEntityStatus $status, array $params )

private

getAllowedParams()

Wikibase\Lexeme\MediaWiki\Api\EditFormElements::getAllowedParams ( )

protected

getExamplesMessages()

Wikibase\Lexeme\MediaWiki\Api\EditFormElements::getExamplesMessages ( )

protected

getRevIdForWhenUserWasLastToEdit()

Wikibase\Lexeme\MediaWiki\Api\EditFormElements::getRevIdForWhenUserWasLastToEdit ( int $latestRevisionId, int $baseRevId, EntityId $entityId )

private

Returns $latestRevisionId if all of edits since $baseRevId are done by the same user, otherwise returns $baseRevId.

isInternal()

Wikibase\Lexeme\MediaWiki\Api\EditFormElements::isInternal

(

)

As long as this codebase is in development and APIs might change any time without notice, we mark all as internal.

This adds an "unstable" notice, but does not hide them in any way.

isWriteMode()

Wikibase\Lexeme\MediaWiki\Api\EditFormElements::isWriteMode

(

)

mustBePosted()

Wikibase\Lexeme\MediaWiki\Api\EditFormElements::mustBePosted

(

)

needsToken()

Wikibase\Lexeme\MediaWiki\Api\EditFormElements::needsToken

(

)

saveForm()

Wikibase\Lexeme\MediaWiki\Api\EditFormElements::saveForm ( Form $form, string $summary, int $baseRevisionId, array $params )

private

Member Data Documentation

$editEntityFactory

MediaWikiEditEntityFactory Wikibase\Lexeme\MediaWiki\Api\EditFormElements::$editEntityFactory

private

$entityRevisionLookup

EntityRevisionLookup Wikibase\Lexeme\MediaWiki\Api\EditFormElements::$entityRevisionLookup

private

$entityStore

EntityStore Wikibase\Lexeme\MediaWiki\Api\EditFormElements::$entityStore

private

$errorReporter

ApiErrorReporter Wikibase\Lexeme\MediaWiki\Api\EditFormElements::$errorReporter

private

$formSerializer

FormSerializer Wikibase\Lexeme\MediaWiki\Api\EditFormElements::$formSerializer

private

$requestParser

EditFormElementsRequestParser Wikibase\Lexeme\MediaWiki\Api\EditFormElements::$requestParser

private

$resultBuilder

ResultBuilder Wikibase\Lexeme\MediaWiki\Api\EditFormElements::$resultBuilder

private

$summaryFormatter

SummaryFormatter Wikibase\Lexeme\MediaWiki\Api\EditFormElements::$summaryFormatter

private

LATEST_REVISION

const Wikibase\Lexeme\MediaWiki\Api\EditFormElements::LATEST_REVISION = 0

private

---

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

• src/MediaWiki/Api/EditFormElements.php