MediaWiki  REL1_23
WikitextContent Class Reference

Content object for wiki text pages. More...

Inheritance diagram for WikitextContent:
Collaboration diagram for WikitextContent:

List of all members.

Public Member Functions

 __construct ($text)
 addSectionHeader ($header)
 Returns a new WikitextContent object with the given section heading prepended.
 getParserOutput (Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
 Returns a ParserOutput object resulting from parsing the content's text using $wgParser.
 getRedirectTarget ()
 Implement redirect extraction for wikitext.
 getSection ($section)
 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.
 matchMagicWord (MagicWord $word)
 This implementation calls $word->match() on the this TextContent object's text.
 preloadTransform (Title $title, ParserOptions $popts, $params=array())
 Returns a Content object with preload transformations applied (or this object if no transformations apply).
 preSaveTransform (Title $title, User $user, ParserOptions $popts)
 Returns a Content object with pre-save transformations applied using Parser::preSaveTransform().
 replaceSection ($section, 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.

Protected Member Functions

 getHtml ()

Detailed Description

Content object for wiki text pages.

Definition at line 33 of file WikitextContent.php.


Constructor & Destructor Documentation

Parameters:
string$modelId
Since:
1.21

Reimplemented from AbstractContent.

Definition at line 35 of file WikitextContent.php.


Member Function Documentation

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

Parameters:
string$header
Returns:
Content

Reimplemented from AbstractContent.

Definition at line 122 of file WikitextContent.php.

References TextContent\getNativeData(), and wfMessage().

WikitextContent::getHtml ( ) [protected]
Exceptions:
MWException

Reimplemented from TextContent.

Definition at line 330 of file WikitextContent.php.

WikitextContent::getParserOutput ( Title title,
revId = null,
ParserOptions options = null,
generateHtml = true 
)

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

Since:
1.21
Parameters:
Title$title*
int$revIdRevision to pass to the parser (default: null)
ParserOptions$options(default: null)
bool$generateHtml(default: false)

Reimplemented from TextContent.

Definition at line 313 of file WikitextContent.php.

References $options, $wgParser, AbstractContent\getContentHandler(), TextContent\getNativeData(), and global.

Referenced by isCountable().

Implement redirect extraction for wikitext.

Returns:
null|Title
Note:
: migrated here from Title::newFromRedirectInternal()
See also:
Content::getRedirectTarget
AbstractContent::getRedirectTarget

Reimplemented from AbstractContent.

Definition at line 180 of file WikitextContent.php.

References $title, array(), MagicWord\get(), TextContent\getNativeData(), global, Title\isValidRedirectTarget(), and Title\newFromText().

Parameters:
string$section
Returns:
Content|bool|null
See also:
Content::getSection()

Reimplemented from AbstractContent.

Definition at line 46 of file WikitextContent.php.

References $section, $wgParser, TextContent\getNativeData(), and global.

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

Reimplemented from TextContent.

Definition at line 289 of file WikitextContent.php.

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$hasLinksIf it is known whether this content contains links, provide this information here, to avoid redundant parsing to find out (default: null).
Title$titleOptional title, defaults to the title from the current main request.

Definition at line 253 of file WikitextContent.php.

References empty, RequestContext\getMain(), TextContent\getNativeData(), getParserOutput(), global, and AbstractContent\isRedirect().

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 346 of file WikitextContent.php.

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

WikitextContent::preloadTransform ( Title title,
ParserOptions popts,
params = array() 
)

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 161 of file WikitextContent.php.

References $params, $wgParser, TextContent\getNativeData(), and global.

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 141 of file WikitextContent.php.

References $wgParser, TextContent\getNativeData(), and global.

WikitextContent::replaceSection ( section,
Content with,
sectionTitle = '' 
)

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 225 of file WikitextContent.php.

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


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