Go to the documentation of this file.
23 use Wikimedia\ScopedCallback;
124 [
'Parser',
'statelessFetchRevision' ];
130 [
'Parser',
'statelessFetchTemplate' ];
402 if ( !isset( $this->mDateFormat ) ) {
403 $this->mDateFormat = $this->mUser->getDatePreference();
409 if ( !isset( $this->mTimestamp ) ) {
485 return wfSetVar( $this->mInterwikiMagic, $x );
489 return wfSetVar( $this->mAllowExternalImages, $x );
493 return wfSetVar( $this->mAllowExternalImagesFrom, $x );
497 return wfSetVar( $this->mEnableImageWhitelist, $x );
501 return wfSetVar( $this->mDateFormat, $x );
505 return wfSetVar( $this->mEditSection, $x );
509 return wfSetVar( $this->mNumberHeadings, $x );
513 return wfSetVar( $this->mAllowSpecialInclusion, $x );
517 return wfSetVar( $this->mTidy, $x );
521 return wfSetVar( $this->mInterfaceMessage, $x );
525 return wfSetVar( $this->mTargetLanguage, $x,
true );
529 return wfSetVar( $this->mMaxIncludeSize, $x );
533 return wfSetVar( $this->mMaxPPNodeCount, $x );
537 return wfSetVar( $this->mMaxGeneratedPPNodeCount, $x );
541 return wfSetVar( $this->mMaxTemplateDepth, $x );
546 return wfSetVar( $this->mExpensiveParserFunctionLimit, $x );
550 return wfSetVar( $this->mRemoveComments, $x );
555 return wfSetVar( $this->mCurrentRevisionCallback, $x );
560 return wfSetVar( $this->mSpeculativeRevIdCallback, $x );
564 return wfSetVar( $this->mTemplateCallback, $x );
568 return wfSetVar( $this->mEnableLimitReport, $x );
572 return wfSetVar( $this->mTimestamp, $x );
576 return wfSetVar( $this->mCleanSignatures, $x );
580 return wfSetVar( $this->mExternalLinkTarget, $x );
584 return wfSetVar( $this->mDisableContentConversion, $x );
588 return wfSetVar( $this->mDisableTitleConversion, $x );
592 if ( is_string( $x ) ) {
596 return wfSetVar( $this->mUserLang, $x );
600 return wfSetVar( $this->mThumbSize, $x );
604 return wfSetVar( $this->mStubThreshold, $x );
608 return wfSetVar( $this->mPreSaveTransform, $x );
612 return wfSetVar( $this->mIsPreview, $x );
616 return wfSetVar( $this->mIsSectionPreview, $x );
620 return wfSetVar( $this->mIsPrintable, $x );
629 return wfSetVar( $this->allowUnsafeRawHtml, $x );
643 $this->redirectTarget =
$title;
661 $this->mExtraKey .=
'!' . $key;
670 if (
$user ===
null ) {
678 if (
$lang ===
null ) {
738 $wgAllowExternalImagesFrom, $wgEnableImageWhitelist, $wgAllowSpecialInclusion,
740 $wgCleanSignatures, $wgExternalLinkTarget, $wgExpensiveParserFunctionLimit,
741 $wgMaxGeneratedPPNodeCount, $wgDisableLangConversion, $wgDisableTitleConversion,
746 $this->mAllowExternalImages = $wgAllowExternalImages;
747 $this->mAllowExternalImagesFrom = $wgAllowExternalImagesFrom;
748 $this->mEnableImageWhitelist = $wgEnableImageWhitelist;
749 $this->mAllowSpecialInclusion = $wgAllowSpecialInclusion;
751 $this->mMaxPPNodeCount = $wgMaxPPNodeCount;
752 $this->mMaxGeneratedPPNodeCount = $wgMaxGeneratedPPNodeCount;
753 $this->mMaxPPExpandDepth = $wgMaxPPExpandDepth;
754 $this->mMaxTemplateDepth = $wgMaxTemplateDepth;
755 $this->mExpensiveParserFunctionLimit = $wgExpensiveParserFunctionLimit;
756 $this->mCleanSignatures = $wgCleanSignatures;
757 $this->mExternalLinkTarget = $wgExternalLinkTarget;
758 $this->mDisableContentConversion = $wgDisableLangConversion;
759 $this->mDisableTitleConversion = $wgDisableLangConversion || $wgDisableTitleConversion;
760 $this->mMagicISBNLinks = $wgEnableMagicLinks[
'ISBN'];
761 $this->mMagicPMIDLinks = $wgEnableMagicLinks[
'PMID'];
762 $this->mMagicRFCLinks = $wgEnableMagicLinks[
'RFC'];
764 $this->mUser =
$user;
765 $this->mNumberHeadings =
$user->getOption(
'numberheadings' );
766 $this->mThumbSize =
$user->getOption(
'thumbsize' );
767 $this->mStubThreshold =
$user->getStubThreshold();
768 $this->mUserLang =
$lang;
781 $fields = array_keys( get_class_vars( __CLASS__ ) );
782 $fields = array_diff( $fields, [
783 'mEnableLimitReport',
786 foreach ( $fields
as $field ) {
787 if ( !is_object( $this->$field ) && $this->$field !== $other->$field ) {
793 $this->mUserLang->equals( $other->mUserLang ) &&
804 $this->onAccessCallback = $callback;
816 if ( $this->onAccessCallback ) {
817 call_user_func( $this->onAccessCallback, $optionName );
865 if ( in_array(
'stubthreshold', $forOptions ) ) {
871 if ( in_array(
'dateformat', $forOptions ) ) {
875 if ( in_array(
'numberheadings', $forOptions ) ) {
876 $confstr .=
'!' . ( $this->mNumberHeadings ?
'1' :
'' );
881 if ( in_array(
'userlang', $forOptions ) ) {
882 $confstr .=
'!' . $this->mUserLang->getCode();
887 if ( in_array(
'thumbsize', $forOptions ) ) {
895 if ( !is_null(
$title ) ) {
896 $confstr .=
$title->getPageLanguage()->getExtraHashOptions();
908 if ( !in_array(
'editsection', $forOptions ) ) {
910 } elseif ( !$this->mEditSection ) {
911 $confstr .=
'!edit=0';
914 if ( $this->mIsPrintable && in_array(
'printable', $forOptions ) ) {
915 $confstr .=
'!printable=1';
918 if ( $this->mExtraKey !=
'' ) {
924 Hooks::run(
'PageRenderingHash', [ &$confstr, $this->
getUser(), &$forOptions ] );
927 $confstr = str_replace(
' ',
'_', $confstr );
947 if ( $titleToCheck->equals(
$title ) ) {
949 'page' =>
$title->getArticleID(),
950 'user_text' =>
$user->getName(),
951 'user' =>
$user->getId(),
952 'parent_id' =>
$title->getLatestRevID(),
957 return call_user_func( $oldCallback, $titleToCheck,
$parser );
964 function ( $titleToCheck, &$exists )
use (
$title ) {
965 if ( $titleToCheck->equals(
$title ) ) {
972 return new ScopedCallback(
function ()
use (
$title, $key ) {
974 unset(
$wgHooks[
'TitleExists'][$key] );
$onAccessCallback
Function to be called when an option is accessed.
Set options of the Parser.
getAllowExternalImagesFrom()
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
getExpensiveParserFunctionLimit()
$mMaxTemplateDepth
Maximum recursion depth for templates within templates.
$wgMaxArticleSize
Maximum article size in kilobytes.
callable $mCurrentRevisionCallback
Callback for current revision fetching; first argument to call_user_func().
setAllowUnsafeRawHtml( $x)
disableContentConversion( $x=true)
if(!isset( $args[0])) $lang
$mStubThreshold
Maximum article size of an article to be marked as "stub".
initialiseFromUser( $user, $lang)
Get user options.
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...
$mTargetLanguage
Overrides $mInterfaceMessage with arbitrary language.
boolean $allowUnsafeRawHtml
If the wiki is configured to allow raw html ($wgRawHtml = true) is it allowed in the specific case of...
getDisableTitleConversion()
setAllowExternalImages( $x)
callable $mTemplateCallback
Callback for template fetching; first argument to call_user_func().
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
$mMaxPPExpandDepth
Maximum recursion depth in PPFrame::expand()
$mRemoveComments
Remove HTML comments.
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 account $user
static newFromAnon()
Get a ParserOptions object for an anonymous user.
setEnableImageWhitelist( $x)
$mMaxGeneratedPPNodeCount
Maximum number of nodes generated by Preprocessor::preprocessToObj()
$mIsPrintable
Parsing the printable version of the page?
setSpeculativeRevIdCallback( $x)
disableTitleConversion( $x=true)
setMaxGeneratedPPNodeCount( $x)
setCurrentRevisionCallback( $x)
getUser()
Get the User object.
getUserLangObj()
Get the user language used by the parser for this page and split the parser cache.
$mPreSaveTransform
Transform wiki markup when saving the page?
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
registerWatcher( $callback)
Registers a callback for tracking which ParserOptions which are used.
setupFakeRevision( $title, $content, $user)
Sets a hook to force that a page exists, and sets a current revision callback to return a revision wi...
$mInterfaceMessage
Which lang to call for PLURAL and GRAMMAR.
getLanguage()
Get the Language object.
$mExpensiveParserFunctionLimit
Maximum number of calls per parse to expensive parser functions.
$mAllowExternalImages
Allow external images inline?
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
$mAllowSpecialInclusion
Allow inclusion of special pages?
namespace and then decline to actually register it file or subcat img or subcat $title
$mTidy
Use tidy to cleanup output HTML?
callable null $mSpeculativeRevIdCallback
Callback to generate a guess for {{REVISIONID}}.
getRedirectTarget()
Get the previously-set redirect target.
static newFromUserAndLang(User $user, Language $lang)
Get a ParserOptions object from a given user and language.
getAllowSpecialInclusion()
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
$mMagicRFCLinks
Are magic RFC links enabled?
$mUserLang
Language object of the User language.
$mDisableTitleConversion
Whether title conversion should be disabled.
$mIsSectionPreview
Parsing the page for a "preview" operation on a single section?
getEnableImageWhitelist()
$wgInterwikiMagic
Treat language links as magic connectors, not inline links.
setExternalLinkTarget( $x)
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
$mMagicPMIDLinks
Are magic PMID links enabled?
do that in ParserLimitReportFormat instead $parser
setAllowSpecialInclusion( $x)
$mDateFormat
Date format index.
when a variable name is used in a it is silently declared as a new masking the global
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
getUserLang()
Same as getUserLangObj() but returns a string instead.
$mDisableContentConversion
Whether content conversion should be disabled.
$mExtraKey
Extra key that should be present in the caching key.
$mAllowExternalImagesFrom
If not, any exception?
getDisableContentConversion()
optionUsed( $optionName)
Called when an option is accessed.
$mInterwikiMagic
Interlanguage links are removed and returned in an array.
$mEnableImageWhitelist
If not or it doesn't match, should we check an on-wiki whitelist?
getSpeculativeRevIdCallback()
static newFromContext(IContextSource $context)
Get a ParserOptions object from a IContextSource object.
getCurrentRevisionCallback()
$mMaxIncludeSize
Maximum size of template expansions, in bytes.
$mMaxPPNodeCount
Maximum number of nodes touched by PPFrame::expand()
$mTimestamp
Timestamp used for {{CURRENTDAY}} etc.
$mNumberHeadings
Automatically number headings?
setRedirectTarget( $title)
Set the redirect target.
setExpensiveParserFunctionLimit( $x)
$mEditSection
Create "edit section" links?
$mExternalLinkTarget
Target attribute for external links.
Interface for objects which can provide a MediaWiki context on request.
Title null $redirectTarget
If the page being parsed is a redirect, this should hold the redirect target.
setAllowExternalImagesFrom( $x)
matches(ParserOptions $other)
Check if these options match that of another options set.
enableLimitReport( $x=true)
Represents a title within MediaWiki.
__construct( $user=null, $lang=null)
Constructor.
User $mUser
Stored user object.
$wgHooks['ArticleShow'][]
static singleton()
Get an instance of this class.
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
$mIsPreview
Parsing the page for a "preview" operation?
static isRealObject( $obj)
Returns a bool value whenever $obj is a stub object.
static legacyOptions()
Returns the full array of options that would have been used by in 1.16.
$wgRenderHashAppend
Append a configured value to the parser cache and the sitenotice key so that they can be kept separat...
$mMagicISBNLinks
Are magic ISBN links enabled?
static factory( $code)
Get a cached or new language object for a given language code.
getMaxGeneratedPPNodeCount()
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.
$mCleanSignatures
Clean up signature texts?
$mEnableLimitReport
Enable limit report in an HTML comment on output.
Internationalisation code.
optionsHash( $forOptions, $title=null)
Generate a hash string with the values set on these ParserOptions for the keys given in the array.
$mThumbSize
Thumb size preferred by the user.
static newFromUser( $user)
Get a ParserOptions object from a given user.
addExtraKey( $key)
Extra key that should be present in the parser cache 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 and the content language as $wgContLang