Content handler for CSS pages. More...

Inheritance diagram for CssContentHandler:

[legend]

Collaboration diagram for CssContentHandler:

[legend]

Public Member Functions
	__construct ( $modelId=CONTENT_MODEL_CSS)

	makeRedirectContent (Title $destination, $text='')
	Create a redirect that is also valid CSS.

	preSaveTransform (Content $content, PreSaveTransformParams $pstParams)
	Returns a $content object with pre-save transformations applied (or the same object if no transformations apply).

	supportsRedirects ()
	Returns true if this content model supports redirects.

Public Member Functions inherited from CodeContentHandler
	getPageLanguage (Title $title, Content $content=null)
	Returns the English language, because code is English, and should be handled as such.

	getPageViewLanguage (Title $title, Content $content=null)
	Returns the English language, because code is English, and should be handled as such.

Public Member Functions inherited from TextContentHandler
	__construct ( $modelId=CONTENT_MODEL_TEXT, $formats=[CONTENT_FORMAT_TEXT])
	Constructor, initializing the ContentHandler instance with its model ID and a list of supported formats.

	getDataForSearchIndex (WikiPage $page, ParserOutput $output, SearchEngine $engine)
	Return fields to be indexed by search engine as representation of this document.

	getFieldsForSearchIndex (SearchEngine $engine)
	Get fields definition for search index.

	makeEmptyContent ()
	Creates an empty TextContent object.

	merge3 (Content $oldContent, Content $myContent, Content $yourContent)
	Attempts to merge differences between three versions.

	serializeContent (Content $content, $format=null)
	Returns the content's text as-is.

	supportsDirectEditing ()

	unserializeContent ( $text, $format=null)
	Unserializes a Content object of the type supported by this ContentHandler.

Public Member Functions inherited from ContentHandler
	canBeUsedOn (Title $title)
	Determines whether the content type handled by this ContentHandler can be used for the main slot of the given page.

	createDifferenceEngine (IContextSource $context, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
	Factory for creating an appropriate DifferenceEngine for this content model.

	exportTransform ( $blob, $format=null)
	Applies transformations on export (returns the blob unchanged per default).

	fillParserOutputInternal (Content $content, ContentParseParams $cpoParams, ParserOutput &$output)
	A temporary layer to move AbstractContent::fillParserOutput to ContentHandler::fillParserOutput.

	generateHTMLOnEdit ()
	Whether an edit on the content should trigger an HTML render and ParserCache entry.

	getActionOverrides ()
	Returns overrides for action handlers.

	getAutoDeleteReason (Title $title, &$hasHistory=false)
	Auto-generates a deletion reason.

	getAutosummary (Content $oldContent=null, Content $newContent=null, $flags=0)
	Return an applicable auto-summary if one exists for the given edit.

	getChangeTag (Content $oldContent=null, Content $newContent=null, $flags=0)
	Return an applicable tag if one exists for the given edit or return null.

	getDefaultFormat ()
	The format used for serialization/deserialization by default by this ContentHandler.

	getDeletionUpdates (Title $title, $role)
	Returns a list of DeferrableUpdate objects for removing information about content in some secondary data store.

	getModelID ()
	Returns the model id that identifies the content model this ContentHandler can handle.

	getParserOutput (Content $content, ContentParseParams $cpoParams)
	Returns a ParserOutput object containing information derived from this content.

	getParserOutputForIndexing (WikiPage $page, ParserCache $cache=null)
	Produce page output suitable for indexing.

	getSecondaryDataUpdates (Title $title, Content $content, $role, SlotRenderingProvider $slotOutput)
	Returns a list of DeferrableUpdate objects for recording information about the given Content in some secondary data store.

	getSlotDiffRenderer (IContextSource $context, array $options=[])
	Get an appropriate SlotDiffRenderer for this content model.

	getSupportedFormats ()
	Returns a list of serialization formats supported by the serializeContent() and unserializeContent() methods of this ContentHandler.

	getUndoContent (Content $currentContent, Content $undoContent, Content $undoAfterContent, $undoIsLatest=false)
	Get the Content object that needs to be saved in order to undo all changes between $undo and $undoafter.

	importTransform ( $blob, $format=null)
	Apply import transformation (per default, returns $blob unchanged).

	isParserCacheSupported ()
	Returns true for content models that support caching using the ParserCache mechanism.

	isSupportedFormat ( $format)
	Returns true if $format is a serialization format supported by this ContentHandler, and false otherwise.

	preloadTransform (Content $content, PreloadTransformParams $pltParams)
	Returns a $content object with preload transformations applied (or the same object if no transformations apply).

	supportsCategories ()
	Returns true if this content model supports categories.

	supportsDirectApiEditing ()
	Whether or not this content model supports direct editing via ApiEditPage.

	supportsPreloadContent ()
	If a non-existing page can be created with the contents from another (arbitrary) page being preloaded in the editor, see {.

	supportsSections ()
	Returns true if this content model supports sections.

	validateSave (Content $content, ValidationParams $validationParams)
	Validate content for saving it.

Protected Member Functions

fillParserOutput (Content $content, ContentParseParams $cpoParams, ParserOutput &$output)

Fills the provided ParserOutput object with information derived from the content.Unless $generateHtml was false, this includes an HTML representation of the content provided by getHtml().For content models listed in $wgTextModelsToParse, this method will call the MediaWiki wikitext parser on the text to extract any (wikitext) links, magic words, etc., but note that the Table of Contents will not be generated (feature added by T307691, but should be refactored: T313455).Subclasses may override this to provide custom content processing. For custom HTML generation alone, it is sufficient to override getHtml().

Stability: stable: to override

Since: 1.38

Parameters

Content	$content
ContentParseParams	$cpoParams
ParserOutput	&$output	The output object to fill (reference).

getContentClass ()

Protected Member Functions inherited from ContentHandler

addSearchField (&$fields, SearchEngine $engine, $name, $type)

Add new field definition to array.

callDeprecatedContentGPO (Content $content, ContentParseParams $cpoParams)

If provided content overrides deprecated Content::getParserOutput, call it and return.

callDeprecatedContentPLT (Content $content, PreloadTransformParams $params)

If provided content overrides deprecated Content::preloadTransform, call it and return.

callDeprecatedContentPST (Content $content, PreSaveTransformParams $params)

Provided content overrides deprecated Content::preSaveTransform, call it and return.

checkFormat ( $format)

Convenient for checking whether a format provided as a parameter is actually supported.

checkModelID ( $model_id)

getDiffEngineClass ()

Returns the name of the diff engine to use.

getSlotDiffRendererInternal (IContextSource $context)

Return the SlotDiffRenderer appropriate for this content handler.

getSlotDiffRendererWithOptions (IContextSource $context, $options=[])

Return the SlotDiffRenderer appropriate for this content handler.

latestRevision (WikiPage $page)

Get the latest revision of the given $page, fetching it from the primary if necessary.

shouldCallDeprecatedContentTransformMethod (Content $content, $params)

Check if we need to provide content overrides deprecated Content method.

Additional Inherited Members
Static Public Member Functions inherited from ContentHandler
static	getAllContentFormats ()

static	getContentModels ()

static	getContentText (Content $content=null)
	Convenience function for getting flat text from a Content object.

static	getDefaultModelFor (Title $title)
	Returns the name of the default content model to be used for the page with the given title.

static	getForContent (Content $content)
	Returns the appropriate ContentHandler singleton for the given Content object.

static	getForModelID ( $modelId)
	Returns the ContentHandler singleton for the given model ID.

static	getForTitle (Title $title)
	Returns the appropriate ContentHandler singleton for the given title.

static	getLocalizedName ( $name, Language $lang=null)
	Returns the localized name for a given content model.

static	makeContent ( $text, Title $title=null, $modelId=null, $format=null)
	Convenience function for creating a Content object from a given textual representation.

Protected Attributes inherited from ContentHandler
string	$mModelID

string[]	$mSupportedFormats

Detailed Description

Content handler for CSS pages.

Since: 1.21

Definition at line 36 of file CssContentHandler.php.

Constructor & Destructor Documentation

◆ __construct()

CssContentHandler::__construct ( $modelId = CONTENT_MODEL_CSS )

Parameters

string $modelId

Definition at line 41 of file CssContentHandler.php.

References CONTENT_FORMAT_CSS.

Member Function Documentation

◆ fillParserOutput()

CssContentHandler::fillParserOutput	(	Content	$content,
		ContentParseParams	$cpoParams,
		ParserOutput &	$output )

protected

Fills the provided ParserOutput object with information derived from the content.Unless $generateHtml was false, this includes an HTML representation of the content provided by getHtml().For content models listed in $wgTextModelsToParse, this method will call the MediaWiki wikitext parser on the text to extract any (wikitext) links, magic words, etc., but note that the Table of Contents will not be generated (feature added by T307691, but should be refactored: T313455).Subclasses may override this to provide custom content processing. For custom HTML generation alone, it is sufficient to override getHtml().

Stability: stable: to override

Since: 1.38

Parameters

Content	$content
ContentParseParams	$cpoParams
ParserOutput	&$output	The output object to fill (reference).

Reimplemented from TextContentHandler.

Definition at line 108 of file CssContentHandler.php.

References $content, ParserOutput\clearWrapperDivClass(), MediaWiki\Content\Renderer\ContentParseParams\getGenerateHtml(), MediaWiki\Content\Renderer\ContentParseParams\getPage(), MediaWiki\Content\Renderer\ContentParseParams\getRevId(), and ParserOutput\setText().

◆ getContentClass()

CssContentHandler::getContentClass ( )

protected

Stability: stable: to override

Returns: string

Exceptions

MWException

Reimplemented from CodeContentHandler.

Definition at line 45 of file CssContentHandler.php.

Referenced by makeRedirectContent().

◆ makeRedirectContent()

CssContentHandler::makeRedirectContent	(	Title	$destination,
			$text = '' )

Create a redirect that is also valid CSS.

Parameters

Title	$destination
string	$text	ignored

Returns: CssContent

Reimplemented from ContentHandler.

Definition at line 60 of file CssContentHandler.php.

References getContentClass(), Title\getFullURL(), and PROTO_RELATIVE.

◆ preSaveTransform()

CssContentHandler::preSaveTransform	(	Content	$content,
		PreSaveTransformParams	$pstParams )

Returns a $content object with pre-save transformations applied (or the same object if no transformations apply).

Note: Not stable to call other then from ContentHandler hierarchy. Callers need to use ContentTransformer::preSaveTransform.

Stability: stable: to override

Since: 1.37

Parameters

Content	$content
PreSaveTransformParams	$pstParams

Returns: Content

Reimplemented from TextContentHandler.

Definition at line 67 of file CssContentHandler.php.

References $content, ContentHandler\callDeprecatedContentPST(), and ContentHandler\shouldCallDeprecatedContentTransformMethod().

◆ supportsRedirects()

CssContentHandler::supportsRedirects ( )

Returns true if this content model supports redirects.

This default implementation returns false.

Content models that return true here should also implement ContentHandler::makeRedirectContent to return a Content object.

Stability: stable: to override

Returns: bool Always false.

Reimplemented from ContentHandler.

Definition at line 49 of file CssContentHandler.php.

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

includes/content/CssContentHandler.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillParserOutput()

◆ getContentClass()

◆ makeRedirectContent()

◆ preSaveTransform()

◆ supportsRedirects()