50 parent::__construct(
"The content model '$modelId' is not registered on this wiki.\n" .
51 'See https://www.mediawiki.org/wiki/Content_handlers to find out which extensions ' .
52 'handle this content model.' );
121 global $wgContentHandlerTextFallback;
131 wfDebugLog(
'ContentHandler',
'Accessing ' .
$content->getModel() .
' content as text!' );
133 if ( $wgContentHandlerTextFallback ==
'fail' ) {
135 "Attempt to get text from Content with model " .
140 if ( $wgContentHandlerTextFallback ==
'serialize' ) {
171 $modelId = null, $format = null ) {
172 if ( is_null( $modelId ) ) {
173 if ( is_null(
$title ) ) {
174 throw new MWException(
"Must provide a Title object or a content model ID." );
177 $modelId =
$title->getContentModel();
182 return $handler->unserializeContent( $text, $format );
230 if ( !
Hooks::run(
'ContentHandlerDefaultModelFor', [ $title, &$model ] ) ) {
231 if ( !is_null( $model ) ) {
237 $isCodePage =
NS_MEDIAWIKI == $ns && preg_match(
'!\.(css|js|json)$!u', $title->
getText(), $m );
243 Hooks::run(
'TitleIsCssOrJsPage', [ $title, &$isCodePage ],
'1.25' );
246 $isCodeSubpage =
NS_USER == $ns
248 && preg_match(
"/\\/.*\\.(js|css|json)$/", $title->
getText(), $m );
249 if ( $isCodeSubpage ) {
255 $isWikitext = $isWikitext && !$isCodePage && !$isCodeSubpage;
258 Hooks::run(
'TitleIsWikitextPage', [ $title, &$isWikitext ],
'1.25' );
260 if ( !$isWikitext ) {
347 if ( empty( $wgContentHandlers[$modelId] ) ) {
357 throw new MWException(
"ContentHandlerForModelID must supply a ContentHandler instance" );
360 $classOrCallback = $wgContentHandlers[$modelId];
362 if ( is_callable( $classOrCallback ) ) {
363 $handler = call_user_func( $classOrCallback, $modelId );
365 $handler =
new $classOrCallback( $modelId );
369 throw new MWException(
"$classOrCallback from \$wgContentHandlers is not " .
370 "compatible with ContentHandler" );
374 wfDebugLog(
'ContentHandler',
'Created handler for ' . $modelId
398 $key =
"content-model-$name";
402 $msg->inLanguage(
$lang );
405 return $msg->exists() ? $msg->plain() :
$name;
411 return array_keys( $wgContentHandlers );
419 foreach ( $wgContentHandlers
as $model => $class ) {
421 $formats = array_merge( $formats,
$handler->getSupportedFormats() );
424 $formats = array_unique( $formats );
451 $this->mModelID = $modelId;
452 $this->mSupportedFormats = $formats;
454 $this->mModelName = preg_replace(
'/(Content)?Handler$/',
'', get_class( $this ) );
455 $this->mModelName = preg_replace(
'/[_\\\\]/',
'', $this->mModelName );
456 $this->mModelName = strtolower( $this->mModelName );
564 if ( $model_id !== $this->mModelID ) {
566 "expected {$this->mModelID} " .
567 "but got $model_id." );
596 return $this->mSupportedFormats[0];
617 return in_array( $format, $this->mSupportedFormats );
630 "Format $format is not supported for content model "
708 Hooks::run(
'PageContentLanguage', [ $title, &$pageLang, $wgLang ] );
739 $variant = $pageLang->getPreferredVariant();
740 if ( $pageLang->getCode() !== $variant ) {
823 $ot = !is_null( $oldContent ) ? $oldContent->getRedirectTarget() : null;
824 $rt = !is_null( $newContent ) ? $newContent->getRedirectTarget() : null;
826 if ( is_object( $rt ) ) {
827 if ( !is_object( $ot )
828 || !$rt->equals( $ot )
829 || $ot->getFragment() != $rt->getFragment()
831 $truncatedtext = $newContent->getTextForSummary(
833 - strlen(
wfMessage(
'autoredircomment' )->inContentLanguage()->
text() )
834 - strlen( $rt->getFullText() ) );
836 return wfMessage(
'autoredircomment', $rt->getFullText() )
837 ->rawParams( $truncatedtext )->inContentLanguage()->text();
846 $truncatedtext = $newContent->getTextForSummary(
847 200 - strlen(
wfMessage(
'autosumm-new' )->inContentLanguage()->
text() ) );
849 return wfMessage(
'autosumm-new' )->rawParams( $truncatedtext )
850 ->inContentLanguage()->text();
854 if ( !empty( $oldContent ) && $oldContent->getSize() > 0 && $newContent->getSize() == 0 ) {
855 return wfMessage(
'autosumm-blank' )->inContentLanguage()->text();
856 } elseif ( !empty( $oldContent )
857 && $oldContent->getSize() > 10 * $newContent->getSize()
858 && $newContent->getSize() < 500
862 $truncatedtext = $newContent->getTextForSummary(
863 200 - strlen(
wfMessage(
'autosumm-replace' )->inContentLanguage()->
text() ) );
865 return wfMessage(
'autosumm-replace' )->rawParams( $truncatedtext )
866 ->inContentLanguage()->text();
871 return wfMessage(
'autosumm-newblank' )->inContentLanguage()->text();
900 if ( is_null(
$rev ) ) {
912 $prev =
$rev->getPrevious();
925 $res =
$dbr->select(
'revision',
'rev_user_text',
934 if ( $res ===
false ) {
939 $hasHistory = ( $res->numRows() > 1 );
940 $row =
$dbr->fetchObject( $res );
943 $onlyAuthor = $row->rev_user_text;
945 foreach ( $res
as $row ) {
946 if ( $row->rev_user_text != $onlyAuthor ) {
959 $reason =
wfMessage(
'exbeforeblank',
'$1' )->inContentLanguage()->text();
966 )->inContentLanguage()->text();
968 $reason =
wfMessage(
'excontent',
'$1' )->inContentLanguage()->text();
972 if ( $reason ==
'-' ) {
978 $text =
$content ?
$content->getTextForSummary( 255 - ( strlen( $reason ) - 2 ) ) :
'';
981 $reason = str_replace(
'$1', $text, $reason );
1002 if ( empty( $cur_content ) ) {
1007 $undoafter_content = $undoafter->
getContent();
1009 if ( !$undo_content || !$undoafter_content ) {
1017 if ( $cur_content->equals( $undo_content ) ) {
1019 return $undoafter_content;
1022 $undone_content = $this->
merge3( $undo_content, $undoafter_content, $cur_content );
1024 return $undone_content;
1048 } elseif (
$context ===
'canonical' ) {
1051 throw new MWException(
"Bad context for parser options: $context" );
1054 $options->enableLimitReport( $wgEnableParserLimitReporting );
1140 if ( self::$enableDeprecationWarnings ) {
1166 if ( $warn === null ) {
1167 $warn = self::$enableDeprecationWarnings;
1181 MediaWiki\suppressWarnings();
1184 if ( is_array( $handler ) ) {
1185 if ( is_object( $handler[0] ) ) {
1186 $info = get_class( $handler[0] );
1188 $info = $handler[0];
1191 if ( isset( $handler[1] ) ) {
1192 $info .=
'::' . $handler[1];
1194 } elseif ( is_object( $handler ) ) {
1195 $info = get_class( $handler[0] );
1196 $info .=
'::on' . $event;
1201 $handlerInfo[] = $info;
1204 MediaWiki\restoreWarnings();
1206 wfWarn(
"Using obsolete hook $event via ContentHandler::runLegacyHooks()! Handlers: " .
1207 implode(
', ', $handlerInfo ), 2 );
1211 $contentObjects = [];
1214 foreach (
$args as $k => $v ) {
1215 if ( $v instanceof
Content ) {
1218 $contentObjects[$k] = $v;
1220 $v = $v->serialize();
1221 $contentTexts[$k] = $v;
1230 foreach ( $contentTexts
as $k => $orig ) {
1233 $modified =
$args[$k];
1236 if ( $modified !== $orig ) {
merge3(Content $oldContent, Content $myContent, Content $yourContent)
Attempts to merge differences between three versions.
getAutoDeleteReason(Title $title, &$hasHistory)
Auto-generates a deletion reason.
static newFromContext(IContextSource $context)
Get a ParserOptions object from a IContextSource object.
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
Interface for objects which can provide a MediaWiki context on request.
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
supportsSections()
Returns true if this content model supports sections.
const CONTENT_MODEL_WIKITEXT
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
getArticleID($flags=0)
Get the article ID for this Title from the link cache, adding it if necessary.
getText()
Get the text form (spaces not underscores) of the main part.
supportsRedirects()
Returns true if this content model supports redirects.
static getAllContentFormats()
static array $handlers
A Cache of ContentHandler instances by model id.
static getForModelID($modelId)
Returns the ContentHandler singleton for the given model ID.
null for the local 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 prev or next refreshes the diff cache $unhide
if(!isset($args[0])) $lang
static getContentModels()
static isRegistered($name)
Returns true if a hook has a function registered to it.
static newFromUserAndLang(User $user, Language $lang)
Get a ParserOptions object from a given user and language.
static getDefaultModelFor(Title $title)
Returns the name of the default content model to be used for the page with the given title...
unserializeContent($blob, $format=null)
Unserializes a Content object of the type supported by this ContentHandler.
getModelID()
Returns the model id that identifies the content model this ContentHandler can handle.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
static getHandlers($name)
Returns an array of all the event functions attached to a hook This combines functions registered via...
Represents a title within MediaWiki.
when a variable name is used in a it is silently declared as a new local masking the global
getPageLanguage(Title $title, Content $content=null)
Get the language in which the content of the given page is written.
static newFromUser($user)
Get a ParserOptions object from a given user.
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target...
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
static getNamespaceContentModel($index)
Get the default content model for a namespace This does not mean that all pages in that namespace hav...
static getLocalizedName($name, Language $lang=null)
Returns the localized name for a given content model.
getContentModel($flags=0)
Get the page's content model id, see the CONTENT_MODEL_XXX constants.
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
Content object implementation for representing flat text.
null for the local 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 prev or next $refreshCache
static deprecated($func, $version, $component=false)
Logs a deprecation warning, visible if $wgDevelopmentWarnings, but only if self::$enableDeprecationWa...
makeRedirectContent(Title $destination, $text= '')
Creates a new Content object that acts as a redirect to the given page, or null if redirects are not ...
wfWarn($msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
isSupportedFormat($format)
Returns true if $format is a serialization format supported by this ContentHandler, and false otherwise.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist 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
static runLegacyHooks($event, $args=[], $warn=null)
Call a legacy hook that uses text instead of Content objects.
getActionOverrides()
Returns overrides for action handlers.
static getForContent(Content $content)
Returns the appropriate ContentHandler singleton for the given Content object.
static getContentText(Content $content=null)
Convenience function for getting flat text from a Content object.
string $modelId
The name of the unknown content model.
getDiffEngineClass()
Returns the name of the diff engine to use.
Base interface for content objects.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing 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 unsetoffset-wrap String Wrap the message in html(usually something like"<
wfDeprecated($function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
makeEmptyContent()
Creates an empty Content object of the type supported by this ContentHandler.
namespace and then decline to actually register it file or subcat img or subcat $title
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
getNamespace()
Get the namespace index, i.e.
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
A content handler knows how do deal with a specific type of content on a wiki page.
static makeContent($text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
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
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
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
supportsDirectApiEditing()
Whether or not this content model supports direct editing via ApiEditPage.
CONTENT_MODEL_JAVASCRIPT
Uploads have to be specially set up to be secure.
canBeUsedOn(Title $title)
Determines whether the content type handled by this ContentHandler can be used on the given page...
static $enableDeprecationWarnings
Switch for enabling deprecation warnings.
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
Exception thrown when an unregistered content model is requested.
string[] $mSupportedFormats
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
exportTransform($blob, $format=null)
Applies transformations on export (returns the blob unchanged per default).
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist 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
$wgContentHandlers
Plugins for page content model handling.
getAutosummary(Content $oldContent=null, Content $newContent=null, $flags)
Return an applicable auto-summary if one exists for the given edit.
serializeContent(Content $content, $format=null)
Serializes a Content object of the type supported by this ContentHandler.
getContent($audience=self::FOR_PUBLIC, User $user=null)
Fetch revision content if it's available to the specified audience.
isParserCacheSupported()
Returns true for content models that support caching using the ParserCache mechanism.
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 local content language as $wgContLang
checkFormat($format)
Convenient for checking whether a format provided as a parameter is actually supported.
createDifferenceEngine(IContextSource $context, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)
Factory for creating an appropriate DifferenceEngine for this content model.
__construct($modelId, $formats)
Constructor, initializing the ContentHandler instance with its model ID and a list of supported forma...
getSupportedFormats()
Returns a list of serialization formats supported by the serializeContent() and unserializeContent() ...
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
getModel()
Returns the ID of the content model used by this Content object.
supportsDirectEditing()
Return true if this content model supports direct editing, such as via EditPage.
static factory($code)
Get a cached or new language object for a given language code.
supportsCategories()
Returns true if this content model supports categories.
null for the local 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 prev or next refreshes the diff cache allow viewing deleted revs & $differenceEngine
getPageViewLanguage(Title $title, Content $content=null)
Get the language in which the content of this page is written when viewed by user.
makeParserOptions($context)
Get parser options suitable for rendering and caching the article.
getDefaultFormat()
The format used for serialization/deserialization by default by this ContentHandler.
static singleton()
Get the signleton instance of this class.
Exception representing a failure to serialize or unserialize a content object.
wfGetLangObj($langcode=false)
Return a Language object from $langcode.
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...
importTransform($blob, $format=null)
Apply import transformation (per default, returns $blob unchanged).
Allows to change the fields on the form that will be generated $name