MediaWiki  REL1_31
TextConflictHelper.php
Go to the documentation of this file.
1 <?php
25 namespace MediaWiki\EditPage;
26 
27 use Content;
29 use Html;
32 use Title;
33 
41 
45  protected $title;
46 
50  public $contentModel = null;
51 
55  public $contentFormat = null;
56 
60  protected $out;
61 
65  protected $stats;
66 
70  protected $submitLabel;
71 
75  protected $yourtext = '';
76 
80  protected $storedversion = '';
81 
90  ) {
91  $this->title = $title;
92  $this->out = $out;
93  $this->stats = $stats;
94  $this->submitLabel = $submitLabel;
95  $this->contentModel = $title->getContentModel();
96  $this->contentFormat = ContentHandler::getForModelID( $this->contentModel )->getDefaultFormat();
97  }
98 
103  public function setTextboxes( $yourtext, $storedversion ) {
104  $this->yourtext = $yourtext;
105  $this->storedversion = $storedversion;
106  }
107 
111  public function setContentModel( $contentModel ) {
112  $this->contentModel = $contentModel;
113  }
114 
118  public function setContentFormat( $contentFormat ) {
119  $this->contentFormat = $contentFormat;
120  }
121 
125  public function incrementConflictStats() {
126  $this->stats->increment( 'edit.failures.conflict' );
127  // Only include 'standard' namespaces to avoid creating unknown numbers of statsd metrics
128  if (
129  $this->title->getNamespace() >= NS_MAIN &&
130  $this->title->getNamespace() <= NS_CATEGORY_TALK
131  ) {
132  $this->stats->increment(
133  'edit.failures.conflict.byNamespaceId.' . $this->title->getNamespace()
134  );
135  }
136  }
137 
141  public function incrementResolvedStats() {
142  $this->stats->increment( 'edit.failures.conflict.resolved' );
143  // Only include 'standard' namespaces to avoid creating unknown numbers of statsd metrics
144  if (
145  $this->title->getNamespace() >= NS_MAIN &&
146  $this->title->getNamespace() <= NS_CATEGORY_TALK
147  ) {
148  $this->stats->increment(
149  'edit.failures.conflict.resolved.byNamespaceId.' . $this->title->getNamespace()
150  );
151  }
152  }
153 
157  public function getExplainHeader() {
158  return Html::rawElement(
159  'div',
160  [ 'class' => 'mw-explainconflict' ],
161  $this->out->msg( 'explainconflict', $this->out->msg( $this->submitLabel )->text() )->parse()
162  );
163  }
164 
171  public function getEditConflictMainTextBox( $customAttribs = [] ) {
172  $builder = new TextboxBuilder();
173  $classes = $builder->getTextboxProtectionCSSClasses( $this->title );
174 
175  $attribs = [ 'tabindex' => 1 ];
177 
178  $attribs = $builder->mergeClassesIntoAttributes( $classes, $attribs );
179 
180  $attribs = $builder->buildTextboxAttribs(
181  'wpTextbox1',
182  $attribs,
183  $this->out->getUser(),
184  $this->title
185  );
186 
187  $this->out->addHTML(
188  Html::textarea( 'wpTextbox1', $builder->addNewLineAtEnd( $this->storedversion ), $attribs )
189  );
190  }
191 
198  public function getEditFormHtmlBeforeContent() {
199  return '';
200  }
201 
208  public function getEditFormHtmlAfterContent() {
209  return '';
210  }
211 
216  public function showEditFormTextAfterFooters() {
217  $this->out->wrapWikiMsg( '<h2>$1</h2>', "yourdiff" );
218 
219  $yourContent = $this->toEditContent( $this->yourtext );
220  $storedContent = $this->toEditContent( $this->storedversion );
221  $handler = ContentHandler::getForModelID( $this->contentModel );
222  $diffEngine = $handler->createDifferenceEngine( $this->out );
223 
224  $diffEngine->setContent( $yourContent, $storedContent );
225  $diffEngine->showDiff(
226  $this->out->msg( 'yourtext' )->parse(),
227  $this->out->msg( 'storedversion' )->text()
228  );
229 
230  $this->out->wrapWikiMsg( '<h2>$1</h2>', "yourtext" );
231 
232  $builder = new TextboxBuilder();
233  $attribs = $builder->buildTextboxAttribs(
234  'wpTextbox2',
235  [ 'tabindex' => 6, 'readonly' ],
236  $this->out->getUser(),
237  $this->title
238  );
239 
240  $this->out->addHTML(
241  Html::textarea( 'wpTextbox2', $builder->addNewLineAtEnd( $this->yourtext ), $attribs )
242  );
243  }
244 
249  public function toEditContent( $text ) {
251  $text,
252  $this->title,
253  $this->contentModel,
254  $this->contentFormat
255  );
256  }
257 }
MediaWiki\EditPage\TextConflictHelper\getExplainHeader
getExplainHeader()
Definition: TextConflictHelper.php:157
MediaWiki\EditPage\TextConflictHelper\$contentModel
null string $contentModel
Definition: TextConflictHelper.php:50
ContentHandler
A content handler knows how do deal with a specific type of content on a wiki page.
Definition: ContentHandler.php:49
ContentHandler\getForModelID
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
Definition: ContentHandler.php:293
MediaWiki\EditPage\TextConflictHelper\$storedversion
string $storedversion
Definition: TextConflictHelper.php:80
$handler
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition: hooks.txt:903
Html\textarea
static textarea( $name, $value='', array $attribs=[])
Convenience function to produce a <textarea> element.
Definition: Html.php:790
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
MediaWiki\EditPage\TextConflictHelper\getEditConflictMainTextBox
getEditConflictMainTextBox( $customAttribs=[])
HTML to build the textbox1 on edit conflicts.
Definition: TextConflictHelper.php:171
MediaWiki\EditPage\TextConflictHelper\$title
Title $title
Definition: TextConflictHelper.php:45
MediaWiki\EditPage\TextboxBuilder
Helps EditPage build textboxes.
Definition: TextboxBuilder.php:37
MediaWiki\EditPage\TextConflictHelper\$out
OutputPage $out
Definition: TextConflictHelper.php:60
MediaWiki\EditPage\TextConflictHelper\showEditFormTextAfterFooters
showEditFormTextAfterFooters()
Content to go in the edit form after the footers (templates on this page, hidden categories,...
Definition: TextConflictHelper.php:216
$customAttribs
null means default & $customAttribs
Definition: hooks.txt:1995
MediaWiki\EditPage\TextConflictHelper\setContentFormat
setContentFormat( $contentFormat)
Definition: TextConflictHelper.php:118
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
NS_MAIN
const NS_MAIN
Definition: Defines.php:74
MediaWiki\EditPage\TextConflictHelper\toEditContent
toEditContent( $text)
Definition: TextConflictHelper.php:249
title
title
Definition: parserTests.txt:219
OutputPage
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:45
ContentHandler\makeContent
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
Definition: ContentHandler.php:129
MediaWiki\EditPage\TextConflictHelper\setTextboxes
setTextboxes( $yourtext, $storedversion)
Definition: TextConflictHelper.php:103
MediaWiki\EditPage\TextConflictHelper
Helper for displaying edit conflicts in text content models to users.
Definition: TextConflictHelper.php:40
MediaWiki\EditPage\TextConflictHelper\$yourtext
string $yourtext
Definition: TextConflictHelper.php:75
$attribs
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:2014
MediaWiki\EditPage\TextConflictHelper\getEditFormHtmlAfterContent
getEditFormHtmlAfterContent()
Content to go in the edit form after textbox1.
Definition: TextConflictHelper.php:208
Title\getContentModel
getContentModel( $flags=0)
Get the page's content model id, see the CONTENT_MODEL_XXX constants.
Definition: Title.php:980
MediaWiki\EditPage\TextConflictHelper\incrementConflictStats
incrementConflictStats()
Record a user encountering an edit conflict.
Definition: TextConflictHelper.php:125
MediaWiki\EditPage\TextConflictHelper\setContentModel
setContentModel( $contentModel)
Definition: TextConflictHelper.php:111
MediaWiki\EditPage\TextConflictHelper\$submitLabel
string $submitLabel
Message key for submit button's label.
Definition: TextConflictHelper.php:70
Content
Base interface for content objects.
Definition: Content.php:34
IBufferingStatsdDataFactory
MediaWiki adaptation of StatsdDataFactory that provides buffering functionality.
Definition: IBufferingStatsdDataFactory.php:10
MediaWiki\EditPage\TextConflictHelper\$contentFormat
null string $contentFormat
Definition: TextConflictHelper.php:55
Title
Represents a title within MediaWiki.
Definition: Title.php:39
MediaWiki\EditPage\TextConflictHelper\getEditFormHtmlBeforeContent
getEditFormHtmlBeforeContent()
Content to go in the edit form before textbox1.
Definition: TextConflictHelper.php:198
MediaWiki\EditPage\TextConflictHelper\__construct
__construct(Title $title, OutputPage $out, IBufferingStatsdDataFactory $stats, $submitLabel)
Definition: TextConflictHelper.php:88
MediaWiki\EditPage\TextConflictHelper\incrementResolvedStats
incrementResolvedStats()
Record when a user has resolved an edit conflict.
Definition: TextConflictHelper.php:141
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
NS_CATEGORY_TALK
const NS_CATEGORY_TALK
Definition: Defines.php:89
MediaWiki\EditPage\TextConflictHelper\$stats
IBufferingStatsdDataFactory $stats
Definition: TextConflictHelper.php:65
MediaWiki\EditPage
Definition: TextboxBuilder.php:25
Html
This class is a collection of static functions that serve two purposes:
Definition: Html.php:48