MediaWiki  master
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. More...
 
 getPageViewLanguage (Title $title, Content $content=null)
 Returns the English language, because code is English, and should be handled as such. More...
 
- 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. More...
 
 getDataForSearchIndex (WikiPage $page, ParserOutput $output, SearchEngine $engine)
 Return fields to be indexed by search engine as representation of this document. More...
 
 getFieldsForSearchIndex (SearchEngine $engine)
 Get fields definition for search index. More...
 
 makeEmptyContent ()
 Creates an empty TextContent object. More...
 
 merge3 (Content $oldContent, Content $myContent, Content $yourContent)
 Attempts to merge differences between three versions. More...
 
 preSaveTransform (Content $content, PreSaveTransformParams $pstParams)
 Returns a $content object with pre-save transformations applied (or the same object if no transformations apply). More...
 
 serializeContent (Content $content, $format=null)
 Returns the content's text as-is. More...
 
 supportsDirectEditing ()
 
 unserializeContent ( $text, $format=null)
 Unserializes a Content object of the type supported by this ContentHandler. More...
 
- 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. 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...
 
 exportTransform ( $blob, $format=null)
 Applies transformations on export (returns the blob unchanged per default). More...
 
 fillParserOutputInternal (Content $content, ContentParseParams $cpoParams, ParserOutput &$output)
 A temporary layer to move AbstractContent::fillParserOutput to ContentHandler::fillParserOutput. More...
 
 generateHTMLOnEdit ()
 Whether an edit on the content should trigger an HTML render and ParserCache entry. 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=0)
 Return an applicable auto-summary if one exists for the given edit. More...
 
 getChangeTag (Content $oldContent=null, Content $newContent=null, $flags=0)
 Return an applicable tag if one exists for the given edit or return null. More...
 
 getDefaultFormat ()
 The format used for serialization/deserialization by default by this ContentHandler. More...
 
 getDeletionUpdates (Title $title, $role)
 Returns a list of DeferrableUpdate objects for removing information about content in some secondary data store. More...
 
 getModelID ()
 Returns the model id that identifies the content model this ContentHandler can handle. More...
 
 getParserOutput (Content $content, ContentParseParams $cpoParams)
 Returns a ParserOutput object containing information derived from this content. More...
 
 getParserOutputForIndexing (WikiPage $page, ParserCache $cache=null)
 Produce page output suitable for indexing. More...
 
 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. More...
 
 getSlotDiffRenderer (IContextSource $context, array $options=[])
 Get an appropriate SlotDiffRenderer for this content model. More...
 
 getSupportedFormats ()
 Returns a list of serialization formats supported by the serializeContent() and unserializeContent() methods of this ContentHandler. More...
 
 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. More...
 
 importTransform ( $blob, $format=null)
 Apply import transformation (per default, returns $blob unchanged). 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...
 
 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. More...
 
 preloadTransform (Content $content, PreloadTransformParams $pltParams)
 Returns a $content object with preload transformations applied (or the same object if no transformations apply). More...
 
 supportsCategories ()
 Returns true if this content model supports categories. More...
 
 supportsDirectApiEditing ()
 Whether or not this content model supports direct editing via ApiEditPage. More...
 
 supportsRedirects ()
 Returns true if this content model supports redirects. More...
 
 supportsSections ()
 Returns true if this content model supports sections. More...
 

Protected Member Functions

 getContentClass ()
 
- Protected Member Functions inherited from TextContentHandler
 fillParserOutput (Content $content, ContentParseParams $cpoParams, ParserOutput &$output)
 Fills the provided ParserOutput object with information derived from the content. More...
 
- Protected Member Functions inherited from ContentHandler
 addSearchField (&$fields, SearchEngine $engine, $name, $type)
 Add new field definition to array. More...
 
 callDeprecatedContentGPO (Content $content, ContentParseParams $cpoParams)
 If provided content overrides deprecated Content::getParserOutput, call it and return. More...
 
 callDeprecatedContentPLT (Content $content, PreloadTransformParams $params)
 If provided content overrides deprecated Content::preloadTransform, call it and return. More...
 
 callDeprecatedContentPST (Content $content, PreSaveTransformParams $params)
 Provided content overrides deprecated Content::preSaveTransform, call it and return. More...
 
 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...
 
 getSlotDiffRendererInternal (IContextSource $context)
 Return the SlotDiffRenderer appropriate for this content handler. More...
 
 getSlotDiffRendererWithOptions (IContextSource $context, $options=[])
 Return the SlotDiffRenderer appropriate for this content handler. More...
 
 latestRevision (WikiPage $page)
 Get the latest revision of the given $page, fetching it from the primary if necessary. More...
 
 shouldCallDeprecatedContentTransformMethod (Content $content, $params)
 Check if we need to provide content overrides deprecated Content method. More...
 

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. 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, Language $lang=null)
 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...
 
- Protected Attributes inherited from ContentHandler
string $mModelID
 
string[] $mSupportedFormats
 

Detailed Description

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

Stability: stable
to extend
Since
1.24

Definition at line 33 of file CodeContentHandler.php.

Member Function Documentation

◆ getContentClass()

CodeContentHandler::getContentClass ( )
protected
Stability: stable
to override
Returns
string
Exceptions
MWException

Reimplemented from TextContentHandler.

Reimplemented in JsonContentHandler, JavaScriptContentHandler, and CssContentHandler.

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.

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

Stability: 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: