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 ()

	getCancelLink ()

	getCheckboxes (&$tabindex, $checked)
	Returns an array of html code of the following checkboxes old style: minor and watch. More...

	getCheckboxesOOUI (&$tabindex, $checked)
	Returns an array of html code of the following checkboxes: minor and watch. 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...

	getSummaryInput ($summary="", $labelText=null, $inputAttrs=null, $spanLabelAttrs=null)
	Standard summary input and label (wgSummary), abstracted so EditPage subclasses may reorganize the form. More...

	getSummaryInputOOUI ($summary="", $labelText=null, $inputAttrs=null)
	Same as self::getSummaryInput, but uses OOUI, instead of plain HTML. 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...

	isOouiEnabled ()
	Check if the edit page is using OOUI controls. 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...

	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 $wgOut. 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)
	Shows a bulletin board style toolbar for common editing functions. More...

static	getPreviewLimitReport ($output)
	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 = ''

bool	$firsttime

string	$formtype

bool	$hasPresetSummary = false
	Has a summary been preset using GET parameter &summary= ? More...

string	$hookError = ''

bool	$incompleteForm = false

bool	$isConflict = false

bool	$isCssJsSubpage = false

bool	$isCssSubpage = false

bool	$isJsSubpage = false

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

bool	$isWrongCaseCssJsPage = false

bool stdClass	$lastDelete

Article	$mArticle

Revision bool	$mBaseRevision = false

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

int	$oldid = 0

int	$parentRevId = 0

bool	$preview = false

	$previewTextAfterContent = ''

bool	$recreate = false

bool	$save = false

null	$scrolltop = null

string	$section = ''

string	$sectiontitle = ''

string	$starttime = ''

string	$summary = ''

	$suppressIntro = false

string	$textbox1 = ''

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

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

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

	getContentObject ($def_content=null)

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

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

	getEditPermissionErrors ($rigor= 'secure')

	getLastDelete ()

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

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

	isWrongCaseCssJsPage ()
	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 ()

	showFormAfterText ()

	showFormBeforeText ()

	showHeader ()

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

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

	showPreview ($text)
	Append preview output to $wgOut. 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
	checkUnicodeCompliantBrowser ()
	Check if the browser is on a blacklist of user-agents known to mangle UTF-8 data on form submission. More...

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

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

	getSummaryInputAttributes (array $inputAttrs=null)
	Helper function for summary input functions, which returns the neccessary attributes for the input. 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...

	makeSafe ($invalue)
	A number of web browsers are known to corrupt non-ASCII characters in a UTF-8 text editing environment. 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...

	unmakeSafe ($invalue)
	Reverse the previously applied transliteration of non-ASCII characters back to UTF-8. More...

Private Attributes
null array	$changeTags = null

integer	$editRevId = null

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

bool	$oouiEnabled = false
	Whether OOUI should be enabled here. More...

WikiPage	$page

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

Constructor & Destructor Documentation

EditPage::__construct ( Article $article )

Parameters

Article $article

Definition at line 424 of file EditPage.php.

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

Member Function Documentation

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

Referenced by internalAttemptSave().

EditPage::addEditNotices ( )

protected

Since: 1.29

Definition at line 4612 of file EditPage.php.

References $wgOut, and global.

Referenced by showEditForm().

EditPage::addExplainConflictHeader ( OutputPage $out )

protected

Parameters

OutputPage $out

Since: 1.29

Definition at line 4719 of file EditPage.php.

References text, and OutputPage\wrapWikiMsg().

Referenced by showHeader().

EditPage::addLongPageWarningHeader ( )

protected

Since: 1.29

Definition at line 4644 of file EditPage.php.

References $wgLang, $wgMaxArticleSize, $wgOut, and global.

Referenced by showHeader().

EditPage::addNewLineAtEnd ( $wikitext )

protected

Parameters

string $wikitext

Returns: string

Since: 1.29

Definition at line 4773 of file EditPage.php.

Referenced by showTextbox().

EditPage::addPageProtectionWarningHeaders ( )

protected

Since: 1.29

Definition at line 4675 of file EditPage.php.

References $wgOut, as, MWNamespace\getRestrictionLevels(), global, list, and LogEventsList\showLogExtract().

Referenced by showHeader().

EditPage::addTalkPageText ( )

protected

Since: 1.29

Definition at line 4633 of file EditPage.php.

References $wgOut, and global.

Referenced by showEditForm().

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

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

Referenced by edit().

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

protected

Parameters

string	$name
	mixed[]	$customAttribs
User	$user

Returns: mixed[]

Since: 1.29

Definition at line 4733 of file EditPage.php.

References $attribs, $name, and User\getOption().

Referenced by showTextbox().

EditPage::checkUnicodeCompliantBrowser ( )

private

Check if the browser is on a blacklist of user-agents known to mangle UTF-8 data on form submission.

Returns true if Unicode should make it through, false if it's known to be a problem.

Returns: bool

Definition at line 4481 of file EditPage.php.

References $wgBrowserBlackList, $wgRequest, as, and global.

Referenced by safeUnicodeOutput(), showFormBeforeText(), and showHeader().

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

References $content, $wgOut, $wgRequest, displayViewSourcePage(), getContentObject(), and global.

Referenced by edit().

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

protected

Definition at line 3336 of file EditPage.php.

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

Referenced by showEditForm().

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

protected

Display a read-only View Source page.

Parameters

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

Definition at line 740 of file EditPage.php.

References $e, $textbox1, $wgOut, getContextTitle(), getTemplates(), global, makeTemplatesOnThisPageList(), Hooks\run(), Content\serialize(), showTextbox(), and toEditText().

Referenced by displayPermissionsError(), and edit().

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

References $parserOutput, $wgUser, getPreviewParserOptions(), global, and Content\preSaveTransform().

Referenced by getPreviewText().

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

References $contentModel, $status, $user, $wgOut, $wgRequest, $wgUser, DeferredUpdates\addCallableUpdate(), attemptSave(), diff, displayPermissionsError(), displayViewSourcePage(), First, getContentObject(), getEditPermissionErrors(), global, handleStatus(), importFormData(), initialiseForm(), isWrongCaseCssJsPage(), Revision\newFromId(), noSuchSectionPage(), plain, previewOnOpen(), Hooks\run(), save, showEditForm(), showIntro(), use, wfDebug(), and wfReadOnly().

Referenced by importFormData(), and submit().

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

References $matches, $wgParser, and global.

Referenced by EditPageTest\testExtractSectionTitle().

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

References Title\getLocalURL().

Referenced by showEditForm().

EditPage::getArticle ( )

Returns: Article

Definition at line 441 of file EditPage.php.

References $mArticle.

EditPage::getBaseRevision ( )

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

Returns: Revision Current version when the edit was started

Definition at line 2301 of file EditPage.php.

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

Referenced by mergeChangesIntoContent().

EditPage::getCancelLink ( )

Returns: string

Definition at line 3694 of file EditPage.php.

References $oldid, Html\buttonAttributes(), and getContextTitle().

Referenced by showStandardInputs().

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

Returns an array of html code of the following checkboxes old style: minor and watch.

Parameters

int	$tabindex	Current tabindex
array	$checked	See getCheckboxesDefinition()

Returns: array

Definition at line 4203 of file EditPage.php.

References $attribs, $name, $options, $tabindex, $wgUseMediaWikiUIEverywhere, as, Xml\check(), getCheckboxesDefinition(), global, Html\rawElement(), Hooks\run(), Xml\tags(), and Linker\titleAttrib().

Referenced by getCheckboxesOOUI(), and showStandardInputs().

EditPage::getCheckboxesDefinition ( $checked )

protected

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

References $wgUser, global, and Hooks\run().

Referenced by getCheckboxes(), and getCheckboxesOOUI().

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

Returns an array of html code of the following checkboxes: minor and watch.

Parameters

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

Returns: array

Definition at line 4263 of file EditPage.php.

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

Referenced by showStandardInputs().

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

References $content, $params, $summary, $wgContLang, $wgOut, $wgRequest, $wgUser, Revision\DELETED_TEXT, getOriginalContent(), getPreloadedContent(), global, Revision\newFromId(), ParserOptions\newFromUserAndLang(), NS_MEDIAWIKI, page, Revision\RAW, toEditContent(), and true.

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

EditPage::getContext ( )

Since: 1.28

Returns: IContextSource

Definition at line 449 of file EditPage.php.

References $context.

EditPage::getContextTitle ( )

Get the context title object.

If not set, $wgTitle will be returned. This behavior might change in the future to return $this->mTitle instead.

Returns: Title

Definition at line 477 of file EditPage.php.

References $mContextTitle, $wgTitle, and global.

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

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

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

EditPage::getCopywarn ( )

protected

Get the copyright warning.

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

Returns: string

Definition at line 3508 of file EditPage.php.

Referenced by showStandardInputs().

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

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

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

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

References $attribs, $tabindex, getSaveButtonLabel(), Hooks\run(), Html\submitButton(), and Linker\tooltipAndAccesskeyAttribs().

Referenced by showStandardInputs().

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

protected

Parameters

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

Returns: array

Definition at line 664 of file EditPage.php.

References $wgUser, as, diff, global, and wfArrayDiff2().

Referenced by edit().

static EditPage::getEditToolbar ( $title = null )

static

Shows a bulletin board style toolbar for common editing functions.

It can be disabled in the user preferences.

Parameters

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

Returns: string

Definition at line 4010 of file EditPage.php.

References $params, $title, $wgContLang, $wgEnableUploads, $wgForeignFileRepos, $wgOut, as, Xml\encodeJsCall(), global, ResourceLoader\inDebugMode(), ResourceLoader\makeInlineScript(), NS_FILE, NS_MEDIA, Hooks\run(), MWNamespace\wantSignatures(), and wfMessage().

EditPage::getLastDelete ( )

protected

Returns: bool|stdClass

Definition at line 3763 of file EditPage.php.

References $dbr, DB_REPLICA, LogPage\DELETED_COMMENT, LogPage\DELETED_USER, and wfGetDB().

Referenced by wasDeletedSinceLastEdit().

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

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

Referenced by getContentObject().

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

References $parentRevId.

Referenced by showEditForm().

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

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

Referenced by getContentObject().

static EditPage::getPreviewLimitReport ( $output )

static

Get the Limit report for page previews.

Since: 1.22

Parameters

ParserOutput $output ParserOutput object from the parse

Returns: string HTML

Definition at line 3548 of file EditPage.php.

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

Referenced by ApiParse\execute().

EditPage::getPreviewParserOptions ( )

protected

Get parser options for a preview.

Returns: ParserOptions

Definition at line 3952 of file EditPage.php.

References page.

Referenced by doPreviewParse().

EditPage::getPreviewText ( )

Get the rendered text for previewing.

Exceptions

MWException

Returns: string

Definition at line 3807 of file EditPage.php.

References $attribs, $content, $parserOutput, $previewTextAfterContent, $wgAllowUserCss, $wgAllowUserJs, $wgLang, $wgOut, CONTENT_MODEL_CSS, CONTENT_MODEL_JAVASCRIPT, doPreviewParse(), global, incrementEditFailureStats(), Html\rawElement(), Hooks\run(), toEditContent(), and true.

Referenced by showEditForm().

EditPage::getSaveButtonLabel ( )

private

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

Returns: string

Definition at line 4322 of file EditPage.php.

Referenced by getEditButtons(), and showHeader().

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

Standard summary input and label (wgSummary), abstracted so EditPage subclasses may reorganize the form.

Note that you do not need to worry about the label's for=, it will be inferred by the id given to the input. You can remove them both by passing [ 'id' => false ] to $userInputAttrs.

Parameters

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

Returns: array An array in the format [ $label, $input ]

Definition at line 3096 of file EditPage.php.

References $input, getSummaryInputAttributes(), Html\input(), and Xml\tags().

Referenced by showSummaryInput().

EditPage::getSummaryInputAttributes ( array $inputAttrs = null )

private

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

Parameters

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

Returns: array

Definition at line 3070 of file EditPage.php.

References Linker\tooltipAndAccesskeyAttribs().

Referenced by getSummaryInput(), and getSummaryInputOOUI().

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

Same as self::getSummaryInput, but uses OOUI, instead of plain HTML.

Builds a standard summary input with a label.

Parameters

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

Returns: OOUI\FieldLayout OOUI FieldLayout with Label and Input

Definition at line 3131 of file EditPage.php.

References getSummaryInputAttributes().

Referenced by showSummaryInput().

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

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

Referenced by showEditForm(), and showStandardInputs().

EditPage::getTemplates ( )

Returns: array

Definition at line 3986 of file EditPage.php.

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

Referenced by displayViewSourcePage(), and showEditForm().

EditPage::getTitle ( )

Since: 1.19

Returns: Title

Definition at line 457 of file EditPage.php.

References $mTitle.

Referenced by getCurrentContent(), internalAttemptSave(), showHeader(), and toEditContent().

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

References $query, $request, $wgOut, $wgUser, RequestContext\getMain(), Status\getWikiText(), global, incrementResolvedConflicts(), Hooks\run(), setPostEditCookie(), and spamPageWithContent().

Referenced by edit().

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

Referenced by 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 858 of file EditPage.php.

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

Referenced by edit().

EditPage::incrementConflictStats ( )

protected

Definition at line 3679 of file EditPage.php.

References NS_CATEGORY_TALK, and NS_MAIN.

Referenced by showConflict().

EditPage::incrementEditFailureStats ( $failureType )

private

Definition at line 3943 of file EditPage.php.

Referenced by getPreviewText().

EditPage::incrementResolvedConflicts ( )

private

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

Definition at line 1497 of file EditPage.php.

References $wgRequest, and global.

Referenced by handleStatus().

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

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

Referenced by edit().

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 (boolean): 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 1745 of file EditPage.php.

References $autoSumm, $changeTags, $code, $content, $edittime, $flags, $matches, $mTitle, $sectiontitle, $status, $summary, $undidRev, $wgMaxArticleSize, $wgParser, $wgRequest, $wgUser, addContentModelChangeLogEntry(), ChangeTags\canAddTagsAccompanyingChange(), DB_MASTER, EDIT_AUTOSUMMARY, EDIT_FORCE_BOT, EDIT_MINOR, EDIT_NEW, EDIT_UPDATE, etc, false, ContentHandler\getContentText(), getCurrentContent(), getTitle(), global, mergeChangesIntoContent(), StatusValue\newGood(), newSectionSummary(), NS_FILE, NS_MEDIAWIKI, of, page, Hooks\run(), runPostMergeFilters(), Title\setContentModel(), toEditContent(), toEditText(), updateWatchlist(), Revision\userWasLastToEdit(), wasDeletedSinceLastEdit(), wfDebug(), wfDebugLog(), and wfReadOnly().

Referenced by attemptSave().

EditPage::isOouiEnabled ( )

Check if the edit page is using OOUI controls.

Returns: bool

Definition at line 490 of file EditPage.php.

References $oouiEnabled.

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

References ContentHandler\getForTitle().

Referenced by importFormData(), and showEditForm().

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

References ContentHandler\getForModelID().

Referenced by toEditContent(), and toEditText().

EditPage::isWrongCaseCssJsPage ( )

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

References $name, and Skin\getSkinNames().

Referenced by edit(), and showHeader().

EditPage::makeSafe ( $invalue )

private

A number of web browsers are known to corrupt non-ASCII characters in a UTF-8 text editing environment.

To protect against this, detected browsers will be served an armored version of the text, with non-ASCII chars converted to numeric HTML character references.

Preexisting such character references will have a 0 added to them to ensure that round-trips do not alter the original data.

Parameters

string $invalue

Returns: string

Definition at line 4538 of file EditPage.php.

Referenced by safeUnicodeOutput().

EditPage::makeTemplatesOnThisPageList ( array $templates )

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

Parameters

Title[] $templates

Returns: string HTML

Definition at line 2874 of file EditPage.php.

References $type, and Html\rawElement().

Referenced by displayViewSourcePage(), and showEditForm().

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

References array(), and global.

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

staticprotected

Parameters

string	$text
array	$regexes

Returns: bool|string

Definition at line 2343 of file EditPage.php.

References $matches, and as.

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

References array(), and global.

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

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

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

Referenced by internalAttemptSave().

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

References $summary, $wgParser, and global.

Referenced by internalAttemptSave().

EditPage::noSuchSectionPage ( )

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

Definition at line 4430 of file EditPage.php.

References $res, $wgOut, global, and Hooks\run().

Referenced by edit().

EditPage::previewOnOpen ( )

protected

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

Returns: bool

Definition at line 794 of file EditPage.php.

References $wgRequest, $wgUser, and global.

Referenced by edit().

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

References $content, $minoredit, $status, $summary, $user, StatusValue\fatal(), and Hooks\run().

Referenced by internalAttemptSave().

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.

Parameters

WebRequest	$request
string	$field

Returns: string

Definition at line 4506 of file EditPage.php.

References $request, and unmakeSafe().

Referenced by importFormData().

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.

Parameters

string $text

Returns: string

Definition at line 4520 of file EditPage.php.

References checkUnicodeCompliantBrowser(), and makeSafe().

Referenced by showTextbox().

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

EditPage::setContextTitle ( $title )

Set the context Title object.

Parameters

Title | null $title Title object or null

Definition at line 466 of file EditPage.php.

References $title.

EditPage::setHeaders ( )

Definition at line 2353 of file EditPage.php.

References $wgOut, $wgUser, false, getContextTitle(), global, and NS_MEDIAWIKI.

Referenced by showEditForm().

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

References $response, RequestContext\getMain(), and page.

Referenced by handleStatus().

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

References $content.

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

References $handler, $wgOut, ContentHandler\getForModelID(), global, incrementConflictStats(), Hooks\run(), showTextbox2(), and toEditContent().

Referenced by showEditForm().

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

References showTextbox1().

Referenced by showEditForm().

EditPage::showCustomIntro ( )

protected

Attempt to show a custom editing introduction, if supplied.

Returns: bool

Definition at line 2527 of file EditPage.php.

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

Referenced by showIntro().

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

References $wgContLang, $wgOut, $wgUser, getCurrentContent(), global, ParserOptions\newFromUserAndLang(), NS_MEDIAWIKI, page, Hooks\run(), and toEditContent().

Referenced by displayPreviewArea(), and spamPageWithContent().

EditPage::showEditForm ( $formCallback = null )

Send the edit form and related headers to $wgOut.

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

References $content, $key, $textbox1, $username, $wgOut, $wgUser, addEditNotices(), addTalkPageText(), Xml\checkLabel(), Xml\closeElement(), diff, displayPreviewArea(), Xml\element(), Linker\formatHiddenCategories(), getActionURL(), getContextTitle(), getCurrentContent(), getParentRevId(), getPreviewText(), getSummaryPreview(), getTemplates(), global, Html\hidden(), isSectionEditSupported(), makeTemplatesOnThisPageList(), Xml\openElement(), Html\openElement(), page, Html\rawElement(), Hooks\run(), setHeaders(), showConflict(), showContentForm(), showEditTools(), showFormAfterText(), showFormBeforeText(), showHeader(), showStandardInputs(), showSummaryInput(), showTextbox1(), showTosSummary(), Linker\titleAttrib(), toEditText(), wasDeletedSinceLastEdit(), and wfWarn().

Referenced by edit().

EditPage::showEditTools ( )

protected

Definition at line 3495 of file EditPage.php.

References $wgOut, and global.

Referenced by showEditForm().

EditPage::showFormAfterText ( )

protected

Definition at line 3238 of file EditPage.php.

References $wgOut, $wgUser, global, and Html\hidden().

Referenced by showEditForm().

EditPage::showFormBeforeText ( )

protected

Definition at line 3221 of file EditPage.php.

References $wgOut, checkUnicodeCompliantBrowser(), global, Html\hidden(), name, and type.

Referenced by showEditForm().

EditPage::showHeader ( )

protected

Definition at line 2908 of file EditPage.php.

References $wgAllowUserCss, $wgAllowUserJs, $wgOut, $wgUser, addExplainConflictHeader(), addLongPageWarningHeader(), addPageProtectionWarningHeaders(), checkUnicodeCompliantBrowser(), Revision\DELETED_TEXT, diff, getSaveButtonLabel(), getTitle(), SpecialPage\getTitleFor(), global, isWrongCaseCssJsPage(), page, showHeaderCopyrightWarning(), wfReadOnly(), and wfReadOnlyReason().

Referenced by showEditForm().

EditPage::showHeaderCopyrightWarning ( )

protected

Show the header copyright warning.

Definition at line 3467 of file EditPage.php.

References $wgOut, and global.

Referenced by showHeader().

EditPage::showIntro ( )

protected

Show all applicable editing introductions.

Definition at line 2411 of file EditPage.php.

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

Referenced by edit().

EditPage::showPreview ( $text )

protected

Append preview output to $wgOut.

Includes category rendering if this is a category page.

Parameters

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

Definition at line 3384 of file EditPage.php.

References $wgOut, global, and Hooks\run().

Referenced by displayPreviewArea().

in this case you re responsible for computing and outputting the entire conflict i the difference between revisions and your text headers and sections and Diff or EditPage::showStandardInputs ( & $tabindex = 2 )

protected

Definition at line 3590 of file EditPage.php.

References $tabindex, $wgOut, Html\element(), getCancelLink(), getCheckboxes(), getCheckboxesOOUI(), getCopywarn(), getEditButtons(), getSummaryPreview(), global, Html\linkButton(), Skin\makeInternalOrExternalUrl(), Hooks\run(), and showSummaryInput().

Referenced by showEditForm().

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

References $input, $wgOut, getSummaryInput(), getSummaryInputOOUI(), global, and list.

Referenced by showEditForm(), and showStandardInputs().

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

protected

Definition at line 3325 of file EditPage.php.

References $attribs, $customAttribs, $name, $wgOut, $wgUser, addNewLineAtEnd(), buildTextboxAttribs(), global, safeUnicodeOutput(), and Html\textarea().

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

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	$customAttribs	Array of html attributes to use in the textarea
string	$textoverride	Optional text to override $this->textarea1 with

Definition at line 3275 of file EditPage.php.

References $attribs, $customAttribs, MWNamespace\getRestrictionLevels(), showTextbox(), and wasDeletedSinceLastEdit().

Referenced by showContentForm(), and showEditForm().

EditPage::showTextbox2 ( )

protected

Definition at line 3321 of file EditPage.php.

References showTextbox().

Referenced by showConflict(), and spamPageWithContent().

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

References $wgOut, global, and Hooks\run().

Referenced by showEditForm().

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

References $textbox1, $wgLang, $wgOut, getContextTitle(), global, showDiff(), showTextbox2(), and wfEscapeWikiText().

Referenced by handleStatus().

EditPage::submit ( )

Deprecated:: since 1.29, call edit directly

Definition at line 519 of file EditPage.php.

References edit().

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, false resp. 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 2589 of file EditPage.php.

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

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

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

References $content, and isSupportedContentModel().

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

EditPage::tokenOk ( & $request )

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

Parameters

WebRequest $request

Returns: bool

Access:: private

Definition at line 1439 of file EditPage.php.

References $mTokenOk, $request, $wgUser, and global.

Referenced by importFormData().

EditPage::unmakeSafe ( $invalue )

private

Reverse the previously applied transliteration of non-ASCII characters back to UTF-8.

Used to protect data from corruption by broken web browsers as listed in $wgBrowserBlackList.

Parameters

string $invalue

Returns: string

Definition at line 4580 of file EditPage.php.

References codepointToUtf8().

Referenced by safeUnicodeInput().

EditPage::updateWatchlist ( )

protected

Register the change of watch status.

Definition at line 2233 of file EditPage.php.

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

Referenced by internalAttemptSave().

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

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

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

Member Data Documentation

string EditPage::$action = 'submit'

Definition at line 218 of file EditPage.php.

bool EditPage::$allowBlankArticle = false

protected

Definition at line 278 of file EditPage.php.

bool EditPage::$allowBlankSummary = false

Definition at line 272 of file EditPage.php.

bool EditPage::$allowSelfRedirect = false

protected

Definition at line 284 of file EditPage.php.

string EditPage::$autoSumm = ''

Definition at line 287 of file EditPage.php.

Referenced by internalAttemptSave().

bool EditPage::$blankArticle = false

protected

Definition at line 275 of file EditPage.php.

bool EditPage::$bot = true

Definition at line 364 of file EditPage.php.

Referenced by attemptSave().

null array EditPage::$changeTags = null

private

Definition at line 373 of file EditPage.php.

Referenced by internalAttemptSave().

null string EditPage::$contentFormat = null

Definition at line 370 of file EditPage.php.

bool int EditPage::$contentLength = false

protected

Definition at line 399 of file EditPage.php.

string EditPage::$contentModel

Definition at line 367 of file EditPage.php.

Referenced by edit().

IContextSource EditPage::$context

protected

Definition at line 409 of file EditPage.php.

Referenced by getContext().

bool EditPage::$deletedSinceEdit

Definition at line 239 of file EditPage.php.

Referenced by wasDeletedSinceLastEdit().

EditPage::$didSave = false

Definition at line 390 of file EditPage.php.

bool EditPage::$diff = false

Definition at line 313 of file EditPage.php.

Referenced by importFormData().

bool EditPage::$edit

protected

Definition at line 396 of file EditPage.php.

string EditPage::$editFormPageTop = ''

Before even the preview.

Definition at line 379 of file EditPage.php.

EditPage::$editFormTextAfterContent = ''

Definition at line 385 of file EditPage.php.

EditPage::$editFormTextAfterTools = ''

Definition at line 383 of file EditPage.php.

EditPage::$editFormTextAfterWarn = ''

Definition at line 382 of file EditPage.php.

EditPage::$editFormTextBeforeContent = ''

Definition at line 381 of file EditPage.php.

EditPage::$editFormTextBottom = ''

Definition at line 384 of file EditPage.php.

EditPage::$editFormTextTop = ''

Definition at line 380 of file EditPage.php.

string EditPage::$editintro = ''

Definition at line 358 of file EditPage.php.

integer EditPage::$editRevId = null

private

Definition at line 340 of file EditPage.php.

string EditPage::$edittime = ''

Definition at line 337 of file EditPage.php.

Referenced by internalAttemptSave().

bool EditPage::$enableApiEditOverride = false

private

Set in ApiEditPage, based on ContentHandler::allowsDirectApiEditing.

Definition at line 404 of file EditPage.php.

bool EditPage::$firsttime

Definition at line 245 of file EditPage.php.

string EditPage::$formtype

Definition at line 242 of file EditPage.php.

bool EditPage::$hasPresetSummary = false

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

Definition at line 296 of file EditPage.php.

string EditPage::$hookError = ''

Definition at line 290 of file EditPage.php.

bool EditPage::$incompleteForm = false

Definition at line 260 of file EditPage.php.

bool EditPage::$isConflict = false

Definition at line 221 of file EditPage.php.

bool EditPage::$isCssJsSubpage = false

Definition at line 224 of file EditPage.php.

bool EditPage::$isCssSubpage = false

Definition at line 227 of file EditPage.php.

bool EditPage::$isJsSubpage = false

Definition at line 230 of file EditPage.php.

bool EditPage::$isNew = false

New page or new section.

Definition at line 236 of file EditPage.php.

Referenced by initialiseForm().

bool EditPage::$isOldRev = false

private

Whether an old revision is edited.

Definition at line 414 of file EditPage.php.

bool EditPage::$isWrongCaseCssJsPage = false

Definition at line 233 of file EditPage.php.

bool stdClass EditPage::$lastDelete

Definition at line 248 of file EditPage.php.

Article EditPage::$mArticle

Definition at line 207 of file EditPage.php.

Referenced by getArticle().

Revision bool EditPage::$mBaseRevision = false

Definition at line 299 of file EditPage.php.

Referenced by getBaseRevision().

null Title EditPage::$mContextTitle = null

private

Definition at line 215 of file EditPage.php.

Referenced by getContextTitle().

bool EditPage::$minoredit = false

Definition at line 316 of file EditPage.php.

Referenced by runPostMergeFilters().

bool EditPage::$missingComment = false

Definition at line 266 of file EditPage.php.

bool EditPage::$missingSummary = false

Definition at line 269 of file EditPage.php.

ParserOutput EditPage::$mParserOutput

Definition at line 293 of file EditPage.php.

EditPage::$mPreloadContent = null

Definition at line 387 of file EditPage.php.

Referenced by getPreloadedContent().

bool EditPage::$mShowSummaryField = true

Definition at line 302 of file EditPage.php.

Title EditPage::$mTitle

Definition at line 212 of file EditPage.php.

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

bool EditPage::$mTokenOk = false

Definition at line 251 of file EditPage.php.

Referenced by tokenOk().

bool EditPage::$mTokenOkExceptSuffix = false

Definition at line 254 of file EditPage.php.

bool EditPage::$mTriedSave = false

Definition at line 257 of file EditPage.php.

bool EditPage::$nosummary = false

Definition at line 334 of file EditPage.php.

int EditPage::$oldid = 0

Definition at line 352 of file EditPage.php.

Referenced by getCancelLink().

bool EditPage::$oouiEnabled = false

private

Whether OOUI should be enabled here.

Definition at line 419 of file EditPage.php.

Referenced by isOouiEnabled().

WikiPage EditPage::$page

private

Definition at line 209 of file EditPage.php.

int EditPage::$parentRevId = 0

Definition at line 355 of file EditPage.php.

Referenced by getParentRevId().

bool EditPage::$preview = false

Definition at line 310 of file EditPage.php.

Referenced by importFormData().

EditPage::$previewTextAfterContent = ''

Definition at line 386 of file EditPage.php.

Referenced by getPreviewText().

bool EditPage::$recreate = false

Definition at line 322 of file EditPage.php.

bool EditPage::$save = false

Definition at line 307 of file EditPage.php.

null EditPage::$scrolltop = null

Definition at line 361 of file EditPage.php.

string EditPage::$section = ''

Definition at line 343 of file EditPage.php.

string EditPage::$sectiontitle = ''

Definition at line 346 of file EditPage.php.

Referenced by internalAttemptSave().

bool EditPage::$selfRedirect = false

protected

Definition at line 281 of file EditPage.php.

string EditPage::$starttime = ''

Definition at line 349 of file EditPage.php.

string EditPage::$summary = ''

Definition at line 331 of file EditPage.php.

Referenced by getContentObject(), internalAttemptSave(), newSectionSummary(), and runPostMergeFilters().

EditPage::$suppressIntro = false

Definition at line 393 of file EditPage.php.

string EditPage::$textbox1 = ''

Definition at line 325 of file EditPage.php.

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

string EditPage::$textbox2 = ''

Definition at line 328 of file EditPage.php.

bool EditPage::$tooBig = false

Definition at line 263 of file EditPage.php.

EditPage::$undidRev = 0

Definition at line 391 of file EditPage.php.

Referenced by importFormData(), and internalAttemptSave().

bool EditPage::$watchthis = false

Definition at line 319 of file EditPage.php.

Referenced by updateWatchlist().

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

Referenced by ApiEditPage\execute().

const EditPage::AS_BLANK_ARTICLE = 224

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

Definition at line 108 of file EditPage.php.

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

const EditPage::AS_BLOCKED_PAGE_FOR_USER = 215

Status: User is blocked from editing this page.

Definition at line 66 of file EditPage.php.

Referenced by ApiEditPage\execute().

const EditPage::AS_CANNOT_USE_CUSTOM_MODEL = 241

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

Definition at line 178 of file EditPage.php.

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

const EditPage::AS_CONFLICT_DETECTED = 225

Status: (non-resolvable) edit conflict.

Definition at line 113 of file EditPage.php.

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

const EditPage::AS_CONTENT_TOO_BIG = 216

Status: Content too big (> $wgMaxArticleSize)

Definition at line 71 of file EditPage.php.

Referenced by ApiEditPage\execute().

const EditPage::AS_END = 231

Status: WikiPage::doEdit() was unsuccessful.

Definition at line 134 of file EditPage.php.

const EditPage::AS_HOOK_ERROR = 210

Status: Article update aborted by a hook function.

Definition at line 56 of file EditPage.php.

Referenced by ApiEditPage\execute().

const EditPage::AS_HOOK_ERROR_EXPECTED = 212

Status: A hook function returned an error.

Definition at line 61 of file EditPage.php.

Referenced by ApiEditPage\execute().

const EditPage::AS_IMAGE_REDIRECT_ANON = 233

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

Definition at line 144 of file EditPage.php.

Referenced by ApiEditPage\execute().

const EditPage::AS_IMAGE_REDIRECT_LOGGED = 234

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

Definition at line 149 of file EditPage.php.

Referenced by ApiEditPage\execute().

const EditPage::AS_MAX_ARTICLE_SIZE_EXCEEDED = 229

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

Definition at line 129 of file EditPage.php.

Referenced by ApiEditPage\execute().

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

Referenced by ApiEditPage\execute().

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

Referenced by ApiEditPage\execute().

const EditPage::AS_PARSE_ERROR = 240

Status: can't parse content.

Definition at line 172 of file EditPage.php.

const EditPage::AS_RATE_LIMITED = 221

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

Definition at line 91 of file EditPage.php.

Referenced by ApiEditPage\execute().

const EditPage::AS_READ_ONLY_PAGE = 220

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

Definition at line 86 of file EditPage.php.

Referenced by ApiEditPage\execute().

const EditPage::AS_READ_ONLY_PAGE_ANON = 218

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

Definition at line 76 of file EditPage.php.

Referenced by ApiEditPage\execute().

const EditPage::AS_READ_ONLY_PAGE_LOGGED = 219

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

Definition at line 81 of file EditPage.php.

Referenced by ApiEditPage\execute().

const EditPage::AS_SELF_REDIRECT = 236

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

Definition at line 161 of file EditPage.php.

const EditPage::AS_SPAM_ERROR = 232

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

Definition at line 139 of file EditPage.php.

Referenced by ApiEditPage\execute().

const EditPage::AS_SUCCESS_NEW_ARTICLE = 201

Status: Article successfully created.

Definition at line 51 of file EditPage.php.

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

const EditPage::AS_SUCCESS_UPDATE = 200

Status: Article successfully updated.

Definition at line 46 of file EditPage.php.

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

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

Referenced by ApiEditPage\execute().

const EditPage::AS_TEXTBOX_EMPTY = 228

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

Definition at line 124 of file EditPage.php.

Referenced by ApiEditPage\execute().

const EditPage::EDITFORM_ID = 'editform'

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

Definition at line 183 of file EditPage.php.

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

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

Referenced by Article\view().

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

includes/EditPage.php
docs/hooks.txt

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

Member Function Documentation

Member Data Documentation