MediaWiki\EditPage\TextConflictHelper Class Reference

Helper for displaying edit conflicts in text content models to users. More...

Public Member Functions
	__construct (protected readonly Title $title, protected readonly OutputPage $out, protected readonly StatsFactory $stats, protected readonly string $submitLabel, private readonly IContentHandlerFactory $contentHandlerFactory, ?TextboxBuilder $textboxBuilder=null,)
	getEditConflictMainTextBox (array $customAttribs=[])
	HTML to build the textbox1 on edit conflicts.
	getEditFormHtmlAfterContent ()
	Content to go in the edit form after textbox1.
	getEditFormHtmlBeforeContent ()
	Content to go in the edit form before textbox1.
	getExplainHeader ()
	incrementConflictStats (?User $user=null)
	Record a user encountering an edit conflict.
	incrementResolvedStats (?User $user=null)
	Record when a user has resolved an edit conflict.
	setContentFormat (string $contentFormat)
	setContentModel (string $contentModel)
	setTextboxes (string $yourtext, string $storedversion)
	showEditFormTextAfterFooters ()
	Content to go in the edit form after the footers (templates on this page, hidden categories, limit report)

Public Attributes
string	$contentFormat = null
string	$contentModel = null

Protected Member Functions
	getUserBucket (?int $userEdits)

Protected Attributes
string	$storedversion = ''
string	$yourtext = ''

Detailed Description

Helper for displaying edit conflicts in text content models to users.

Since

1.31

Author

Kunal Mehta legok.nosp@m.tm@d.nosp@m.ebian.nosp@m..org

Definition at line 26 of file TextConflictHelper.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\EditPage\TextConflictHelper::__construct	(	protected readonly Title	$title,
		protected readonly OutputPage	$out,
		protected readonly StatsFactory	$stats,
		protected readonly string	$submitLabel,
		private readonly IContentHandlerFactory	$contentHandlerFactory,
		?TextboxBuilder	$textboxBuilder = null )

Parameters

Title	$title
OutputPage	$out
StatsFactory	$stats
string	$submitLabel	Message key for the label of the submit button
IContentHandlerFactory	$contentHandlerFactory	Required param with legacy support
TextboxBuilder | null	$textboxBuilder

Exceptions

UnknownContentModelException

Definition at line 46 of file TextConflictHelper.php.

References MediaWiki\MediaWikiServices\getInstance().

Member Function Documentation

getEditConflictMainTextBox()

MediaWiki\EditPage\TextConflictHelper::getEditConflictMainTextBox

(

array

$customAttribs = []

)

HTML to build the textbox1 on edit conflicts.

Returns

string HTML

Definition at line 158 of file TextConflictHelper.php.

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

getEditFormHtmlAfterContent()

MediaWiki\EditPage\TextConflictHelper::getEditFormHtmlAfterContent

(

)

Content to go in the edit form after textbox1.

See also

EditPage::$editFormTextAfterContent

Returns

string HTML

Definition at line 200 of file TextConflictHelper.php.

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

getEditFormHtmlBeforeContent()

MediaWiki\EditPage\TextConflictHelper::getEditFormHtmlBeforeContent

(

)

Content to go in the edit form before textbox1.

See also

EditPage::$editFormTextBeforeContent

Returns

string HTML

Definition at line 190 of file TextConflictHelper.php.

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

getExplainHeader()

MediaWiki\EditPage\TextConflictHelper::getExplainHeader

(

)

Returns

string HTML

Definition at line 145 of file TextConflictHelper.php.

getUserBucket()

MediaWiki\EditPage\TextConflictHelper::getUserBucket ( ?int $userEdits )

protected

Definition at line 128 of file TextConflictHelper.php.

incrementConflictStats()

MediaWiki\EditPage\TextConflictHelper::incrementConflictStats

(

?User

$user = null

)

Record a user encountering an edit conflict.

Definition at line 79 of file TextConflictHelper.php.

incrementResolvedStats()

MediaWiki\EditPage\TextConflictHelper::incrementResolvedStats

(

?User

$user = null

)

Record when a user has resolved an edit conflict.

Definition at line 104 of file TextConflictHelper.php.

setContentFormat()

MediaWiki\EditPage\TextConflictHelper::setContentFormat

(

string

$contentFormat

)

Definition at line 72 of file TextConflictHelper.php.

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

setContentModel()

MediaWiki\EditPage\TextConflictHelper::setContentModel

(

string

$contentModel

)

Definition at line 68 of file TextConflictHelper.php.

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

setTextboxes()

MediaWiki\EditPage\TextConflictHelper::setTextboxes	(	string	$yourtext,
		string	$storedversion )

Definition at line 63 of file TextConflictHelper.php.

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

showEditFormTextAfterFooters()

MediaWiki\EditPage\TextConflictHelper::showEditFormTextAfterFooters

(

)

Content to go in the edit form after the footers (templates on this page, hidden categories, limit report)

Definition at line 208 of file TextConflictHelper.php.

Member Data Documentation

$contentFormat

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

Definition at line 29 of file TextConflictHelper.php.

$contentModel

string MediaWiki\EditPage\TextConflictHelper::$contentModel = null

Definition at line 28 of file TextConflictHelper.php.

$storedversion

string MediaWiki\EditPage\TextConflictHelper::$storedversion = ''

protected

Definition at line 32 of file TextConflictHelper.php.

$yourtext

string MediaWiki\EditPage\TextConflictHelper::$yourtext = ''

protected

Definition at line 31 of file TextConflictHelper.php.

---

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

• includes/EditPage/TextConflictHelper.php