Wikibase\Repo\Actions\EditEntityAction Class Reference

Handles the edit action for Wikibase entities. More...

Inheritance diagram for Wikibase\Repo\Actions\EditEntityAction:

Collaboration diagram for Wikibase\Repo\Actions\EditEntityAction:

Public Member Functions
	__construct (Page $page, IContextSource $context=null)
	getName ()
	show ()
	requiresUnblock ()
	requiresWrite ()

Protected Member Functions
	showPermissionError ( $action)
	Show an error page if the user is not allowed to perform the given action.
	loadRevisions ()
	Loads the revisions specified by the web request and returns them as a three element array wrapped in a Status object.
	showUndoErrorPage (Status $status)
	Output an error page showing the given status.
Protected Member Functions inherited from Wikibase\Repo\Actions\ViewEntityAction
	getDescription ()

Private Member Functions
	getStatus (WebRequest $req, RevisionRecord $latestRevision)
	getTitleText ()
	Used for overriding the page HTML title with the label, if available, or else the id.
	getCancelLink ()
	Returns a cancel link back to viewing the entity's page.
	showDiffStyle ()
	Add style sheets and supporting JS for diff display.
	getSummaryInput ( $labelText)
	Generate standard summary input and label (wgSummary), compatible to EditPage.
	displayUndoDiff (EntityContentDiff $diff)
	getEditButton ()
	showConfirmationForm ( $undidRevision=0)
	Shows a form that can be used to confirm the requested undo/restore action.

Private Attributes
	$entityDiffVisualizer

Additional Inherited Members
Static Public Member Functions inherited from Wikibase\Repo\Actions\ViewEntityAction
static	onBeforeDisplayNoArticleText (Article $article)
	Handler for the BeforeDisplayNoArticleText called by Article.

Detailed Description

Handles the edit action for Wikibase entities.

This shows the forms for the undo and restore operations if requested. Otherwise it will just show the normal entity view.

Copyright

GPL-2.0-or-later

Author

Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Jens Ohlig

Daniel Kinzler

Constructor & Destructor Documentation

__construct()

Wikibase\Repo\Actions\EditEntityAction::__construct	(	Page	$page,
		IContextSource	$context = null
	)

See also

Action::__construct

Parameters

Page	$page
IContextSource | null	$context

Reimplemented in Wikibase\Repo\Actions\SubmitEntityAction.

Member Function Documentation

displayUndoDiff()

Wikibase\Repo\Actions\EditEntityAction::displayUndoDiff ( EntityContentDiff  $diff )

private

getCancelLink()

Wikibase\Repo\Actions\EditEntityAction::getCancelLink ( )

private

Returns a cancel link back to viewing the entity's page.

Returns

string

getEditButton()

Wikibase\Repo\Actions\EditEntityAction::getEditButton ( )

private

Returns

string HTML

getName()

Wikibase\Repo\Actions\EditEntityAction::getName

(

)

See also

Action::getName()

Returns

string

Reimplemented in Wikibase\Repo\Actions\SubmitEntityAction.

getStatus()

Wikibase\Repo\Actions\EditEntityAction::getStatus ( WebRequest  $req, RevisionRecord  $latestRevision  )

private

Parameters

WebRequest	$req
RevisionRecord	$latestRevision

Returns

Status

getSummaryInput()

Wikibase\Repo\Actions\EditEntityAction::getSummaryInput (   $labelText )

private

Generate standard summary input and label (wgSummary), compatible to EditPage.

Parameters

string

$labelText

The html to place inside the label

Returns

string HTML

getTitleText()

Wikibase\Repo\Actions\EditEntityAction::getTitleText ( )

private

Used for overriding the page HTML title with the label, if available, or else the id.

This is passed via parser output and output page to save overhead on view / edit actions.

Returns

string

loadRevisions()

Wikibase\Repo\Actions\EditEntityAction::loadRevisions ( )

protected

Loads the revisions specified by the web request and returns them as a three element array wrapped in a Status object.

If any error arises, it will be reported using the status object.

Returns

Status A Status object containing an array with three revision record objects, [ $olderRevision, $newerRevision, $latestRevision ].

Exceptions

MWException

if the page's latest revision cannot be loaded

requiresUnblock()

Wikibase\Repo\Actions\EditEntityAction::requiresUnblock

(

)

See also

Action::requiresUnblock

Returns

bool Always true.

Reimplemented from Wikibase\Repo\Actions\ViewEntityAction.

requiresWrite()

Wikibase\Repo\Actions\EditEntityAction::requiresWrite

(

)

See also

Action::requiresWrite

Returns

bool Always true.

Reimplemented from Wikibase\Repo\Actions\ViewEntityAction.

show()

Wikibase\Repo\Actions\EditEntityAction::show

(

)

See also

FormlessAction::show

Calls parent show() action to just display the entity, unless an undo action is requested.

Reimplemented from Wikibase\Repo\Actions\ViewEntityAction.

Reimplemented in Wikibase\Repo\Actions\SubmitEntityAction.

showConfirmationForm()

Wikibase\Repo\Actions\EditEntityAction::showConfirmationForm (   $undidRevision = 0 )

private

Shows a form that can be used to confirm the requested undo/restore action.

Parameters

int

$undidRevision

showDiffStyle()

Wikibase\Repo\Actions\EditEntityAction::showDiffStyle ( )

private

Add style sheets and supporting JS for diff display.

showPermissionError()

Wikibase\Repo\Actions\EditEntityAction::showPermissionError (   $action )

protected

Show an error page if the user is not allowed to perform the given action.

Parameters

string

$action

The action to check

Returns

bool true if there were permission errors

showUndoErrorPage()

Wikibase\Repo\Actions\EditEntityAction::showUndoErrorPage ( Status  $status )

protected

Output an error page showing the given status.

Parameters

Status

$status

The status to report.

Member Data Documentation

$entityDiffVisualizer

Wikibase\Repo\Actions\EditEntityAction::$entityDiffVisualizer

private

---

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

• repo/includes/Actions/EditEntityAction.php