Base implementation for content objects. More...

Inheritance diagram for AbstractContent:

Collaboration diagram for AbstractContent:

Public Member Functions
	__construct ($modelId=null)
	addSectionHeader ($header)
	convert ($toModel, $lossy= '')
	This base implementation calls the hook ConvertContent to enable custom conversions.
	equals (Content $that=null)
	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.
	getRedirectChain ()
	getRedirectTarget ()
	Subclasses that implement redirects should override this.
	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.
	getSection ($sectionId)
	getSupportedFormats ()
	getUltimateRedirectTarget ()
	isEmpty ()
	isRedirect ()
	isSupportedFormat ($format)
	isValid ()
	Subclasses may override this to implement (light weight) validation.
	matchMagicWord (MagicWord $word)
	This default implementation always returns false.
	preloadTransform (Title $title, ParserOptions $popts, $params=array())
	prepareSave (WikiPage $page, $flags, $baseRevId, User $user)
	preSaveTransform (Title $title, User $user, ParserOptions $popts)
	replaceSection ($sectionId, Content $with, $sectionTitle= '')
	serialize ($format=null)
	updateRedirect (Title $target)
	This default implementation always returns $this.
Protected Member Functions
	checkFormat ($format)
	checkModelID ($modelId)
	fillParserOutput (Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
	Fills the provided ParserOutput with information derived from the content.
Protected Attributes
string	$model_id
	Name of the content model this Content object represents.

Detailed Description

Base implementation for content objects.

Definition at line 34 of file AbstractContent.php.

Constructor & Destructor Documentation

AbstractContent::__construct ( $ modelId = null )

Parameters:

string $modelId

Since:: 1.21

Reimplemented in RevisionTestModifyableContent, DummyContentForTesting, and WikitextContent.

Definition at line 49 of file AbstractContent.php.

Member Function Documentation

AbstractContent::addSectionHeader ( $ header )

Since:: 1.21

Returns:: Content $this

See also:: Content::addSectionHeader

Implements Content.

Reimplemented in WikitextContent.

Definition at line 366 of file AbstractContent.php.

AbstractContent::checkFormat ( $ format ) [protected]

Since:: 1.21

Parameters:

string $format The serialization format to check.

Exceptions:

MWException If the format is not supported by this content handler.

Definition at line 131 of file AbstractContent.php.

AbstractContent::checkModelID ( $ modelId ) [protected]

Since:: 1.21

Parameters:

string $modelId The model to check

Exceptions:

MWException If the provided ID is not the ID of the content model supported by this Content object.

Definition at line 70 of file AbstractContent.php.

Referenced by TextContent\diff().

AbstractContent::convert	(	$	toModel,
		$	lossy = `''`
	)

This base implementation calls the hook ConvertContent to enable custom conversions.

Subclasses may override this to implement conversion for "their" content model.

Parameters:

string	$toModel
string	$lossy

Returns:: Content|bool

See also:: Content::convert()

Implements Content.

Reimplemented in TextContent.

Definition at line 439 of file AbstractContent.php.

AbstractContent::equals ( Content $ that = null )

Since:: 1.21

Parameters:

Content $that

Returns:: bool

See also:: Content::equals

Implements Content.

Definition at line 186 of file AbstractContent.php.

AbstractContent::fillParserOutput	(	Title $	title,
		$	revId,
		ParserOptions $	options,
		$	generateHtml,
		ParserOutput &$	output
	)		`[protected]`

Fills the provided ParserOutput with information derived from the content.

Unless $generateHtml was false, this includes an HTML representation of the content.

This is called by getParserOutput() after consulting the ContentGetParserOutput hook. Subclasses are expected to override this method (or getParserOutput(), if need be). Subclasses of TextContent should generally override getHtml() instead.

This placeholder implementation always throws an exception.

Since:: 1.24

Parameters:

Title	$title	Context title for parsing
int \| null	$revId	Revision ID (for {{REVISIONID}})
ParserOptions	$options	Parser options
bool	$generateHtml	Whether or not to generate HTML
ParserOutput	&$output	The output object to fill (reference).

Exceptions:

MWException

Reimplemented in DummyContentForTesting, WikitextContent, TextContent, and JsonContent.

Definition at line 516 of file AbstractContent.php.

AbstractContent::getContentHandler ( )

Since:: 1.21

See also:: Content::getContentHandler

Implements Content.

Definition at line 85 of file AbstractContent.php.

AbstractContent::getDefaultFormat ( )

Since:: 1.21

See also:: Content::getDefaultFormat

Implements Content.

Definition at line 94 of file AbstractContent.php.

AbstractContent::getDeletionUpdates	(	WikiPage $	page,
		ParserOutput $	parserOutput = `null`
	)

Since:: 1.21

Parameters:

WikiPage	$page
ParserOutput	$parserOutput

Returns:: LinksDeletionUpdate[]

See also:: Content::getDeletionUpdates

Implements Content.

Definition at line 406 of file AbstractContent.php.

AbstractContent::getModel ( )

Since:: 1.21

See also:: Content::getModel

Implements Content.

Definition at line 58 of file AbstractContent.php.

Referenced by TextContent\fillParserOutput(), TextContent\preSaveTransform(), and WikitextContent\replaceSection().

AbstractContent::getParserOutput	(	Title $	title,
		$	revId = `null`,
		ParserOptions $	options = `null`,
		$	generateHtml = `true`
	)

Returns a ParserOutput object containing information derived from this content.

Most importantly, unless $generateHtml was false, the return value contains an HTML representation of the content.

Subclasses that want to control the parser output may override this, but it is preferred to override fillParserOutput() instead.

Subclasses that override getParserOutput() itself should take care to call the ContentGetParserOutput hook.

Since:: 1.24

Parameters:

Title	$title	Context title for parsing
int \| null	$revId	Revision ID (for {{REVISIONID}})
ParserOptions \| null	$options	Parser options
bool	$generateHtml	Whether or not to generate HTML

Returns:: ParserOutput Containing information derived from this content.

Implements Content.

Reimplemented in DummyContentForTesting, and MessageContent.

Definition at line 473 of file AbstractContent.php.

Referenced by WikitextContent\isCountable().

AbstractContent::getRedirectChain ( )

Since:: 1.21

Returns:: Title[]|null

See also:: Content::getRedirectChain

Implements Content.

Definition at line 241 of file AbstractContent.php.

Referenced by WikitextContent\fillParserOutput().

AbstractContent::getRedirectTarget ( )

Subclasses that implement redirects should override this.

Since:: 1.21

Returns:: null

See also:: Content::getRedirectTarget

Implements Content.

Reimplemented in WikitextContent.

Definition at line 280 of file AbstractContent.php.

AbstractContent::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.

This default implementation calls $this->getParserOutput( $content, $title, null, null, false ), and then calls getSecondaryDataUpdates( $title, $recursive ) on the resulting ParserOutput object.

Subclasses may override this to determine the secondary data updates more efficiently, preferably without the need to generate a parser output object.