MediaWiki  master
TextContent.php
Go to the documentation of this file.
1 <?php
29 
38 
42  protected $mText;
43 
49  public function __construct( $text, $model_id = CONTENT_MODEL_TEXT ) {
50  parent::__construct( $model_id );
51 
52  if ( $text === null || $text === false ) {
53  wfWarn( "TextContent constructed with \$text = " . var_export( $text, true ) . "! "
54  . "This may indicate an error in the caller's scope.", 2 );
55 
56  $text = '';
57  }
58 
59  if ( !is_string( $text ) ) {
60  throw new MWException( "TextContent expects a string in the constructor." );
61  }
62 
63  $this->mText = $text;
64  }
65 
71  public function copy() {
72  return $this; # NOTE: this is ok since TextContent are immutable.
73  }
74 
75  public function getTextForSummary( $maxlength = 250 ) {
76  $text = $this->getText();
77 
78  $truncatedtext = MediaWikiServices::getInstance()->getContentLanguage()->
79  truncateForDatabase( preg_replace( "/[\n\r]/", ' ', $text ), max( 0, $maxlength ) );
80 
81  return $truncatedtext;
82  }
83 
89  public function getSize() {
90  $text = $this->getText();
91 
92  return strlen( $text );
93  }
94 
104  public function isCountable( $hasLinks = null ) {
105  global $wgArticleCountMethod;
106 
107  if ( $this->isRedirect() ) {
108  return false;
109  }
110 
111  if ( $wgArticleCountMethod === 'any' ) {
112  return true;
113  }
114 
115  return false;
116  }
117 
125  public function getNativeData() {
126  return $this->getText();
127  }
128 
136  public function getText() {
137  return $this->mText;
138  }
139 
145  public function getTextForSearchIndex() {
146  return $this->getText();
147  }
148 
157  public function getWikitextForTransclusion() {
158  $wikitext = $this->convert( CONTENT_MODEL_WIKITEXT, 'lossy' );
159 
160  if ( $wikitext ) {
161  return $wikitext->getText();
162  } else {
163  return false;
164  }
165  }
166 
180  public static function normalizeLineEndings( $text ) {
181  return str_replace( [ "\r\n", "\r" ], "\n", rtrim( $text ) );
182  }
183 
196  public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
197  $text = $this->getText();
198  $pst = self::normalizeLineEndings( $text );
199 
200  return ( $text === $pst ) ? $this : new static( $pst, $this->getModel() );
201  }
202 
215  public function diff( Content $that, Language $lang = null ) {
216  $this->checkModelID( $that->getModel() );
217 
218  // @todo could implement this in DifferenceEngine and just delegate here?
219 
220  if ( !$lang ) {
221  $lang = MediaWikiServices::getInstance()->getContentLanguage();
222  }
223 
224  $otext = $this->getText();
225  $ntext = $that->getText();
226 
227  # Note: Use native PHP diff, external engines don't give us abstract output
228  $ota = explode( "\n", $lang->segmentForDiff( $otext ) );
229  $nta = explode( "\n", $lang->segmentForDiff( $ntext ) );
230 
231  $diff = new Diff( $ota, $nta );
232 
233  return $diff;
234  }
235 
253  protected function fillParserOutput( Title $title, $revId,
254  ParserOptions $options, $generateHtml, ParserOutput &$output
255  ) {
256  global $wgTextModelsToParse;
257 
258  if ( in_array( $this->getModel(), $wgTextModelsToParse ) ) {
259  // parse just to get links etc into the database, HTML is replaced below.
260  $output = MediaWikiServices::getInstance()->getParser()
261  ->parse( $this->getText(), $title, $options, true, true, $revId );
262  }
263 
264  if ( $generateHtml ) {
265  $html = $this->getHtml();
266  } else {
267  $html = '';
268  }
269 
270  $output->clearWrapperDivClass();
271  $output->setText( $html );
272  }
273 
287  protected function getHtml() {
288  return $this->getHighlightHtml();
289  }
290 
307  protected function getHighlightHtml() {
308  return htmlspecialchars( $this->getText() );
309  }
310 
324  public function convert( $toModel, $lossy = '' ) {
325  $converted = parent::convert( $toModel, $lossy );
326 
327  if ( $converted !== false ) {
328  return $converted;
329  }
330 
331  $toHandler = ContentHandler::getForModelID( $toModel );
332 
333  if ( $toHandler instanceof TextContentHandler ) {
334  // NOTE: ignore content serialization format - it's just text anyway.
335  $text = $this->getText();
336  $converted = $toHandler->unserializeContent( $text );
337  }
338 
339  return $converted;
340  }
341 
342 }
getNativeData()
Returns the text represented by this Content object, as a string.
$wgArticleCountMethod
Method used to determine if a page in a content namespace should be counted as a valid article...
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 & $html
Definition: hooks.txt:1982
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:235
__construct( $text, $model_id=CONTENT_MODEL_TEXT)
Definition: TextContent.php:49
setText( $text)
$model_id
Name of the content model this Content object represents.
getWikitextForTransclusion()
Returns attempts to convert this content object to wikitext, and then returns the text string...
In both all secondary updates will be triggered handle like object that caches derived data representing a and can trigger updates of cached copies of that e g in the links the and the CDN layer DerivedPageDataUpdater is used by PageUpdater when creating new but can also be used independently when performing meta data updates during or when puring a page It s a stepping stone on the way to a more complete refactoring of WikiPage NOTE
Definition: pageupdater.txt:78
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
string $mText
Definition: TextContent.php:42
if(!isset( $args[0])) $lang
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 MediaWikiServices
Definition: injection.txt:23
const CONTENT_MODEL_TEXT
Definition: Defines.php:238
getHtml()
Generates an HTML version of the content, for display.
getText()
Returns the text represented by this Content object, as a string.
getTextForSummary( $maxlength=250)
Returns a textual representation of the content suitable for use in edit summaries and log messages...
Definition: TextContent.php:75
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2217
This document provides an overview of the usage of PageUpdater and that is
Definition: pageupdater.txt:3
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types are
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:50
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
getHighlightHtml()
Generates an HTML version of the content, for display.
Base implementation for content objects.
Class representing a &#39;diff&#39; between two sequences of strings.
Definition: Diff.php:32
$wgTextModelsToParse
Determines which types of text are parsed as wikitext.
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 & $options
Definition: hooks.txt:1982
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
getSize()
Returns the text&#39;s size in bytes.
Definition: TextContent.php:89
preSaveTransform(Title $title, User $user, ParserOptions $popts)
Returns a Content object with pre-save transformations applied.
checkModelID( $modelId)
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:35
isCountable( $hasLinks=null)
Returns true if this content is not a redirect, and $wgArticleCountMethod is "any".
clearWrapperDivClass()
Clears the CSS class to use for the wrapping div, effectively disabling the wrapper div until addWrap...
getModel()
Returns the ID of the content model used by this Content object.
static normalizeLineEndings( $text)
Do a "\\r\\n" -> "\\n" and "\\r" -> "\\n" transformation as well as trim trailing whitespace...
fillParserOutput(Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
Fills the provided ParserOutput object with information derived from the content. ...
diff(Content $that, Language $lang=null)
Diff this content object with another content object.
convert( $toModel, $lossy='')
This implementation provides lossless conversion between content models based on TextContent.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
getTextForSearchIndex()
Returns the text represented by this Content object, as a string.