MediaWiki  REL1_31
MediaWiki\EditPage\TextConflictHelper Class Reference

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

Collaboration diagram for MediaWiki\EditPage\TextConflictHelper:

Public Member Functions

 __construct (Title $title, OutputPage $out, IBufferingStatsdDataFactory $stats, $submitLabel)
 
 getEditConflictMainTextBox ( $customAttribs=[])
 HTML to build the textbox1 on edit conflicts. More...
 
 getEditFormHtmlAfterContent ()
 Content to go in the edit form after textbox1. More...
 
 getEditFormHtmlBeforeContent ()
 Content to go in the edit form before textbox1. More...
 
 getExplainHeader ()
 
 incrementConflictStats ()
 Record a user encountering an edit conflict. More...
 
 incrementResolvedStats ()
 Record when a user has resolved an edit conflict. More...
 
 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) More...
 
 toEditContent ( $text)
 

Public Attributes

null string $contentFormat = null
 
null string $contentModel = null
 

Protected Attributes

OutputPage $out
 
IBufferingStatsdDataFactory $stats
 
string $storedversion = ''
 
string $submitLabel
 Message key for submit button's label. More...
 
Title $title
 
string $yourtext = ''
 

Detailed Description

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

Since
1.31

Definition at line 40 of file TextConflictHelper.php.

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getEditConflictMainTextBox()

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

HTML to build the textbox1 on edit conflicts.

Parameters
mixed[] | null$customAttribs
Returns
string HTML

Definition at line 171 of file TextConflictHelper.php.

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

Referenced by 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 208 of file TextConflictHelper.php.

Referenced by 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 198 of file TextConflictHelper.php.

Referenced by EditPage\showEditForm().

◆ getExplainHeader()

MediaWiki\EditPage\TextConflictHelper::getExplainHeader ( )
Returns
string HTML

Definition at line 157 of file TextConflictHelper.php.

References Html\rawElement().

◆ incrementConflictStats()

MediaWiki\EditPage\TextConflictHelper::incrementConflictStats ( )

Record a user encountering an edit conflict.

Definition at line 125 of file TextConflictHelper.php.

References NS_CATEGORY_TALK, NS_MAIN, and title.

◆ incrementResolvedStats()

MediaWiki\EditPage\TextConflictHelper::incrementResolvedStats ( )

Record when a user has resolved an edit conflict.

Definition at line 141 of file TextConflictHelper.php.

References NS_CATEGORY_TALK, NS_MAIN, and title.

◆ setContentFormat()

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

Definition at line 118 of file TextConflictHelper.php.

References MediaWiki\EditPage\TextConflictHelper\$contentFormat.

Referenced by EditPage\showEditForm().

◆ setContentModel()

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

Definition at line 111 of file TextConflictHelper.php.

References MediaWiki\EditPage\TextConflictHelper\$contentModel.

Referenced by EditPage\showEditForm().

◆ setTextboxes()

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

Definition at line 103 of file TextConflictHelper.php.

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

Referenced by 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 216 of file TextConflictHelper.php.

References $attribs, $handler, ContentHandler\getForModelID(), Html\textarea(), and MediaWiki\EditPage\TextConflictHelper\toEditContent().

◆ toEditContent()

MediaWiki\EditPage\TextConflictHelper::toEditContent (   $text)
Parameters
string$text
Returns
Content

Definition at line 249 of file TextConflictHelper.php.

References ContentHandler\makeContent(), and title.

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

Member Data Documentation

◆ $contentFormat

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

◆ $contentModel

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

◆ $out

OutputPage MediaWiki\EditPage\TextConflictHelper::$out
protected

◆ $stats

IBufferingStatsdDataFactory MediaWiki\EditPage\TextConflictHelper::$stats
protected

◆ $storedversion

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

◆ $submitLabel

string MediaWiki\EditPage\TextConflictHelper::$submitLabel
protected

Message key for submit button's label.

Definition at line 70 of file TextConflictHelper.php.

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

◆ $title

Title MediaWiki\EditPage\TextConflictHelper::$title
protected

◆ $yourtext

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

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