Go to the documentation of this file.
80 global $wgContentHandlerTextFallback;
90 wfDebugLog(
'ContentHandler',
'Accessing ' .
$content->getModel() .
' content as text!' );
92 if ( $wgContentHandlerTextFallback ==
'fail' ) {
94 "Attempt to get text from Content with model " .
99 if ( $wgContentHandlerTextFallback ==
'serialize' ) {
130 $modelId =
null, $format =
null ) {
131 if ( is_null( $modelId ) ) {
132 if ( is_null(
$title ) ) {
133 throw new MWException(
"Must provide a Title object or a content model ID." );
136 $modelId =
$title->getContentModel();
141 return $handler->unserializeContent( $text, $format );
182 $ns =
$title->getNamespace();
189 if ( !
Hooks::run(
'ContentHandlerDefaultModelFor', [
$title, &$model ] ) ) {
190 if ( !is_null( $model ) ) {
196 $isCodePage =
NS_MEDIAWIKI == $ns && preg_match(
'!\.(css|js|json)$!u',
$title->getText(), $m );
202 $isCodeSubpage =
NS_USER == $ns
204 && preg_match(
"/\\/.*\\.(js|css|json)$/",
$title->getText(), $m );
205 if ( $isCodeSubpage ) {
211 $isWikitext = $isWikitext && !$isCodePage && !$isCodeSubpage;
213 if ( !$isWikitext ) {
241 $modelId =
$title->getContentModel();
310 throw new MWException(
"ContentHandlerForModelID must supply a ContentHandler instance" );
315 if ( is_callable( $classOrCallback ) ) {
316 $handler = call_user_func( $classOrCallback, $modelId );
318 $handler =
new $classOrCallback( $modelId );
322 throw new MWException(
"$classOrCallback from \$wgContentHandlers is not " .
323 "compatible with ContentHandler" );
327 wfDebugLog(
'ContentHandler',
'Created handler for ' . $modelId
351 $key =
"content-model-$name";
355 $msg->inLanguage(
$lang );
358 return $msg->exists() ? $msg->plain() :
$name;
365 Hooks::run(
'GetContentModels', [ &$models ] );
376 $formats = array_merge( $formats,
$handler->getSupportedFormats() );
379 $formats = array_unique( $formats );
406 $this->mModelID = $modelId;
407 $this->mSupportedFormats = $formats;
515 if ( $model_id !== $this->mModelID ) {
517 "expected {$this->mModelID} " .
518 "but got $model_id." );
547 return $this->mSupportedFormats[0];
568 return in_array( $format, $this->mSupportedFormats );
581 "Format $format is not supported for content model "
695 $variant = $pageLang->getPreferredVariant();
696 if ( $pageLang->getCode() !== $variant ) {
779 $ot = !is_null( $oldContent ) ? $oldContent->getRedirectTarget() :
null;
780 $rt = !is_null( $newContent ) ? $newContent->getRedirectTarget() :
null;
782 if ( is_object( $rt ) ) {
783 if ( !is_object( $ot )
784 || !$rt->equals( $ot )
785 || $ot->getFragment() != $rt->getFragment()
787 $truncatedtext = $newContent->getTextForSummary(
789 - strlen(
wfMessage(
'autoredircomment' )->inContentLanguage()->
text() )
790 - strlen( $rt->getFullText() ) );
792 return wfMessage(
'autoredircomment', $rt->getFullText() )
793 ->rawParams( $truncatedtext )->inContentLanguage()->text();
802 $truncatedtext = $newContent->getTextForSummary(
803 200 - strlen(
wfMessage(
'autosumm-new' )->inContentLanguage()->
text() ) );
805 return wfMessage(
'autosumm-new' )->rawParams( $truncatedtext )
806 ->inContentLanguage()->text();
810 if ( !empty( $oldContent ) && $oldContent->getSize() > 0 && $newContent->getSize() == 0 ) {
811 return wfMessage(
'autosumm-blank' )->inContentLanguage()->text();
812 } elseif ( !empty( $oldContent )
813 && $oldContent->getSize() > 10 * $newContent->getSize()
814 && $newContent->getSize() < 500
818 $truncatedtext = $newContent->getTextForSummary(
819 200 - strlen(
wfMessage(
'autosumm-replace' )->inContentLanguage()->
text() ) );
821 return wfMessage(
'autosumm-replace' )->rawParams( $truncatedtext )
822 ->inContentLanguage()->text();
827 return wfMessage(
'autosumm-newblank' )->inContentLanguage()->text();
856 if ( is_null(
$rev ) ) {
868 $prev =
$rev->getPrevious();
881 $res =
$dbr->select(
'revision',
'rev_user_text',
890 if (
$res ===
false ) {
895 $hasHistory = (
$res->numRows() > 1 );
899 $onlyAuthor = $row->rev_user_text;
901 foreach (
$res as $row ) {
902 if ( $row->rev_user_text != $onlyAuthor ) {
915 $reason =
wfMessage(
'exbeforeblank',
'$1' )->inContentLanguage()->text();
922 )->inContentLanguage()->text();
924 $reason =
wfMessage(
'excontent',
'$1' )->inContentLanguage()->text();
928 if ( $reason ==
'-' ) {
934 $text =
$content ?
$content->getTextForSummary( 255 - ( strlen( $reason ) - 2 ) ) :
'';
937 $reason = str_replace(
'$1', $text, $reason );
958 if ( empty( $cur_content ) ) {
963 $undoafter_content = $undoafter->
getContent();
965 if ( !$undo_content || !$undoafter_content ) {
985 if ( $cur_content->equals( $undo_content ) ) {
987 return $undoafter_content;
990 $undone_content = $this->
merge3( $undo_content, $undoafter_content, $cur_content );
992 return $undone_content;
1016 } elseif (
$context ===
'canonical' ) {
1019 throw new MWException(
"Bad context for parser options: $context" );
1022 $options->enableLimitReport( $wgEnableParserLimitReporting );
1105 $fields[
'category'] =
$engine->makeSearchFieldMapping(
1111 $fields[
'external_link'] =
$engine->makeSearchFieldMapping(
1116 $fields[
'outgoing_link'] =
$engine->makeSearchFieldMapping(
1121 $fields[
'template'] =
$engine->makeSearchFieldMapping(
1127 $fields[
'content_model'] =
$engine->makeSearchFieldMapping(
1171 $fieldData[
'category'] = $searchDataExtractor->getCategories(
$output );
1172 $fieldData[
'external_link'] = $searchDataExtractor->getExternalLinks(
$output );
1173 $fieldData[
'outgoing_link'] = $searchDataExtractor->getOutgoingLinks(
$output );
1174 $fieldData[
'template'] = $searchDataExtractor->getTemplates(
$output );
1176 $text =
$content->getTextForSearchIndex();
1178 $fieldData[
'text'] = $text;
1179 $fieldData[
'source_text'] = $text;
1180 $fieldData[
'text_bytes'] =
$content->getSize();
1181 $fieldData[
'content_model'] =
$content->getModel();
1198 $parserOptions =
$page->makeParserOptions(
'canonical' );
1205 $page->getContent()->getParserOutput(
$page->getTitle(),
$revId, $parserOptions );
A content handler knows how do deal with a specific type of content on a wiki page.
static getForModelID( $modelId)
Returns the ContentHandler singleton for the given model ID.
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
getAutosummary(Content $oldContent=null, Content $newContent=null, $flags)
Return an applicable auto-summary if one exists for the given edit.
static getAllContentFormats()
supportsDirectEditing()
Return true if this content model supports direct editing, such as via EditPage.
if(!isset( $args[0])) $lang
makeParserOptions( $context)
Get parser options suitable for rendering and caching the article.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
getContent( $audience=self::FOR_PUBLIC, User $user=null)
Fetch revision content if it's available to the specified audience.
getActionOverrides()
Returns overrides for action handlers.
static getNamespaceContentModel( $index)
Get the default content model for a namespace This does not mean that all pages in that namespace hav...
getAutoDeleteReason(Title $title, &$hasHistory)
Auto-generates a deletion reason.
unserializeContent( $blob, $format=null)
Unserializes a Content object of the type supported by this ContentHandler.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
getPageViewLanguage(Title $title, Content $content=null)
Get the language in which the content of this page is written when viewed by user.
Class representing a MediaWiki article and history.
getArticleID( $flags=0)
Get the article ID for this Title from the link cache, adding it if necessary.
string[] $mSupportedFormats
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
Allows to change the fields on the form that will be generated $name
const FLAG_CASEFOLD
Generic field flags.
const CONTENT_MODEL_WIKITEXT
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
serializeContent(Content $content, $format=null)
Serializes a Content object of the type supported by this ContentHandler.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
supportsSections()
Returns true if this content model supports sections.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
isSupportedFormat( $format)
Returns true if $format is a serialization format supported by this ContentHandler,...
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify as strings Extensions should add to this list prev or next refreshes the diff cache allow viewing deleted revs & $differenceEngine
createDifferenceEngine(IContextSource $context, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
Factory for creating an appropriate DifferenceEngine for this content model.
canBeUsedOn(Title $title)
Determines whether the content type handled by this ContentHandler can be used on the given page.
importTransform( $blob, $format=null)
Apply import transformation (per default, returns $blob unchanged).
supportsRedirects()
Returns true if this content model supports redirects.
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target.
static getDefaultModelFor(Title $title)
Returns the name of the default content model to be used for the page with the given title.
namespace and then decline to actually register it file or subcat img or subcat $title
$wgContentHandlers
Plugins for page content model handling.
static getContentModels()
static newFromUserAndLang(User $user, Language $lang)
Get a ParserOptions object from a given user and language.
supportsDirectApiEditing()
Whether or not this content model supports direct editing via ApiEditPage.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
merge3(Content $oldContent, Content $myContent, Content $yourContent)
Attempts to merge differences between three versions.
makeEmptyContent()
Creates an empty Content object of the type supported by this ContentHandler.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
getDataForSearchIndex(WikiPage $page, ParserOutput $output, SearchEngine $engine)
Return fields to be indexed by search engine as representation of this document.
the value to return A Title object or null for latest all implement SearchIndexField $engine
when a variable name is used in a it is silently declared as a new masking the global
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
static singleton()
Get the signleton instance of this class.
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
getPageLanguage(Title $title, Content $content=null)
Get the language in which the content of the given page is written.
isParserCacheSupported()
Returns true for content models that support caching using the ParserCache mechanism.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
getDefaultFormat()
The format used for serialization/deserialization by default by this ContentHandler.
static getLocalizedName( $name, Language $lang=null)
Returns the localized name for a given content model.
static newFromContext(IContextSource $context)
Get a ParserOptions object from a IContextSource object.
getDiffEngineClass()
Returns the name of the diff engine to use.
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify as strings Extensions should add to this list prev or next $refreshCache
supportsCategories()
Returns true if this content model supports categories.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Content object implementation for representing flat text.
Contain a class for special pages.
Interface for objects which can provide a MediaWiki context on request.
exportTransform( $blob, $format=null)
Applies transformations on export (returns the blob unchanged per default).
Base interface for content objects.
getFieldsForSearchIndex(SearchEngine $engine)
Get fields definition for search index.
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify as strings Extensions should add to this list prev or next refreshes the diff cache $unhide
Represents a title within MediaWiki.
makeRedirectContent(Title $destination, $text='')
Creates a new Content object that acts as a redirect to the given page, or null if redirects are not ...
checkFormat( $format)
Convenient for checking whether a format provided as a parameter is actually supported.
static getContentText(Content $content=null)
Convenience function for getting flat text from a Content object.
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
static array $handlers
A Cache of ContentHandler instances by model id.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context $revId
Exception thrown when an unregistered content model is requested.
addSearchField(&$fields, SearchEngine $engine, $name, $type)
Add new field definition to array.
static factory( $code)
Get a cached or new language object for a given language code.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
const CONTENT_MODEL_JAVASCRIPT
__construct( $modelId, $formats)
Constructor, initializing the ContentHandler instance with its model ID and a list of supported forma...
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
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 $undoa...
getSupportedFormats()
Returns a list of serialization formats supported by the serializeContent() and unserializeContent() ...
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Internationalisation code.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
getModelID()
Returns the model id that identifies the content model this ContentHandler can handle.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context $parserOutput
static getForContent(Content $content)
Returns the appropriate ContentHandler singleton for the given Content object.
getParserOutputForIndexing(WikiPage $page, ParserCache $cache=null)
Produce page output suitable for indexing.
the array() calling protocol came about after MediaWiki 1.4rc1.
static newFromUser( $user)
Get a ParserOptions object from a given user.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
const INDEX_TYPE_TEXT
Field types.