MediaWiki  master
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)
 
 getDataForSearchIndex (WikiPage $page, ParserOutput $parserOutput, 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...
 
 isParserCacheSupported ()
 Returns true, because wikitext supports caching using the ParserCache mechanism. More...
 
 makeRedirectContent (Title $destination, $text='')
 Returns a WikitextContent object representing a redirect to the given destination page. More...
 
 serializeContent (Content $content, $format=null)
 Returns the content's text as-is. More...
 
 supportsRedirects ()
 Returns true because wikitext supports redirects. More...
 
 supportsSections ()
 Returns true because wikitext supports sections. 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...
 
 makeEmptyContent ()
 Creates an empty TextContent object. More...
 
 merge3 (Content $oldContent, Content $myContent, Content $yourContent)
 Attempts to merge differences between three versions. 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...
 
 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...
 
 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...
 
 isSupportedFormat ( $format)
 Returns true if $format is a serialization format supported by this ContentHandler, and false otherwise. More...
 
 supportsCategories ()
 Returns true if this content model supports categories. More...
 
 supportsDirectApiEditing ()
 Whether or not this content model supports direct editing via ApiEditPage. More...
 

Protected Member Functions

 getContentClass ()
 Returns the name of the associated Content class, to be used when creating new objects. More...
 
 getFileHandler ()
 Get file handler. More...
 
- 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...
 
 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...
 

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

Definition at line 34 of file WikitextContentHandler.php.

Constructor & Destructor Documentation

◆ __construct()

WikitextContentHandler::__construct (   $modelId = CONTENT_MODEL_WIKITEXT)

Definition at line 36 of file WikitextContentHandler.php.

References CONTENT_FORMAT_WIKITEXT.

Member Function Documentation

◆ getContentClass()

WikitextContentHandler::getContentClass ( )
protected

Returns the name of the associated Content class, to be used when creating new objects.

Override expected by subclasses.

Since
1.24
Returns
string

Reimplemented from TextContentHandler.

Definition at line 40 of file WikitextContentHandler.php.

Referenced by makeRedirectContent().

◆ getDataForSearchIndex()

WikitextContentHandler::getDataForSearchIndex ( WikiPage  $page,
ParserOutput  $output,
SearchEngine  $engine 
)

Return fields to be indexed by search engine as representation of this document.

Overriding class should call parent function or take care of calling the SearchDataForIndex hook. Stable to override

Parameters
WikiPage$pagePage to index
ParserOutput$output
SearchEngine$engineSearch engine for which we are indexing
Returns
array Map of name=>value for fields
Since
1.28

Reimplemented from TextContentHandler.

Reimplemented in FileContentHandler.

Definition at line 149 of file WikitextContentHandler.php.

References getFileHandler(), WikiPage\getTitle(), and NS_FILE.

◆ getFieldsForSearchIndex()

WikitextContentHandler::getFieldsForSearchIndex ( SearchEngine  $engine)

Get fields definition for search index.

Todo:
Expose title, redirect, namespace, text, source_text, text_bytes field mappings here. (see T142670 and T143409)

Stable to override

Parameters
SearchEngine$engine
Returns
SearchIndexField[] List of fields this content handler can provide.
Since
1.28

Reimplemented from TextContentHandler.

Reimplemented in FileContentHandler.

Definition at line 128 of file WikitextContentHandler.php.

References SearchIndexField\FLAG_NO_HIGHLIGHT, SearchIndexField\FLAG_SCORING, getFileHandler(), SearchIndexField\INDEX_TYPE_TEXT, and SearchEngine\makeSearchFieldMapping().

◆ getFileHandler()

WikitextContentHandler::getFileHandler ( )
protected

Get file handler.

Returns
FileContentHandler

Definition at line 124 of file WikitextContentHandler.php.

Referenced by getDataForSearchIndex(), and getFieldsForSearchIndex().

◆ 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 116 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 54 of file WikitextContentHandler.php.

References getContentClass(), Title\getFullText(), Title\getInterwiki(), Title\getNamespace(), and NS_CATEGORY.

◆ serializeContent()

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

Returns the content's text as-is.

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

Reimplemented from TextContentHandler.

Definition at line 180 of file WikitextContentHandler.php.

References $content, and ContentHandler\checkFormat().

◆ supportsRedirects()

WikitextContentHandler::supportsRedirects ( )

Returns true because wikitext supports redirects.

Returns
bool Always true.
See also
ContentHandler::supportsRedirects

Reimplemented from ContentHandler.

Definition at line 91 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 102 of file WikitextContentHandler.php.


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