Content handler for JavaScript pages. More...

Inherits MediaWiki\Content\CodeContentHandler.

Collaboration diagram for MediaWiki\Content\JavaScriptContentHandler:

[legend]

Public Member Functions

__construct ( $modelId=CONTENT_MODEL_JAVASCRIPT)

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

Create a redirect that is also valid JavaScript.

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

Public Member Functions inherited from MediaWiki\Content\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 MediaWiki\Content\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.Values for the parameters are typically provided as literals by subclass's constructors.

Stability: stable: to call

Parameters

string	$modelId	(use CONTENT_MODEL_XXX constants).
string[]	$formats	List for supported serialization formats (typically as MIME types)

getDataForSearchIndex (WikiPage $page, ParserOutput $output, SearchEngine $engine, ?RevisionRecord $revision=null)

Return fields to be indexed by search engine as representation of this document.Overriding class should call parent function or take care of calling the SearchDataForIndex hook.The $output must be the result of a call to getParserOutputForIndexing() on the same content handler. That method may return ParserOutput without HTML; this base implementation does not rely on the HTML being present, so it is safe to call even by subclasses that override getParserOutputForIndexing() to skip HTML generation. On the other hand, since the default implementation of getParserOutputForIndexing() does generate HTML, subclasses are free to rely on the HTML here if they do not override getParserOutputForIndexing().

Stability: stable: to override

Parameters

WikiPage	$page	Page to index
ParserOutput	$output
SearchEngine	$engine	Search engine for which we are indexing
RevisionRecord \| null	$revision	Revision content to fetch if provided or use the latest revision from WikiPage::getRevisionRecord() if not

Returns: array Map of name=>value for fields, an empty array is returned if the latest revision cannot be retrieved.

Since: 1.28

getFieldsForSearchIndex (SearchEngine $engine)

Get fields definition for search index.

Todo: Expose title, redirect, namespace, text, source_text, text_bytes field mappings here. (see T142670 and T143409)

Stability: stable: to override

Parameters

SearchEngine $engine

Returns: SearchIndexField[] List of fields this content handler can provide.

Since: 1.28

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 MediaWiki\Content\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 by 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, ?RevisionRecord $revision=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 (by 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.

	getContentClass ()

Protected Member Functions inherited from MediaWiki\Content\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)

	createTextSlotDiffRenderer (array $options=[])
	Create a TextSlotDiffRenderer and inject dependencies.

	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.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Content\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	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 MediaWiki\Content\ContentHandler
string	$mModelID

string[]	$mSupportedFormats

Detailed Description

Content handler for JavaScript pages.

Todo: Create a ScriptContentHandler base class, do highlighting stuff there?

Since: 1.21

Definition at line 41 of file JavaScriptContentHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Content\JavaScriptContentHandler::__construct ( $modelId = CONTENT_MODEL_JAVASCRIPT )

Parameters

string $modelId

Definition at line 46 of file JavaScriptContentHandler.php.

References CONTENT_FORMAT_JAVASCRIPT.

Member Function Documentation

◆ fillParserOutput()

MediaWiki\Content\JavaScriptContentHandler::fillParserOutput	(	Content	$content,
		ContentParseParams	$cpoParams,
		ParserOutput &	$output )

protected

Fills the provided ParserOutput object with information derived from the content.

Unless $cpo->getGenerateHtml was false, this includes an HTML representation of the content.

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.

Subclasses may override this to provide custom content processing..

Stability: stable: to override

Since: 1.38

Parameters

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

Reimplemented from MediaWiki\Content\TextContentHandler.

Definition at line 125 of file JavaScriptContentHandler.php.

References MediaWiki\Parser\ParserOutput\clearWrapperDivClass(), MediaWiki\Html\element(), MediaWiki\Content\Renderer\ContentParseParams\getGenerateHtml(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Content\Content\getModel(), MediaWiki\Content\Renderer\ContentParseParams\getPage(), MediaWiki\Content\Renderer\ContentParseParams\getRevId(), MediaWiki\Parser\ParserOutput\setOutputFlag(), MediaWiki\Parser\ParserOutput\setRawText(), MediaWiki\Parser\ParserOutput\setSections(), and MediaWiki\MainConfigNames\TextModelsToParse.

◆ getContentClass()

MediaWiki\Content\JavaScriptContentHandler::getContentClass ( )

protected

Returns: class-string<JavaScriptContent>

Reimplemented from MediaWiki\Content\CodeContentHandler.

Definition at line 53 of file JavaScriptContentHandler.php.

Referenced by MediaWiki\Content\JavaScriptContentHandler\makeRedirectContent().

◆ makeRedirectContent()

MediaWiki\Content\JavaScriptContentHandler::makeRedirectContent	(	Title	$destination,
			$text = '' )

Create a redirect that is also valid JavaScript.

Parameters

Title	$destination
string	$text	ignored

Returns: JavaScriptContent

Reimplemented from MediaWiki\Content\ContentHandler.

Definition at line 69 of file JavaScriptContentHandler.php.

References $url, MediaWiki\Content\JavaScriptContentHandler\getContentClass(), MediaWiki\Title\Title\getFullURL(), and PROTO_RELATIVE.

◆ preSaveTransform()

MediaWiki\Content\JavaScriptContentHandler::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 MediaWiki\Content\TextContentHandler.

Definition at line 82 of file JavaScriptContentHandler.php.

◆ supportsRedirects()

MediaWiki\Content\JavaScriptContentHandler::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 MediaWiki\Content\ContentHandler.

Definition at line 58 of file JavaScriptContentHandler.php.

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

includes/content/JavaScriptContentHandler.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillParserOutput()

◆ getContentClass()

◆ makeRedirectContent()

◆ preSaveTransform()

◆ supportsRedirects()