MediaWiki  1.23.8
WikitextContentHandler Class Reference

Content handler for wiki text pages. More...

Inheritance diagram for WikitextContentHandler:
Collaboration diagram for WikitextContentHandler:

Public Member Functions

 __construct ( $modelId=CONTENT_MODEL_WIKITEXT)
 
 isParserCacheSupported ()
 Returns true, because wikitext supports caching using the ParserCache mechanism. More...
 
 makeEmptyContent ()
 
 makeRedirectContent (Title $destination, $text='')
 Returns a WikitextContent object representing a redirect to the given destination page. More...
 
 supportsRedirects ()
 Returns true because wikitext supports redirects. More...
 
 supportsSections ()
 Returns true because wikitext supports sections. More...
 
 unserializeContent ( $text, $format=null)
 Unserializes a Content object of the type supported by this ContentHandler. More...
 
- 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...
 
 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...
 
 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...
 

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 wiki text pages.

Definition at line 31 of file WikitextContentHandler.php.

Constructor & Destructor Documentation

◆ __construct()

WikitextContentHandler::__construct (   $modelId = CONTENT_MODEL_WIKITEXT)

Definition at line 33 of file WikitextContentHandler.php.

References array(), and CONTENT_FORMAT_WIKITEXT.

Member Function Documentation

◆ isParserCacheSupported()

WikitextContentHandler::isParserCacheSupported ( )

Returns true, because wikitext supports caching using the ParserCache mechanism.

Since
1.21
Returns
bool Always true.
See also
ContentHandler::isParserCacheSupported

Reimplemented from ContentHandler.

Definition at line 117 of file WikitextContentHandler.php.

◆ makeEmptyContent()

WikitextContentHandler::makeEmptyContent ( )
Returns
Content A new WikitextContent object with empty text.
See also
ContentHandler::makeEmptyContent

Reimplemented from TextContentHandler.

Definition at line 48 of file WikitextContentHandler.php.

◆ makeRedirectContent()

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

Returns a WikitextContent object representing a redirect to the given destination page.

Parameters
Title$destinationThe page to redirect to.
string$textText to include in the redirect, if possible.
Returns
Content
See also
ContentHandler::makeRedirectContent

Reimplemented from ContentHandler.

Definition at line 62 of file WikitextContentHandler.php.

References Language\fetchLanguageName(), MagicWord\get(), Title\getFullText(), Title\getInterwiki(), Title\getNamespace(), and NS_CATEGORY.

◆ supportsRedirects()

WikitextContentHandler::supportsRedirects ( )

Returns true because wikitext supports redirects.

Returns
bool Always true.
See also
ContentHandler::supportsRedirects

Reimplemented from ContentHandler.

Definition at line 92 of file WikitextContentHandler.php.

◆ supportsSections()

WikitextContentHandler::supportsSections ( )

Returns true because wikitext supports sections.

Returns
bool Always true.
See also
ContentHandler::supportsSections

Reimplemented from ContentHandler.

Definition at line 103 of file WikitextContentHandler.php.

◆ unserializeContent()

WikitextContentHandler::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 TextContentHandler.

Definition at line 37 of file WikitextContentHandler.php.

References ContentHandler\checkFormat().


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