The edit page/HTML interface (split from Article) The actual database and text munging is still in Article, but it should get easier to call those from alternate interfaces. More...

Collaboration diagram for 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 ()

	getBaseRevision ()
	Returns 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...

	getCancelLink ()

	getCheckboxesDefinition ( $checked)
	Return an array of checkbox definitions. More...

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

	getContext ()

	getContextTitle ()
	Get the context title object. More...

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

	getParentRevId ()
	Get the edit's parent revision ID. More...

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

	getSummaryInputWidget ( $summary="", $labelText=null, $inputAttrs=null)
	Builds a standard summary input with a label. More...

	getTemplates ()

	getTitle ()

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

	initialiseForm ()
	Initialise form fields in the object Called on the first invocation, e.g. More...

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

	isSupportedContentModel ( $modelId)
	Returns if the given content model is editable. More...

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

	noSuchSectionPage ()
	Creates a basic error page which informs the user that they have attempted to edit a nonexistent section. More...

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

	setContextTitle ( $title)
	Set the context Title object. More...

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

	setHeaders ()

	setPreloadedContent (Content $content)
	Use this method before edit() to preload some content into the edit box. More...

	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...

	submit ()

	tokenOk (&$request)
	Make sure the form isn't faking a user's credentials. More...

Static Public Member Functions
static	extractSectionTitle ( $text)
	Extract the section title from current section text, if any. More...

static	getCopyrightWarning ( $title, $format='plain', $langcode=null)
	Get the copyright warning, by default returns wikitext. More...

static	getEditToolbar ( $title=null)
	Allow extensions to provide a toolbar. More...

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

static	matchSpamRegex ( $text)
	Check given input text against $wgSpamRegex, and return the text of the first match. More...

static	matchSummarySpamRegex ( $text)
	Check given input text against $wgSummarySpamRegex, and return the text of the first match. More...

Public Attributes
string	$action = 'submit'

bool	$allowBlankSummary = false

string	$autoSumm = ''

bool	$bot = true

null string	$contentFormat = null

string	$contentModel

bool	$deletedSinceEdit

	$didSave = false

bool	$diff = false

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

	$editFormTextAfterContent = ''

	$editFormTextAfterTools = ''

	$editFormTextAfterWarn = ''

	$editFormTextBeforeContent = ''

	$editFormTextBottom = ''

	$editFormTextTop = ''

string	$editintro = ''

string	$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	$hasPresetSummary = false
	Has a summary been preset using GET parameter &summary= ? More...

string	$hookError = ''

bool	$incompleteForm = false

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

bool	$isNew = false
	New page or new section. More...

bool stdClass	$lastDelete

Article	$mArticle

Revision bool null	$mBaseRevision = false
	A revision object corresponding to $this->editRevId. More...

bool	$minoredit = false

bool	$missingComment = false

bool	$missingSummary = false

ParserOutput	$mParserOutput

	$mPreloadContent = null

bool	$mShowSummaryField = true

Title	$mTitle

bool	$mTokenOk = false

bool	$mTokenOkExceptSuffix = false

bool	$mTriedSave = false

bool	$nosummary = false
	If true, hide the summary field. More...

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

int	$parentRevId = 0
	Revision ID the edit is based on, adjusted when an edit conflict is resolved. More...

bool	$preview = false

	$previewTextAfterContent = ''

bool	$recreate = false

bool	$save = false

null	$scrolltop = null

string	$section = ''

string	$sectiontitle = ''

string	$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 = ''

bool	$tooBig = false

	$undidRev = 0

bool	$watchthis = false

const	AS_ARTICLE_WAS_DELETED = 222
	Status: article was deleted while editing and param 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_CANNOT_USE_CUSTOM_MODEL = 241
	Status: when changing the content model is disallowed due to $wgContentHandlerUseDB being false. 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 ( Title->userCan('create') == false ) 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 (wfReadOnly() == 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 (redirect to the same article) and wpIgnoreSelfRedirect == 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...

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 = 'ℳ𝒲♥𝓊𝓃𝒾𝒸ℴ𝒹ℯ'
	Used for Unicode support checks. More...

Protected Member Functions
	addContentModelChangeLogEntry (User $user, $oldModel, $newModel, $reason)

	addEditNotices ()

	addExplainConflictHeader (OutputPage $out)

	addLongPageWarningHeader ()

	addNewLineAtEnd ( $wikitext)

	addPageProtectionWarningHeaders ()

	addTalkPageText ()

	buildTextboxAttribs ( $name, array $customAttribs, User $user)

	displayPermissionsError (array $permErrors)
	Display a permissions error page, like OutputPage::showPermissionsErrorPage(), but with the following differences: More...

	displayPreviewArea ( $previewOutput, $isOnTop=false)

	displayViewSourcePage (Content $content, $errorMessage='')
	Display a read-only View Source page. More...

	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)

	getCopywarn ()
	Get the copyright warning. More...

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

	getEditPermissionErrors ( $rigor='secure')

	getLastDelete ()
	Get the last log record of this page being deleted, if ever. More...

	getPreloadedContent ( $preload, $params=[])
	Get the contents to be preloaded into the box, either set by an earlier setPreloadText() or by loading the given page. More...

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

	getSubmitButtonLabel ()
	Get the message key of the label for the button to save the page. More...

	getSummaryPreview ( $isSubjectPreview, $summary="")

	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...

	incrementConflictStats ()

	isSectionEditSupported ()
	Returns whether section editing is supported for the current page. More...

	isWrongCaseUserConfigPage ()
	Checks whether the user entered a skin name in uppercase, e.g. More...

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

	runPostMergeFilters (Content $content, Status $status, User $user)
	Run hooks that can filter edits just before they get saved. More...

	safeUnicodeInput ( $request, $field)
	Filter an input field through a Unicode de-armoring process if it came from an old browser with known broken Unicode editing issues. More...

	safeUnicodeOutput ( $text)
	Filter an output field through a Unicode armoring process if it is going to an old browser with known broken Unicode editing issues. More...

	setPostEditCookie ( $statusValue)
	Sets post-edit cookie indicating the user just saved a particular revision. More...

	showConflict ()
	Show an edit conflict. 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...

	showCustomIntro ()
	Attempt to show a custom editing introduction, if supplied. More...

	showEditTools ()
	Inserts optional text shown below edit and upload forms. More...

	showFormAfterText ()

	showFormBeforeText ()

	showHeader ()

	showHeaderCopyrightWarning ()
	Show the header copyright warning. More...

	showIntro ()
	Show all applicable editing introductions. More...

	showPreview ( $text)
	Append preview output to OutputPage. More...

	showStandardInputs (&$tabindex=2)

	showSummaryInput ( $isSubjectPreview, $summary="")

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

	showTextbox1 ( $customAttribs=null, $textoverride=null)
	Method to output wpTextbox1 The $textoverride method can be used by subclasses overriding showContentForm to pass back to this method. More...

	showTextbox2 ()

	showTosSummary ()
	Give a chance for site and per-namespace customizations of terms of service summary link that might exist separately from the copyright notice. More...

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

	toEditText ( $content)
	Gets an editable textual representation of $content. More...

	updateWatchlist ()
	Register the change of watch status. More...

	wasDeletedSinceLastEdit ()
	Check if a page was deleted while the user was editing it, before submit. More...

Static Protected Member Functions
static	matchSpamRegexInternal ( $text, $regexes)

Protected Attributes
bool	$allowBlankArticle = false

bool	$allowSelfRedirect = false

bool	$blankArticle = false

bool int	$contentLength = false

IContextSource	$context

bool	$edit

bool	$selfRedirect = false

Private Member Functions
	formatStatusErrors (Status $status)
	Wrap status errors in an errorbox for increased visibility. More...

	getEditConflictHelper ()

	getOriginalContent (User $user)
	Get the content of the wanted revision, without section extraction. More...

	getSummaryInputAttributes (array $inputAttrs=null)
	Helper function for summary input functions, which returns the necessary attributes for the input. More...

	guessSectionName ( $text)
	Turns section name wikitext into anchors for use in HTTP redirects. More...

	handleStatus (Status $status, $resultDetails)
	Handle status, such as after attempt save. More...

	incrementEditFailureStats ( $failureType)

	incrementResolvedConflicts ()
	Log when a page was successfully saved after the edit conflict view. More...

	mergeChangesIntoContent (&$editContent)
	Attempts to do 3-way merge of edit content with a base revision and current content, in case of edit conflict, in whichever way appropriate for the content type. More...

	newSectionSummary (&$sectionanchor=null)
	Return the summary to be used for a new section. More...

	newTextConflictHelper ( $submitButtonLabel)

Private Attributes
null array	$changeTags = null

TextConflictHelper null	$editConflictHelper

callable	$editConflictHelperFactory
	Factory function to create an edit conflict helper. More...

int	$editRevId = null
	Revision ID of the latest revision of the page when editing was initiated on the client. More...

bool	$enableApiEditOverride = false
	Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing. More...

bool	$isOldRev = false
	Whether an old revision is edited. More...

null Title	$mContextTitle = null

WikiPage	$page

string null	$unicodeCheck
	What the user submitted in the 'wpUnicodeCheck' field. More...

Detailed Description

The edit page/HTML interface (split from Article) The actual database and text munging is still in Article, but it should get easier to call those from alternate interfaces.

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.

Definition at line 44 of file EditPage.php.

Constructor & Destructor Documentation

◆ __construct()

EditPage::__construct ( Article $article )

Parameters

Article $article

Definition at line 475 of file EditPage.php.

References $article, $handler, ContextSource\getContext(), ContentHandler\getForModelID(), Article\getPage(), ContextSource\getTitle(), and page.

Member Function Documentation

◆ addContentModelChangeLogEntry()

EditPage::addContentModelChangeLogEntry	(	User	$user,
			$oldModel,
			$newModel,
			$reason
	)

protected

Parameters

User	$user
string \| false	$oldModel	false if the page is being newly created
string	$newModel
string	$reason

Definition at line 2331 of file EditPage.php.

References $user.

Referenced by internalAttemptSave().

◆ addEditNotices()

EditPage::addEditNotices ( )

protected

Since: 1.29

Definition at line 4370 of file EditPage.php.

References $out, and captcha-old\count.

Referenced by showEditForm().

◆ addExplainConflictHeader()

EditPage::addExplainConflictHeader ( OutputPage $out )

protected

Parameters

OutputPage $out

Since: 1.29

Definition at line 4474 of file EditPage.php.

References $out, and getEditConflictHelper().

Referenced by showHeader().

◆ addLongPageWarningHeader()

EditPage::addLongPageWarningHeader ( )

protected

Since: 1.29

Definition at line 4399 of file EditPage.php.

References $lang, and $out.

Referenced by showHeader().

◆ addNewLineAtEnd()

EditPage::addNewLineAtEnd ( $wikitext )

protected

Parameters

string $wikitext

Returns: string

Since: 1.29

Definition at line 4498 of file EditPage.php.

◆ addPageProtectionWarningHeaders()

EditPage::addPageProtectionWarningHeaders ( )

protected

Since: 1.29

Definition at line 4431 of file EditPage.php.

References $out, $page, as, captcha-old\count, MWNamespace\getRestrictionLevels(), list, and LogEventsList\showLogExtract().

Referenced by showHeader().

◆ addTalkPageText()

EditPage::addTalkPageText ( )

protected

Since: 1.29

Definition at line 4390 of file EditPage.php.

Referenced by showEditForm().

◆ attemptSave()

EditPage::attemptSave ( & $resultDetails = false )

Attempt submission.

Parameters

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

Exceptions

UserBlockedError|ReadOnlyError|ThrottledError|PermissionsError

Returns: Status The resulting status object.

Definition at line 1567 of file EditPage.php.

References $bot, internalAttemptSave(), and Hooks\run().

Referenced by edit().

◆ buildTextboxAttribs()

EditPage::buildTextboxAttribs	(		$name,
		array	$customAttribs,
		User	$user
	)

protected

Parameters

string	$name
mixed[]	$customAttribs
User	$user

Returns: mixed[]

Since: 1.29

Definition at line 4487 of file EditPage.php.

References $customAttribs, $name, and $user.

◆ displayPermissionsError()

EditPage::displayPermissionsError ( array $permErrors )

protected

Display a permissions error page, like OutputPage::showPermissionsErrorPage(), but with the following differences:

If redlink=1, the user will be redirected to the page
If there is content to display or the error occurs while either saving, previewing or showing the difference, it will be a "View source for ..." page displaying the source code after the error message.

Since: 1.19

Parameters

array $permErrors Array of permissions errors, as returned by Title::getUserPermissionsErrors().

Exceptions

PermissionsError

Definition at line 753 of file EditPage.php.

References $action, $content, $out, displayViewSourcePage(), and getContentObject().

Referenced by edit().

◆ displayPreviewArea()

EditPage::displayPreviewArea	(	$previewOutput,
		$isOnTop = `false`
	)

protected

Definition at line 3420 of file EditPage.php.

References $attribs, $out, Xml\openElement(), Html\rawElement(), showDiff(), and showPreview().

Referenced by showEditForm().

◆ displayViewSourcePage()

EditPage::displayViewSourcePage	(	Content	$content,
			$errorMessage = `''`
	)

protected

Display a read-only View Source page.

Parameters

Content	$content
string	$errorMessage	additional wikitext error message to display

Definition at line 783 of file EditPage.php.

References $content, $e, $out, $textbox1, getContextTitle(), getTemplates(), makeTemplatesOnThisPageList(), Hooks\run(), showTextbox(), and toEditText().

Referenced by displayPermissionsError(), and edit().

◆ doPreviewParse()

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 4037 of file EditPage.php.

References $content, $user, and getPreviewParserOptions().

Referenced by getPreviewText().

◆ edit()

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 579 of file EditPage.php.

References $contentModel, $out, $request, DeferredUpdates\addCallableUpdate(), attemptSave(), diff, displayPermissionsError(), displayViewSourcePage(), First, getContentObject(), getEditPermissionErrors(), handleStatus(), importFormData(), initialiseForm(), Revision\newFromId(), noSuchSectionPage(), plain, previewOnOpen(), Hooks\run(), save, showEditForm(), showIntro(), wfDebug(), and wfReadOnly().

Referenced by importFormData(), and submit().

◆ extractSectionTitle()

static EditPage::extractSectionTitle ( $text )

static

Extract the section title from current section text, if any.

Parameters

string $text

Returns: string|bool String or false

Definition at line 3039 of file EditPage.php.

References $matches, and $wgParser.

Referenced by showHeader(), and EditPageTest\testExtractSectionTitle().

◆ formatStatusErrors()

EditPage::formatStatusErrors ( Status $status )

private

Wrap status errors in an errorbox for increased visibility.

Parameters

Status $status

Returns: string Wikitext

Definition at line 1782 of file EditPage.php.

References div.

Referenced by runPostMergeFilters().

◆ getActionURL()

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 3775 of file EditPage.php.

References $title, and captcha-old\action.

Referenced by showEditForm().

◆ getArticle()

EditPage::getArticle ( )

Returns: Article

Definition at line 491 of file EditPage.php.

References $mArticle.

Referenced by WikiEditorHooks\editPageAttemptSave(), WikiEditorHooks\editPageAttemptSaveAfter(), and WikiEditorHooks\editPageShowEditFormInitial().

◆ getBaseRevision()

EditPage::getBaseRevision ( )

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

Warning: this method is very poorly named. If the user opened the form with ?oldid=X, one might think of X as the "base revision", which is NOT what this returns, see oldid for that. One might further assume that this corresponds to the $baseRevId parameter of WikiPage::doEditContent, which is not the case either. getExpectedParentRevision() would perhaps be a better name.

Returns: Revision|null Current version when editing was initiated on the client

Definition at line 2422 of file EditPage.php.

References $mBaseRevision, DB_MASTER, Revision\loadFromTimestamp(), Revision\newFromId(), and wfGetDB().

Referenced by mergeChangesIntoContent().

◆ getCancelLink()

EditPage::getCancelLink ( )

Returns: string

Definition at line 3748 of file EditPage.php.

References $oldid, and getContextTitle().

Referenced by showStandardInputs().

◆ getCheckboxesDefinition()

EditPage::getCheckboxesDefinition ( $checked )

Return an array of checkbox definitions.

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

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
Parameters

array $checked Array of checkbox name (matching the 'legacy-name') => bool, where bool indicates the checked status of the checkbox

Returns
array

Definition at line 4113 of file EditPage.php.

References $user, and Hooks\run().

Referenced by getCheckboxesWidget().

◆ getCheckboxesWidget()

EditPage::getCheckboxesWidget	(	&	$tabindex,
			$checked
	)

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

Parameters

int	&$tabindex	Current tabindex
array	$checked	Array of checkbox => bool, where bool indicates the checked status of the checkbox

Returns: array Associative array of string keys to OOUI\FieldLayout instances

Definition at line 4158 of file EditPage.php.

References $name, $options, $tabindex, $title, as, getCheckboxesDefinition(), and Linker\titleAttrib().

Referenced by showStandardInputs().

◆ getContentObject()

EditPage::getContentObject ( $def_content = null )

protected

Parameters

Content | null $def_content The default value to return

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

Since: 1.21

Definition at line 1176 of file EditPage.php.

References $content, $out, $params, $request, $summary, $user, Revision\DELETED_TEXT, getOriginalContent(), getPreloadedContent(), WikiPage\hasDifferencesOutsideMainSlot(), isSupportedContentModel(), Revision\newFromId(), ParserOptions\newFromUserAndLang(), NS_MEDIAWIKI, page, Revision\RAW, toEditContent(), and true.

Referenced by displayPermissionsError(), edit(), and initialiseForm().

◆ getContext()

EditPage::getContext ( )

Since: 1.28

Returns: IContextSource

Definition at line 499 of file EditPage.php.

References $context.

Referenced by newTextConflictHelper().

◆ getContextTitle()

EditPage::getContextTitle ( )

Get the context title object.

If not set, $wgTitle will be returned, but this is deprecated. This will throw an exception.

Returns: Title

Definition at line 528 of file EditPage.php.

References $mContextTitle, $wgTitle, and wfDeprecated().

Referenced by displayViewSourcePage(), getCancelLink(), setHeaders(), showEditForm(), and spamPageWithContent().

◆ getCopyrightWarning()

static EditPage::getCopyrightWarning	(	$title,
		$format = `'plain'`,
		$langcode = `null`
	)

static

Get the copyright warning, by default returns wikitext.

Parameters

Title	$title
string	$format	Output format, valid values are any function of a Message object
Language \| string \| null	$langcode	Language code or Language object.

Returns: string

Definition at line 3606 of file EditPage.php.

References $title, $wgRightsText, Hooks\run(), and wfMessage().

Referenced by getCopywarn().

◆ getCopywarn()

EditPage::getCopywarn ( )

protected

Get the copyright warning.

Renamed to getCopyrightWarning(), old name kept around for backwards compatibility

Returns: string

Definition at line 3594 of file EditPage.php.

References getCopyrightWarning().

Referenced by showStandardInputs().

◆ getCurrentContent()

EditPage::getCurrentContent ( )

protected

Get the current content of the page.

This is basically similar to WikiPage::getContent( Revision::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 1400 of file EditPage.php.

References $content, $handler, $rev, ContentHandler\getForModelID(), getTitle(), page, and Revision\RAW.

Referenced by getOriginalContent(), internalAttemptSave(), showDiff(), and showEditForm().

◆ getEditButtons()

EditPage::getEditButtons ( & $tabindex )

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

Parameters

int &$tabindex Current tabindex

Returns: array

Definition at line 4227 of file EditPage.php.

References $tabindex, Linker\accesskey(), getSubmitButtonLabel(), Hooks\run(), and Linker\titleAttrib().

Referenced by showStandardInputs().

◆ getEditConflictHelper()

EditPage::getEditConflictHelper ( )

private

Returns: TextConflictHelper

Definition at line 4542 of file EditPage.php.

References $editConflictHelper, and getSubmitButtonLabel().

Referenced by addExplainConflictHeader(), incrementConflictStats(), incrementResolvedConflicts(), showConflict(), and showEditForm().

◆ getEditPermissionErrors()

EditPage::getEditPermissionErrors ( $rigor = 'secure' )

protected

Parameters

string $rigor Same format as Title::getUserPermissionErrors()

Returns: array

Definition at line 709 of file EditPage.php.

References $user, as, diff, and wfArrayDiff2().

Referenced by edit().

◆ getEditToolbar()

static EditPage::getEditToolbar ( $title = null )

static

Allow extensions to provide a toolbar.

Parameters

Title | null $title Title object for the page being edited (optional)

Returns: string|null

Definition at line 4084 of file EditPage.php.

References Hooks\run().

◆ getLastDelete()

EditPage::getLastDelete ( )

protected

Get the last log record of this page being deleted, if ever.

This is used to detect whether a delete occurred during editing.

Returns: bool|stdClass

Definition at line 3811 of file EditPage.php.

References $dbr, DB_REPLICA, LogPage\DELETED_COMMENT, LogPage\DELETED_USER, CommentStore\getStore(), ActorMigration\newMigration(), and wfGetDB().

Referenced by wasDeletedSinceLastEdit().

◆ getOriginalContent()

EditPage::getOriginalContent ( User $user )

private

Get the content of the wanted revision, without section extraction.

The result of this function can be used to compare user's input with section replaced in its context (using WikiPage::replaceSectionAtRev()) to the original text of the edit.

This differs from Article::getContent() that when a missing revision is encountered the result will be null and not the 'missing-revision' message.

Since: 1.19

Parameters

User $user The user to get the revision for

Returns: Content|null

Definition at line 1359 of file EditPage.php.

References $content, $handler, $user, Revision\FOR_THIS_USER, getCurrentContent(), and ContentHandler\getForModelID().

Referenced by getContentObject().

◆ getParentRevId()

EditPage::getParentRevId ( )

Get the edit's parent revision ID.

The "parent" revision is the ancestor that should be recorded in this page's revision history. It is either the revision ID of the in-memory article content, or in the case of a 3-way merge in order to rebase across a recoverable edit conflict, the ID of the newer revision to which we have rebased this page.

Since: 1.27

Returns: int Revision ID

Definition at line 1384 of file EditPage.php.

References $parentRevId.

Referenced by showEditForm().

◆ getPreloadedContent()

EditPage::getPreloadedContent	(	$preload,
		$params = `[]`
	)

protected

Get the contents to be preloaded into the box, either set by an earlier setPreloadText() or by loading the given page.

Parameters

string	$preload	Representing the title to preload from.
array	$params	Parameters to use (interface-message style) in the preloaded text

Returns: Content

Since: 1.21

Definition at line 1461 of file EditPage.php.

References $content, $handler, $mPreloadContent, $page, $params, $title, $user, WikiPage\factory(), WikiPage\getContent(), ContentHandler\getForModelID(), WikiPage\getRedirectTarget(), WikiPage\isRedirect(), Title\newFromText(), ParserOptions\newFromUser(), Revision\RAW, and wfDebug().

Referenced by getContentObject().

◆ getPreviewLimitReport()

static 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 3634 of file EditPage.php.

References $output, $value, $wgLang, as, Html\closeElement(), Html\openElement(), Html\rawElement(), Hooks\run(), and wfMessage().

Referenced by ApiParse\execute().

◆ getPreviewParserOptions()

EditPage::getPreviewParserOptions ( )

protected

Get parser options for a preview.

Returns: ParserOptions

Definition at line 4014 of file EditPage.php.

References page.

Referenced by doPreviewParse().

◆ getPreviewText()

EditPage::getPreviewText ( )

Get the rendered text for previewing.

Exceptions

MWException

Returns: string

Definition at line 3859 of file EditPage.php.

References $attribs, $content, $mTokenOk, $out, $previewTextAfterContent, CONTENT_MODEL_CSS, CONTENT_MODEL_JAVASCRIPT, CONTENT_MODEL_JSON, captcha-old\count, doPreviewParse(), getTitle(), incrementEditFailureStats(), Html\rawElement(), Hooks\run(), toEditContent(), and true.

Referenced by showEditForm().

◆ getSubmitButtonLabel()

EditPage::getSubmitButtonLabel ( )

protected

Get the message key of the label for the button to save the page.

Since: 1.30

Returns: string

Definition at line 4203 of file EditPage.php.

Referenced by getEditButtons(), getEditConflictHelper(), and showHeader().

◆ getSummaryInputAttributes()

EditPage::getSummaryInputAttributes ( array $inputAttrs = null )

private

Helper function for summary input functions, which returns the necessary attributes for the input.

Parameters

array | null $inputAttrs Array of attrs to use on the input

Returns: array

Definition at line 3217 of file EditPage.php.

References CommentStore\COMMENT_CHARACTER_LIMIT, and MIGRATION_OLD.

Referenced by getSummaryInputWidget().

◆ getSummaryInputWidget()

EditPage::getSummaryInputWidget	(	$summary = `""`,
		$labelText = `null`,
		$inputAttrs = `null`
	)

Builds a standard summary input with a label.

Parameters

string	$summary	The value of the summary input
string \| null	$labelText	The html to place inside the label
array \| null	$inputAttrs	Array of attrs to use on the input

Returns: OOUI\FieldLayout OOUI FieldLayout with Label and Input

Definition at line 3242 of file EditPage.php.

References $summary, Linker\accesskey(), getSummaryInputAttributes(), and Linker\titleAttrib().

Referenced by showSummaryInput().

◆ getSummaryPreview()

EditPage::getSummaryPreview	(	$isSubjectPreview,
		$summary = `""`
	)

protected

Parameters

bool	$isSubjectPreview	True if this is the section subject/title up top, or false if this is the comment summary down below the textarea
string	$summary	The text of the summary to display

Returns: string

Definition at line 3303 of file EditPage.php.

References $summary, $wgParser, Linker\commentBlock(), diff, and Xml\tags().

Referenced by showEditForm(), and showStandardInputs().

◆ getTemplates()

EditPage::getTemplates ( )

Returns: array

Definition at line 4061 of file EditPage.php.

References $template, as, and Title\makeTitle().

Referenced by displayViewSourcePage(), and showEditForm().

◆ getTitle()

EditPage::getTitle ( )

Since: 1.19

Returns: Title

Definition at line 507 of file EditPage.php.

References $mTitle.

Referenced by getCurrentContent(), getPreviewText(), internalAttemptSave(), newTextConflictHelper(), showHeader(), showTextbox1(), toEditContent(), and SpamBlacklistHooks\validate().

◆ guessSectionName()

EditPage::guessSectionName ( $text )

private

Turns section name wikitext into anchors for use in HTTP redirects.

Various versions of Microsoft browsers misinterpret fragment encoding of Location: headers resulting in mojibake in address bar. Redirect them to legacy section IDs, if possible. All the other browsers get HTML5 if the wiki is configured for it, to spread the new style links more efficiently.

Parameters

string $text

Returns: string

Definition at line 4512 of file EditPage.php.

References $name, and $wgParser.

Referenced by internalAttemptSave(), and newSectionSummary().

◆ handleStatus()

EditPage::handleStatus	(	Status	$status,
			$resultDetails
	)

private

Handle status, such as after attempt save.

Parameters

Status	$status
array \| bool	$resultDetails

Exceptions

ErrorPageError

Returns: bool False, if output is done, true if rest of the form should be displayed

Definition at line 1601 of file EditPage.php.

References $out, $query, $request, AS_ARTICLE_WAS_DELETED, AS_BLANK_ARTICLE, AS_BLOCKED_PAGE_FOR_USER, AS_CANNOT_USE_CUSTOM_MODEL, AS_CONFLICT_DETECTED, AS_CONTENT_TOO_BIG, AS_END, AS_HOOK_ERROR, AS_HOOK_ERROR_EXPECTED, AS_IMAGE_REDIRECT_ANON, AS_IMAGE_REDIRECT_LOGGED, AS_MAX_ARTICLE_SIZE_EXCEEDED, AS_NO_CHANGE_CONTENT_MODEL, AS_NO_CREATE_PERMISSION, AS_PARSE_ERROR, AS_RATE_LIMITED, AS_READ_ONLY_PAGE, AS_READ_ONLY_PAGE_ANON, AS_READ_ONLY_PAGE_LOGGED, AS_SELF_REDIRECT, AS_SPAM_ERROR, AS_SUCCESS_NEW_ARTICLE, AS_SUCCESS_UPDATE, AS_SUMMARY_NEEDED, AS_TEXTBOX_EMPTY, AS_UNICODE_NOT_SUPPORTED, incrementResolvedConflicts(), Hooks\run(), setPostEditCookie(), and spamPageWithContent().

Referenced by edit().

◆ importContentFormData()

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 1128 of file EditPage.php.

Referenced by importFormData().

◆ importFormData()

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 908 of file EditPage.php.

References $changeTags, $diff, $e, $handler, $preview, $request, $textbox1, $undidRev, $user, diff, edit(), ContentHandler\getForModelID(), ContentHandler\getLocalizedName(), importContentFormData(), isSectionEditSupported(), NS_USER, NS_USER_TALK, Hooks\run(), save, tokenOk(), true, wfDebug(), wfEscapeWikiText(), and wfTimestampNow().

Referenced by edit().

◆ incrementConflictStats()

EditPage::incrementConflictStats ( )

protected

Definition at line 3741 of file EditPage.php.

References getEditConflictHelper().

Referenced by showConflict().

◆ incrementEditFailureStats()

EditPage::incrementEditFailureStats ( $failureType )

private

Definition at line 4005 of file EditPage.php.

Referenced by getPreviewText().

◆ incrementResolvedConflicts()

EditPage::incrementResolvedConflicts ( )

private

Log when a page was successfully saved after the edit conflict view.

Definition at line 1584 of file EditPage.php.

References getEditConflictHelper().

Referenced by handleStatus().

◆ initialiseForm()

EditPage::initialiseForm ( )

Initialise form fields in the object Called on the first invocation, e.g.

when a user clicks an edit link

Returns: bool If the requested section is valid

Definition at line 1137 of file EditPage.php.

References $content, $isNew, $user, content, getContentObject(), page, and toEditText().

Referenced by edit().

◆ internalAttemptSave()

EditPage::internalAttemptSave	(	&	$result,
			$bot = `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 doEditContent is OK. True if null edit, false otherwise. redirect (bool): Set if doEditContent is OK. True if resulting revision is a redirect.
bool	$bot	True if edit is being made under the bot right.

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 1850 of file EditPage.php.

References $autoSumm, $bot, $changeTags, $code, $content, $edittime, $matches, $mTitle, $request, $sectiontitle, $summary, $undidRev, $user, addContentModelChangeLogEntry(), AS_CANNOT_USE_CUSTOM_MODEL, AS_CHANGE_TAG_ERROR, AS_END, AS_HOOK_ERROR, AS_HOOK_ERROR_EXPECTED, AS_IMAGE_REDIRECT_ANON, AS_IMAGE_REDIRECT_LOGGED, AS_NO_CREATE_PERMISSION, AS_PARSE_ERROR, AS_RATE_LIMITED, AS_READ_ONLY_PAGE, AS_READ_ONLY_PAGE_LOGGED, AS_SELF_REDIRECT, AS_SPAM_ERROR, AS_SUCCESS_NEW_ARTICLE, AS_SUCCESS_UPDATE, AS_SUMMARY_NEEDED, AS_TEXTBOX_EMPTY, AS_UNICODE_NOT_SUPPORTED, ChangeTags\canAddTagsAccompanyingChange(), DB_MASTER, EDIT_AUTOSUMMARY, EDIT_FORCE_BOT, EDIT_MINOR, EDIT_NEW, EDIT_UPDATE, etc, false, ContentHandler\getContentText(), getCurrentContent(), getTitle(), guessSectionName(), matchSpamRegex(), matchSummarySpamRegex(), mergeChangesIntoContent(), StatusValue\newGood(), newSectionSummary(), not, NS_FILE, NS_MEDIAWIKI, of, page, Hooks\run(), runPostMergeFilters(), Title\setContentModel(), toEditContent(), toEditText(), updateWatchlist(), Revision\userWasLastToEdit(), wasDeletedSinceLastEdit(), wfDebug(), wfDebugLog(), and wfReadOnly().

Referenced by attemptSave().

◆ isSectionEditSupported()

EditPage::isSectionEditSupported ( )

protected

Returns whether section editing is supported for the current page.

Subclasses may override this to replace the default behavior, which is to check ContentHandler::supportsSections.

Returns: bool True if this edit page supports sections, false otherwise.

Definition at line 898 of file EditPage.php.

References ContentHandler\getForTitle().

Referenced by importFormData(), and showEditForm().

◆ isSupportedContentModel()

EditPage::isSupportedContentModel ( $modelId )

Returns if the given content model is editable.

Parameters

string $modelId The ID of the content model to test. Use CONTENT_MODEL_XXX constants.

Returns: bool

Exceptions

MWException If $modelId has no known handler

Definition at line 545 of file EditPage.php.

References ContentHandler\getForModelID().

Referenced by getContentObject(), toEditContent(), and toEditText().

◆ isWrongCaseUserConfigPage()

EditPage::isWrongCaseUserConfigPage ( )

protected

Checks whether the user entered a skin name in uppercase, e.g.

"User:Example/Monobook.css" instead of "monobook.css"

Returns: bool

Definition at line 877 of file EditPage.php.

References $name, and Skin\getSkinNames().

Referenced by showHeader().

◆ makeTemplatesOnThisPageList()

EditPage::makeTemplatesOnThisPageList ( array $templates )

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

Parameters

Title[] $templates

Returns: string HTML

Definition at line 3015 of file EditPage.php.

References $type, and Html\rawElement().

Referenced by displayViewSourcePage(), and showEditForm().

◆ matchSpamRegex()

static EditPage::matchSpamRegex ( $text )

static

Check given input text against $wgSpamRegex, and return the text of the first match.

Parameters

string $text

Returns: string|bool Matching string or false

Definition at line 2439 of file EditPage.php.

References $wgSpamRegex, array(), and matchSpamRegexInternal().

Referenced by internalAttemptSave().

◆ matchSpamRegexInternal()

static EditPage::matchSpamRegexInternal	(	$text,
		$regexes
	)

staticprotected

Parameters

string	$text
array	$regexes

Returns: bool|string

Definition at line 2464 of file EditPage.php.

References $matches, and as.

Referenced by matchSpamRegex(), and matchSummarySpamRegex().

◆ matchSummarySpamRegex()

static EditPage::matchSummarySpamRegex ( $text )

static

Check given input text against $wgSummarySpamRegex, and return the text of the first match.

Parameters

string $text

Returns: string|bool Matching string or false

Definition at line 2453 of file EditPage.php.

References $wgSummarySpamRegex, array(), and matchSpamRegexInternal().

Referenced by MovePage\checkPermissions(), MergeHistory\checkPermissions(), SpecialChangeContentModel\getFormFields(), and internalAttemptSave().

◆ mergeChangesIntoContent()

EditPage::mergeChangesIntoContent ( & $editContent )

private

Attempts to do 3-way merge of edit content with a base revision and current content, in case of edit conflict, in whichever way appropriate for the content type.

Since: 1.21

Parameters

Content $editContent

Returns: bool

Definition at line 2376 of file EditPage.php.

References $handler, DB_MASTER, getBaseRevision(), ContentHandler\getForModelID(), Revision\loadFromTitle(), and wfGetDB().

Referenced by internalAttemptSave().

◆ newSectionSummary()

EditPage::newSectionSummary ( & $sectionanchor = null )

private

Return the summary to be used for a new section.

Parameters

string $sectionanchor Set to the section anchor text

Returns: string

Definition at line 1802 of file EditPage.php.

References $summary, $wgParser, and guessSectionName().

Referenced by internalAttemptSave().

◆ newTextConflictHelper()

EditPage::newTextConflictHelper ( $submitButtonLabel )

private

Parameters

string $submitButtonLabel

Returns: TextConflictHelper

Definition at line 4557 of file EditPage.php.

References getContext(), and getTitle().

◆ noSuchSectionPage()

EditPage::noSuchSectionPage ( )

Creates a basic error page which informs the user that they have attempted to edit a nonexistent section.

Definition at line 4296 of file EditPage.php.

References $out, $res, and Hooks\run().

Referenced by edit().

◆ previewOnOpen()

EditPage::previewOnOpen ( )

protected

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

Returns: bool

Definition at line 836 of file EditPage.php.

References $request.

Referenced by edit().

◆ runPostMergeFilters()

EditPage::runPostMergeFilters	(	Content	$content,
		Status	$status,
		User	$user
	)

protected

Run hooks that can filter edits just before they get saved.

Parameters

Content	$content	The Content to filter.
Status	$status	For reporting the outcome to the caller
User	$user	The user performing the edit

Returns: bool

Definition at line 1735 of file EditPage.php.

References $content, $user, AS_HOOK_ERROR, AS_HOOK_ERROR_EXPECTED, formatStatusErrors(), and Hooks\run().

Referenced by internalAttemptSave().

◆ safeUnicodeInput()

EditPage::safeUnicodeInput	(	$request,
		$field
	)

protected

Filter an input field through a Unicode de-armoring process if it came from an old browser with known broken Unicode editing issues.

Deprecated:: since 1.30, does nothing

Parameters

WebRequest	$request
string	$field

Returns: string

Definition at line 4350 of file EditPage.php.

References $request.

◆ safeUnicodeOutput()

EditPage::safeUnicodeOutput ( $text )

protected

Filter an output field through a Unicode armoring process if it is going to an old browser with known broken Unicode editing issues.

Deprecated:: since 1.30, does nothing

Parameters

string $text

Returns: string

Definition at line 4363 of file EditPage.php.

◆ setApiEditOverride()

EditPage::setApiEditOverride ( $enableOverride )

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

Set to false by default.

Parameters

bool $enableOverride

Definition at line 556 of file EditPage.php.

◆ setContextTitle()

EditPage::setContextTitle ( $title )

Set the context Title object.

Parameters

Title | null $title Title object or null

Definition at line 516 of file EditPage.php.

References $title.

◆ setEditConflictHelperFactory()

EditPage::setEditConflictHelperFactory ( callable $factory )

Set a factory function to create an EditConflictHelper.

Parameters

callable $factory Factory function

Since: 1.31

Definition at line 4534 of file EditPage.php.

◆ setHeaders()

EditPage::setHeaders ( )

Definition at line 2474 of file EditPage.php.

References $out, $user, false, getContextTitle(), and NS_MEDIAWIKI.

Referenced by showEditForm().

◆ setPostEditCookie()

EditPage::setPostEditCookie ( $statusValue )

protected

Sets post-edit cookie indicating the user just saved a particular revision.

This uses a temporary cookie for each revision ID so separate saves will never interfere with each other.

Article::view deletes the cookie on server-side after the redirect and converts the value to the global JavaScript variable wgPostEdit.

If the variable were set on the server, it would be cached, which is unwanted since the post-edit state should only apply to the load right after the save.

Parameters

int $statusValue The status value (to check for new article status)

Definition at line 1546 of file EditPage.php.

References $response, and page.

Referenced by handleStatus().

◆ setPreloadedContent()

EditPage::setPreloadedContent ( Content $content )

Use this method before edit() to preload some content into the edit box.

Parameters

Content $content

Since: 1.21

Definition at line 1446 of file EditPage.php.

References $content.

◆ showConflict()

EditPage::showConflict ( )

protected

Show an edit conflict.

textbox1 is already shown in showEditForm(). If you want to use another entry point to this function, be careful.

Definition at line 3730 of file EditPage.php.

References $out, getEditConflictHelper(), incrementConflictStats(), and Hooks\run().

Referenced by showEditForm().

◆ showContentForm()

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 3362 of file EditPage.php.

References showTextbox1().

Referenced by showEditForm().

◆ showCustomIntro()

EditPage::showCustomIntro ( )

protected

Attempt to show a custom editing introduction, if supplied.

Returns: bool

Definition at line 2657 of file EditPage.php.

References $mTitle, $title, and Title\newFromText().

Referenced by showIntro().

◆ showDiff()

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 3489 of file EditPage.php.

References $user, getCurrentContent(), ParserOptions\newFromUserAndLang(), NS_MEDIAWIKI, page, Hooks\run(), and toEditContent().

Referenced by displayPreviewArea(), and spamPageWithContent().

◆ showEditForm()

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. Please use the EditPage::showEditForm:fields hook instead.

Definition at line 2742 of file EditPage.php.

References $content, $editConflictHelper, $out, $textbox1, $user, $username, addEditNotices(), addTalkPageText(), Xml\checkLabel(), Xml\closeElement(), diff, displayPreviewArea(), Xml\element(), Linker\formatHiddenCategories(), getActionURL(), getContextTitle(), getCurrentContent(), getEditConflictHelper(), MediaWiki\EditPage\TextConflictHelper\getEditConflictMainTextBox(), MediaWiki\EditPage\TextConflictHelper\getEditFormHtmlAfterContent(), MediaWiki\EditPage\TextConflictHelper\getEditFormHtmlBeforeContent(), getParentRevId(), getPreviewText(), CommentStore\getStore(), getSummaryPreview(), getTemplates(), Html\hidden(), isSectionEditSupported(), makeTemplatesOnThisPageList(), Xml\openElement(), Html\openElement(), page, Html\rawElement(), Hooks\run(), MediaWiki\EditPage\TextConflictHelper\setContentFormat(), MediaWiki\EditPage\TextConflictHelper\setContentModel(), setHeaders(), MediaWiki\EditPage\TextConflictHelper\setTextboxes(), showConflict(), showContentForm(), showEditTools(), showFormAfterText(), showFormBeforeText(), showHeader(), showStandardInputs(), showSummaryInput(), showTosSummary(), Linker\titleAttrib(), toEditText(), wasDeletedSinceLastEdit(), and wfWarn().

Referenced by edit().

◆ showEditTools()

EditPage::showEditTools ( )

protected

Inserts optional text shown below edit and upload forms.

Can be used to offer special characters not present on most keyboards for copying/pasting.

Definition at line 3582 of file EditPage.php.

Referenced by showEditForm().

◆ showFormAfterText()

EditPage::showFormAfterText ( )

protected

Definition at line 3334 of file EditPage.php.

References Html\hidden().

Referenced by showEditForm().

◆ showFormBeforeText()

EditPage::showFormBeforeText ( )

protected

Definition at line 3325 of file EditPage.php.

References $out, and Html\hidden().

Referenced by showEditForm().

◆ showHeader()

EditPage::showHeader ( )

protected

Definition at line 3049 of file EditPage.php.

References $out, $user, addExplainConflictHeader(), addLongPageWarningHeader(), addPageProtectionWarningHeaders(), Revision\DELETED_TEXT, diff, extractSectionTitle(), getSubmitButtonLabel(), getTitle(), SpecialPage\getTitleFor(), isWrongCaseUserConfigPage(), page, showHeaderCopyrightWarning(), wfReadOnly(), and wfReadOnlyReason().

Referenced by showEditForm().

◆ showHeaderCopyrightWarning()

EditPage::showHeaderCopyrightWarning ( )

protected

Show the header copyright warning.

Definition at line 3551 of file EditPage.php.

Referenced by showHeader().

◆ showIntro()

EditPage::showIntro ( )

protected

Show all applicable editing introductions.

Definition at line 2539 of file EditPage.php.

References $dbr, $out, $user, $username, CONTENT_MODEL_CSS, CONTENT_MODEL_JAVASCRIPT, CONTENT_MODEL_JSON, DB_REPLICA, MWNamespace\getCanonicalName(), in, User\isIP(), Skin\makeInternalOrExternalUrl(), User\newFromName(), Block\newFromTarget(), not, NS_FILE, NS_MEDIAWIKI, NS_USER, NS_USER_TALK, showCustomIntro(), LogEventsList\showLogExtract(), Block\TYPE_AUTO, wfEscapeWikiText(), wfExpandUrl(), wfFindFile(), and wfGetDB().

Referenced by edit().

◆ showPreview()

EditPage::showPreview ( $text )

protected

Append preview output to OutputPage.

Includes category rendering if this is a category page.

Parameters

string $text The HTML to be output for the preview.

Definition at line 3468 of file EditPage.php.

References $out, and Hooks\run().

Referenced by displayPreviewArea().

◆ showStandardInputs()

EditPage::showStandardInputs ( & $tabindex = 2 )

protected

Definition at line 3680 of file EditPage.php.

References $out, $tabindex, getCancelLink(), getCheckboxesWidget(), getCopywarn(), getEditButtons(), getSummaryPreview(), Html\linkButton(), Skin\makeInternalOrExternalUrl(), Hooks\run(), and showSummaryInput().

Referenced by showEditForm().

◆ showSummaryInput()

EditPage::showSummaryInput	(	$isSubjectPreview,
		$summary = `""`
	)

protected

Parameters

bool	$isSubjectPreview	True if this is the section subject/title up top, or false if this is the comment summary down below the textarea
string	$summary	The text of the summary to display

Definition at line 3275 of file EditPage.php.

References getSummaryInputWidget().

Referenced by showEditForm(), and showStandardInputs().

◆ showTextbox()

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

protected

Definition at line 3406 of file EditPage.php.

References $attribs, $customAttribs, $mTitle, $name, and Html\textarea().

Referenced by displayViewSourcePage(), showTextbox1(), and showTextbox2().

◆ showTextbox1()

EditPage::showTextbox1	(	$customAttribs = `null`,
		$textoverride = `null`
	)

protected

Method to output wpTextbox1 The $textoverride method can be used by subclasses overriding showContentForm to pass back to this method.

Parameters

array \| null	$customAttribs	Array of html attributes to use in the textarea
string \| null	$textoverride	Optional text to override $this->textarea1 with

Definition at line 3374 of file EditPage.php.

References $attribs, $customAttribs, getTitle(), showTextbox(), and wasDeletedSinceLastEdit().

Referenced by showContentForm().

◆ showTextbox2()

EditPage::showTextbox2 ( )

protected

Definition at line 3402 of file EditPage.php.

References showTextbox().

Referenced by spamPageWithContent().

◆ showTosSummary()

EditPage::showTosSummary ( )

protected

Give a chance for site and per-namespace customizations of terms of service summary link that might exist separately from the copyright notice.

This will display between the save button and the edit tools, so should remain short!

Definition at line 3567 of file EditPage.php.

References $out, and Hooks\run().

Referenced by showEditForm().

◆ spamPageWithContent()

EditPage::spamPageWithContent ( $match = false )

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

Parameters

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

Definition at line 4315 of file EditPage.php.

References $out, $textbox1, getContextTitle(), showDiff(), showTextbox2(), and wfEscapeWikiText().

Referenced by handleStatus().

◆ submit()

EditPage::submit ( )

Deprecated:: since 1.29, call edit directly

Definition at line 563 of file EditPage.php.

References edit(), and wfDeprecated().

◆ toEditContent()

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 | bool $text Text to unserialize

Returns: Content|bool|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 2719 of file EditPage.php.

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

Referenced by getContentObject(), getPreviewText(), internalAttemptSave(), and showDiff().

◆ toEditText()

EditPage::toEditText ( $content )

protected

Gets an editable textual representation of $content.

The textual representation can be turned by into a Content object by the toEditContent() method.

If $content is null or false or a string, $content is returned unchanged.

If the given 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

Content | null | bool | string $content

Returns: string The editable text form of the content.

Exceptions

MWException If $content is not an instance of TextContent and $this->allowNonTextContent is not true.

Definition at line 2691 of file EditPage.php.

References $content, and isSupportedContentModel().

Referenced by displayViewSourcePage(), initialiseForm(), internalAttemptSave(), and showEditForm().

◆ tokenOk()

EditPage::tokenOk ( & $request )

Make sure the form isn't faking a user's credentials.

Parameters

WebRequest &$request

Returns: bool

Access:\n private

Definition at line 1524 of file EditPage.php.

References $mTokenOk, $request, and $user.

Referenced by importFormData().

◆ updateWatchlist()

EditPage::updateWatchlist ( )

protected

Register the change of watch status.

Definition at line 2348 of file EditPage.php.

References $mTitle, $title, $user, $watchthis, DeferredUpdates\addCallableUpdate(), WatchAction\doWatchOrUnwatch(), User\IGNORE_USER_RIGHTS, and use.

Referenced by internalAttemptSave().

◆ wasDeletedSinceLastEdit()

EditPage::wasDeletedSinceLastEdit ( )

protected

Check if a page was deleted while the user was editing it, before submit.

Note that we rely on the logging table, which hasn't been always there, but that doesn't matter, because this only applies to brand new deletes.

Returns: bool

Definition at line 3786 of file EditPage.php.

References $deletedSinceEdit, getLastDelete(), and wfTimestamp().

Referenced by internalAttemptSave(), showEditForm(), and showTextbox1().

Member Data Documentation

◆ $action

string EditPage::$action = 'submit'

Definition at line 236 of file EditPage.php.

Referenced by displayPermissionsError().

◆ $allowBlankArticle

bool EditPage::$allowBlankArticle = false

protected

Definition at line 290 of file EditPage.php.

◆ $allowBlankSummary

bool EditPage::$allowBlankSummary = false

Definition at line 284 of file EditPage.php.

◆ $allowSelfRedirect

bool EditPage::$allowSelfRedirect = false

protected

Definition at line 296 of file EditPage.php.

◆ $autoSumm

string EditPage::$autoSumm = ''

Definition at line 299 of file EditPage.php.

Referenced by internalAttemptSave().

◆ $blankArticle

bool EditPage::$blankArticle = false

protected

Definition at line 287 of file EditPage.php.

◆ $bot

bool EditPage::$bot = true

Definition at line 403 of file EditPage.php.

Referenced by attemptSave(), and internalAttemptSave().

◆ $changeTags

null array EditPage::$changeTags = null

private

Definition at line 412 of file EditPage.php.

Referenced by importFormData(), and internalAttemptSave().

◆ $contentFormat

null string EditPage::$contentFormat = null

Definition at line 409 of file EditPage.php.

◆ $contentLength

bool int EditPage::$contentLength = false

protected

Definition at line 438 of file EditPage.php.

◆ $contentModel

string EditPage::$contentModel

Definition at line 406 of file EditPage.php.

Referenced by edit().

◆ $context

IContextSource EditPage::$context

protected

Definition at line 448 of file EditPage.php.

Referenced by getContext().

◆ $deletedSinceEdit

bool EditPage::$deletedSinceEdit

Definition at line 248 of file EditPage.php.

Referenced by wasDeletedSinceLastEdit().

◆ $didSave

EditPage::$didSave = false

Definition at line 429 of file EditPage.php.

◆ $diff

bool EditPage::$diff = false

Definition at line 325 of file EditPage.php.

Referenced by importFormData().

◆ $edit

bool EditPage::$edit

protected

Definition at line 435 of file EditPage.php.

◆ $editConflictHelper

TextConflictHelper null EditPage::$editConflictHelper

private

Definition at line 470 of file EditPage.php.

Referenced by getEditConflictHelper(), and showEditForm().

◆ $editConflictHelperFactory

callable EditPage::$editConflictHelperFactory

private

Factory function to create an edit conflict helper.

Definition at line 465 of file EditPage.php.

◆ $editFormPageTop

string EditPage::$editFormPageTop = ''

Before even the preview.

Definition at line 418 of file EditPage.php.

◆ $editFormTextAfterContent

EditPage::$editFormTextAfterContent = ''

Definition at line 424 of file EditPage.php.

◆ $editFormTextAfterTools

EditPage::$editFormTextAfterTools = ''

Definition at line 422 of file EditPage.php.

◆ $editFormTextAfterWarn

EditPage::$editFormTextAfterWarn = ''

Definition at line 421 of file EditPage.php.

◆ $editFormTextBeforeContent

EditPage::$editFormTextBeforeContent = ''

Definition at line 420 of file EditPage.php.

◆ $editFormTextBottom

EditPage::$editFormTextBottom = ''

Definition at line 423 of file EditPage.php.

◆ $editFormTextTop

EditPage::$editFormTextTop = ''

Definition at line 419 of file EditPage.php.

◆ $editintro

string EditPage::$editintro = ''

Definition at line 397 of file EditPage.php.

◆ $editRevId

int EditPage::$editRevId = null

private

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

This is used to detect and resolve edit conflicts.

Note: 0 if the page did not exist at that time.; When starting an edit from an old revision, this still records the current revision at the time, not the one the edit is based on.

See also: $oldid; getBaseRevision()

Definition at line 369 of file EditPage.php.

◆ $edittime

string EditPage::$edittime = ''

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

Definition at line 356 of file EditPage.php.

Referenced by internalAttemptSave().

◆ $enableApiEditOverride

bool EditPage::$enableApiEditOverride = false

private

Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing.

Definition at line 443 of file EditPage.php.

◆ $firsttime

bool EditPage::$firsttime

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

Definition at line 257 of file EditPage.php.

◆ $formtype

string EditPage::$formtype

Definition at line 251 of file EditPage.php.

◆ $hasPresetSummary

bool EditPage::$hasPresetSummary = false

Has a summary been preset using GET parameter &summary= ?

Definition at line 308 of file EditPage.php.

◆ $hookError

string EditPage::$hookError = ''

Definition at line 302 of file EditPage.php.

◆ $incompleteForm

bool EditPage::$incompleteForm = false

Definition at line 272 of file EditPage.php.

◆ $isConflict

bool 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 242 of file EditPage.php.

◆ $isNew

bool EditPage::$isNew = false

New page or new section.

Definition at line 245 of file EditPage.php.

Referenced by initialiseForm().

◆ $isOldRev

bool EditPage::$isOldRev = false

private

Whether an old revision is edited.

Definition at line 453 of file EditPage.php.

◆ $lastDelete

bool stdClass EditPage::$lastDelete

Definition at line 260 of file EditPage.php.

◆ $mArticle

Article EditPage::$mArticle

Deprecated:: for public usage since 1.30 use EditPage::getArticle()

Definition at line 222 of file EditPage.php.

Referenced by getArticle().

◆ $mBaseRevision

Revision bool null EditPage::$mBaseRevision = false

A revision object corresponding to $this->editRevId.

Definition at line 311 of file EditPage.php.

Referenced by getBaseRevision().

◆ $mContextTitle

null Title EditPage::$mContextTitle = null

private

Definition at line 233 of file EditPage.php.

Referenced by getContextTitle().

◆ $minoredit

bool EditPage::$minoredit = false

Definition at line 328 of file EditPage.php.

◆ $missingComment

bool EditPage::$missingComment = false

Definition at line 278 of file EditPage.php.

◆ $missingSummary

bool EditPage::$missingSummary = false

Definition at line 281 of file EditPage.php.

◆ $mParserOutput

ParserOutput EditPage::$mParserOutput

Definition at line 305 of file EditPage.php.

◆ $mPreloadContent

EditPage::$mPreloadContent = null

Definition at line 426 of file EditPage.php.

Referenced by getPreloadedContent().

◆ $mShowSummaryField

bool EditPage::$mShowSummaryField = true

Definition at line 314 of file EditPage.php.

◆ $mTitle

Title EditPage::$mTitle

Deprecated:: for public usage since 1.30 use EditPage::getTitle()

Definition at line 230 of file EditPage.php.

Referenced by getTitle(), internalAttemptSave(), showCustomIntro(), showTextbox(), and updateWatchlist().

◆ $mTokenOk

bool EditPage::$mTokenOk = false

Definition at line 263 of file EditPage.php.

Referenced by getPreviewText(), and tokenOk().

◆ $mTokenOkExceptSuffix

bool EditPage::$mTokenOkExceptSuffix = false

Definition at line 266 of file EditPage.php.

◆ $mTriedSave

bool EditPage::$mTriedSave = false

Definition at line 269 of file EditPage.php.

◆ $nosummary

bool EditPage::$nosummary = false

If true, hide the summary field.

Definition at line 350 of file EditPage.php.

◆ $oldid

int 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 387 of file EditPage.php.

Referenced by getCancelLink().

◆ $page

WikiPage EditPage::$page

private

Definition at line 224 of file EditPage.php.

Referenced by addPageProtectionWarningHeaders(), and getPreloadedContent().

◆ $parentRevId

int EditPage::$parentRevId = 0

Revision ID the edit is based on, adjusted when an edit conflict is resolved.

See also: $editRevId; $oldid; getparentRevId()

Definition at line 394 of file EditPage.php.

Referenced by getParentRevId().

◆ $preview

bool EditPage::$preview = false

Definition at line 322 of file EditPage.php.

Referenced by importFormData().

◆ $previewTextAfterContent

EditPage::$previewTextAfterContent = ''

Definition at line 425 of file EditPage.php.

Referenced by getPreviewText().

◆ $recreate

bool EditPage::$recreate = false

Definition at line 334 of file EditPage.php.

◆ $save

bool EditPage::$save = false

Definition at line 319 of file EditPage.php.

◆ $scrolltop

null EditPage::$scrolltop = null

Definition at line 400 of file EditPage.php.

◆ $section

string EditPage::$section = ''

Definition at line 372 of file EditPage.php.

◆ $sectiontitle

string EditPage::$sectiontitle = ''

Definition at line 375 of file EditPage.php.

Referenced by internalAttemptSave().

◆ $selfRedirect

bool EditPage::$selfRedirect = false

protected

Definition at line 293 of file EditPage.php.

◆ $starttime

string EditPage::$starttime = ''

Timestamp from the first time the edit form was rendered.

Definition at line 380 of file EditPage.php.

◆ $summary

string EditPage::$summary = ''

Definition at line 345 of file EditPage.php.

Referenced by getContentObject(), getSummaryInputWidget(), getSummaryPreview(), internalAttemptSave(), and newSectionSummary().

◆ $suppressIntro

EditPage::$suppressIntro = false

Definition at line 432 of file EditPage.php.

◆ $textbox1

string EditPage::$textbox1 = ''

Page content input field.

Definition at line 339 of file EditPage.php.

Referenced by displayViewSourcePage(), importFormData(), showEditForm(), and spamPageWithContent().

◆ $textbox2

string EditPage::$textbox2 = ''

Definition at line 342 of file EditPage.php.

◆ $tooBig

bool EditPage::$tooBig = false

Definition at line 275 of file EditPage.php.

◆ $undidRev

EditPage::$undidRev = 0

Definition at line 430 of file EditPage.php.

Referenced by importFormData(), and internalAttemptSave().

◆ $unicodeCheck

string null EditPage::$unicodeCheck

private

What the user submitted in the 'wpUnicodeCheck' field.

Definition at line 458 of file EditPage.php.

◆ $watchthis

bool EditPage::$watchthis = false

Definition at line 331 of file EditPage.php.

Referenced by updateWatchlist().

◆ AS_ARTICLE_WAS_DELETED

const EditPage::AS_ARTICLE_WAS_DELETED = 222

Status: article was deleted while editing and param wpRecreate == false or form was not posted.

Definition at line 104 of file EditPage.php.

Referenced by WikiEditorHooks\editPageAttemptSaveAfter(), ApiEditPage\execute(), and handleStatus().

◆ AS_BLANK_ARTICLE

const EditPage::AS_BLANK_ARTICLE = 224

Status: user tried to create a blank page and wpIgnoreBlankArticle == false.

Definition at line 115 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), EditPageTest\provideCreatePages(), EditPageTest\testCreatePage(), and EditPageTest\testCreatePageTrx().

◆ AS_BLOCKED_PAGE_FOR_USER

const EditPage::AS_BLOCKED_PAGE_FOR_USER = 215

Status: User is blocked from editing this page.

Definition at line 73 of file EditPage.php.

Referenced by ApiEditPage\execute(), and handleStatus().

◆ AS_CANNOT_USE_CUSTOM_MODEL

const EditPage::AS_CANNOT_USE_CUSTOM_MODEL = 241

Status: when changing the content model is disallowed due to $wgContentHandlerUseDB being false.

Definition at line 185 of file EditPage.php.

Referenced by handleStatus(), and internalAttemptSave().

◆ AS_CHANGE_TAG_ERROR

const EditPage::AS_CHANGE_TAG_ERROR = 237

Status: an error relating to change tagging.

Look at the message key for more details

Definition at line 174 of file EditPage.php.

Referenced by internalAttemptSave().

◆ AS_CONFLICT_DETECTED

const EditPage::AS_CONFLICT_DETECTED = 225

Status: (non-resolvable) edit conflict.

Definition at line 120 of file EditPage.php.

Referenced by WikiEditorHooks\editPageAttemptSaveAfter(), ApiEditPage\execute(), handleStatus(), and EditPageTest\provideAutoMerge().

◆ AS_CONTENT_TOO_BIG

const EditPage::AS_CONTENT_TOO_BIG = 216

Status: Content too big (> $wgMaxArticleSize)

Definition at line 78 of file EditPage.php.

Referenced by ApiEditPage\execute(), and handleStatus().

◆ AS_END

const EditPage::AS_END = 231

Status: WikiPage::doEdit() was unsuccessful.

Definition at line 141 of file EditPage.php.

Referenced by handleStatus(), and internalAttemptSave().

◆ AS_HOOK_ERROR

const EditPage::AS_HOOK_ERROR = 210

Status: Article update aborted by a hook function.

Definition at line 63 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), internalAttemptSave(), and runPostMergeFilters().

◆ AS_HOOK_ERROR_EXPECTED

const EditPage::AS_HOOK_ERROR_EXPECTED = 212

Status: A hook function returned an error.

Definition at line 68 of file EditPage.php.

Referenced by SimpleCaptcha\confirmEditMerged(), ApiEditPage\execute(), handleStatus(), internalAttemptSave(), and runPostMergeFilters().

◆ AS_IMAGE_REDIRECT_ANON

const EditPage::AS_IMAGE_REDIRECT_ANON = 233

Status: anonymous user is not allowed to upload (User::isAllowed('upload') == false)

Definition at line 151 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), and internalAttemptSave().

◆ AS_IMAGE_REDIRECT_LOGGED

const EditPage::AS_IMAGE_REDIRECT_LOGGED = 234

Status: logged in user is not allowed to upload (User::isAllowed('upload') == false)

Definition at line 156 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), and internalAttemptSave().

◆ AS_MAX_ARTICLE_SIZE_EXCEEDED

const EditPage::AS_MAX_ARTICLE_SIZE_EXCEEDED = 229

Status: article is too big (> $wgMaxArticleSize), after merging in the new section.

Definition at line 136 of file EditPage.php.

Referenced by ApiEditPage\execute(), and handleStatus().

◆ AS_NO_CHANGE_CONTENT_MODEL

const EditPage::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 )

Definition at line 162 of file EditPage.php.

Referenced by ApiEditPage\execute(), and handleStatus().

◆ AS_NO_CREATE_PERMISSION

const EditPage::AS_NO_CREATE_PERMISSION = 223

Status: user tried to create this page, but is not allowed to do that ( Title->userCan('create') == false )

Definition at line 110 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), and internalAttemptSave().

◆ AS_PARSE_ERROR

const EditPage::AS_PARSE_ERROR = 240

Status: can't parse content.

Definition at line 179 of file EditPage.php.

Referenced by handleStatus(), and internalAttemptSave().

◆ AS_RATE_LIMITED

const EditPage::AS_RATE_LIMITED = 221

Status: rate limiter for action 'edit' was tripped.

Definition at line 98 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), and internalAttemptSave().

◆ AS_READ_ONLY_PAGE

const EditPage::AS_READ_ONLY_PAGE = 220

Status: wiki is in readonly mode (wfReadOnly() == true)

Definition at line 93 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), and internalAttemptSave().

◆ AS_READ_ONLY_PAGE_ANON

const EditPage::AS_READ_ONLY_PAGE_ANON = 218

Status: this anonymous user is not allowed to edit this page.

Definition at line 83 of file EditPage.php.

Referenced by ApiEditPage\execute(), and handleStatus().

◆ AS_READ_ONLY_PAGE_LOGGED

const EditPage::AS_READ_ONLY_PAGE_LOGGED = 219

Status: this logged in user is not allowed to edit this page.

Definition at line 88 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), and internalAttemptSave().

◆ AS_SELF_REDIRECT

const EditPage::AS_SELF_REDIRECT = 236

Status: user tried to create self-redirect (redirect to the same article) and wpIgnoreSelfRedirect == false.

Definition at line 168 of file EditPage.php.

Referenced by handleStatus(), and internalAttemptSave().

◆ AS_SPAM_ERROR

const EditPage::AS_SPAM_ERROR = 232

Status: summary contained spam according to one of the regexes in $wgSummarySpamRegex.

Definition at line 146 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), and internalAttemptSave().

◆ AS_SUCCESS_NEW_ARTICLE

const EditPage::AS_SUCCESS_NEW_ARTICLE = 201

Status: Article successfully created.

Definition at line 58 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), internalAttemptSave(), and EditPageTest\provideCreatePages().

◆ AS_SUCCESS_UPDATE

const EditPage::AS_SUCCESS_UPDATE = 200

Status: Article successfully updated.

Definition at line 53 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), internalAttemptSave(), EditPageTest\provideAutoMerge(), EditPageTest\testAutoMerge(), EditPageTest\testSectionEdit(), EditPageTest\testUpdatePage(), and EditPageTest\testUpdatePageTrx().

◆ AS_SUMMARY_NEEDED

const EditPage::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.

Definition at line 126 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), and internalAttemptSave().

◆ AS_TEXTBOX_EMPTY

const EditPage::AS_TEXTBOX_EMPTY = 228

Status: user tried to create a new section without content.

Definition at line 131 of file EditPage.php.

Referenced by ApiEditPage\execute(), handleStatus(), and internalAttemptSave().

◆ AS_UNICODE_NOT_SUPPORTED

const EditPage::AS_UNICODE_NOT_SUPPORTED = 242

Status: edit rejected because browser doesn't support Unicode.

Definition at line 190 of file EditPage.php.

Referenced by handleStatus(), and internalAttemptSave().

◆ EDITFORM_ID

const EditPage::EDITFORM_ID = 'editform'

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

Definition at line 195 of file EditPage.php.

◆ POST_EDIT_COOKIE_DURATION

const 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 216 of file EditPage.php.

◆ POST_EDIT_COOKIE_KEY_PREFIX

const 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 201 of file EditPage.php.

Referenced by Article\view().

◆ UNICODE_CHECK

const EditPage::UNICODE_CHECK = 'ℳ𝒲♥𝓊𝓃𝒾𝒸ℴ𝒹ℯ'

Used for Unicode support checks.

Definition at line 48 of file EditPage.php.

Referenced by EditPageTest\assertEdit(), ApiEditPage\execute(), and EditPageTest\testCheckDirectEditingDisallowed_forNonTextContent().

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

includes/EditPage.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addContentModelChangeLogEntry()

◆ addEditNotices()

◆ addExplainConflictHeader()

◆ addLongPageWarningHeader()

◆ addNewLineAtEnd()

◆ addPageProtectionWarningHeaders()

◆ addTalkPageText()

◆ attemptSave()

◆ buildTextboxAttribs()

◆ displayPermissionsError()

◆ displayPreviewArea()

◆ displayViewSourcePage()

◆ doPreviewParse()

◆ edit()

◆ extractSectionTitle()

◆ formatStatusErrors()

◆ getActionURL()

◆ getArticle()

◆ getBaseRevision()

◆ getCancelLink()

◆ getCheckboxesDefinition()

◆ getCheckboxesWidget()

◆ getContentObject()

◆ getContext()

◆ getContextTitle()

◆ getCopyrightWarning()

◆ getCopywarn()

◆ getCurrentContent()

◆ getEditButtons()

◆ getEditConflictHelper()

◆ getEditPermissionErrors()

◆ getEditToolbar()

◆ getLastDelete()

◆ getOriginalContent()

◆ getParentRevId()

◆ getPreloadedContent()

◆ getPreviewLimitReport()

◆ getPreviewParserOptions()

◆ getPreviewText()

◆ getSubmitButtonLabel()

◆ getSummaryInputAttributes()

◆ getSummaryInputWidget()

◆ getSummaryPreview()

◆ getTemplates()

◆ getTitle()

◆ guessSectionName()

◆ handleStatus()

◆ importContentFormData()

◆ importFormData()

◆ incrementConflictStats()

◆ incrementEditFailureStats()

◆ incrementResolvedConflicts()

◆ initialiseForm()

◆ internalAttemptSave()

◆ isSectionEditSupported()

◆ isSupportedContentModel()

◆ isWrongCaseUserConfigPage()

◆ makeTemplatesOnThisPageList()

◆ matchSpamRegex()

◆ matchSpamRegexInternal()

◆ matchSummarySpamRegex()

◆ mergeChangesIntoContent()

◆ newSectionSummary()

◆ newTextConflictHelper()

◆ noSuchSectionPage()

◆ previewOnOpen()

◆ runPostMergeFilters()

◆ safeUnicodeInput()