23use Wikimedia\ScopedCallback;
54 'dateformat' => [ __CLASS__,
'initDateFormat' ],
63 'numberheadings' =>
true,
65 'stubthreshold' =>
true,
131 throw new InvalidArgumentException(
"Unknown parser option $name" );
134 if ( isset( self::$lazyOptions[
$name] ) && $this->
options[$name] ===
null ) {
135 $this->
options[$name] = call_user_func( self::$lazyOptions[
$name], $this,
$name );
137 if ( !empty( self::$inCacheKey[
$name] ) ) {
153 throw new InvalidArgumentException(
"Unknown parser option $name" );
170 throw new InvalidArgumentException(
"Unknown parser option $name" );
184 return $this->
getOption(
'interwikiMagic' );
201 return $this->
getOption(
'allowExternalImages' );
221 return $this->
getOption(
'allowExternalImagesFrom' );
241 return $this->
getOption(
'enableImageWhitelist' );
258 return $this->
getOption(
'numberheadings' );
275 return $this->
getOption(
'allowSpecialInclusion' );
309 return $this->
getOption(
'interfaceMessage' );
326 return $this->
getOption(
'targetLanguage' );
335 return $this->
setOption(
'targetLanguage', $x );
343 return $this->
getOption(
'maxIncludeSize' );
360 return $this->
getOption(
'maxPPNodeCount' );
377 return $this->
getOption(
'maxGeneratedPPNodeCount' );
394 return $this->
getOption(
'maxPPExpandDepth' );
402 return $this->
getOption(
'maxTemplateDepth' );
420 return $this->
getOption(
'expensiveParserFunctionLimit' );
439 return $this->
getOption(
'removeComments' );
457 return $this->
getOption(
'enableLimitReport' );
475 return $this->
getOption(
'cleanSignatures' );
493 return $this->
getOption(
'externalLinkTarget' );
510 return $this->
getOption(
'disableContentConversion' );
527 return $this->
getOption(
'disableTitleConversion' );
561 return $this->
getOption(
'stubthreshold' );
595 return $this->
getOption(
'isSectionPreview' );
629 return $this->
getOption(
'preSaveTransform' );
653 return $popt->mUser->getDatePreference();
708 if ( is_string( $x ) ) {
709 $x = Language::factory( $x );
721 return $this->
getOption(
'magicISBNLinks' );
730 return $this->
getOption(
'magicPMIDLinks' );
738 return $this->
getOption(
'magicRFCLinks' );
756 return $this->
getOption(
'allowUnsafeRawHtml' );
787 if ( $className ===
true ) {
788 $className =
'mw-parser-output';
790 return $this->
setOption(
'wrapclass', $className );
799 return $this->
getOption(
'currentRevisionCallback' );
817 return $this->
getOption(
'templateCallback' );
835 return $this->
getOption(
'speculativeRevIdCallback' );
855 if ( !isset( $this->mTimestamp ) ) {
858 return $this->mTimestamp;
867 return wfSetVar( $this->mTimestamp, $x );
875 return $this->mEditSection;
884 return wfSetVar( $this->mEditSection, $x );
898 $this->redirectTarget =
$title;
908 return $this->redirectTarget;
918 $this->mExtraKey .=
'!' . $key;
937 if (
$user ===
null ) {
945 if (
$lang ===
null ) {
1022 foreach ( self::getCanonicalOverrides()
as $k => $v ) {
1023 $ret->setOption( $k, $v );
1045 if ( self::$defaults ===
null ) {
1048 'dateformat' =>
null,
1050 'interfaceMessage' =>
false,
1051 'targetLanguage' =>
null,
1052 'removeComments' =>
true,
1053 'enableLimitReport' =>
false,
1054 'preSaveTransform' =>
true,
1055 'isPreview' =>
false,
1056 'isSectionPreview' =>
false,
1057 'printable' =>
false,
1058 'allowUnsafeRawHtml' =>
true,
1059 'wrapclass' =>
'mw-parser-output',
1060 'currentRevisionCallback' => [
'Parser',
'statelessFetchRevision' ],
1061 'templateCallback' => [
'Parser',
'statelessFetchTemplate' ],
1062 'speculativeRevIdCallback' =>
null,
1066 Hooks::run(
'ParserOptionsRegister', [
1069 &self::$lazyOptions,
1073 ksort( self::$inCacheKey );
1077 return self::$defaults + [
1096 'numberheadings' => User::getDefaultOption(
'numberheadings' ),
1097 'thumbsize' => User::getDefaultOption(
'thumbsize' ),
1098 'stubthreshold' => 0,
1128 $this->
options = self::getDefaults();
1130 $this->mUser =
$user;
1131 $this->
options[
'numberheadings'] =
$user->getOption(
'numberheadings' );
1132 $this->
options[
'thumbsize'] =
$user->getOption(
'thumbsize' );
1133 $this->
options[
'stubthreshold'] =
$user->getStubThreshold();
1148 foreach ( self::$lazyOptions
as $name => $callback ) {
1152 if ( $other->options[
$name] ===
null ) {
1153 $other->options[
$name] = call_user_func( $callback, $other,
$name );
1160 'enableLimitReport',
1165 if ( $o1 !== $o2 ) {
1171 $fields = array_keys( get_class_vars( __CLASS__ ) );
1172 $fields = array_diff( $fields, [
1179 foreach ( $fields
as $field ) {
1180 if ( !is_object( $this->$field ) && $this->$field !== $other->$field ) {
1194 $this->onAccessCallback = $callback;
1206 if ( $this->onAccessCallback ) {
1207 call_user_func( $this->onAccessCallback, $optionName );
1238 if ( self::$defaults ===
null ) {
1239 self::getDefaults();
1241 return array_keys( array_filter( self::$inCacheKey ) );
1252 } elseif (
$value ===
false ) {
1254 } elseif (
$value ===
null ) {
1257 return $value->getCode();
1258 } elseif ( is_array(
$value ) ) {
1259 return '[' . join(
',', array_map( [ $this,
'optionToString' ],
$value ) ) .
']';
1281 $defaults = self::getCanonicalOverrides() + self::getDefaults();
1289 if ( in_array(
'editsection', $forOptions,
true ) ) {
1290 $options[
'editsection'] = $this->mEditSection;
1303 if ( $include && in_array( $option, $forOptions,
true ) ) {
1307 $values[] =
"$option=$v";
1312 $confstr = $values ? join(
'!', $values ) :
'canonical';
1316 if ( !is_null(
$title ) ) {
1317 $confstr .=
$title->getPageLanguage()->getExtraHashOptions();
1325 if ( $this->mExtraKey !=
'' ) {
1326 $confstr .= $this->mExtraKey;
1331 Hooks::run(
'PageRenderingHash', [ &$confstr, $this->
getUser(), &$forOptions ] );
1334 $confstr = str_replace(
' ',
'_', $confstr );
1345 $defaults = self::getCanonicalOverrides() + self::getDefaults();
1347 if ( empty( self::$inCacheKey[$option] ) ) {
1373 if ( $titleToCheck->equals(
$title ) ) {
1374 return new Revision( [
1375 'page' => $title->getArticleID(),
1376 'user_text' => $user->getName(),
1377 'user' => $user->getId(),
1378 'parent_id' => $title->getLatestRevID(),
1380 'content' => $content
1383 return call_user_func( $oldCallback, $titleToCheck, $parser );
1390 function ( $titleToCheck, &$exists )
use (
$title ) {
1391 if ( $titleToCheck->equals(
$title ) ) {
1397 LinkCache::singleton()->clearBadLink(
$title->getPrefixedDBkey() );
1398 return new ScopedCallback(
function ()
use (
$title, $key ) {
1400 unset(
$wgHooks[
'TitleExists'][$key] );
1401 LinkCache::singleton()->clearLink(
$title );
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgMaxTemplateDepth
Maximum recursion depth for templates within templates.
$wgMaxPPNodeCount
A complexity limit on template expansion: the maximum number of nodes visited by PPFrame::expand()
$wgMaxArticleSize
Maximum article size in kilobytes.
$wgMaxGeneratedPPNodeCount
A complexity limit on template expansion: the maximum number of elements generated by Preprocessor::p...
$wgEnableParserLimitReporting
Whether to include the NewPP limit report as a HTML comment.
$wgEnableImageWhitelist
If $wgAllowExternalImages is false, you can allow an on-wiki whitelist of regular expression fragment...
$wgCleanSignatures
If true, removes (by substituting) templates in signatures.
$wgRenderHashAppend
Append a configured value to the parser cache and the sitenotice key so that they can be kept separat...
$wgDisableLangConversion
Whether to enable language variant conversion.
$wgAllowSpecialInclusion
Allow special page inclusions such as {{Special:Allpages}}.
$wgAllowExternalImagesFrom
If the above is false, you can specify an exception here.
$wgInterwikiMagic
Treat language links as magic connectors, not inline links.
$wgAllowExternalImages
Whether to allow inline image pointing to other websites.
$wgEnableMagicLinks
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links.
$wgExternalLinkTarget
Set a default target for external links, e.g.
$wgExpensiveParserFunctionLimit
Maximum number of calls per parse to expensive parser functions such as PAGESINCATEGORY.
$wgDisableTitleConversion
Whether to enable language variant conversion for links.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfSetVar(&$dest, $source, $force=false)
Sets dest to source and returns the original value of dest If source is NULL, it just returns the val...
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Internationalisation code.
Set options of the Parser.
setAllowExternalImagesFrom( $x)
External images to allow.
disableTitleConversion( $x=true)
Whether title conversion should be disabled.
setIsSectionPreview( $x)
Parsing the page for a "preview" operation on a single section?
setIsPrintable( $x)
Parsing the printable version of the page?
getRedirectTarget()
Get the previously-set redirect target.
setAllowUnsafeRawHtml( $x)
If the wiki is configured to allow raw html ($wgRawHtml = true) is it allowed in the specific case of...
static newCanonical(User $user=null, $lang=null)
Creates a "canonical" ParserOptions object.
getTidy()
Use tidy to cleanup output HTML?
setIsPreview( $x)
Parsing the page for a "preview" operation?
setDateFormat( $x)
Date format index.
static initDateFormat( $popt)
Lazy initializer for dateFormat.
getSpeculativeRevIdCallback()
Callback to generate a guess for {{REVISIONID}}.
enableLimitReport( $x=true)
Enable limit report in an HTML comment on output.
setTidy( $x)
Use tidy to cleanup output HTML?
optionToString( $value)
Convert an option to a string value.
callable null $onAccessCallback
Function to be called when an option is accessed.
getAllowExternalImages()
Allow all external images inline?
setNumberHeadings( $x)
Automatically number headings?
matches(ParserOptions $other)
Check if these options match that of another options set.
getMaxIncludeSize()
Maximum size of template expansions, in bytes.
setStubThreshold( $x)
Thumb size preferred by the user.
setTemplateCallback( $x)
Callback for template fetching; first argument to call_user_func().
setAllowExternalImages( $x)
Allow all external images inline?
getUserLangObj()
Get the user language used by the parser for this page and split the parser cache.
setMaxIncludeSize( $x)
Maximum size of template expansions, in bytes.
getEditSection()
Create "edit section" links?
static getCanonicalOverrides()
Get "canonical" non-default option values.
getEnableImageWhitelist()
Use the on-wiki external image whitelist?
getTargetLanguage()
Target language for the parse.
getAllowExternalImagesFrom()
External images to allow.
getCurrentRevisionCallback()
Callback for current revision fetching; first argument to call_user_func().
getIsSectionPreview()
Parsing the page for a "preview" operation on a single section?
getDisableContentConversion()
Whether content conversion should be disabled.
setInterfaceMessage( $x)
Parsing an interface message?
setTimestamp( $x)
Timestamp used for {{CURRENTDAY}} etc.
getMaxPPExpandDepth()
Maximum recursion depth in PPFrame::expand()
getExpensiveParserFunctionLimit()
Maximum number of calls per parse to expensive parser functions.
getAllowUnsafeRawHtml()
If the wiki is configured to allow raw html ($wgRawHtml = true) is it allowed in the specific case of...
getNumberHeadings()
Automatically number headings?
setCurrentRevisionCallback( $x)
Callback for current revision fetching; first argument to call_user_func().
getIsPreview()
Parsing the page for a "preview" operation?
static getDefaults()
Get default option values.
setOptionLegacy( $name, $value)
Legacy implementation.
setMaxTemplateDepth( $x)
Maximum recursion depth for templates within templates.
setEnableImageWhitelist( $x)
Use the on-wiki external image whitelist?
getPreSaveTransform()
Transform wiki markup when saving the page?
setWrapOutputClass( $className)
CSS class to use to wrap output from Parser::parse()
User $mUser
Stored user object.
optionUsed( $optionName)
Called when an option is accessed.
setRedirectTarget( $title)
Set the redirect target.
getWrapOutputClass()
Class to use to wrap output from Parser::parse()
getIsPrintable()
Parsing the printable version of the page?
getStubThreshold()
Thumb size preferred by the user.
disableContentConversion( $x=true)
Whether content conversion should be disabled.
initialiseFromUser( $user, $lang)
Get user options.
getOption( $name)
Fetch an option, generically.
setThumbSize( $x)
Thumb size preferred by the user.
optionsHash( $forOptions, $title=null)
Generate a hash string with the values set on these ParserOptions for the keys given in the array.
$mExtraKey
Appended to the options hash.
setAllowSpecialInclusion( $x)
Allow inclusion of special pages?
setOption( $name, $value)
Set an option, generically.
getMaxTemplateDepth()
Maximum recursion depth for templates within templates.
getAllowSpecialInclusion()
Allow inclusion of special pages?
setTargetLanguage( $x)
Target language for the parse.
string null $mTimestamp
Timestamp used for {{CURRENTDAY}} etc.
getMagicRFCLinks()
Are magic RFC links enabled?
setupFakeRevision( $title, $content, $user)
Sets a hook to force that a page exists, and sets a current revision callback to return a revision wi...
getMagicPMIDLinks()
Are magic PMID links enabled?
static legacyOptions()
Returns the full array of options that would have been used by in 1.16.
static array $inCacheKey
Specify options that are included in the cache key.
static newFromContext(IContextSource $context)
Get a ParserOptions object from a IContextSource object.
static callback[] $lazyOptions
Lazy-loaded options.
registerWatcher( $callback)
Registers a callback for tracking which ParserOptions which are used.
getCleanSignatures()
Clean up signature texts?
addExtraKey( $key)
Extra key that should be present in the parser cache key.
setInterwikiMagic( $x)
Specify whether to extract interlanguage links.
static newFromAnon()
Get a ParserOptions object for an anonymous user.
setUserLang( $x)
Set the user language used by the parser for this page and split the parser cache.
static newFromUser( $user)
Get a ParserOptions object from a given user.
getUserLang()
Same as getUserLangObj() but returns a string instead.
getDateFormat()
Date format index.
setExternalLinkTarget( $x)
Target attribute for external links.
getMaxGeneratedPPNodeCount()
Maximum number of nodes generated by Preprocessor::preprocessToObj()
array $options
Current values for all options that are relevant for caching.
getRemoveComments()
Remove HTML comments.
setRemoveComments( $x)
Remove HTML comments.
Title null $redirectTarget
If the page being parsed is a redirect, this should hold the redirect target.
setMaxGeneratedPPNodeCount( $x)
Maximum number of nodes generated by Preprocessor::preprocessToObj()
getMaxPPNodeCount()
Maximum number of nodes touched by PPFrame::expand()
static newFromUserAndLang(User $user, Language $lang)
Get a ParserOptions object from a given user and language.
getEnableLimitReport()
Enable limit report in an HTML comment on output.
getExternalLinkTarget()
Target attribute for external links.
getMagicISBNLinks()
Are magic ISBN links enabled?
getThumbSize()
Thumb size preferred by the user.
getInterwikiMagic()
Whether to extract interlanguage links.
__construct( $user=null, $lang=null)
setEditSection( $x)
Create "edit section" links?
getTimestamp()
Timestamp used for {{CURRENTDAY}} etc.
getTemplateCallback()
Callback for template fetching; first argument to call_user_func().
setSpeculativeRevIdCallback( $x)
Callback to generate a guess for {{REVISIONID}}.
isSafeToCache()
Test whether these options are safe to cache.
getDisableTitleConversion()
Whether title conversion should be disabled.
getInterfaceMessage()
Parsing an interface message?
bool $mEditSection
The edit section flag is in ParserOptions for historical reasons, but doesn't actually affect the par...
static allCacheVaryingOptions()
Return all option keys that vary the options hash.
setExpensiveParserFunctionLimit( $x)
Maximum number of calls per parse to expensive parser functions.
setPreSaveTransform( $x)
Transform wiki markup when saving the page?
setMaxPPNodeCount( $x)
Maximum number of nodes touched by PPFrame::expand()
static array null $defaults
Default values for all options that are relevant for caching.
setCleanSignatures( $x)
Clean up signature texts?
static isRealObject( $obj)
Returns a bool value whenever $obj is a stub object.
Represents a title within MediaWiki.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
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
when a variable name is used in a it is silently declared as a new local masking the global
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 in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database key
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 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
the array() calling protocol came about after MediaWiki 1.4rc1.
do that in ParserLimitReportFormat instead $parser
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options(say) and put it in one place. Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle
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 & $options
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
namespace and then decline to actually register it file or subcat img or subcat $title
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 & $ret
$wgHooks['ArticleShow'][]
Allows to change the fields on the form that will be generated $name
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
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
Interface for objects which can provide a MediaWiki context on request.
if(!isset( $args[0])) $lang