CodeContentHandler Class Reference

Content handler for code content such as CSS, JavaScript, JSON, etc. More...

Inheritance diagram for CodeContentHandler:

Collaboration diagram for CodeContentHandler:

Public Member Functions
	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).
	getActionOverrides ()
	Returns overrides for action handlers.
	getAutoDeleteReason (Title $title, &$hasHistory)
	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.
	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 ( $current, $undo, $undoafter, $undoIsLatest=false)
	Get the Content object that needs to be saved in order to undo all revisions 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.
	makeRedirectContent (Title $destination, $text='')
	Creates a new Content object that acts as a redirect to the given page, or null if redirects are not supported by this content model.
	supportsCategories ()
	Returns true if this content model supports categories.
	supportsDirectApiEditing ()
	Whether or not this content model supports direct editing via ApiEditPage.
	supportsRedirects ()
	Returns true if this content model supports redirects.
	supportsSections ()
	Returns true if this content model supports sections.

Protected Member Functions
	getContentClass ()
	Stable to override.
Protected Member Functions inherited from ContentHandler
	addSearchField (&$fields, SearchEngine $engine, $name, $type)
	Add new field definition to array.
	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.

Additional Inherited Members
Static Public Member Functions inherited from ContentHandler
static	cleanupHandlersCache ()
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 code content such as CSS, JavaScript, JSON, etc.

Stable to extend

Since

1.24

Definition at line 33 of file CodeContentHandler.php.

Member Function Documentation

getContentClass()

CodeContentHandler::getContentClass ( )

protected

Stable to override.

Returns

string

Exceptions

MWException

Reimplemented from TextContentHandler.

Reimplemented in CssContentHandler, JavaScriptContentHandler, and JsonContentHandler.

Definition at line 73 of file CodeContentHandler.php.

getPageLanguage()

CodeContentHandler::getPageLanguage	(	Title	$title,
		Content	$content = null
	)

Returns the English language, because code is English, and should be handled as such.

Stable to override

Parameters

Title	$title
Content | null	$content

Returns

Language

See also

ContentHandler::getPageLanguage()

Reimplemented from ContentHandler.

Definition at line 47 of file CodeContentHandler.php.

getPageViewLanguage()

CodeContentHandler::getPageViewLanguage	(	Title	$title,
		Content	$content = null
	)

Returns the English language, because code is English, and should be handled as such.

Stable to override

Parameters

Title	$title
Content | null	$content

Returns

Language

See also

ContentHandler::getPageViewLanguage()

Reimplemented from ContentHandler.

Definition at line 63 of file CodeContentHandler.php.

---

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

• includes/content/CodeContentHandler.php