MediaWiki  1.33.0
WikitextContent Class Reference

Content object for wiki text pages. More...

Inheritance diagram for WikitextContent:
Collaboration diagram for WikitextContent:

Public Member Functions

 __construct ( $text)
 
 addSectionHeader ( $header)
 Returns a new WikitextContent object with the given section heading prepended. More...
 
 getRedirectTarget ()
 Implement redirect extraction for wikitext. More...
 
 getSection ( $sectionId)
 
 getTextForSummary ( $maxlength=250)
 
 isCountable ( $hasLinks=null, Title $title=null)
 Returns true if this content is not a redirect, and this content's text is countable according to the criteria defined by $wgArticleCountMethod. More...
 
 matchMagicWord (MagicWord $word)
 This implementation calls $word->match() on the this TextContent object's text. More...
 
 preloadTransform (Title $title, ParserOptions $popts, $params=[])
 Returns a Content object with preload transformations applied (or this object if no transformations apply). More...
 
 preSaveTransform (Title $title, User $user, ParserOptions $popts)
 Returns a Content object with pre-save transformations applied using Parser::preSaveTransform(). More...
 
 replaceSection ( $sectionId, Content $with, $sectionTitle='')
 
 updateRedirect (Title $target)
 This implementation replaces the first link on the page with the given new target if this Content object is a redirect. More...
 
- Public Member Functions inherited from TextContent
 __construct ( $text, $model_id=CONTENT_MODEL_TEXT)
 
 convert ( $toModel, $lossy='')
 This implementation provides lossless conversion between content models based on TextContent. More...
 
 copy ()
 
 diff (Content $that, Language $lang=null)
 Diff this content object with another content object. More...
 
 getNativeData ()
 Returns the text represented by this Content object, as a string. More...
 
 getSize ()
 Returns the text's size in bytes. More...
 
 getText ()
 Returns the text represented by this Content object, as a string. More...
 
 getTextForSearchIndex ()
 Returns the text represented by this Content object, as a string. More...
 
 getWikitextForTransclusion ()
 Returns attempts to convert this content object to wikitext, and then returns the text string. More...
 
 isCountable ( $hasLinks=null)
 Returns true if this content is not a redirect, and $wgArticleCountMethod is "any". More...
 
- Public Member Functions inherited from AbstractContent
 equals (Content $that=null)
 Decides whether two Content objects are equal. More...
 
 getContentHandler ()
 
 getDefaultFormat ()
 
 getDeletionUpdates (WikiPage $page, ParserOutput $parserOutput=null)
 
 getModel ()
 
 getParserOutput (Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
 Returns a ParserOutput object containing information derived from this content. More...
 
 getRedirectChain ()
 
 getSecondaryDataUpdates (Title $title, Content $old=null, $recursive=true, ParserOutput $parserOutput=null)
 Returns a list of DataUpdate objects for recording information about this Content in some secondary data store. More...
 
 getSupportedFormats ()
 
 getUltimateRedirectTarget ()
 
 isEmpty ()
 
 isRedirect ()
 
 isSupportedFormat ( $format)
 
 isValid ()
 Subclasses may override this to implement (light weight) validation. More...
 
 prepareSave (WikiPage $page, $flags, $parentRevId, User $user)
 
 serialize ( $format=null)
 

Protected Member Functions

 fillParserOutput (Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
 Returns a ParserOutput object resulting from parsing the content's text using $wgParser. More...
 
 getHtml ()
 
 getRedirectTargetAndText ()
 Extract the redirect target and the remaining text on the page. More...
 
- Protected Member Functions inherited from TextContent
 getHighlightHtml ()
 Generates an HTML version of the content, for display. More...
 
- Protected Member Functions inherited from AbstractContent
 checkFormat ( $format)
 
 checkModelID ( $modelId)
 
 equalsInternal (Content $that)
 Checks whether $that is logically equal to this Content object. More...
 

Private Attributes

bool $hadSignature = false
 Tracks if the parser set the user-signature flag when creating this content, which would make it expire faster in ApiStashEdit. More...
 
array null $previousParseStackTrace = null
 Stack trace of the previous parse. More...
 
 $redirectTargetAndText = null
 

Additional Inherited Members

- Static Public Member Functions inherited from TextContent
static normalizeLineEndings ( $text)
 Do a "\\r\\n" -> "\\n" and "\\r" -> "\\n" transformation as well as trim trailing whitespace. More...
 
- Protected Attributes inherited from TextContent
string $mText
 
- Protected Attributes inherited from AbstractContent
 $model_id
 Name of the content model this Content object represents. More...
 

Detailed Description

Content object for wiki text pages.

Definition at line 36 of file WikitextContent.php.

Constructor & Destructor Documentation

◆ __construct()

WikitextContent::__construct (   $modelId)
Parameters
string | null$modelId
Since
1.21

Reimplemented from AbstractContent.

Definition at line 50 of file WikitextContent.php.

References CONTENT_MODEL_WIKITEXT.

Member Function Documentation

◆ addSectionHeader()

WikitextContent::addSectionHeader (   $header)

Returns a new WikitextContent object with the given section heading prepended.

Parameters
string$header
Returns
Content

Reimplemented from AbstractContent.

Definition at line 130 of file WikitextContent.php.

References $header, TextContent\getText(), and wfMessage().

◆ fillParserOutput()

WikitextContent::fillParserOutput ( Title  $title,
  $revId,
ParserOptions  $options,
  $generateHtml,
ParserOutput $output 
)
protected

Returns a ParserOutput object resulting from parsing the content's text using $wgParser.

Parameters
Title$title
int$revIdRevision to pass to the parser (default: null)
ParserOptions$options(default: null)
bool$generateHtml(default: true)
ParserOutput&$outputParserOutput representing the HTML form of the text, may be manipulated or replaced.

Reimplemented from TextContent.

Definition at line 341 of file WikitextContent.php.

References $options, $output, $previousParseStackTrace, $title, $wgParser, ParserOptions\allCacheVaryingOptions(), false, AbstractContent\getRedirectChain(), Article\getRedirectHeaderHtml(), getRedirectTargetAndText(), list, and ParserOutput\setText().

◆ getHtml()

WikitextContent::getHtml ( )
protected
Exceptions
MWException

Reimplemented from TextContent.

Definition at line 394 of file WikitextContent.php.

◆ getRedirectTarget()

WikitextContent::getRedirectTarget ( )

Implement redirect extraction for wikitext.

Returns
Title|null
See also
Content::getRedirectTarget

Reimplemented from AbstractContent.

Definition at line 246 of file WikitextContent.php.

References $title, getRedirectTargetAndText(), and list.

◆ getRedirectTargetAndText()

WikitextContent::getRedirectTargetAndText ( )
protected

Extract the redirect target and the remaining text on the page.

Note
migrated here from Title::newFromRedirectInternal()
Since
1.23
Returns
array List of two elements: Title|null and string.

Definition at line 196 of file WikitextContent.php.

References $redirectTargetAndText, $title, $wgMaxRedirects, false, TextContent\getText(), and Title\newFromText().

Referenced by fillParserOutput(), and getRedirectTarget().

◆ getSection()

WikitextContent::getSection (   $sectionId)
Parameters
string | int$sectionId
Returns
Content|bool|null
See also
Content::getSection()

Reimplemented from AbstractContent.

Definition at line 61 of file WikitextContent.php.

References $wgParser, and TextContent\getText().

◆ getTextForSummary()

WikitextContent::getTextForSummary (   $maxlength = 250)
Parameters
int$maxlength
Returns
string

Reimplemented from TextContent.

Definition at line 319 of file WikitextContent.php.

◆ isCountable()

WikitextContent::isCountable (   $hasLinks = null,
Title  $title = null 
)

Returns true if this content is not a redirect, and this content's text is countable according to the criteria defined by $wgArticleCountMethod.

Parameters
bool | null$hasLinksIf it is known whether this content contains links, provide this information here, to avoid redundant parsing to find out (default: null).
Title | null$titleOptional title, defaults to the title from the current main request.
Returns
bool

Definition at line 290 of file WikitextContent.php.

References $context, $title, $wgArticleCountMethod, RequestContext\getMain(), AbstractContent\getParserOutput(), MediaWiki\getTitle(), AbstractContent\isRedirect(), and not.

◆ matchMagicWord()

WikitextContent::matchMagicWord ( MagicWord  $word)

This implementation calls $word->match() on the this TextContent object's text.

Parameters
MagicWord$word
Returns
bool
See also
Content::matchMagicWord()

Reimplemented from AbstractContent.

Definition at line 410 of file WikitextContent.php.

References TextContent\getText(), and MagicWord\match().

◆ preloadTransform()

WikitextContent::preloadTransform ( Title  $title,
ParserOptions  $popts,
  $params = [] 
)

Returns a Content object with preload transformations applied (or this object if no transformations apply).

Parameters
Title$title
ParserOptions$popts
array$params
Returns
Content

Reimplemented from AbstractContent.

Definition at line 178 of file WikitextContent.php.

References $params, $title, $wgParser, and TextContent\getText().

◆ preSaveTransform()

WikitextContent::preSaveTransform ( Title  $title,
User  $user,
ParserOptions  $popts 
)

Returns a Content object with pre-save transformations applied using Parser::preSaveTransform().

Parameters
Title$title
User$user
ParserOptions$popts
Returns
Content

Reimplemented from TextContent.

Definition at line 149 of file WikitextContent.php.

References $ret, $title, $user, $wgParser, and TextContent\getText().

◆ replaceSection()

WikitextContent::replaceSection (   $sectionId,
Content  $with,
  $sectionTitle = '' 
)
Parameters
string | int | null | bool$sectionId
Content$with
string$sectionTitle
Exceptions
MWException
Returns
Content
See also
Content::replaceSection()

Reimplemented from AbstractContent.

Definition at line 84 of file WikitextContent.php.

References $wgParser, TextContent\copy(), AbstractContent\getModel(), Content\getModel(), TextContent\getText(), Hooks\run(), and wfMessage().

◆ updateRedirect()

WikitextContent::updateRedirect ( Title  $target)

This implementation replaces the first link on the page with the given new target if this Content object is a redirect.

Otherwise, this method returns $this.

Since
1.21
Parameters
Title$target
Returns
Content
See also
Content::updateRedirect()

Reimplemented from AbstractContent.

Definition at line 264 of file WikitextContent.php.

References Title\getFullText(), TextContent\getText(), and AbstractContent\isRedirect().

Member Data Documentation

◆ $hadSignature

bool WikitextContent::$hadSignature = false
private

Tracks if the parser set the user-signature flag when creating this content, which would make it expire faster in ApiStashEdit.

Definition at line 43 of file WikitextContent.php.

◆ $previousParseStackTrace

array null WikitextContent::$previousParseStackTrace = null
private

Stack trace of the previous parse.

Definition at line 48 of file WikitextContent.php.

Referenced by fillParserOutput().

◆ $redirectTargetAndText

WikitextContent::$redirectTargetAndText = null
private

Definition at line 37 of file WikitextContent.php.

Referenced by getRedirectTargetAndText().


The documentation for this class was generated from the following file: