FileContentHandler Class Reference
Content handler for File: files TODO: this handler s not used directly now, but instead manually called by WikitextHandler. More...
Inheritance diagram for FileContentHandler:
Collaboration diagram for FileContentHandler:
Public Member Functions | |
| 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... | |
 Public Member Functions inherited from WikitextContentHandler | |
| __construct ( $modelId=CONTENT_MODEL_WIKITEXT) | |
| 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) | |
| 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... | |
| makeParserOptions ( $context) | |
| Get parser options suitable for rendering and caching the article. More... | |
| supportsCategories () | |
| Returns true if this content model supports categories. More... | |
| supportsDirectApiEditing () | |
| Whether or not this content model supports direct editing via ApiEditPage. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ContentHandler | |
| static | cleanupHandlersCache () |
| Clean up handlers cache. 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, 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 Member Functions inherited from WikitextContentHandler | |
| 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... | |
| Protected Attributes inherited from ContentHandler | |
| string | $mModelID |
| string[] | $mSupportedFormats |
| Static Protected Attributes inherited from ContentHandler | |
| static array | $handlers |
| A Cache of ContentHandler instances by model id. More... | |
Detailed Description
Content handler for File: files TODO: this handler s not used directly now, but instead manually called by WikitextHandler.
This should be fixed in the future.
Definition at line 11 of file FileContentHandler.php.
Member Function Documentation
◆ getDataForSearchIndex()
| FileContentHandler::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.
- Parameters
-
WikiPage $page Page to index ParserOutput $output SearchEngine $engine Search engine for which we are indexing
- Returns
- array Map of name=>value for fields
- Since
- 1.28
Reimplemented from WikitextContentHandler.
Definition at line 36 of file FileContentHandler.php.
References $file, $title, WikiPage\getTitle(), and NS_FILE.
◆ getFieldsForSearchIndex()
| FileContentHandler::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)
- Parameters
-
SearchEngine $engine
- Returns
- SearchIndexField[] List of fields this content handler can provide.
- Since
- 1.28
Reimplemented from WikitextContentHandler.
Definition at line 13 of file FileContentHandler.php.
References SearchIndexField\FLAG_CASEFOLD, SearchIndexField\INDEX_TYPE_INTEGER, SearchIndexField\INDEX_TYPE_KEYWORD, SearchIndexField\INDEX_TYPE_SHORT_TEXT, SearchIndexField\INDEX_TYPE_TEXT, and SearchEngine\makeSearchFieldMapping().
The documentation for this class was generated from the following file:
- includes/content/FileContentHandler.php
