MediaWiki  master
TextContent.php
Go to the documentation of this file.
1 <?php
29 
40 
44  protected $mText;
45 
52  public function __construct( $text, $model_id = CONTENT_MODEL_TEXT ) {
53  parent::__construct( $model_id );
54 
55  if ( $text === null || $text === false ) {
56  wfWarn( "TextContent constructed with \$text = " . var_export( $text, true ) . "! "
57  . "This may indicate an error in the caller's scope.", 2 );
58 
59  $text = '';
60  }
61 
62  if ( !is_string( $text ) ) {
63  throw new MWException( "TextContent expects a string in the constructor." );
64  }
65 
66  $this->mText = $text;
67  }
68 
74  public function copy() {
75  return $this; # NOTE: this is ok since TextContent are immutable.
76  }
77 
85  public function getTextForSummary( $maxlength = 250 ) {
86  $text = $this->getText();
87 
88  $truncatedtext = MediaWikiServices::getInstance()->getContentLanguage()->
89  truncateForDatabase( preg_replace( "/[\n\r]/", ' ', $text ), max( 0, $maxlength ) );
90 
91  return $truncatedtext;
92  }
93 
101  public function getSize() {
102  $text = $this->getText();
103 
104  return strlen( $text );
105  }
106 
118  public function isCountable( $hasLinks = null ) {
119  $articleCountMethod = MediaWikiServices::getInstance()->getMainConfig()->get( 'ArticleCountMethod' );
120 
121  if ( $this->isRedirect() ) {
122  return false;
123  }
124 
125  if ( $articleCountMethod === 'any' ) {
126  return true;
127  }
128 
129  return false;
130  }
131 
139  public function getNativeData() {
140  return $this->getText();
141  }
142 
153  public function getText() {
154  return $this->mText;
155  }
156 
164  public function getTextForSearchIndex() {
165  return $this->getText();
166  }
167 
178  public function getWikitextForTransclusion() {
180  $wikitext = $this->convert( CONTENT_MODEL_WIKITEXT, 'lossy' );
181  '@phan-var WikitextContent $wikitext';
182 
183  if ( $wikitext ) {
184  return $wikitext->getText();
185  } else {
186  return false;
187  }
188  }
189 
203  public static function normalizeLineEndings( $text ) {
204  return str_replace( [ "\r\n", "\r" ], "\n", rtrim( $text ) );
205  }
206 
220  public function diff( Content $that, Language $lang = null ) {
221  $this->checkModelID( $that->getModel() );
223  '@phan-var self $that';
224  // @todo could implement this in DifferenceEngine and just delegate here?
225 
226  if ( !$lang ) {
227  $lang = MediaWikiServices::getInstance()->getContentLanguage();
228  }
229 
230  $otext = $this->getText();
231  $ntext = $that->getText();
232 
233  # Note: Use native PHP diff, external engines don't give us abstract output
234  $ota = explode( "\n", $lang->segmentForDiff( $otext ) );
235  $nta = explode( "\n", $lang->segmentForDiff( $ntext ) );
236 
237  $diff = new Diff( $ota, $nta );
238 
239  return $diff;
240  }
241 
258  public function convert( $toModel, $lossy = '' ) {
259  $converted = parent::convert( $toModel, $lossy );
260 
261  if ( $converted !== false ) {
262  return $converted;
263  }
264 
265  $toHandler = $this->getContentHandlerFactory()->getContentHandler( $toModel );
266 
267  if ( $toHandler instanceof TextContentHandler ) {
268  // NOTE: ignore content serialization format - it's just text anyway.
269  $text = $this->getText();
270  $converted = $toHandler->unserializeContent( $text );
271  }
272 
273  return $converted;
274  }
275 
276 }
TextContent\__construct
__construct( $text, $model_id=CONTENT_MODEL_TEXT)
Definition: TextContent.php:52
TextContent\getTextForSearchIndex
getTextForSearchIndex()
Returns the text represented by this Content object, as a string.
Definition: TextContent.php:164
AbstractContent\isRedirect
isRedirect()
Definition: AbstractContent.php:347
TextContent\getWikitextForTransclusion
getWikitextForTransclusion()
Returns attempts to convert this content object to wikitext, and then returns the text string.
Definition: TextContent.php:178
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:203
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:37
AbstractContent\getContentHandlerFactory
getContentHandlerFactory()
Definition: AbstractContent.php:106
TextContent\$mText
string $mText
Definition: TextContent.php:44
TextContent\getText
getText()
Returns the text represented by this Content object, as a string.
Definition: TextContent.php:153
TextContent\getTextForSummary
getTextForSummary( $maxlength=250)
Definition: TextContent.php:85
MWException
MediaWiki exception.
Definition: MWException.php:29
AbstractContent\checkModelID
checkModelID( $modelId)
Definition: AbstractContent.php:83
TextContent\copy
copy()
Definition: TextContent.php:74
TextContent\getSize
getSize()
Returns the text's size in bytes.
Definition: TextContent.php:101
AbstractContent
Base implementation for content objects.
Definition: AbstractContent.php:43
TextContent\isCountable
isCountable( $hasLinks=null)
Returns true if this content is not a redirect, and $wgArticleCountMethod is "any".
Definition: TextContent.php:118
TextContentHandler
Base content handler implementation for flat text contents.
Definition: TextContentHandler.php:35
CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:208
TextContent
Content object implementation for representing flat text.
Definition: TextContent.php:39
Content
Base interface for content objects.
Definition: Content.php:35
AbstractContent\$model_id
string $model_id
Name of the content model this Content object represents.
Definition: AbstractContent.php:52
CONTENT_MODEL_TEXT
const CONTENT_MODEL_TEXT
Definition: Defines.php:211
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:203
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:1043
TextContent\diff
diff(Content $that, Language $lang=null)
Diff this content object with another content object.
Definition: TextContent.php:220
Language
Internationalisation code See https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation for more...
Definition: Language.php:42
TextContent\convert
convert( $toModel, $lossy='')
This implementation provides lossless conversion between content models based on TextContent.
Definition: TextContent.php:258
TextContent\getNativeData
getNativeData()
Returns the text represented by this Content object, as a string.
Definition: TextContent.php:139
Diff
Class representing a 'diff' between two sequences of strings.
Definition: Diff.php:32