MediaWiki  1.23.8
TextContentHandler Class Reference

Base content handler implementation for flat text contents. More...

Inheritance diagram for TextContentHandler:
Collaboration diagram for TextContentHandler:

Public Member Functions

 __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...
 
 makeEmptyContent ()
 Creates an empty TextContent object. 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...
 
 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 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...
 
 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...
 
 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

Base content handler implementation for flat text contents.

Definition at line 31 of file TextContentHandler.php.

Constructor & Destructor Documentation

◆ __construct()

TextContentHandler::__construct (   $modelId = CONTENT_MODEL_TEXT,
  $formats = arrayCONTENT_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.

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

Reimplemented from ContentHandler.

Definition at line 34 of file TextContentHandler.php.

Member Function Documentation

◆ makeEmptyContent()

TextContentHandler::makeEmptyContent ( )

Creates an empty TextContent object.

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

Reimplemented from ContentHandler.

Reimplemented in RevisionTestModifyableContentHandler, CssContentHandler, JavaScriptContentHandler, and WikitextContentHandler.

Definition at line 118 of file TextContentHandler.php.

Referenced by merge3().

◆ merge3()

TextContentHandler::merge3 ( Content  $oldContent,
Content  $myContent,
Content  $yourContent 
)

Attempts to merge differences between three versions.

Returns a new Content object for a clean merge and false for failure or a conflict.

All three Content objects passed as parameters must have the same content model.

This text-based implementation uses wfMerge().

Parameters
Content | string$oldContentThe page's previous content.
Content | string$myContentOne of the page's conflicting contents.
Content | string$yourContentOne of the page's conflicting contents.
Returns
Content|bool

Reimplemented from ContentHandler.

Definition at line 69 of file TextContentHandler.php.

References $ok, ContentHandler\checkModelID(), ContentHandler\getDefaultFormat(), Content\getModel(), makeEmptyContent(), serializeContent(), unserializeContent(), and wfMerge().

◆ serializeContent()

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

Returns the content's text as-is.

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

Reimplemented from ContentHandler.

Definition at line 48 of file TextContentHandler.php.

References ContentHandler\checkFormat(), and Content\getNativeData().

Referenced by merge3().

◆ unserializeContent()

TextContentHandler::unserializeContent (   $text,
  $format = null 
)

Unserializes a Content object of the type supported by this ContentHandler.

Since
1.21
Parameters
string$textSerialized form of the content
string$formatThe format used for serialization
Returns
Content The TextContent object wrapping $text

Reimplemented from ContentHandler.

Reimplemented in RevisionTestModifyableContentHandler, CssContentHandler, JavaScriptContentHandler, and WikitextContentHandler.

Definition at line 105 of file TextContentHandler.php.

References ContentHandler\checkFormat().

Referenced by merge3().


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