Base implementation for content objects. More...

Inheritance diagram for AbstractContent:

[legend]

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. More...

	equals (Content $that=null)

	getContentHandler ()

	getDefaultFormat ()

	getDeletionUpdates (WikiPage $page, ParserOutput $parserOutput=null)

	getModel ()

	getRedirectChain ()

	getRedirectTarget ()
	Subclasses that implement redirects should override this. More...

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

	getSection ( $sectionId)

	getSupportedFormats ()

	getUltimateRedirectTarget ()

	isEmpty ()

	isRedirect ()

	isSupportedFormat ( $format)

	isValid ()
	Subclasses may override this to implement (light weight) validation. More...

	matchMagicWord (MagicWord $word)
	This default implementation always returns false. More...

	preloadTransform (Title $title, ParserOptions $popts, $params=array())

	prepareSave (WikiPage $page, $flags, $baseRevId, User $user)

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

	replaceSection ( $section, Content $with, $sectionTitle='')

	serialize ( $format=null)

	updateRedirect (Title $target)
	This default implementation always returns $this. More...

Public Member Functions inherited from Content
	copy ()
	Return a copy of this Content object. More...

	getNativeData ()
	Returns native representation of the data. More...

	getParserOutput (Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
	Parse the Content object and generate a ParserOutput from the result. More...

	getSize ()
	Returns the content's nominal size in bogo-bytes. More...

	getTextForSearchIndex ()

	getTextForSummary ( $maxLength=250)
	Returns a textual representation of the content suitable for use in edit summaries and log messages. More...

	getWikitextForTransclusion ()

	isCountable ( $hasLinks=null)
	Returns true if this content is countable as a "real" wiki page, provided that it's also in a countable location (e.g. More...

Protected Member Functions
	checkFormat ( $format)

	checkModelID ( $modelId)

Protected Attributes
string	$model_id
	Name of the content model this Content object represents. More...

Detailed Description

Base implementation for content objects.

Definition at line 34 of file AbstractContent.php.

Constructor & Destructor Documentation

◆ __construct()

AbstractContent::__construct ( $modelId = null )

Parameters

string $modelId

Since: 1.21

Reimplemented in RevisionTestModifyableContent, CssContent, JavaScriptContent, WikitextContent, and DummyContentForTesting.

Definition at line 49 of file AbstractContent.php.

Member Function Documentation

◆ addSectionHeader()

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.

◆ checkFormat()

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.

References getModel(), and isSupportedFormat().

◆ checkModelID()

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().

◆ convert()

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.

References array(), getModel(), and wfRunHooks().

◆ equals()

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.

References getModel(), and Content\getNativeData().

◆ getContentHandler()

AbstractContent::getContentHandler ( )

Since: 1.21

See also: Content::getContentHandler

Implements Content.

Definition at line 85 of file AbstractContent.php.

References ContentHandler\getForContent().

Referenced by getDefaultFormat(), TextContent\getParserOutput(), WikitextContent\getParserOutput(), getSupportedFormats(), isSupportedFormat(), and serialize().

◆ getDefaultFormat()

AbstractContent::getDefaultFormat ( )

Since: 1.21

See also: Content::getDefaultFormat

Implements Content.

Definition at line 94 of file AbstractContent.php.

References getContentHandler().

◆ getDeletionUpdates()

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.

References array().

◆ getModel()

AbstractContent::getModel ( )

Since: 1.21

See also: Content::getModel

Implements Content.

Definition at line 58 of file AbstractContent.php.

References $model_id.

Referenced by checkFormat(), convert(), equals(), TextContent\getParserOutput(), and WikitextContent\replaceSection().

◆ getRedirectChain()

AbstractContent::getRedirectChain ( )

Since: 1.21

Returns: Title[]|null

See also: Content::getRedirectChain

Implements Content.

Definition at line 241 of file AbstractContent.php.

References $title, $titles, array(), WikiPage\factory(), getRedirectTarget(), global, and Title\isValidRedirectTarget().

Referenced by getUltimateRedirectTarget().

◆ getRedirectTarget()

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.

Referenced by getRedirectChain(), and isRedirect().

◆ getSecondaryDataUpdates()

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.