MediaWiki REL1_39
|
A content handler knows how do deal with a specific type of content on a wiki page. More...
Public Member Functions | |
__construct ( $modelId, $formats) | |
Constructor, initializing the ContentHandler instance with its model ID and a list of supported formats. | |
canBeUsedOn (Title $title) | |
Determines whether the content type handled by this ContentHandler can be used for the main slot of the given page. | |
createDifferenceEngine (IContextSource $context, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false) | |
Factory for creating an appropriate DifferenceEngine for this content model. | |
exportTransform ( $blob, $format=null) | |
Applies transformations on export (returns the blob unchanged per default). | |
fillParserOutputInternal (Content $content, ContentParseParams $cpoParams, ParserOutput &$output) | |
A temporary layer to move AbstractContent::fillParserOutput to ContentHandler::fillParserOutput. | |
generateHTMLOnEdit () | |
Whether an edit on the content should trigger an HTML render and ParserCache entry. | |
getActionOverrides () | |
Returns overrides for action handlers. | |
getAutoDeleteReason (Title $title, &$hasHistory=false) | |
Auto-generates a deletion reason. | |
getAutosummary (Content $oldContent=null, Content $newContent=null, $flags=0) | |
Return an applicable auto-summary if one exists for the given edit. | |
getChangeTag (Content $oldContent=null, Content $newContent=null, $flags=0) | |
Return an applicable tag if one exists for the given edit or return null. | |
getDataForSearchIndex (WikiPage $page, ParserOutput $output, SearchEngine $engine) | |
Return fields to be indexed by search engine as representation of this document. | |
getDefaultFormat () | |
The format used for serialization/deserialization by default by this ContentHandler. | |
getDeletionUpdates (Title $title, $role) | |
Returns a list of DeferrableUpdate objects for removing information about content in some secondary data store. | |
getFieldsForSearchIndex (SearchEngine $engine) | |
Get fields definition for search index. | |
getModelID () | |
Returns the model id that identifies the content model this ContentHandler can handle. | |
getPageLanguage (Title $title, Content $content=null) | |
Get the language in which the content of the given page is written. | |
getPageViewLanguage (Title $title, Content $content=null) | |
Get the language in which the content of this page is written when viewed by user. | |
getParserOutput (Content $content, ContentParseParams $cpoParams) | |
Returns a ParserOutput object containing information derived from this content. | |
getParserOutputForIndexing (WikiPage $page, ParserCache $cache=null) | |
Produce page output suitable for indexing. | |
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. | |
getSlotDiffRenderer (IContextSource $context, array $options=[]) | |
Get an appropriate SlotDiffRenderer for this content model. | |
getSupportedFormats () | |
Returns a list of serialization formats supported by the serializeContent() and unserializeContent() methods of this ContentHandler. | |
getUndoContent (Content $currentContent, Content $undoContent, Content $undoAfterContent, $undoIsLatest=false) | |
Get the Content object that needs to be saved in order to undo all changes between $undo and $undoafter. | |
importTransform ( $blob, $format=null) | |
Apply import transformation (per default, returns $blob unchanged). | |
isParserCacheSupported () | |
Returns true for content models that support caching using the ParserCache mechanism. | |
isSupportedFormat ( $format) | |
Returns true if $format is a serialization format supported by this ContentHandler, and false otherwise. | |
makeEmptyContent () | |
Creates an empty Content object of the type supported by this ContentHandler. | |
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. | |
merge3 (Content $oldContent, Content $myContent, Content $yourContent) | |
Attempts to merge differences between three versions. | |
preloadTransform (Content $content, PreloadTransformParams $pltParams) | |
Returns a $content object with preload transformations applied (or the same object if no transformations apply). | |
preSaveTransform (Content $content, PreSaveTransformParams $pstParams) | |
Returns a $content object with pre-save transformations applied (or the same object if no transformations apply). | |
serializeContent (Content $content, $format=null) | |
Serializes a Content object of the type supported by this ContentHandler. | |
supportsCategories () | |
Returns true if this content model supports categories. | |
supportsDirectApiEditing () | |
Whether or not this content model supports direct editing via ApiEditPage. | |
supportsDirectEditing () | |
Return true if this content model supports direct editing, such as via EditPage. | |
supportsPreloadContent () | |
If a non-existing page can be created with the contents from another (arbitrary) page being preloaded in the editor, see {. | |
supportsRedirects () | |
Returns true if this content model supports redirects. | |
supportsSections () | |
Returns true if this content model supports sections. | |
unserializeContent ( $blob, $format=null) | |
Unserializes a Content object of the type supported by this ContentHandler. | |
validateSave (Content $content, ValidationParams $validationParams) | |
Validate content for saving it. | |
Static Public Member Functions | |
static | getAllContentFormats () |
static | getContentModels () |
static | getContentText (Content $content=null) |
Convenience function for getting flat text from a Content object. | |
static | getDefaultModelFor (Title $title) |
Returns the name of the default content model to be used for the page with the given title. | |
static | getForContent (Content $content) |
Returns the appropriate ContentHandler singleton for the given Content object. | |
static | getForModelID ( $modelId) |
Returns the ContentHandler singleton for the given model ID. | |
static | getForTitle (Title $title) |
Returns the appropriate ContentHandler singleton for the given title. | |
static | getLocalizedName ( $name, Language $lang=null) |
Returns the localized name for a given content model. | |
static | makeContent ( $text, Title $title=null, $modelId=null, $format=null) |
Convenience function for creating a Content object from a given textual representation. | |
Protected Member Functions | |
addSearchField (&$fields, SearchEngine $engine, $name, $type) | |
Add new field definition to array. | |
callDeprecatedContentGPO (Content $content, ContentParseParams $cpoParams) | |
If provided content overrides deprecated Content::getParserOutput, call it and return. | |
callDeprecatedContentPLT (Content $content, PreloadTransformParams $params) | |
If provided content overrides deprecated Content::preloadTransform, call it and return. | |
callDeprecatedContentPST (Content $content, PreSaveTransformParams $params) | |
Provided content overrides deprecated Content::preSaveTransform, call it and return. | |
checkFormat ( $format) | |
Convenient for checking whether a format provided as a parameter is actually supported. | |
checkModelID ( $model_id) | |
fillParserOutput (Content $content, ContentParseParams $cpoParams, ParserOutput &$output) | |
Fills the provided ParserOutput with information derived from the content. | |
getDiffEngineClass () | |
Returns the name of the diff engine to use. | |
getSlotDiffRendererInternal (IContextSource $context) | |
Return the SlotDiffRenderer appropriate for this content handler. | |
getSlotDiffRendererWithOptions (IContextSource $context, $options=[]) | |
Return the SlotDiffRenderer appropriate for this content handler. | |
latestRevision (WikiPage $page) | |
Get the latest revision of the given $page, fetching it from the primary if necessary. | |
shouldCallDeprecatedContentTransformMethod (Content $content, $params) | |
Check if we need to provide content overrides deprecated Content method. | |
Protected Attributes | |
string | $mModelID |
string[] | $mSupportedFormats |
A content handler knows how do deal with a specific type of content on a wiki page.
Content is stored in the database in a serialized form (using a serialization format a.k.a. MIME type) and is unserialized into its native PHP representation (the content model), which is wrapped in an instance of the appropriate subclass of Content.
ContentHandler instances are stateless singletons that serve, among other things, as a factory for Content objects. Generally, there is one subclass of ContentHandler and one subclass of Content for every type of content model.
Some content types have a flat model, that is, their native representation is the same as their serialized form. Examples would be JavaScript and CSS code. As of now, this also applies to wikitext (MediaWiki's default content type), but wikitext content may be represented by a DOM or AST structure in the future.
Definition at line 65 of file ContentHandler.php.
ContentHandler::__construct | ( | $modelId, | |
$formats ) |
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.
string | $modelId | (use CONTENT_MODEL_XXX constants). |
string[] | $formats | List for supported serialization formats (typically as MIME types) |
Reimplemented in FallbackContentHandler, and TextContentHandler.
Definition at line 360 of file ContentHandler.php.
|
protected |
Add new field definition to array.
SearchIndexField[] | &$fields | |
SearchEngine | $engine | |
string | $name | |
string | $type |
Definition at line 1358 of file ContentHandler.php.
References $type, and SearchEngine\makeSearchFieldMapping().
|
protected |
If provided content overrides deprecated Content::getParserOutput, call it and return.
Content | $content | |
ContentParseParams | $cpoParams |
Definition at line 1872 of file ContentHandler.php.
References $content, MediaWiki\Content\Renderer\ContentParseParams\getGenerateHtml(), MediaWiki\Content\Renderer\ContentParseParams\getPage(), MediaWiki\Content\Renderer\ContentParseParams\getParserOptions(), and MediaWiki\Content\Renderer\ContentParseParams\getRevId().
|
protected |
If provided content overrides deprecated Content::preloadTransform, call it and return.
Content | $content | |
PreloadTransformParams | $params |
Definition at line 1850 of file ContentHandler.php.
|
protected |
Provided content overrides deprecated Content::preSaveTransform, call it and return.
Content | $content | |
PreSaveTransformParams | $params |
Definition at line 1826 of file ContentHandler.php.
Referenced by CssContentHandler\preSaveTransform(), JavaScriptContentHandler\preSaveTransform(), and TextContentHandler\preSaveTransform().
ContentHandler::canBeUsedOn | ( | Title | $title | ) |
Determines whether the content type handled by this ContentHandler can be used for the main slot of the given page.
This default implementation always returns true. Subclasses may override this to restrict the use of this content model to specific locations, typically based on the namespace or some other aspect of the title, such as a special suffix (e.g. ".svg" for SVG content).
Title | $title | The page's title. |
Definition at line 796 of file ContentHandler.php.
References $title, and getModelID().
|
protected |
Convenient for checking whether a format provided as a parameter is actually supported.
string | $format | The serialization format to check |
MWException | If the format is not supported by this content handler. |
Definition at line 545 of file ContentHandler.php.
References getModelID(), and isSupportedFormat().
Referenced by TextContentHandler\serializeContent(), and TextContentHandler\unserializeContent().
|
protected |
string | $model_id | The model to check |
MWException | If the model ID is not the ID of the content model supported by this ContentHandler. |
Definition at line 478 of file ContentHandler.php.
Referenced by TextContentHandler\merge3().
ContentHandler::createDifferenceEngine | ( | IContextSource | $context, |
$old = 0, | |||
$new = 0, | |||
$rcid = 0, | |||
$refreshCache = false, | |||
$unhide = false ) |
Factory for creating an appropriate DifferenceEngine for this content model.
Since 1.32, this is only used for page-level diffs; to diff two content objects, use getSlotDiffRenderer.
The DifferenceEngine subclass to use is selected in getDiffEngineClass(). The GetDifferenceEngine hook will receive the DifferenceEngine object and can replace or wrap it. (Note that in older versions of MediaWiki the hook documentation instructed extensions to return false from the hook; you should not rely on always being able to decorate the DifferenceEngine instance from the hook. If the owner of the content type wants to decorate the instance, overriding this method is a safer approach.)
IContextSource | $context | Context to use, anything else will be ignored. |
int | $old | Revision ID we want to show and diff with. |
int | string | $new | Either a revision ID or one of the strings 'cur', 'prev' or 'next'. |
int | $rcid | FIXME: Deprecated, no longer used. Defaults to 0. |
bool | $refreshCache | If set, refreshes the diff cache. Defaults to false. |
bool | $unhide | If set, allow viewing deleted revs. Defaults to false. |
Definition at line 601 of file ContentHandler.php.
References getDiffEngineClass().
Referenced by getSlotDiffRenderer().
ContentHandler::exportTransform | ( | $blob, | |
$format = null ) |
Applies transformations on export (returns the blob unchanged per default).
Subclasses may override this to perform transformations such as conversion of legacy formats or filtering of internal meta-data.
string | $blob | The blob to be exported |
string | null | $format | The blob's serialization format |
Definition at line 391 of file ContentHandler.php.
References $blob.
|
protected |
Fills the provided ParserOutput with information derived from the content.
Unless $cpoParams->getGenerateHtml() was false, this includes an HTML representation of the content.
If $cpoParams->getGenerateHtml() is false, and you chose not to generate html, the ParserOutput must have a text of null. If the text of the ParserOutput object is anything other than null (even if ''), it is assumed that you don't support not generating html, and that it is safe to reuse the parser output for calls expecting that html was generated.
Subclasses are expected to override this method.
This placeholder implementation always throws an exception.
Content | $content | |
ContentParseParams | $cpoParams | |
ParserOutput | &$output | The output object to fill (reference). |
MWException |
Reimplemented in CssContentHandler, FallbackContentHandler, JavaScriptContentHandler, TextContentHandler, JsonContentHandler, and WikitextContentHandler.
Definition at line 1786 of file ContentHandler.php.
ContentHandler::fillParserOutputInternal | ( | Content | $content, |
ContentParseParams | $cpoParams, | ||
ParserOutput & | $output ) |
A temporary layer to move AbstractContent::fillParserOutput to ContentHandler::fillParserOutput.
Content | $content | |
ContentParseParams | $cpoParams | |
ParserOutput | &$output | The output object to fill (reference). |
Definition at line 1754 of file ContentHandler.php.
References $content.
ContentHandler::generateHTMLOnEdit | ( | ) |
Whether an edit on the content should trigger an HTML render and ParserCache entry.
Definition at line 1290 of file ContentHandler.php.
ContentHandler::getActionOverrides | ( | ) |
Returns overrides for action handlers.
Classes listed here will be used instead of the default one when (and only when) $wgActions[$action] === true. This allows subclasses to override the default action handlers.
Definition at line 570 of file ContentHandler.php.
|
static |
MWException | |
MWUnknownContentModelException |
Definition at line 333 of file ContentHandler.php.
ContentHandler::getAutoDeleteReason | ( | Title | $title, |
& | $hasHistory = false ) |
Auto-generates a deletion reason.
Title | $title | The page's title |
bool | &$hasHistory | Whether the page has a history |
Definition at line 1050 of file ContentHandler.php.
References $content, $dbr, $res, $revQuery, $revStore, $title, DB_REPLICA, wfDeprecated(), wfGetDB(), and wfMessage().
ContentHandler::getAutosummary | ( | Content | $oldContent = null, |
Content | $newContent = null, | ||
$flags = 0 ) |
Return an applicable auto-summary if one exists for the given edit.
Content | null | $oldContent | The previous text of the page. |
Content | null | $newContent | The submitted text of the page. |
int | $flags | Bit mask: a bit mask of flags submitted for the edit. |
Definition at line 925 of file ContentHandler.php.
References wfMessage().
Return an applicable tag if one exists for the given edit or return null.
Content | null | $oldContent | The previous text of the page. |
Content | null | $newContent | The submitted text of the page. |
int | $flags | Bit mask: a bit mask of flags submitted for the edit. |
Definition at line 1013 of file ContentHandler.php.
References ChangeTags\getSoftwareTags().
|
static |
MWException | |
MWUnknownContentModelException |
Definition at line 321 of file ContentHandler.php.
|
static |
Convenience function for getting flat text from a Content object.
This should only be used in the context of backwards compatibility with code that is not yet able to handle Content objects!
If $content is null, this method returns the empty string.
If $content is an instance of TextContent, this method returns the flat text as returned by $content->getText().
If $content is not a TextContent object, the behavior of this method depends on the global $wgContentHandlerTextFallback:
Content | null | $content |
MWException | If the content is not an instance of TextContent and wgContentHandlerTextFallback was set to 'fail'. |
Definition at line 100 of file ContentHandler.php.
References $content, and wfDebugLog().
ContentHandler::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.
The $output must be the result of a call to getParserOutputForIndexing()
on the same content handler. That method may return ParserOutput without HTML
; this base implementation does not rely on the HTML being present, so it is safe to call even by subclasses that override getParserOutputForIndexing()
to skip HTML generation. On the other hand, since the default implementation of getParserOutputForIndexing()
does generate HTML, subclasses are free to rely on the HTML here if they do not override getParserOutputForIndexing()
.
WikiPage | $page | Page to index |
ParserOutput | $output | |
SearchEngine | $engine | Search engine for which we are indexing |
Reimplemented in TextContentHandler, FileContentHandler, and WikitextContentHandler.
Definition at line 1386 of file ContentHandler.php.
References $content, and WikiPage\getContent().
ContentHandler::getDefaultFormat | ( | ) |
The format used for serialization/deserialization by default by this ContentHandler.
This default implementation will return the first element of the array of formats that was passed to the constructor.
Definition at line 512 of file ContentHandler.php.
Referenced by TextContentHandler\merge3().
|
static |
Returns the name of the default content model to be used for the page with the given title.
Note: There should rarely be need to call this method directly. To determine the actual content model for a given page, use Title::getContentModel().
Which model is to be used by default for the page is determined based on several factors:
If none of the above applies, the wikitext model is used.
Note: this is used by, and may thus not use, Title::getContentModel()
Title | $title |
Definition at line 204 of file ContentHandler.php.
References $title.
ContentHandler::getDeletionUpdates | ( | Title | $title, |
$role ) |
Returns a list of DeferrableUpdate objects for removing information about content in some secondary data store.
This is used when a page is deleted, and also when a slot is removed from a page.
Application logic should not call this method directly. Instead, it should call WikiPage::getSecondaryDataUpdates().
Title | $title | The title of the page to supply the updates for |
string | $role | The role (slot) in which the content is being used. Which updates are performed should generally not depend on the role the content has, but the DeferrableUpdates themselves may need to know the role, to track to which slot the data refers, and to avoid overwriting data of the same kind from another slot. |
Definition at line 1541 of file ContentHandler.php.
|
protected |
Returns the name of the diff engine to use.
Definition at line 812 of file ContentHandler.php.
Referenced by createDifferenceEngine().
ContentHandler::getFieldsForSearchIndex | ( | SearchEngine | $engine | ) |
Get fields definition for search index.
SearchEngine | $engine |
Reimplemented in FileContentHandler, TextContentHandler, and WikitextContentHandler.
Definition at line 1317 of file ContentHandler.php.
References SearchEngine\makeSearchFieldMapping().
|
static |
Returns the appropriate ContentHandler singleton for the given Content object.
Content | $content |
MWException | |
MWUnknownContentModelException |
Definition at line 246 of file ContentHandler.php.
References $content.
|
static |
Returns the ContentHandler singleton for the given model ID.
Use the CONTENT_MODEL_XXX constants to identify the desired content model.
ContentHandler singletons are taken from the global $wgContentHandlers array. Keys in that array are model names, the values are either ContentHandler singleton objects, or strings specifying the appropriate subclass of ContentHandler.
If a class name is encountered when looking up the singleton for a given model name, the class is instantiated and the class name is replaced by the resulting singleton in $wgContentHandlers.
If no ContentHandler is defined for the desired $modelId, the ContentHandler may be provided by the ContentHandlerForModelID hook. If no ContentHandler can be determined, an MWException is raised.
string | $modelId | The ID of the content model for which to get a handler. Use CONTENT_MODEL_XXX constants. |
MWException | For internal errors and problems in the configuration. |
MWUnknownContentModelException | If no handler is known for the model ID. |
Definition at line 281 of file ContentHandler.php.
|
static |
Returns the appropriate ContentHandler singleton for the given title.
Title | $title |
MWException | |
MWUnknownContentModelException |
Definition at line 224 of file ContentHandler.php.
References $title, and wfDeprecated().
|
static |
Returns the localized name for a given content model.
Model names are localized using system messages. Message keys have the form content-model-$name, where $name is getContentModelName( $id ).
string | $name | The content model ID, as given by a CONTENT_MODEL_XXX constant or returned by Content::getModel() or SlotRecord::getModel(). |
Language | null | $lang | The language to parse the message in (since 1.26) |
MWException | If the model ID isn't known. |
Definition at line 300 of file ContentHandler.php.
References $lang, and wfMessage().
ContentHandler::getModelID | ( | ) |
Returns the model id that identifies the content model this ContentHandler can handle.
Use with the CONTENT_MODEL_XXX constants.
Definition at line 466 of file ContentHandler.php.
Referenced by canBeUsedOn(), checkFormat(), getSlotDiffRenderer(), and FallbackContentHandler\unserializeContent().
Get the language in which the content of the given page is written.
This default implementation just returns the content language (except for pages in the MediaWiki namespace)
Note that the page's language is not cacheable, since it may in some cases depend on user settings.
Also note that the page language may or may not depend on the actual content of the page, that is, this method may load the content in order to determine the language.
Title | $title | The page to determine the language for. |
Content | null | $content | The page's content, if you have it handy, to avoid reloading it. |
Reimplemented in CodeContentHandler.
Definition at line 714 of file ContentHandler.php.
References $lang, $title, $wgLang, NS_MEDIAWIKI, StubObject\unstub(), wfDeprecated(), and wfGetLangObj().
Referenced by TextContentHandler\getDataForSearchIndex(), and getPageViewLanguage().
Get the language in which the content of this page is written when viewed by user.
Defaults to $this->getPageLanguage(), but if the user specified a preferred variant, the variant will be used.
This default implementation just returns $this->getPageLanguage( $title, $content ) unless the user specified a preferred variant.
Note that the pages view language is not cacheable, since it depends on user settings.
Also note that the page language may or may not depend on the actual content of the page, that is, this method may load the content in order to determine the language.
Title | $title | The page to determine the language for. |
Content | null | $content | The page's content, if you have it handy, to avoid reloading it. |
Reimplemented in CodeContentHandler.
Definition at line 760 of file ContentHandler.php.
References $content, $title, getPageLanguage(), and NS_MEDIAWIKI.
ContentHandler::getParserOutput | ( | Content | $content, |
ContentParseParams | $cpoParams ) |
Returns a ParserOutput object containing information derived from this content.
Most importantly, unless $cpoParams->getGenerateHtml was false, the return value contains an HTML representation of the content.
Subclasses that want to control the parser output may override fillParserOutput() instead.
Content | $content | |
ContentParseParams | $cpoParams |
Definition at line 1681 of file ContentHandler.php.
References $content, $title, MediaWiki\Content\Renderer\ContentParseParams\getGenerateHtml(), MediaWiki\Content\Renderer\ContentParseParams\getPage(), MediaWiki\Content\Renderer\ContentParseParams\getParserOptions(), and MediaWiki\Content\Renderer\ContentParseParams\getRevId().
ContentHandler::getParserOutputForIndexing | ( | WikiPage | $page, |
ParserCache | $cache = null ) |
Produce page output suitable for indexing.
Typically used with getDataForSearchIndex()
.
Specific content handlers may override it if they need different content handling.
The default implementation returns output with HTML
, but callers should not rely on this, and subclasses may override this method and skip HTML generation if it is not needed for indexing. (In that case, they should not attempt to store the output in the $cache.)
WikiPage | $page | |
ParserCache | null | $cache | deprecated since 1.38 and won't have any effect |
Definition at line 1432 of file ContentHandler.php.
References WikiPage\makeParserOptions().
ContentHandler::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.
Application logic should not call this method directly. Instead, it should call DerivedPageDataUpdater::getSecondaryDataUpdates().
Title | $title | The title of the page to supply the updates for |
Content | $content | The content to generate data updates for. |
string | $role | The role (slot) in which the content is being used. Which updates are performed should generally not depend on the role the content has, but the DeferrableUpdates themselves may need to know the role, to track to which slot the data refers, and to avoid overwriting data of the same kind from another slot. |
SlotRenderingProvider | $slotOutput | A provider that can be used to gain access to a ParserOutput of $content by calling $slotOutput->getSlotParserOutput( $role, false ). |
Definition at line 1502 of file ContentHandler.php.
|
final |
Get an appropriate SlotDiffRenderer for this content model.
IContextSource | $context | |
array | $options | of the slot diff renderer (optional) |
Definition at line 622 of file ContentHandler.php.
References createDifferenceEngine(), getModelID(), and getSlotDiffRendererWithOptions().
|
protected |
Return the SlotDiffRenderer appropriate for this content handler.
IContextSource | $context |
Reimplemented in FallbackContentHandler.
Definition at line 648 of file ContentHandler.php.
Referenced by getSlotDiffRendererWithOptions().
|
protected |
Return the SlotDiffRenderer appropriate for this content handler.
IContextSource | $context | |
array | $options |
Definition at line 661 of file ContentHandler.php.
References TextSlotDiffRenderer\ENGINE_EXTERNAL, TextSlotDiffRenderer\ENGINE_PHP, TextSlotDiffRenderer\ENGINE_WIKIDIFF2, TextSlotDiffRenderer\ENGINE_WIKIDIFF2_INLINE, and getSlotDiffRendererInternal().
Referenced by getSlotDiffRenderer().
ContentHandler::getSupportedFormats | ( | ) |
Returns a list of serialization formats supported by the serializeContent() and unserializeContent() methods of this ContentHandler.
Definition at line 496 of file ContentHandler.php.
ContentHandler::getUndoContent | ( | Content | $currentContent, |
Content | $undoContent, | ||
Content | $undoAfterContent, | ||
$undoIsLatest = false ) |
Get the Content object that needs to be saved in order to undo all changes between $undo and $undoafter.
Content | $currentContent | The current text |
Content | $undoContent | The content of the revision to undo |
Content | $undoAfterContent | Must be from an earlier revision than $undo |
bool | $undoIsLatest | Set true if $undo is from the current revision (since 1.32) |
Definition at line 1168 of file ContentHandler.php.
References Content\equals(), and Content\getModel().
ContentHandler::importTransform | ( | $blob, | |
$format = null ) |
Apply import transformation (per default, returns $blob unchanged).
This gives subclasses an opportunity to transform data blobs on import.
string | $blob | |
string | null | $format |
Definition at line 421 of file ContentHandler.php.
References $blob.
ContentHandler::isParserCacheSupported | ( | ) |
Returns true for content models that support caching using the ParserCache mechanism.
See WikiPage::shouldCheckParserCache().
Reimplemented in WikitextContentHandler.
Definition at line 1209 of file ContentHandler.php.
ContentHandler::isSupportedFormat | ( | $format | ) |
Returns true if $format is a serialization format supported by this ContentHandler, and false otherwise.
Note that if $format is null, this method always returns true, because null means "use the default format".
string | $format | The serialization format to check |
Definition at line 530 of file ContentHandler.php.
Referenced by checkFormat().
|
protected |
Get the latest revision of the given $page, fetching it from the primary if necessary.
WikiPage | $page |
Definition at line 1453 of file ContentHandler.php.
References WikiPage\getRevisionRecord(), WikiPage\getTitle(), and WikiPage\loadPageData().
|
static |
Convenience function for creating a Content object from a given textual representation.
$text will be deserialized into a Content object of the model specified by $modelId (or, if that is not given, $title->getContentModel()) using the given format.
string | $text | The textual representation, will be unserialized to create the Content object |
Title | null | $title | The title of the page this text belongs to. Required if $modelId is not provided. |
string | null | $modelId | The model to deserialize to. If not provided, $title->getContentModel() is used. |
string | null | $format | The format to use for deserialization. If not given, the model's default format is used. |
MWException | If model ID or format is not supported or if the text can not be unserialized using the format. |
MWContentSerializationException |
Definition at line 152 of file ContentHandler.php.
References $title.
|
abstract |
Creates an empty Content object of the type supported by this ContentHandler.
Reimplemented in FallbackContentHandler, JsonContentHandler, and TextContentHandler.
ContentHandler::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.
This default implementation always returns null. Subclasses supporting redirects must override this method.
Note that subclasses that override this method to return a Content object should also override supportsRedirects() to return true.
Title | $destination | The page to redirect to. |
string | $text | Text to include in the redirect, if possible. |
Reimplemented in CssContentHandler, JavaScriptContentHandler, and WikitextContentHandler.
Definition at line 454 of file ContentHandler.php.
Attempts to merge differences between three versions.
Returns a new Content object for a clean merge and false for failure or a conflict.
This default implementation always returns false.
Content | $oldContent | The page's previous content. |
Content | $myContent | One of the page's conflicting contents. |
Content | $yourContent | One of the page's conflicting contents. |
Reimplemented in TextContentHandler.
Definition at line 831 of file ContentHandler.php.
ContentHandler::preloadTransform | ( | Content | $content, |
PreloadTransformParams | $pltParams ) |
Returns a $content object with preload transformations applied (or the same object if no transformations apply).
Content | $content | |
PreloadTransformParams | $pltParams |
Reimplemented in WikitextContentHandler.
Definition at line 1592 of file ContentHandler.php.
References $content.
ContentHandler::preSaveTransform | ( | Content | $content, |
PreSaveTransformParams | $pstParams ) |
Returns a $content object with pre-save transformations applied (or the same object if no transformations apply).
Content | $content | |
PreSaveTransformParams | $pstParams |
Reimplemented in CssContentHandler, JavaScriptContentHandler, JsonContentHandler, TextContentHandler, and WikitextContentHandler.
Definition at line 1559 of file ContentHandler.php.
References $content.
|
abstract |
Serializes a Content object of the type supported by this ContentHandler.
Content | $content | The Content object to serialize |
string | null | $format | The desired serialization format |
Reimplemented in FallbackContentHandler, TextContentHandler, and WikitextContentHandler.
|
protected |
Check if we need to provide content overrides deprecated Content method.
Content | $content | |
PreSaveTransformParams | PreloadTransformParams | $params |
Definition at line 1803 of file ContentHandler.php.
Referenced by CssContentHandler\preSaveTransform(), JavaScriptContentHandler\preSaveTransform(), and TextContentHandler\preSaveTransform().
ContentHandler::supportsCategories | ( | ) |
Returns true if this content model supports categories.
The default implementation returns true.
Definition at line 1236 of file ContentHandler.php.
ContentHandler::supportsDirectApiEditing | ( | ) |
Whether or not this content model supports direct editing via ApiEditPage.
Definition at line 1301 of file ContentHandler.php.
ContentHandler::supportsDirectEditing | ( | ) |
Return true if this content model supports direct editing, such as via EditPage.
This should return true for TextContent and its derivatives, and return false for structured data content.
Reimplemented in FallbackContentHandler, and TextContentHandler.
Definition at line 1264 of file ContentHandler.php.
ContentHandler::supportsPreloadContent | ( | ) |
If a non-existing page can be created with the contents from another (arbitrary) page being preloaded in the editor, see {.
Reimplemented in JsonContentHandler, and WikitextContentHandler.
Definition at line 1278 of file ContentHandler.php.
ContentHandler::supportsRedirects | ( | ) |
Returns true if this content model supports redirects.
This default implementation returns false.
Content models that return true here should also implement ContentHandler::makeRedirectContent to return a Content object.
Reimplemented in CssContentHandler, JavaScriptContentHandler, and WikitextContentHandler.
Definition at line 1251 of file ContentHandler.php.
ContentHandler::supportsSections | ( | ) |
Returns true if this content model supports sections.
This default implementation returns false.
Content models that return true here should also implement Content::getSection, Content::replaceSection, etc. to handle sections.
Reimplemented in WikitextContentHandler.
Definition at line 1224 of file ContentHandler.php.
|
abstract |
Unserializes a Content object of the type supported by this ContentHandler.
string | $blob | Serialized form of the content |
string | null | $format | The format used for serialization |
MWContentSerializationException |
Reimplemented in FallbackContentHandler, and TextContentHandler.
ContentHandler::validateSave | ( | Content | $content, |
ValidationParams | $validationParams ) |
Validate content for saving it.
This may be used to check the content's consistency with global state. This function should NOT write any information to the database.
Note that this method will usually be called inside the same transaction bracket that will be used to save the new revision, so the revision passed in is probably unsaved (has no id) and might belong to unsaved page.
Content | $content | |
ValidationParams | $validationParams |
Reimplemented in JsonContentHandler.
Definition at line 1629 of file ContentHandler.php.
References $content, MediaWiki\Content\ValidationParams\getFlags(), MediaWiki\Content\ValidationParams\getPageIdentity(), and MediaWiki\Content\ValidationParams\getParentRevisionId().
|
protected |
Definition at line 342 of file ContentHandler.php.
|
protected |
Definition at line 347 of file ContentHandler.php.