MediaWiki  master
UnknownContentHandler Class Reference

Content handler implementation for unknown content. More...

Inheritance diagram for UnknownContentHandler:
Collaboration diagram for UnknownContentHandler:

Public Member Functions

 __construct ( $modelId, $formats=null)
 Constructs an UnknownContentHandler. More...
 
 makeEmptyContent ()
 Creates an empty UnknownContent object. More...
 
 serializeContent (Content $content, $format=null)
 Returns the content's data as-is. More...
 
 supportsDirectEditing ()
 
 unserializeContent ( $blob, $format=null)
 Constructs an UnknownContent instance wrapping the given data. 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...
 
 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...
 
 getDataForSearchIndex (WikiPage $page, ParserOutput $output, SearchEngine $engine)
 Return fields to be indexed by search engine as representation of this document. 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...
 
 getFieldsForSearchIndex (SearchEngine $engine)
 Get fields definition for search index. More...
 
 getModelID ()
 Returns the model id that identifies the content model this ContentHandler can handle. More...
 
 getPageLanguage (Title $title, Content $content=null)
 Get the language in which the content of the given page is written. More...
 
 getPageViewLanguage (Title $title, Content $content=null)
 Get the language in which the content of this page is written when viewed by user. 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 ( $current, $undo, $undoafter, $undoIsLatest=false)
 Get the Content object that needs to be saved in order to undo all revisions 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...
 
 merge3 (Content $oldContent, Content $myContent, Content $yourContent)
 Attempts to merge differences between three versions. 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

 getSlotDiffRendererInternal (IContextSource $context)
 
- Protected Member Functions inherited from ContentHandler
 addSearchField (&$fields, SearchEngine $engine, $name, $type)
 Add new field definition to array. 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...
 
 getSlotDiffRendererWithOptions (IContextSource $context, $options=[])
 Return the SlotDiffRenderer appropriate for this content handler. 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 implementation for unknown content.

This can be used to handle content for which no ContentHandler exists on the system, perhaps because the extension that provided it has been removed.

Definition at line 34 of file UnknownContentHandler.php.

Constructor & Destructor Documentation

◆ __construct()

UnknownContentHandler::__construct (   $modelId,
  $formats = null 
)

Constructs an UnknownContentHandler.

Since UnknownContentHandler can be registered for multiple model IDs on a system, multiple instances of UnknownContentHandler may coexist.

To preserve the serialization format of the original content model, it must be supplied to the constructor via the $formats parameter. If not given, the default format is reported as 'application/octet-stream'.

Parameters
string$modelId
string[] | null$formats

Reimplemented from ContentHandler.

Definition at line 48 of file UnknownContentHandler.php.

Member Function Documentation

◆ getSlotDiffRendererInternal()

UnknownContentHandler::getSlotDiffRendererInternal ( IContextSource  $context)
protected
Parameters
IContextSource$context
Returns
SlotDiffRenderer

Reimplemented from ContentHandler.

Definition at line 112 of file UnknownContentHandler.php.

References $context.

◆ makeEmptyContent()

UnknownContentHandler::makeEmptyContent ( )

Creates an empty UnknownContent object.

Since
1.21
Returns
Content A new UnknownContent object with empty text.

Reimplemented from ContentHandler.

Definition at line 96 of file UnknownContentHandler.php.

References unserializeContent().

◆ serializeContent()

UnknownContentHandler::serializeContent ( Content  $content,
  $format = null 
)

Returns the content's data as-is.

Parameters
Content$content
string | null$formatThe serialization format to check
Returns
mixed

Reimplemented from ContentHandler.

Definition at line 69 of file UnknownContentHandler.php.

References $content.

◆ supportsDirectEditing()

UnknownContentHandler::supportsDirectEditing ( )
Returns
false

Reimplemented from ContentHandler.

Definition at line 103 of file UnknownContentHandler.php.

◆ unserializeContent()

UnknownContentHandler::unserializeContent (   $blob,
  $format = null 
)

Constructs an UnknownContent instance wrapping the given data.

Since
1.21
Parameters
string$blobserialized content in an unknown format
string | null$formatignored
Returns
Content The UnknownContent object wrapping $data

Reimplemented from ContentHandler.

Definition at line 85 of file UnknownContentHandler.php.

References $blob, and ContentHandler\getModelID().

Referenced by makeEmptyContent().


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