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() {
159  $wikitext = $this->convert( CONTENT_MODEL_WIKITEXT, 'lossy' );
160  '@phan-var WikitextContent $wikitext';
161 
162  if ( $wikitext ) {
163  return $wikitext->getText();
164  } else {
165  return false;
166  }
167  }
168 
182  public static function normalizeLineEndings( $text ) {
183  return str_replace( [ "\r\n", "\r" ], "\n", rtrim( $text ) );
184  }
185 
198  public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
199  $text = $this->getText();
200  $pst = self::normalizeLineEndings( $text );
201 
202  return ( $text === $pst ) ? $this : new static( $pst, $this->getModel() );
203  }
204 
217  public function diff( Content $that, Language $lang = null ) {
218  $this->checkModelID( $that->getModel() );
220  '@phan-var self $that';
221  // @todo could implement this in DifferenceEngine and just delegate here?
222 
223  if ( !$lang ) {
224  $lang = MediaWikiServices::getInstance()->getContentLanguage();
225  }
226 
227  $otext = $this->getText();
228  $ntext = $that->getText();
229 
230  # Note: Use native PHP diff, external engines don't give us abstract output
231  $ota = explode( "\n", $lang->segmentForDiff( $otext ) );
232  $nta = explode( "\n", $lang->segmentForDiff( $ntext ) );
233 
234  $diff = new Diff( $ota, $nta );
235 
236  return $diff;
237  }
238 
256  protected function fillParserOutput( Title $title, $revId,
257  ParserOptions $options, $generateHtml, ParserOutput &$output
258  ) {
259  global $wgTextModelsToParse;
260 
261  if ( in_array( $this->getModel(), $wgTextModelsToParse ) ) {
262  // parse just to get links etc into the database, HTML is replaced below.
263  $output = MediaWikiServices::getInstance()->getParser()
264  ->parse( $this->getText(), $title, $options, true, true, $revId );
265  }
266 
267  if ( $generateHtml ) {
268  $html = $this->getHtml();
269  } else {
270  $html = '';
271  }
272 
273  $output->clearWrapperDivClass();
274  $output->setText( $html );
275  }
276 
290  protected function getHtml() {
291  return $this->getHighlightHtml();
292  }
293 
310  protected function getHighlightHtml() {
311  return htmlspecialchars( $this->getText() );
312  }
313 
327  public function convert( $toModel, $lossy = '' ) {
328  $converted = parent::convert( $toModel, $lossy );
329 
330  if ( $converted !== false ) {
331  return $converted;
332  }
333 
334  $toHandler = ContentHandler::getForModelID( $toModel );
335 
336  if ( $toHandler instanceof TextContentHandler ) {
337  // NOTE: ignore content serialization format - it's just text anyway.
338  $text = $this->getText();
339  $converted = $toHandler->unserializeContent( $text );
340  }
341 
342  return $converted;
343  }
344 
345 }
TextContent\__construct
__construct( $text, $model_id=CONTENT_MODEL_TEXT)
Definition: TextContent.php:49
ParserOptions
Set options of the Parser.
Definition: ParserOptions.php:42
TextContent\getTextForSearchIndex
getTextForSearchIndex()
Returns the text represented by this Content object, as a string.
Definition: TextContent.php:145
ContentHandler\getForModelID
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
Definition: ContentHandler.php:254
ParserOutput
Definition: ParserOutput.php:25
AbstractContent\isRedirect
isRedirect()
Definition: AbstractContent.php:356
TextContent\getWikitextForTransclusion
getWikitextForTransclusion()
Returns attempts to convert this content object to wikitext, and then returns the text string.
Definition: TextContent.php:157
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:129
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:35
TextContent\getHtml
getHtml()
Generates an HTML version of the content, for display.
Definition: TextContent.php:290
TextContent\$mText
string $mText
Definition: TextContent.php:42
CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:215
TextContent\getText
getText()
Returns the text represented by this Content object, as a string.
Definition: TextContent.php:136
TextContent\getTextForSummary
getTextForSummary( $maxlength=250)
Returns a textual representation of the content suitable for use in edit summaries and log messages.
Definition: TextContent.php:75
MWException
MediaWiki exception.
Definition: MWException.php:26
AbstractContent\checkModelID
checkModelID( $modelId)
Definition: AbstractContent.php:72
TextContent\getHighlightHtml
getHighlightHtml()
Generates an HTML version of the content, for display.
Definition: TextContent.php:310
TextContent\copy
copy()
Definition: TextContent.php:71
$title
$title
Definition: testCompression.php:36
ParserOutput\setText
setText( $text)
Definition: ParserOutput.php:641
TextContent\preSaveTransform
preSaveTransform(Title $title, User $user, ParserOptions $popts)
Returns a Content object with pre-save transformations applied.
Definition: TextContent.php:198
ParserOutput\clearWrapperDivClass
clearWrapperDivClass()
Clears the CSS class to use for the wrapping div, effectively disabling the wrapper div until addWrap...
Definition: ParserOutput.php:432
TextContent\getSize
getSize()
Returns the text's size in bytes.
Definition: TextContent.php:89
AbstractContent
Base implementation for content objects.
Definition: AbstractContent.php:34
TextContent\isCountable
isCountable( $hasLinks=null)
Returns true if this content is not a redirect, and $wgArticleCountMethod is "any".
Definition: TextContent.php:104
TextContentHandler
Base content handler implementation for flat text contents.
Definition: TextContentHandler.php:31
TextContent
Content object implementation for representing flat text.
Definition: TextContent.php:37
Content
Base interface for content objects.
Definition: Content.php:34
AbstractContent\getModel
getModel()
Definition: AbstractContent.php:60
AbstractContent\$model_id
string $model_id
Name of the content model this Content object represents.
Definition: AbstractContent.php:43
Title
Represents a title within MediaWiki.
Definition: Title.php:42
Content\getModel
getModel()
Returns the ID of the content model used by this Content object.
TextContent\normalizeLineEndings
static normalizeLineEndings( $text)
Do a "\\r\\n" -> "\\n" and "\\r" -> "\\n" transformation as well as trim trailing whitespace.
Definition: TextContent.php:182
$wgTextModelsToParse
$wgTextModelsToParse
Determines which types of text are parsed as wikitext.
Definition: DefaultSettings.php:8626
wfWarn
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
Definition: GlobalFunctions.php:1065
$wgArticleCountMethod
$wgArticleCountMethod
Method used to determine if a page in a content namespace should be counted as a valid article.
Definition: DefaultSettings.php:4381
TextContent\diff
diff(Content $that, Language $lang=null)
Diff this content object with another content object.
Definition: TextContent.php:217
CONTENT_MODEL_TEXT
const CONTENT_MODEL_TEXT
Definition: Defines.php:218
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:51
Language
Internationalisation code.
Definition: Language.php:39
TextContent\fillParserOutput
fillParserOutput(Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
Fills the provided ParserOutput object with information derived from the content.
Definition: TextContent.php:256
TextContent\convert
convert( $toModel, $lossy='')
This implementation provides lossless conversion between content models based on TextContent.
Definition: TextContent.php:327
TextContent\getNativeData
getNativeData()
Returns the text represented by this Content object, as a string.
Definition: TextContent.php:125
Diff
Class representing a 'diff' between two sequences of strings.
Definition: Diff.php:32