MediaWiki master
|
Content object implementation for representing flat text. More...
Inherits AbstractContent.
Inherited by MediaWiki\Content\CssContent, MediaWiki\Content\JavaScriptContent, MediaWiki\Content\JsonContent, and WikitextContent.
Public Member Functions | |
__construct ( $text, $model_id=CONTENT_MODEL_TEXT) | |
convert ( $toModel, $lossy='') | |
This implementation provides lossless conversion between content models based on TextContent. | |
copy () | |
diff (Content $that, Language $lang=null) | |
Diff this content object with another content object. | |
getNativeData () | |
Returns the text represented by this Content object, as a string. | |
getSize () | |
Returns the text's size in bytes. | |
getText () | |
Returns the text represented by this Content object, as a string. | |
getTextForSearchIndex () | |
Returns the text represented by this Content object, as a string. | |
getTextForSummary ( $maxlength=250) | |
getWikitextForTransclusion () | |
Returns attempts to convert this content object to wikitext, and then returns the text string. | |
isCountable ( $hasLinks=null) | |
Returns true if this content is not a redirect, and $wgArticleCountMethod is "any". | |
![]() | |
__construct ( $modelId=null) | |
addSectionHeader ( $header) | |
equals (Content $that=null) | |
Decides whether two Content objects are equal. | |
getContentHandler () | |
getDefaultFormat () | |
getModel () | |
getRedirectTarget () | |
Subclasses that implement redirects should override this. | |
getSection ( $sectionId) | |
getSupportedFormats () | |
isEmpty () | |
isRedirect () | |
isSupportedFormat ( $format) | |
isValid () | |
Subclasses may override this to implement (light weight) validation. | |
matchMagicWord (MagicWord $word) | |
This default implementation always returns false. | |
replaceSection ( $sectionId, Content $with, $sectionTitle='') | |
serialize ( $format=null) | |
updateRedirect (Title $target) | |
This default implementation always returns $this. | |
Static Public Member Functions | |
static | normalizeLineEndings ( $text) |
Do a "\\r\\n" -> "\\n" and "\\r" -> "\\n" transformation as well as trim trailing whitespace. | |
Protected Attributes | |
string | $mText |
![]() | |
string | $model_id |
Name of the content model this Content object represents. | |
Additional Inherited Members | |
![]() | |
checkFormat ( $format) | |
checkModelID ( $modelId) | |
equalsInternal (Content $that) | |
Checks whether $that is logically equal to this Content object. | |
getContentHandlerFactory () | |
Content object implementation for representing flat text.
TextContent instances are immutable
Definition at line 49 of file TextContent.php.
MediaWiki\Content\TextContent::__construct | ( | $text, | |
$model_id = CONTENT_MODEL_TEXT ) |
string | $text | |
string | $model_id |
Reimplemented in MediaWiki\Content\CssContent, MediaWiki\Content\JavaScriptContent, and MediaWiki\Content\JsonContent.
Definition at line 61 of file TextContent.php.
References AbstractContent\$model_id, and wfWarn().
MediaWiki\Content\TextContent::convert | ( | $toModel, | |
$lossy = '' ) |
This implementation provides lossless conversion between content models based on TextContent.
string | $toModel | The desired content model, use the CONTENT_MODEL_XXX flags. |
string | $lossy | Flag, set to "lossy" to allow lossy conversion. If lossy conversion is not allowed, full round-trip conversion is expected to work without losing information. |
MWUnknownContentModelException |
Reimplemented from AbstractContent.
Definition at line 268 of file TextContent.php.
References AbstractContent\getContentHandlerFactory(), and MediaWiki\Content\TextContent\getText().
Referenced by MediaWiki\Content\TextContent\getWikitextForTransclusion().
MediaWiki\Content\TextContent::copy | ( | ) |
Implements Content.
Definition at line 83 of file TextContent.php.
Referenced by WikitextContent\replaceSection().
Diff this content object with another content object.
Content | $that | The other content object to compare this content object to. |
Language | null | $lang | The language object to use for text segmentation. If not given, the content language is used. |
Definition at line 230 of file TextContent.php.
References AbstractContent\checkModelID(), MediaWiki\MediaWikiServices\getInstance(), Content\getModel(), and MediaWiki\Content\TextContent\getText().
MediaWiki\Content\TextContent::getNativeData | ( | ) |
Returns the text represented by this Content object, as a string.
Reimplemented from AbstractContent.
Definition at line 149 of file TextContent.php.
References MediaWiki\Content\TextContent\getText().
MediaWiki\Content\TextContent::getSize | ( | ) |
Returns the text's size in bytes.
Implements Content.
Definition at line 110 of file TextContent.php.
References MediaWiki\Content\TextContent\getText().
MediaWiki\Content\TextContent::getText | ( | ) |
Returns the text represented by this Content object, as a string.
Definition at line 163 of file TextContent.php.
References MediaWiki\Content\TextContent\$mText.
Referenced by WikitextContent\addSectionHeader(), MediaWiki\Content\TextContent\convert(), MediaWiki\Content\TextContent\diff(), MediaWiki\Content\JsonContent\getData(), MediaWiki\Content\TextContent\getNativeData(), MediaWiki\Content\CssContent\getRedirectTarget(), MediaWiki\Content\JavaScriptContent\getRedirectTarget(), WikitextContent\getSection(), MediaWiki\Content\TextContent\getSize(), MediaWiki\Content\TextContent\getTextForSearchIndex(), MediaWiki\Content\TextContent\getTextForSummary(), WikitextContent\matchMagicWord(), and WikitextContent\replaceSection().
MediaWiki\Content\TextContent::getTextForSearchIndex | ( | ) |
Returns the text represented by this Content object, as a string.
Implements Content.
Definition at line 174 of file TextContent.php.
References MediaWiki\Content\TextContent\getText().
MediaWiki\Content\TextContent::getTextForSummary | ( | $maxlength = 250 | ) |
int | $maxlength |
Implements Content.
Reimplemented in WikitextContent.
Definition at line 94 of file TextContent.php.
References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Content\TextContent\getText().
MediaWiki\Content\TextContent::getWikitextForTransclusion | ( | ) |
Returns attempts to convert this content object to wikitext, and then returns the text string.
The conversion may be lossy.
Implements Content.
Definition at line 188 of file TextContent.php.
References CONTENT_MODEL_WIKITEXT, and MediaWiki\Content\TextContent\convert().
MediaWiki\Content\TextContent::isCountable | ( | $hasLinks = null | ) |
Returns true if this content is not a redirect, and $wgArticleCountMethod is "any".
bool | null | $hasLinks | If it is known whether this content contains links, provide this information here, to avoid redundant parsing to find out. |
Implements Content.
Definition at line 127 of file TextContent.php.
References MediaWiki\MainConfigNames\ArticleCountMethod, MediaWiki\MediaWikiServices\getInstance(), and AbstractContent\isRedirect().
|
static |
Do a "\\r\\n" -> "\\n" and "\\r" -> "\\n" transformation as well as trim trailing whitespace.
This was formerly part of Parser::preSaveTransform, but for non-wikitext content models they probably still want to normalize line endings without all of the other PST changes.
string | $text |
Definition at line 213 of file TextContent.php.
|
protected |
Definition at line 54 of file TextContent.php.
Referenced by MediaWiki\Content\TextContent\getText().