MediaWiki  1.23.13
JavaScriptContentHandler Class Reference

Content handler for JavaScript pages. More...

Inheritance diagram for JavaScriptContentHandler:
Collaboration diagram for JavaScriptContentHandler:

Public Member Functions

 __construct ( $modelId=CONTENT_MODEL_JAVASCRIPT)
 
 getPageLanguage (Title $title, Content $content=null)
 Returns the english language, because JS is english, and should be handled as such. More...
 
 getPageViewLanguage (Title $title, Content $content=null)
 Returns the english language, because JS is english, and should be handled as such. More...
 
 makeEmptyContent ()
 
 unserializeContent ( $text, $format=null)
 
- Public Member Functions inherited from TextContentHandler
 __construct ( $modelId=CONTENT_MODEL_TEXT, $formats=array(CONTENT_FORMAT_TEXT))
 Constructor, initializing the ContentHandler instance with its model ID and a list of supported formats. More...
 
 merge3 (Content $oldContent, Content $myContent, Content $yourContent)
 Attempts to merge differences between three versions. More...
 
 serializeContent (Content $content, $format=null)
 Returns the content's text as-is. More...
 
- Public Member Functions inherited from ContentHandler
 canBeUsedOn (Title $title)
 Determines whether the content type handled by this ContentHandler can be used on the given page. More...
 
 createDifferenceEngine (IContextSource $context, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
 Factory for creating an appropriate DifferenceEngine for this content model. More...
 
 getActionOverrides ()
 Returns overrides for action handlers. More...
 
 getAutoDeleteReason (Title $title, &$hasHistory)
 Auto-generates a deletion reason. More...
 
 getAutosummary (Content $oldContent=null, Content $newContent=null, $flags)
 Return an applicable auto-summary if one exists for the given edit. More...
 
 getDefaultFormat ()
 The format used for serialization/deserialization by default by this ContentHandler. More...
 
 getModelID ()
 Returns the model id that identifies the content model this ContentHandler can handle. More...
 
 getSupportedFormats ()
 Returns a list of serialization formats supported by the serializeContent() and unserializeContent() methods of this ContentHandler. More...
 
 getUndoContent (Revision $current, Revision $undo, Revision $undoafter)
 Get the Content object that needs to be saved in order to undo all revisions between $undo and $undoafter. More...
 
 isParserCacheSupported ()
 Returns true for content models that support caching using the ParserCache mechanism. More...
 
 isSupportedFormat ( $format)
 Returns true if $format is a serialization format supported by this ContentHandler, and false otherwise. More...
 
 makeParserOptions ( $context)
 Get parser options suitable for rendering and caching the article. More...
 
 makeRedirectContent (Title $destination, $text='')
 Creates a new Content object that acts as a redirect to the given page, or null of redirects are not supported by this content model. More...
 
 supportsRedirects ()
 Returns true if this content model supports redirects. More...
 
 supportsSections ()
 Returns true if this content model supports sections. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ContentHandler
static deprecated ( $func, $version, $component=false)
 Logs a deprecation warning, visible if $wgDevelopmentWarnings, but only if self::$enableDeprecationWarnings is set to true. More...
 
static getAllContentFormats ()
 
static getContentModels ()
 
static getContentText (Content $content=null)
 Convenience function for getting flat text from a Content object. More...
 
static getDefaultModelFor (Title $title)
 Returns the name of the default content model to be used for the page with the given title. More...
 
static getForContent (Content $content)
 Returns the appropriate ContentHandler singleton for the given Content object. More...
 
static getForModelID ( $modelId)
 Returns the ContentHandler singleton for the given model ID. More...
 
static getForTitle (Title $title)
 Returns the appropriate ContentHandler singleton for the given title. More...
 
static getLocalizedName ( $name)
 Returns the localized name for a given content model. More...
 
static makeContent ( $text, Title $title=null, $modelId=null, $format=null)
 Convenience function for creating a Content object from a given textual representation. More...
 
static runLegacyHooks ( $event, $args=array(), $warn=null)
 Call a legacy hook that uses text instead of Content objects. More...
 
- Protected Member Functions inherited from ContentHandler
 checkFormat ( $format)
 Convenient for checking whether a format provided as a parameter is actually supported. More...
 
 checkModelID ( $model_id)
 
 getDiffEngineClass ()
 Returns the name of the diff engine to use. More...
 
- Protected Attributes inherited from ContentHandler
string $mModelID
 
string[] $mSupportedFormats
 
- Static Protected Attributes inherited from ContentHandler
static $enableDeprecationWarnings = false
 Switch for enabling deprecation warnings. More...
 
static $handlers
 

Detailed Description

Content handler for JavaScript pages.

Since
1.21
Todo:
make ScriptContentHandler base class, do highlighting stuff there?

Definition at line 30 of file JavaScriptContentHandler.php.

Constructor & Destructor Documentation

◆ __construct()

JavaScriptContentHandler::__construct (   $modelId = CONTENT_MODEL_JAVASCRIPT)
Parameters
string$modelId

Definition at line 35 of file JavaScriptContentHandler.php.

References array(), and CONTENT_FORMAT_JAVASCRIPT.

Member Function Documentation

◆ getPageLanguage()

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

Returns the english language, because JS is english, and should be handled as such.

Parameters
Title$title
Content$content
Returns
Language wfGetLangObj( 'en' )
See also
ContentHandler::getPageLanguage()

Reimplemented from ContentHandler.

Definition at line 72 of file JavaScriptContentHandler.php.

References wfGetLangObj().

◆ getPageViewLanguage()

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

Returns the english language, because JS is english, and should be handled as such.

Parameters
Title$title
Content$content
Returns
Language wfGetLangObj( 'en' )
See also
ContentHandler::getPageViewLanguage()

Reimplemented from ContentHandler.

Definition at line 86 of file JavaScriptContentHandler.php.

References wfGetLangObj().

◆ makeEmptyContent()

JavaScriptContentHandler::makeEmptyContent ( )
Returns
JavaScriptContent A new JavaScriptContent object with empty text.
See also
ContentHandler::makeEmptyContent()

Reimplemented from TextContentHandler.

Definition at line 58 of file JavaScriptContentHandler.php.

◆ unserializeContent()

JavaScriptContentHandler::unserializeContent (   $text,
  $format = null 
)
Parameters
string$text
string$format
Returns
JavaScriptContent
See also
ContentHandler::unserializeContent()

Reimplemented from TextContentHandler.

Definition at line 47 of file JavaScriptContentHandler.php.

References ContentHandler\checkFormat().


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