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

Collaboration diagram for MediaWiki\EditPage\TextConflictHelper:

[legend]

Public Member Functions
	__construct (Title $title, OutputPage $out, $stats, $submitLabel, IContentHandlerFactory $contentHandlerFactory)

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

	setContentModel ( $contentModel)

	setTextboxes ( $yourtext, $storedversion)

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

Public Attributes
null string	$contentFormat

null string	$contentModel

Protected Member Functions
	getUserBucket (?int $userEdits)

	incrementStatsByUserEdits ( $userEdits, $keyPrefixBase)
	Retained temporarily for backwards-compatibility.

Protected Attributes
OutputPage	$out

IBufferingStatsdDataFactory StatsFactory	$stats

string	$storedversion = ''

string	$submitLabel
	Message key for submit button's label.

Title	$title

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	(	Title	$title,
		OutputPage	$out,
			$stats,
			$submitLabel,
		IContentHandlerFactory	$contentHandlerFactory )

Parameters

Title	$title
OutputPage	$out
IBufferingStatsdDataFactory \| StatsFactory	$stats
string	$submitLabel
IContentHandlerFactory	$contentHandlerFactory	Required param with legacy support

Exceptions

MWUnknownContentModelException

Definition at line 82 of file TextConflictHelper.php.

References MediaWiki\EditPage\TextConflictHelper\$out, MediaWiki\EditPage\TextConflictHelper\$stats, MediaWiki\EditPage\TextConflictHelper\$submitLabel, MediaWiki\EditPage\TextConflictHelper\$title, MediaWiki\Content\IContentHandlerFactory\getContentHandler(), and MediaWiki\Title\Title\getContentModel().

Member Function Documentation

◆ getEditConflictMainTextBox()

MediaWiki\EditPage\TextConflictHelper::getEditConflictMainTextBox ( array $customAttribs = [] )

HTML to build the textbox1 on edit conflicts.

Parameters

array $customAttribs

Returns: string HTML

Definition at line 229 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 272 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 262 of file TextConflictHelper.php.

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

◆ getExplainHeader()

MediaWiki\EditPage\TextConflictHelper::getExplainHeader ( )

Returns: string HTML

Definition at line 215 of file TextConflictHelper.php.

◆ getUserBucket()

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

protected

Parameters

int | null $userEdits

Returns: string

Definition at line 198 of file TextConflictHelper.php.

Referenced by MediaWiki\EditPage\TextConflictHelper\incrementConflictStats(), MediaWiki\EditPage\TextConflictHelper\incrementResolvedStats(), and MediaWiki\EditPage\TextConflictHelper\incrementStatsByUserEdits().

◆ incrementConflictStats()

MediaWiki\EditPage\TextConflictHelper::incrementConflictStats ( ?User $user = null )

Record a user encountering an edit conflict.

Parameters

User | null $user

Definition at line 125 of file TextConflictHelper.php.

References MediaWiki\EditPage\TextConflictHelper\getUserBucket(), NS_CATEGORY_TALK, and NS_MAIN.

◆ incrementResolvedStats()

MediaWiki\EditPage\TextConflictHelper::incrementResolvedStats ( ?User $user = null )

Record when a user has resolved an edit conflict.

Parameters

User | null $user

Definition at line 153 of file TextConflictHelper.php.

References MediaWiki\EditPage\TextConflictHelper\getUserBucket(), NS_CATEGORY_TALK, and NS_MAIN.

◆ incrementStatsByUserEdits()

MediaWiki\EditPage\TextConflictHelper::incrementStatsByUserEdits	(		$userEdits,
			$keyPrefixBase )

protected

Retained temporarily for backwards-compatibility.

This action should be moved into incrementConflictStats, incrementResolvedStats.

Deprecated: since 1.42, do not use

Parameters

int \| null	$userEdits
string	$keyPrefixBase

Definition at line 188 of file TextConflictHelper.php.

References MediaWiki\EditPage\TextConflictHelper\getUserBucket().

◆ setContentFormat()

MediaWiki\EditPage\TextConflictHelper::setContentFormat ( $contentFormat )

Parameters

string $contentFormat

Definition at line 117 of file TextConflictHelper.php.

References MediaWiki\EditPage\TextConflictHelper\$contentFormat.

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

◆ setContentModel()

MediaWiki\EditPage\TextConflictHelper::setContentModel ( $contentModel )

Parameters

string $contentModel

Definition at line 110 of file TextConflictHelper.php.

References MediaWiki\EditPage\TextConflictHelper\$contentModel.

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

◆ setTextboxes()

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

Parameters

string	$yourtext
string	$storedversion

Definition at line 102 of file TextConflictHelper.php.

References MediaWiki\EditPage\TextConflictHelper\$storedversion, and MediaWiki\EditPage\TextConflictHelper\$yourtext.

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 280 of file TextConflictHelper.php.

Member Data Documentation

◆ $contentFormat

null string MediaWiki\EditPage\TextConflictHelper::$contentFormat

Definition at line 41 of file TextConflictHelper.php.

Referenced by MediaWiki\EditPage\TextConflictHelper\setContentFormat().

◆ $contentModel

null string MediaWiki\EditPage\TextConflictHelper::$contentModel

Definition at line 36 of file TextConflictHelper.php.

Referenced by MediaWiki\EditPage\TextConflictHelper\setContentModel().

◆ $out

OutputPage MediaWiki\EditPage\TextConflictHelper::$out

protected

Definition at line 46 of file TextConflictHelper.php.

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

◆ $stats

IBufferingStatsdDataFactory StatsFactory MediaWiki\EditPage\TextConflictHelper::$stats

protected

Definition at line 51 of file TextConflictHelper.php.

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

◆ $storedversion

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

protected

Definition at line 66 of file TextConflictHelper.php.

Referenced by MediaWiki\EditPage\TextConflictHelper\setTextboxes().

◆ $submitLabel

string MediaWiki\EditPage\TextConflictHelper::$submitLabel

protected

Message key for submit button's label.

Definition at line 56 of file TextConflictHelper.php.

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

◆ $title

Title MediaWiki\EditPage\TextConflictHelper::$title

protected

Definition at line 31 of file TextConflictHelper.php.

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

◆ $yourtext

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

protected

Definition at line 61 of file TextConflictHelper.php.

Referenced by MediaWiki\EditPage\TextConflictHelper\setTextboxes().

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

includes/EditPage/TextConflictHelper.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getEditConflictMainTextBox()

◆ getEditFormHtmlAfterContent()

◆ getEditFormHtmlBeforeContent()

◆ getExplainHeader()

◆ getUserBucket()

◆ incrementConflictStats()

◆ incrementResolvedStats()

◆ incrementStatsByUserEdits()

◆ setContentFormat()

◆ setContentModel()

◆ setTextboxes()

◆ showEditFormTextAfterFooters()

Member Data Documentation

◆ $contentFormat

◆ $contentModel

◆ $out

◆ $stats

◆ $storedversion

◆ $submitLabel

◆ $title

◆ $yourtext