The HTML user interface for page editing. More...

Inheritance diagram for MediaWiki\EditPage\EditPage:

Collaboration diagram for MediaWiki\EditPage\EditPage:

[legend]

Public Member Functions
	__construct (Article $article)

	attemptSave (&$resultDetails=false)
	Attempt submission. More...

	edit ()
	This is the function that gets called for "action=edit". More...

	getArticle ()

	getCheckboxesDefinition ( $values)
	Return an array of field definitions. More...

	getCheckboxesWidget (&$tabindex, $values)
	Returns an array of fields for the edit form, including 'minor' and 'watch' checkboxes and any other added by extensions. More...

	getContext ()

	getContextTitle ()

	getEditButtons (&$tabindex)
	Returns an array of html code of the following buttons: save, diff and preview. More...

	getExpectedParentRevision ()
	Returns the RevisionRecord corresponding to the revision that was current at the time editing was initiated on the client even if the edit was based on an old revision. More...

	getPreviewText ()
	Get the rendered text for previewing. More...

	getTemplates ()

	getTitle ()

	importFormData (&$request)
	This function collects the form data and uses it to populate various member variables. More...

	internalAttemptSave (&$result, $markAsBot=false, $markAsMinor=false)
	Attempt submission (no UI) More...

	makeTemplatesOnThisPageList (array $templates)
	Wrapper around TemplatesOnThisPageFormatter to make a "templates on this page" list. More...

	maybeActivateTempUserCreate ( $doAcquire)
	Check the configuration and current user and enable automatic temporary user creation if possible. More...

	setApiEditOverride ( $enableOverride)
	Allow editing of content that supports API direct editing, but not general direct editing. More...

	setContextTitle ( $title)

	setEditConflictHelperFactory (callable $factory)
	Set a factory function to create an EditConflictHelper. More...

	setHeaders ()

	showDiff ()
	Get a diff between the current contents of the edit box and the version of the page we're editing from. More...

	showEditForm ( $formCallback=null)
	Send the edit form and related headers to OutputPage. More...

	spamPageWithContent ( $match=false)
	Show "your edit contains spam" page with your diff and text. More...

Static Public Member Functions
static	getCopyrightWarning (PageReference $page, string $format, MessageLocalizer $localizer)
	Get the copyright warning. More...

static	getEditToolbar ()
	Allow extensions to provide a toolbar. More...

static	getPreviewLimitReport (ParserOutput $output=null)
	Get the Limit report for page previews. More...

Public Attributes
string	$action = 'submit'

null string	$contentFormat = null

string	$contentModel

	$didSave = false

string	$editFormPageTop = ''
	Before even the preview. More...

	$editFormTextAfterContent = ''

	$editFormTextAfterTools = ''

	$editFormTextAfterWarn = ''

	$editFormTextBeforeContent = ''

	$editFormTextBottom = ''

	$editFormTextTop = ''

string null	$edittime = ''
	Timestamp of the latest revision of the page when editing was initiated on the client. More...

bool	$firsttime
	True the first time the edit form is rendered, false after re-rendering with diff, save prompts, etc. More...

string	$formtype

bool	$isConflict = false
	Whether an edit conflict needs to be resolved. More...

bool	$mShowSummaryField = true

int	$oldid = 0
	Revision ID the edit is based on, or 0 if it's the current revision. More...

bool	$preview = false

	$previewTextAfterContent = ''

bool	$save = false

string	$section = ''

string null	$sectiontitle = null

string null	$starttime = ''
	Timestamp from the first time the edit form was rendered. More...

string	$summary = ''

	$suppressIntro = false

string	$textbox1 = ''
	Page content input field. More...

string	$textbox2 = ''

	$undidRev = 0

const	EDITFORM_ID = 'editform'
	HTML id and name for the beginning of the edit form. More...

const	POST_EDIT_COOKIE_DURATION = 1200
	Duration of PostEdit cookie, in seconds. More...

const	POST_EDIT_COOKIE_KEY_PREFIX = 'PostEditRevision'
	Prefix of key for cookie used to pass post-edit state. More...

const	UNICODE_CHECK = UnicodeConstraint::VALID_UNICODE
	Used for Unicode support checks. More...

Public Attributes inherited from MediaWiki\EditPage\IEditObject
const	AS_ARTICLE_WAS_DELETED = 222
	Status: article was deleted while editing and wpRecreate == false or form was not posted. More...

const	AS_BLANK_ARTICLE = 224
	Status: user tried to create a blank page and wpIgnoreBlankArticle == false. More...

const	AS_BLOCKED_PAGE_FOR_USER = 215
	Status: User is blocked from editing this page. More...

const	AS_CHANGE_TAG_ERROR = 237
	Status: an error relating to change tagging. More...

const	AS_CONFLICT_DETECTED = 225
	Status: (non-resolvable) edit conflict. More...

const	AS_CONTENT_TOO_BIG = 216
	Status: Content too big (> $wgMaxArticleSize) More...

const	AS_END = 231
	Status: WikiPage::doEdit() was unsuccessful. More...

const	AS_HOOK_ERROR = 210
	Status: Article update aborted by a hook function. More...

const	AS_HOOK_ERROR_EXPECTED = 212
	Status: A hook function returned an error. More...

const	AS_IMAGE_REDIRECT_ANON = 233
	Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false) More...

const	AS_IMAGE_REDIRECT_LOGGED = 234
	Status: logged in user is not allowed to upload (User::isAllowed('upload') == false) More...

const	AS_MAX_ARTICLE_SIZE_EXCEEDED = 229
	Status: article is too big (> $wgMaxArticleSize), after merging in the new section. More...

const	AS_NO_CHANGE_CONTENT_MODEL = 235
	Status: user tried to modify the content model, but is not allowed to do that ( User::isAllowed('editcontentmodel') == false ) More...

const	AS_NO_CREATE_PERMISSION = 223
	Status: user tried to create this page, but is not allowed to do that. More...

const	AS_PARSE_ERROR = 240
	Status: can't parse content. More...

const	AS_RATE_LIMITED = 221
	Status: rate limiter for action 'edit' was tripped. More...

const	AS_READ_ONLY_PAGE = 220
	Status: wiki is in readonly mode (ReadOnlyMode::isReadOnly() == true) More...

const	AS_READ_ONLY_PAGE_ANON = 218
	Status: this anonymous user is not allowed to edit this page. More...

const	AS_READ_ONLY_PAGE_LOGGED = 219
	Status: this logged in user is not allowed to edit this page. More...

const	AS_SELF_REDIRECT = 236
	Status: user tried to create self-redirect and wpIgnoreSelfRedirect is false. More...

const	AS_SPAM_ERROR = 232
	Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex. More...

const	AS_SUCCESS_NEW_ARTICLE = 201
	Status: Article successfully created. More...

const	AS_SUCCESS_UPDATE = 200
	Status: Article successfully updated. More...

const	AS_SUMMARY_NEEDED = 226
	Status: no edit summary given and the user has forceeditsummary set and the user is not editing in his own userspace or talkspace and wpIgnoreBlankSummary == false. More...

const	AS_TEXTBOX_EMPTY = 228
	Status: user tried to create a new section without content. More...

const	AS_UNICODE_NOT_SUPPORTED = 242
	Status: edit rejected because browser doesn't support Unicode. More...

Protected Member Functions
	addNewLineAtEnd ( $wikitext)

	doPreviewParse (Content $content)
	Parse the page for a preview. More...

	getActionURL (Title $title)
	Returns the URL to use in the form's action attribute. More...

	getContentObject ( $def_content=null)

	getCurrentContent ()
	Get the current content of the page. More...

	getPreviewParserOptions ()
	Get parser options for a preview. More...

	importContentFormData (&$request)
	Subpage overridable method for extracting the page content data from the posted form to be placed in $this->textbox1, if using customized input this method should be overridden and return the page text that will be used for saving, preview parsing and so on... More...

	previewOnOpen ()
	Should we show a preview when the edit form is first shown? More...

	showContentForm ()
	Subpage overridable method for printing the form for page content editing By default this simply outputs wpTextbox1 Subclasses can override this to provide a custom UI for editing; be it a form, or simply wpTextbox1 with a modified content that will be reverse modified when extracted from the post data. More...

	showFormAfterText ()

	showStandardInputs (&$tabindex=2)

	showTextbox ( $text, $name, $customAttribs=[])

	toEditContent ( $text)
	Turns the given text into a Content object by unserializing it. More...

Protected Attributes
bool	$blankArticle = false

IContextSource	$context

Detailed Description

The HTML user interface for page editing.

This was originally split from the Article class, with some database and text munging logic still partly there.

EditPage cares about two distinct titles:

$this->mContextTitle is the page that forms submit to, links point to, redirects go to, etc.
$this->mTitle (as well as $mArticle) is the page in the database that is actually being edited.

These are usually the same, but they are now allowed to be different.

Surgeon General's Warning: prolonged exposure to this class is known to cause headaches, which may be fatal.

Stability: newable

Note: marked as newable in 1.35 for lack of a better alternative, but should be split up into service objects and command objects in the future (T157658).

Definition at line 144 of file EditPage.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\EditPage\EditPage::__construct ( Article $article )

Stability: stable: to call

Parameters

Article $article

Definition at line 528 of file EditPage.php.

References deprecatePublicProperty(), MediaWiki\EditPage\EditPage\getContext(), Article\getContext(), MediaWiki\MediaWikiServices\getInstance(), Article\getPage(), Article\getTitle(), and MediaWiki\MainConfigNames\WatchlistExpiry.

Member Function Documentation

◆ addNewLineAtEnd()

MediaWiki\EditPage\EditPage::addNewLineAtEnd ( $wikitext )

protected

Parameters

string $wikitext

Returns: string

Since: 1.29

Deprecated:: since 1.38 Use TextboxBuilder::addNewLineAtEnd instead.

Definition at line 4602 of file EditPage.php.

References wfDeprecated().

◆ attemptSave()

MediaWiki\EditPage\EditPage::attemptSave ( & $resultDetails = false )

Attempt submission.

Parameters

array | false &$resultDetails See docs for $result in internalAttemptSave

Exceptions

UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError

Returns: Status

Definition at line 1851 of file EditPage.php.

References getAuthority().

◆ doPreviewParse()

MediaWiki\EditPage\EditPage::doPreviewParse ( Content $content )

protected

Parse the page for a preview.

Subclasses may override this class, in order to parse with different options, or to otherwise modify the preview HTML.

Parameters

Content $content The page content

Returns

array with keys:

parserOutput: The ParserOutput object
html: The HTML to be displayed

Definition at line 4197 of file EditPage.php.

References $content.

◆ edit()

MediaWiki\EditPage\EditPage::edit ( )

This is the function that gets called for "action=edit".

It sets up various member variables, then passes execution to another function, usually showEditForm()

The edit form is self-submitting, so that when things like preview and edit conflicts occur, we get the same form back with the extra stuff added. Only when the final submission is made and all is well do we actually save and redirect to the newly-edited page.

Definition at line 658 of file EditPage.php.

References DeferredUpdates\addCallableUpdate(), MediaWiki\MediaWikiServices\getInstance(), WikiPage\hasDifferencesOutsideMainSlot(), MediaWiki\Revision\SlotRecord\MAIN, MediaWiki\Revision\RevisionRecord\RAW, and wfDebug().

◆ getActionURL()

MediaWiki\EditPage\EditPage::getActionURL ( Title $title )

protected

Returns the URL to use in the form's action attribute.

This is used by EditPage subclasses when simply customizing the action variable in the constructor is not enough. This can be used when the EditPage lives inside of a Special page rather than a custom page action.

Parameters

Title $title Title object for which is being edited (where we go to for &action= links)

Returns: string

Definition at line 3934 of file EditPage.php.

References $title.

◆ getArticle()

MediaWiki\EditPage\EditPage::getArticle ( )

Returns: Article

Definition at line 585 of file EditPage.php.

◆ getCheckboxesDefinition()

MediaWiki\EditPage\EditPage::getCheckboxesDefinition ( $values )

Return an array of field definitions.

Despite the name, not only checkboxes are supported.

Array keys correspond to the <input> 'name' attribute to use for each field.

Array values are associative arrays with the following keys:

'label-message' (required): message for label text
'id' (required): 'id' attribute for the <input>
'default' (required): default checkedness (true or false)
'title-message' (optional): used to generate 'title' attribute for the <label>
'tooltip' (optional): used to generate 'title' and 'accesskey' attributes from messages like 'tooltip-foo', 'accesskey-foo'
'label-id' (optional): 'id' attribute for the <label>
'legacy-name' (optional): short name for backwards-compatibility
'class' (optional): PHP class name of the OOUI widget to use. Defaults to CheckboxInputWidget.
'options' (optional): options to use for DropdownInputWidget, ComboBoxInputWidget, etc. following the structure as given in the documentation for those classes.
'value-attr' (optional): name of the widget config option for the "current value" of the widget. Defaults to 'selected'; for some widget types it should be 'value'.
Parameters

array<string,mixed> $values Map of field names (matching the 'legacy-name') to current field values. For checkboxes, the value is a bool that indicates the checked status of the checkbox.

Returns
array[]

Definition at line 4287 of file EditPage.php.

◆ getCheckboxesWidget()

MediaWiki\EditPage\EditPage::getCheckboxesWidget	(	&	$tabindex,
			$values
	)

Returns an array of fields for the edit form, including 'minor' and 'watch' checkboxes and any other added by extensions.

Despite the name, not only checkboxes are supported.

Parameters

int	&$tabindex	Current tabindex
	array<string,mixed>	$values Map of field names to current field values. For checkboxes, the value is a bool that indicates the checked status of the checkbox.

Returns: \OOUI\Element[] Associative array of string keys to \OOUI\Widget or \OOUI\Layout instances

Definition at line 4372 of file EditPage.php.

References $title.

◆ getContentObject()

MediaWiki\EditPage\EditPage::getContentObject ( $def_content = null )

protected

Parameters

Content | null $def_content The default value to return

Returns: Content|false|null Content on success, $def_content for invalid sections

Since: 1.21

Definition at line 1507 of file EditPage.php.

References $content, getAuthority(), Content\getSection(), ExternalUserNames\getUserLinkTitle(), WikiPage\hasDifferencesOutsideMainSlot(), ExternalUserNames\isExternal(), and ParserOptions\newFromUserAndLang().

◆ getContext()

MediaWiki\EditPage\EditPage::getContext ( )

Since: 1.28

Returns: IContextSource

Definition at line 593 of file EditPage.php.

References MediaWiki\EditPage\EditPage\$context.

Referenced by MediaWiki\EditPage\EditPage\__construct().

◆ getContextTitle()

MediaWiki\EditPage\EditPage::getContextTitle ( )

Exceptions

RuntimeException if no context title was set

Returns: Title

Definition at line 616 of file EditPage.php.

◆ getCopyrightWarning()

static MediaWiki\EditPage\EditPage::getCopyrightWarning	(	PageReference	$page,
		string	$format,
		MessageLocalizer	$localizer
	)

static

Get the copyright warning.

Parameters

PageReference	$page
string	$format	Output format, valid values are any function of a Message object (e.g. 'parse', 'plain')
MessageLocalizer	$localizer

Returns: string

Definition at line 3749 of file EditPage.php.

References $title, and MessageLocalizer\msg().

◆ getCurrentContent()

MediaWiki\EditPage\EditPage::getCurrentContent ( )

protected

Get the current content of the page.

This is basically similar to WikiPage::getContent( RevisionRecord::RAW ) except that when the page doesn't exist an empty content object is returned instead of null.

Since: 1.21

Returns: Content

Definition at line 1784 of file EditPage.php.

References $content.

◆ getEditButtons()

MediaWiki\EditPage\EditPage::getEditButtons ( & $tabindex )

Returns an array of html code of the following buttons: save, diff and preview.

Parameters

int &$tabindex Current tabindex

Returns: string[] Strings or objects with a __toString() implementation. Usually an array of {

See also: ButtonInputWidget}, but EditPageBeforeEditButtons hook handlers might inject something else.

Definition at line 4447 of file EditPage.php.

◆ getEditToolbar()

static MediaWiki\EditPage\EditPage::getEditToolbar ( )

static

Allow extensions to provide a toolbar.

Returns: string|null

Definition at line 4250 of file EditPage.php.

◆ getExpectedParentRevision()

MediaWiki\EditPage\EditPage::getExpectedParentRevision ( )

Returns the RevisionRecord corresponding to the revision that was current at the time editing was initiated on the client even if the edit was based on an old revision.

Since: 1.35

Returns: RevisionRecord|null Current revision when editing was initiated on the client

Definition at line 2778 of file EditPage.php.

References getTitle().

◆ getPreviewLimitReport()

static MediaWiki\EditPage\EditPage::getPreviewLimitReport ( ParserOutput $output = null )

static

Get the Limit report for page previews.

Since: 1.22

Parameters

ParserOutput | null $output ParserOutput object from the parse

Returns: string HTML

Definition at line 3778 of file EditPage.php.

References wfMessage().

◆ getPreviewParserOptions()

MediaWiki\EditPage\EditPage::getPreviewParserOptions ( )

protected

Get parser options for a preview.

Returns: ParserOptions

Definition at line 4174 of file EditPage.php.

◆ getPreviewText()

MediaWiki\EditPage\EditPage::getPreviewText ( )

Get the rendered text for previewing.

Exceptions

MWException

Returns: string

Definition at line 4017 of file EditPage.php.

References $content, CONTENT_MODEL_CSS, CONTENT_MODEL_JAVASCRIPT, CONTENT_MODEL_JSON, and getTitle().

◆ getTemplates()

MediaWiki\EditPage\EditPage::getTemplates ( )

Returns: Title[]

Definition at line 4228 of file EditPage.php.

◆ getTitle()

MediaWiki\EditPage\EditPage::getTitle ( )

Since: 1.19

Returns: Title

Definition at line 601 of file EditPage.php.

◆ importContentFormData()

MediaWiki\EditPage\EditPage::importContentFormData ( & $request )

protected

Subpage overridable method for extracting the page content data from the posted form to be placed in $this->textbox1, if using customized input this method should be overridden and return the page text that will be used for saving, preview parsing and so on...

Parameters

WebRequest &$request

Returns: string|null

Definition at line 1429 of file EditPage.php.

◆ importFormData()

MediaWiki\EditPage\EditPage::importFormData ( & $request )

This function collects the form data and uses it to populate various member variables.

Parameters

WebRequest &$request

Exceptions

ErrorPageError

Definition at line 1166 of file EditPage.php.

References ContentHandler\getLocalizedName(), NS_USER, NS_USER_TALK, wfDebug(), wfEscapeWikiText(), and wfTimestampNow().

◆ internalAttemptSave()

MediaWiki\EditPage\EditPage::internalAttemptSave	(	&	$result,
			$markAsBot = `false`,
			$markAsMinor = `false`
	)

Attempt submission (no UI)

Parameters

array	&$result	Array to add statuses to, currently with the possible keys: spam (string): Spam string from content if any spam is detected by matchSpamRegex. sectionanchor (string): Section anchor for a section save. nullEdit (bool): Set if doUserEditContent is OK. True if null edit, false otherwise. redirect (bool): Set if doUserEditContent is OK. True if resulting revision is a redirect.
bool	$markAsBot	True if edit is being made under the bot right and the bot wishes the edit to be marked as such.
bool	$markAsMinor	True if edit should be marked as minor.

Returns: Status Status object, possibly with a message, but always with one of the AS_* constants in $status->value,

Todo:: FIXME: This interface is TERRIBLE, but hard to get rid of due to various error display idiosyncrasies. There are also lots of cases where error metadata is set in the object and retrieved later instead of being returned, e.g. AS_CONTENT_TOO_BIG and AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some time.

Definition at line 2097 of file EditPage.php.

References $content, $matches, MediaWiki\Storage\PageUpdater\addTags(), DB_PRIMARY, EDIT_AUTOSUMMARY, EDIT_FORCE_BOT, EDIT_MINOR, EDIT_NEW, EDIT_UPDATE, getAuthority(), MediaWiki\Storage\PageUpdater\getStatus(), getTitle(), StatusValue\isOK(), StatusValue\newFatal(), StatusValue\newGood(), RecentChange\PRC_AUTOPATROLLED, MediaWiki\Storage\PageUpdater\prepareUpdate(), MediaWiki\Storage\PageUpdater\setContent(), MediaWiki\Storage\PageUpdater\setOriginalRevisionId(), MediaWiki\Storage\PageUpdater\setRcPatrolStatus(), wfDebug(), wfGetDB(), and Status\wrap().

◆ makeTemplatesOnThisPageList()

MediaWiki\EditPage\EditPage::makeTemplatesOnThisPageList ( array $templates )

Wrapper around TemplatesOnThisPageFormatter to make a "templates on this page" list.

Parameters

PageIdentity[] $templates

Returns: string HTML

Definition at line 3265 of file EditPage.php.

References $type.

◆ maybeActivateTempUserCreate()

MediaWiki\EditPage\EditPage::maybeActivateTempUserCreate ( $doAcquire )

Check the configuration and current user and enable automatic temporary user creation if possible.

Parameters

bool $doAcquire Whether to acquire a name for the temporary account

Since: 1.39

Definition at line 835 of file EditPage.php.

◆ previewOnOpen()

MediaWiki\EditPage\EditPage::previewOnOpen ( )

protected

Should we show a preview when the edit form is first shown?

Returns: bool

Definition at line 1106 of file EditPage.php.

◆ setApiEditOverride()

MediaWiki\EditPage\EditPage::setApiEditOverride ( $enableOverride )

Allow editing of content that supports API direct editing, but not general direct editing.

Set to false by default.

Access: internal: Must only be used by ApiEditPage

Parameters

bool $enableOverride

Definition at line 643 of file EditPage.php.

◆ setContextTitle()

MediaWiki\EditPage\EditPage::setContextTitle ( $title )

Parameters

Title | null $title

Definition at line 608 of file EditPage.php.

References $title.

◆ setEditConflictHelperFactory()

MediaWiki\EditPage\EditPage::setEditConflictHelperFactory ( callable $factory )

Set a factory function to create an EditConflictHelper.

Parameters

callable $factory Factory function

Since: 1.31

Definition at line 4638 of file EditPage.php.

◆ setHeaders()

MediaWiki\EditPage\EditPage::setHeaders ( )

Definition at line 2798 of file EditPage.php.

References NS_MEDIAWIKI.

◆ showContentForm()

MediaWiki\EditPage\EditPage::showContentForm ( )

protected

Subpage overridable method for printing the form for page content editing By default this simply outputs wpTextbox1 Subclasses can override this to provide a custom UI for editing; be it a form, or simply wpTextbox1 with a modified content that will be reverse modified when extracted from the post data.

Note that this is basically the inverse for importContentFormData

Definition at line 3535 of file EditPage.php.

◆ showDiff()

MediaWiki\EditPage\EditPage::showDiff ( )

Get a diff between the current contents of the edit box and the version of the page we're editing from.

If this is a section edit, we'll replace the section as for final save and then make a comparison.

Definition at line 3646 of file EditPage.php.

References ParserOptions\newFromUserAndLang(), and NS_MEDIAWIKI.

◆ showEditForm()

MediaWiki\EditPage\EditPage::showEditForm ( $formCallback = null )

Send the edit form and related headers to OutputPage.

Parameters

callable | null $formCallback That takes an OutputPage parameter; will be called during form output near the top, for captchas and the like.

The $formCallback parameter is deprecated since MediaWiki 1.25 and hard-deprecated since 1.38. Please use the EditPage::showEditForm:fields hook instead.

Definition at line 2984 of file EditPage.php.

References Xml\checkLabel(), Xml\closeElement(), Xml\element(), Xml\openElement(), and wfDeprecated().

◆ showFormAfterText()

MediaWiki\EditPage\EditPage::showFormAfterText ( )

protected

Definition at line 3507 of file EditPage.php.

◆ showStandardInputs()

MediaWiki\EditPage\EditPage::showStandardInputs ( & $tabindex = 2 )

protected

Definition at line 3826 of file EditPage.php.

References getContext().

◆ showTextbox()

MediaWiki\EditPage\EditPage::showTextbox	(	$text,
		$name,
		$customAttribs = `[]`
	)

protected

Definition at line 3566 of file EditPage.php.

◆ spamPageWithContent()

MediaWiki\EditPage\EditPage::spamPageWithContent ( $match = false )

Show "your edit contains spam" page with your diff and text.

Parameters

string | array | false $match Text (or array of texts) which triggered one or more filters

Definition at line 4531 of file EditPage.php.

References wfEscapeWikiText().

◆ toEditContent()

MediaWiki\EditPage\EditPage::toEditContent ( $text )

protected

Turns the given text into a Content object by unserializing it.

If the resulting Content object is not of a type that can be edited using the text base EditPage, an exception will be raised. Set $this->allowNonTextContent to true to allow editing of non-textual content.

Parameters

string | null | false $text Text to unserialize

Returns: Content|false|null The content object created from $text. If $text was false or null, then false or null will be returned instead.

Exceptions

MWException If unserializing the text results in a Content object that is not an instance of TextContent and $this->allowNonTextContent is not true.

Definition at line 2961 of file EditPage.php.

References $content, getTitle(), and ContentHandler\makeContent().

Member Data Documentation

◆ $action

string MediaWiki\EditPage\EditPage::$action = 'submit'

Deprecated:: for public usage since 1.38 with no replacement

Definition at line 201 of file EditPage.php.

◆ $blankArticle

bool MediaWiki\EditPage\EditPage::$blankArticle = false

protected

Definition at line 249 of file EditPage.php.

◆ $contentFormat

null string MediaWiki\EditPage\EditPage::$contentFormat = null

Definition at line 386 of file EditPage.php.

◆ $contentModel

string MediaWiki\EditPage\EditPage::$contentModel

Definition at line 383 of file EditPage.php.

◆ $context

IContextSource MediaWiki\EditPage\EditPage::$context

protected

Definition at line 425 of file EditPage.php.

Referenced by MediaWiki\EditPage\EditPage\getContext().

◆ $didSave

MediaWiki\EditPage\EditPage::$didSave = false

Definition at line 405 of file EditPage.php.

◆ $editFormPageTop

string MediaWiki\EditPage\EditPage::$editFormPageTop = ''

Before even the preview.

Definition at line 395 of file EditPage.php.

◆ $editFormTextAfterContent

MediaWiki\EditPage\EditPage::$editFormTextAfterContent = ''

Definition at line 401 of file EditPage.php.

◆ $editFormTextAfterTools

MediaWiki\EditPage\EditPage::$editFormTextAfterTools = ''

Definition at line 399 of file EditPage.php.

◆ $editFormTextAfterWarn

MediaWiki\EditPage\EditPage::$editFormTextAfterWarn = ''

Definition at line 398 of file EditPage.php.

◆ $editFormTextBeforeContent

MediaWiki\EditPage\EditPage::$editFormTextBeforeContent = ''

Definition at line 397 of file EditPage.php.

◆ $editFormTextBottom

MediaWiki\EditPage\EditPage::$editFormTextBottom = ''

Definition at line 400 of file EditPage.php.

◆ $editFormTextTop

MediaWiki\EditPage\EditPage::$editFormTextTop = ''

Definition at line 396 of file EditPage.php.

◆ $edittime

string null MediaWiki\EditPage\EditPage::$edittime = ''

Timestamp of the latest revision of the page when editing was initiated on the client.

Definition at line 329 of file EditPage.php.

◆ $firsttime

bool MediaWiki\EditPage\EditPage::$firsttime

True the first time the edit form is rendered, false after re-rendering with diff, save prompts, etc.

Definition at line 222 of file EditPage.php.

◆ $formtype

string MediaWiki\EditPage\EditPage::$formtype

Definition at line 216 of file EditPage.php.

◆ $isConflict

bool MediaWiki\EditPage\EditPage::$isConflict = false

Whether an edit conflict needs to be resolved.

Detected based on whether $editRevId is different than the latest revision. When a conflict has successfully been resolved by a 3-way-merge, this field is set to false.

Definition at line 207 of file EditPage.php.

◆ $mShowSummaryField

bool MediaWiki\EditPage\EditPage::$mShowSummaryField = true

Definition at line 277 of file EditPage.php.

◆ $oldid

int MediaWiki\EditPage\EditPage::$oldid = 0

Revision ID the edit is based on, or 0 if it's the current revision.

FIXME: This isn't used in conflict resolution–provide a better justification or merge with parentRevId.

See also: $editRevId

Definition at line 363 of file EditPage.php.

◆ $preview

bool MediaWiki\EditPage\EditPage::$preview = false

Definition at line 285 of file EditPage.php.

◆ $previewTextAfterContent

MediaWiki\EditPage\EditPage::$previewTextAfterContent = ''

Definition at line 402 of file EditPage.php.

◆ $save

bool MediaWiki\EditPage\EditPage::$save = false

Definition at line 282 of file EditPage.php.

◆ $section

string MediaWiki\EditPage\EditPage::$section = ''

Definition at line 345 of file EditPage.php.

◆ $sectiontitle

string null MediaWiki\EditPage\EditPage::$sectiontitle = null

Definition at line 348 of file EditPage.php.

◆ $starttime

string null MediaWiki\EditPage\EditPage::$starttime = ''

Timestamp from the first time the edit form was rendered.

Definition at line 356 of file EditPage.php.

◆ $summary

string MediaWiki\EditPage\EditPage::$summary = ''

Definition at line 317 of file EditPage.php.

◆ $suppressIntro

MediaWiki\EditPage\EditPage::$suppressIntro = false

Definition at line 409 of file EditPage.php.

◆ $textbox1

string MediaWiki\EditPage\EditPage::$textbox1 = ''

Page content input field.

Definition at line 311 of file EditPage.php.

◆ $textbox2

string MediaWiki\EditPage\EditPage::$textbox2 = ''

Definition at line 314 of file EditPage.php.

◆ $undidRev

MediaWiki\EditPage\EditPage::$undidRev = 0

Definition at line 406 of file EditPage.php.

◆ EDITFORM_ID

const MediaWiki\EditPage\EditPage::EDITFORM_ID = 'editform'

HTML id and name for the beginning of the edit form.

Definition at line 156 of file EditPage.php.

◆ POST_EDIT_COOKIE_DURATION

const MediaWiki\EditPage\EditPage::POST_EDIT_COOKIE_DURATION = 1200

Duration of PostEdit cookie, in seconds.

The cookie will be removed instantly if the JavaScript runs.

Otherwise, though, we don't want the cookies to accumulate. RFC 2109 ( https://www.ietf.org/rfc/rfc2109.txt ) specifies a possible limit of only 20 cookies per domain. This still applies at least to some versions of IE without full updates: https://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx

A value of 20 minutes should be enough to take into account slow loads and minor clock skew while still avoiding cookie accumulation when JavaScript is turned off.

Definition at line 177 of file EditPage.php.

◆ POST_EDIT_COOKIE_KEY_PREFIX

const MediaWiki\EditPage\EditPage::POST_EDIT_COOKIE_KEY_PREFIX = 'PostEditRevision'

Prefix of key for cookie used to pass post-edit state.

The revision id edited is added after this

Definition at line 162 of file EditPage.php.

◆ UNICODE_CHECK

const MediaWiki\EditPage\EditPage::UNICODE_CHECK = UnicodeConstraint::VALID_UNICODE

Used for Unicode support checks.

Definition at line 151 of file EditPage.php.

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

includes/editpage/EditPage.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addNewLineAtEnd()

◆ attemptSave()

◆ doPreviewParse()

◆ edit()

◆ getActionURL()

◆ getArticle()

◆ getCheckboxesDefinition()

◆ getCheckboxesWidget()

◆ getContentObject()

◆ getContext()

◆ getContextTitle()

◆ getCopyrightWarning()

◆ getCurrentContent()

◆ getEditButtons()

◆ getEditToolbar()

◆ getExpectedParentRevision()

◆ getPreviewLimitReport()

◆ getPreviewParserOptions()

◆ getPreviewText()

◆ getTemplates()

◆ getTitle()

◆ importContentFormData()

◆ importFormData()

◆ internalAttemptSave()

◆ makeTemplatesOnThisPageList()

◆ maybeActivateTempUserCreate()

◆ previewOnOpen()

◆ setApiEditOverride()

◆ setContextTitle()

◆ setEditConflictHelperFactory()

◆ setHeaders()

◆ showContentForm()

◆ showDiff()

◆ showEditForm()

◆ showFormAfterText()

◆ showStandardInputs()

◆ showTextbox()

◆ spamPageWithContent()

◆ toEditContent()

Member Data Documentation

◆ $action

◆ $blankArticle

◆ $contentFormat

◆ $contentModel

◆ $context

◆ $didSave

◆ $editFormPageTop

◆ $editFormTextAfterContent

◆ $editFormTextAfterTools

◆ $editFormTextAfterWarn

◆ $editFormTextBeforeContent

◆ $editFormTextBottom

◆ $editFormTextTop

◆ $edittime

◆ $firsttime

◆ $formtype

◆ $isConflict

◆ $mShowSummaryField

◆ $oldid

◆ $preview

◆ $previewTextAfterContent

◆ $save

◆ $section

◆ $sectiontitle

◆ $starttime

◆ $summary

◆ $suppressIntro

◆ $textbox1

◆ $textbox2

◆ $undidRev

◆ EDITFORM_ID