Set options of the Parser. More...

Collaboration diagram for ParserOptions:

Public Member Functions
	__construct ($user=null, $lang=null)
	Constructor. More...

	addExtraKey ($key)
	Extra key that should be present in the parser cache key. More...

	disableContentConversion ($x=true)

	disableTitleConversion ($x=true)

	enableLimitReport ($x=true)

	getAllowExternalImages ()

	getAllowExternalImagesFrom ()

	getAllowSpecialInclusion ()

	getAllowUnsafeRawHtml ()

	getCleanSignatures ()

	getCurrentRevisionCallback ()

	getDateFormat ()

	getDisableContentConversion ()

	getDisableTitleConversion ()

	getEditSection ()

	getEnableImageWhitelist ()

	getEnableLimitReport ()

	getExpensiveParserFunctionLimit ()

	getExternalLinkTarget ()

	getInterfaceMessage ()

	getInterwikiMagic ()

	getIsPreview ()

	getIsPrintable ()

	getIsSectionPreview ()

	getMaxGeneratedPPNodeCount ()

	getMaxIncludeSize ()

	getMaxPPExpandDepth ()

	getMaxPPNodeCount ()

	getMaxTemplateDepth ()

	getNumberHeadings ()

	getPreSaveTransform ()

	getRedirectTarget ()
	Get the previously-set redirect target. More...

	getRemoveComments ()

	getStubThreshold ()

	getTargetLanguage ()

	getTemplateCallback ()

	getThumbSize ()

	getTidy ()

	getTimestamp ()

	getUser ()

	getUserLang ()
	Same as getUserLangObj() but returns a string instead. More...

	getUserLangObj ()
	Get the user language used by the parser for this page and split the parser cache. More...

	matches (ParserOptions $other)
	Check if these options match that of another options set. More...

	optionsHash ($forOptions, $title=null)
	Generate a hash string with the values set on these ParserOptions for the keys given in the array. More...

	optionUsed ($optionName)
	Called when an option is accessed. More...

	registerWatcher ($callback)
	Registers a callback for tracking which ParserOptions which are used. More...

	setAllowExternalImages ($x)

	setAllowExternalImagesFrom ($x)

	setAllowSpecialInclusion ($x)

	setAllowUnsafeRawHtml ($x)

	setCleanSignatures ($x)

	setCurrentRevisionCallback ($x)

	setDateFormat ($x)

	setEditSection ($x)

	setEnableImageWhitelist ($x)

	setExpensiveParserFunctionLimit ($x)

	setExternalLinkTarget ($x)

	setInterfaceMessage ($x)

	setInterwikiMagic ($x)

	setIsPreview ($x)

	setIsPrintable ($x)

	setIsSectionPreview ($x)

	setMaxGeneratedPPNodeCount ($x)

	setMaxIncludeSize ($x)

	setMaxPPNodeCount ($x)

	setMaxTemplateDepth ($x)

	setNumberHeadings ($x)

	setPreSaveTransform ($x)

	setRedirectTarget ($title)
	Set the redirect target. More...

	setRemoveComments ($x)

	setStubThreshold ($x)

	setTargetLanguage ($x)

	setTemplateCallback ($x)

	setThumbSize ($x)

	setTidy ($x)

	setTimestamp ($x)

	setupFakeRevision ($title, $content, $user)
	Sets a hook to force that a page exists, and sets a current revision callback to return a revision with custom content when the current revision of the page is requested. More...

	setUserLang ($x)

Static Public Member Functions
static	legacyOptions ()
	Returns the full array of options that would have been used by in 1.16. More...

static	newFromAnon ()
	Get a ParserOptions object for an anonymous user. More...

static	newFromContext (IContextSource $context)
	Get a ParserOptions object from a IContextSource object. More...

static	newFromUser ($user)
	Get a ParserOptions object from a given user. More...

static	newFromUserAndLang (User $user, Language $lang)
	Get a ParserOptions object from a given user and language. More...

Private Member Functions
	initialiseFromUser ($user, $lang)
	Get user options. More...

Private Attributes
boolean	$allowUnsafeRawHtml = true
	If the wiki is configured to allow raw html ($wgRawHtml = true) is it allowed in the specific case of parsing this page. More...

	$mAllowExternalImages
	Allow external images inline? More...

	$mAllowExternalImagesFrom
	If not, any exception? More...

	$mAllowSpecialInclusion
	Allow inclusion of special pages? More...

	$mCleanSignatures
	Clean up signature texts? More...

	$mCurrentRevisionCallback
	Callback for current revision fetching. More...

	$mDateFormat = null
	Date format index. More...

	$mDisableContentConversion
	Whether content conversion should be disabled. More...

	$mDisableTitleConversion
	Whether title conversion should be disabled. More...

	$mEditSection = true
	Create "edit section" links? More...

	$mEnableImageWhitelist
	If not or it doesn't match, should we check an on-wiki whitelist? More...

	$mEnableLimitReport = false
	Enable limit report in an HTML comment on output. More...

	$mExpensiveParserFunctionLimit
	Maximum number of calls per parse to expensive parser functions. More...

	$mExternalLinkTarget
	Target attribute for external links. More...

	$mExtraKey = ''
	Extra key that should be present in the caching key. More...

	$mInterfaceMessage = false
	Which lang to call for PLURAL and GRAMMAR. More...

	$mInterwikiMagic
	Interlanguage links are removed and returned in an array. More...

	$mIsPreview = false
	Parsing the page for a "preview" operation? More...

	$mIsPrintable = false
	Parsing the printable version of the page? More...

	$mIsSectionPreview = false
	Parsing the page for a "preview" operation on a single section? More...

	$mMaxGeneratedPPNodeCount
	Maximum number of nodes generated by Preprocessor::preprocessToObj() More...

	$mMaxIncludeSize
	Maximum size of template expansions, in bytes. More...

	$mMaxPPExpandDepth
	Maximum recursion depth in PPFrame::expand() More...

	$mMaxPPNodeCount
	Maximum number of nodes touched by PPFrame::expand() More...

	$mMaxTemplateDepth
	Maximum recursion depth for templates within templates. More...

	$mNumberHeadings
	Automatically number headings? More...

	$mPreSaveTransform = true
	Transform wiki markup when saving the page? More...

	$mRemoveComments = true
	Remove HTML comments. More...

	$mStubThreshold
	Maximum article size of an article to be marked as "stub". More...

	$mTargetLanguage = null
	Overrides $mInterfaceMessage with arbitrary language. More...

	$mTemplateCallback
	Callback for template fetching. More...

	$mThumbSize
	Thumb size preferred by the user. More...

	$mTidy = false
	Use tidy to cleanup output HTML? More...

	$mTimestamp
	Timestamp used for {{CURRENTDAY}} etc. More...

User	$mUser
	Stored user object. More...

	$mUserLang
	Language object of the User language. More...

	$onAccessCallback = null
	Function to be called when an option is accessed. More...

Title null	$redirectTarget = null
	If the page being parsed is a redirect, this should hold the redirect target. More...

Detailed Description

Set options of the Parser.

All member variables are supposed to be private in theory, although in practice this is not the case.

Definition at line 32 of file ParserOptions.php.

Constructor & Destructor Documentation

ParserOptions::__construct	(	$user = `null`,
		$lang = `null`
	)

Constructor.

Parameters

User	$user
Language	$lang

Definition at line 615 of file ParserOptions.php.

References $lang, $user, $wgLang, $wgUser, global, initialiseFromUser(), StubObject\isRealObject(), and User.

Member Function Documentation

ParserOptions::addExtraKey ( $key )

Extra key that should be present in the parser cache key.

Parameters

string $key

Definition at line 606 of file ParserOptions.php.

References $key.

ParserOptions::disableContentConversion ( $x = true )

Definition at line 529 of file ParserOptions.php.

References wfSetVar().

ParserOptions::disableTitleConversion ( $x = true )

Definition at line 533 of file ParserOptions.php.

References wfSetVar().

ParserOptions::enableLimitReport ( $x = true )

Definition at line 513 of file ParserOptions.php.

References wfSetVar().

ParserOptions::getAllowExternalImages ( )

Definition at line 244 of file ParserOptions.php.

References $mAllowExternalImages.

ParserOptions::getAllowExternalImagesFrom ( )

Definition at line 248 of file ParserOptions.php.

References $mAllowExternalImagesFrom.

ParserOptions::getAllowSpecialInclusion ( )

Definition at line 266 of file ParserOptions.php.

References $mAllowSpecialInclusion.

ParserOptions::getAllowUnsafeRawHtml ( )

Since: 1.29

Returns: bool

Definition at line 431 of file ParserOptions.php.

References $allowUnsafeRawHtml.

ParserOptions::getCleanSignatures ( )

Definition at line 324 of file ParserOptions.php.

References $mCleanSignatures.

ParserOptions::getCurrentRevisionCallback ( )

Definition at line 312 of file ParserOptions.php.

References $mCurrentRevisionCallback.

ParserOptions::getDateFormat ( )

Definition at line 374 of file ParserOptions.php.

References $mDateFormat, and optionUsed().

Referenced by matches(), and optionsHash().

ParserOptions::getDisableContentConversion ( )

Definition at line 332 of file ParserOptions.php.

References $mDisableContentConversion.

ParserOptions::getDisableTitleConversion ( )

Definition at line 336 of file ParserOptions.php.

References $mDisableTitleConversion.

Referenced by Parser\parse().

ParserOptions::getEditSection ( )

Definition at line 256 of file ParserOptions.php.

References $mEditSection.

ParserOptions::getEnableImageWhitelist ( )

Definition at line 252 of file ParserOptions.php.

References $mEnableImageWhitelist.

ParserOptions::getEnableLimitReport ( )

Definition at line 320 of file ParserOptions.php.

References $mEnableLimitReport.

ParserOptions::getExpensiveParserFunctionLimit ( )

Definition at line 303 of file ParserOptions.php.

References $mExpensiveParserFunctionLimit.

ParserOptions::getExternalLinkTarget ( )

Definition at line 328 of file ParserOptions.php.

References $mExternalLinkTarget.

ParserOptions::getInterfaceMessage ( )

Definition at line 274 of file ParserOptions.php.

References $mInterfaceMessage.

ParserOptions::getInterwikiMagic ( )

Definition at line 240 of file ParserOptions.php.

References $mInterwikiMagic.

ParserOptions::getIsPreview ( )

Definition at line 352 of file ParserOptions.php.

References $mIsPreview.

Referenced by ApiStashEdit\stashEditFromPreview().

ParserOptions::getIsPrintable ( )

Definition at line 360 of file ParserOptions.php.

References $mIsPrintable, and optionUsed().

ParserOptions::getIsSectionPreview ( )

Definition at line 356 of file ParserOptions.php.

References $mIsSectionPreview.

Referenced by ApiStashEdit\stashEditFromPreview().

ParserOptions::getMaxGeneratedPPNodeCount ( )

Definition at line 290 of file ParserOptions.php.

References $mMaxGeneratedPPNodeCount.

ParserOptions::getMaxIncludeSize ( )

Definition at line 282 of file ParserOptions.php.

References $mMaxIncludeSize.

ParserOptions::getMaxPPExpandDepth ( )

Definition at line 294 of file ParserOptions.php.

References $mMaxPPExpandDepth.

ParserOptions::getMaxPPNodeCount ( )

Definition at line 286 of file ParserOptions.php.

References $mMaxPPNodeCount.

ParserOptions::getMaxTemplateDepth ( )

Definition at line 298 of file ParserOptions.php.

References $mMaxTemplateDepth.

ParserOptions::getNumberHeadings ( )

Definition at line 260 of file ParserOptions.php.

References $mNumberHeadings, and optionUsed().

ParserOptions::getPreSaveTransform ( )

Definition at line 370 of file ParserOptions.php.

References $mPreSaveTransform.

Referenced by Parser\preSaveTransform().

ParserOptions::getRedirectTarget ( )

Get the previously-set redirect target.

Since: 1.24

Returns: Title|null

Definition at line 598 of file ParserOptions.php.

References $redirectTarget.

ParserOptions::getRemoveComments ( )

Definition at line 307 of file ParserOptions.php.

References $mRemoveComments.

ParserOptions::getStubThreshold ( )

Definition at line 346 of file ParserOptions.php.

References $mStubThreshold, and optionUsed().

Referenced by WikiPage\getParserOutput(), and WikiPage\shouldCheckParserCache().

ParserOptions::getTargetLanguage ( )

Definition at line 278 of file ParserOptions.php.

References $mTargetLanguage.

ParserOptions::getTemplateCallback ( )

Definition at line 316 of file ParserOptions.php.

References $mTemplateCallback.

ParserOptions::getThumbSize ( )

Definition at line 340 of file ParserOptions.php.

References $mThumbSize, and optionUsed().

ParserOptions::getTidy ( )

Definition at line 270 of file ParserOptions.php.

References $mTidy.

ParserOptions::getTimestamp ( )

Definition at line 382 of file ParserOptions.php.

References $mTimestamp, and wfTimestampNow().

Referenced by ApiStashEdit\stashEditFromPreview().

ParserOptions::getUser ( )

Definition at line 366 of file ParserOptions.php.

References $mUser.

Referenced by optionsHash(), ApiStashEdit\stashEditFromPreview(), and Parser\testPst().

ParserOptions::getUserLang ( )

Same as getUserLangObj() but returns a string instead.

Warning: : Calling this causes the parser cache to be fragmented by user language! To avoid cache fragmentation, output should not depend on the user language. Use Parser::getFunctionLang() or Parser::getTargetLanguage() instead!

See also: getUserLangObj()

Returns: string Language code

Since: 1.17

Definition at line 423 of file ParserOptions.php.

References getUserLangObj().

ParserOptions::getUserLangObj ( )

Get the user language used by the parser for this page and split the parser cache.

Warning: : Calling this causes the parser cache to be fragmented by user language! To avoid cache fragmentation, output should not depend on the user language. Use Parser::getFunctionLang() or Parser::getTargetLanguage() instead!

Note: This function will trigger a cache fragmentation by recording the 'userlang' option, see optionUsed(). This is done to avoid cache pollution when the page is rendered based on the language of the user.; When saving, this will return the default language instead of the user's. {{int: }} uses this which used to produce inconsistent link tables (bug 14404).

Returns: Language

Since: 1.19

Definition at line 406 of file ParserOptions.php.

References $mUserLang, and optionUsed().

Referenced by getUserLang().

ParserOptions::initialiseFromUser	(	$user,
		$lang
	)

private

Get user options.

Parameters

User	$user
Language	$lang

Definition at line 682 of file ParserOptions.php.

References $lang, $user, $wgDisableLangConversion, $wgDisableTitleConversion, $wgInterwikiMagic, $wgMaxArticleSize, and global.

Referenced by __construct().

static ParserOptions::legacyOptions ( )

static

Returns the full array of options that would have been used by in 1.16.

Used to get the old parser cache entries when available.

Returns: array

Definition at line 770 of file ParserOptions.php.

Referenced by ParserCache\getETag(), and ParserCache\getKey().

ParserOptions::matches ( ParserOptions $other )

Check if these options match that of another options set.

This ignores report limit settings that only affect HTML comments

Parameters

ParserOptions $other

Returns: bool

Since: 1.25

Definition at line 723 of file ParserOptions.php.

References as, and getDateFormat().

Referenced by ApiStashEdit\stashEditFromPreview().

static ParserOptions::newFromAnon ( )

static

Get a ParserOptions object for an anonymous user.

Since: 1.27

Returns: ParserOptions

Definition at line 639 of file ParserOptions.php.

References $wgContLang, and global.

Referenced by MessageCache\getParserOptions(), and OutputPage\parserOptions().

static ParserOptions::newFromContext ( IContextSource $context )

static

Get a ParserOptions object from a IContextSource object.

Parameters

IContextSource $context

Returns: ParserOptions

Definition at line 672 of file ParserOptions.php.

References IContextSource\getLanguage(), and IContextSource\getUser().

Referenced by ApiExpandTemplates\execute(), SpecialExpandTemplates\execute(), ApiQueryRevisionsBase\extractRevisionInfo(), SpecialExpandTemplates\generateHtml(), RawAction\getRawText(), ContentHandler\makeParserOptions(), OutputPage\parserOptions(), Preferences\profilePreferences(), ParserTest\runTest(), and NewParserTest\testParserTest().

static ParserOptions::newFromUser ( $user )

static

Get a ParserOptions object from a given user.

Language will be taken from $wgLang.

Parameters

User $user

Returns: ParserOptions

Definition at line 651 of file ParserOptions.php.

References $user.

Referenced by CompareParsers\checkOptions(), PPFuzzTest\execute(), ParserTest\fuzzTest(), ParserCache\getKey(), EditPage\getPreloadedContent(), DumpRenderer\handleRevision(), ContentHandler\makeParserOptions(), NewParserTest\testFuzzTests(), ExtraParserTest\testLongNumericLinesDontKillTheParser(), and ParserMethodsTest\testPreSaveTransform().

static ParserOptions::newFromUserAndLang	(	User	$user,
		Language	$lang
	)

static

Get a ParserOptions object from a given user and language.

Parameters

User	$user
Language	$lang

Returns: ParserOptions

Definition at line 662 of file ParserOptions.php.

Referenced by EditPage\getContentObject(), ContentHandler\makeParserOptions(), WikiPage\prepareContentForEdit(), PreprocessorTest\setUp(), ExtraParserTest\setUp(), ParserPreloadTest\setUp(), MagicVariableTest\setUp(), EditPage\showDiff(), TagHookTest\testBadFunctionTagHooks(), TagHookTest\testBadTagHooks(), TagHookTest\testFunctionTagHooks(), TextContentTest\testPreloadTransform(), TextContentTest\testPreSaveTransform(), and TagHookTest\testTagHooks().

ParserOptions::optionsHash	(	$forOptions,
		$title = `null`
	)

Generate a hash string with the values set on these ParserOptions for the keys given in the array.

This will be used as part of the hash key for the parser cache, so users sharing the options with vary for the same page share the same cached data safely.

Extensions which require it should install 'PageRenderingHash' hook, which will give them a chance to modify this key based on their own settings.

Since: 1.17

Parameters

array	$forOptions
Title	$title	Used to get the content language of the page (since r97636)

Returns: string Page rendering hash

Definition at line 797 of file ParserOptions.php.

References $mExtraKey, $mStubThreshold, $mThumbSize, $title, $wgContLang, $wgRenderHashAppend, getDateFormat(), getUser(), global, and Hooks\run().

ParserOptions::optionUsed ( $optionName )

Called when an option is accessed.

Calls the watcher that was set using registerWatcher(). Typically, the watcher callback is ParserOutput::registerOption(). The information registered that way will be used by ParserCache::save().

Parameters

string $optionName Name of the option

Definition at line 758 of file ParserOptions.php.

Referenced by getDateFormat(), getIsPrintable(), getNumberHeadings(), getStubThreshold(), getThumbSize(), and getUserLangObj().

ParserOptions::registerWatcher ( $callback )

Registers a callback for tracking which ParserOptions which are used.

This is a private API with the parser.

Parameters

callable $callback

Definition at line 746 of file ParserOptions.php.

ParserOptions::setAllowExternalImages ( $x )

Definition at line 439 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setAllowExternalImagesFrom ( $x )

Definition at line 443 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setAllowSpecialInclusion ( $x )

Definition at line 463 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setAllowUnsafeRawHtml ( $x )

Parameters

bool|null Value to set or null to get current value

Returns: bool Current value for allowUnsafeRawHtml

Since: 1.29

Definition at line 574 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setCleanSignatures ( $x )

Definition at line 521 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setCurrentRevisionCallback ( $x )

Definition at line 505 of file ParserOptions.php.

References wfSetVar().

Referenced by setupFakeRevision().

ParserOptions::setDateFormat ( $x )

Definition at line 451 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setEditSection ( $x )

Definition at line 455 of file ParserOptions.php.

References wfSetVar().

Referenced by MessageCache\getParserOptions().

ParserOptions::setEnableImageWhitelist ( $x )

Definition at line 447 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setExpensiveParserFunctionLimit ( $x )

Definition at line 496 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setExternalLinkTarget ( $x )

Definition at line 525 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setInterfaceMessage ( $x )

Definition at line 471 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setInterwikiMagic ( $x )

Definition at line 435 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setIsPreview ( $x )

Definition at line 557 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setIsPrintable ( $x )

Definition at line 565 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setIsSectionPreview ( $x )

Definition at line 561 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setMaxGeneratedPPNodeCount ( $x )

Definition at line 487 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setMaxIncludeSize ( $x )

Definition at line 479 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setMaxPPNodeCount ( $x )

Definition at line 483 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setMaxTemplateDepth ( $x )

Definition at line 491 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setNumberHeadings ( $x )

Definition at line 459 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setPreSaveTransform ( $x )

Definition at line 553 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setRedirectTarget ( $title )

Set the redirect target.

Note that setting or changing this does not make the page a redirect or change its target, it merely records the information for reference during the parse.

Since: 1.24

Parameters

Title | null $title

Definition at line 588 of file ParserOptions.php.

References $title.

ParserOptions::setRemoveComments ( $x )

Definition at line 500 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setStubThreshold ( $x )

Definition at line 549 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setTargetLanguage ( $x )

Definition at line 475 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setTemplateCallback ( $x )

Definition at line 509 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setThumbSize ( $x )

Definition at line 545 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setTidy ( $x )

Definition at line 467 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setTimestamp ( $x )

Definition at line 517 of file ParserOptions.php.

References wfSetVar().

ParserOptions::setupFakeRevision	(	$title,
		$content,
		$user
	)

Sets a hook to force that a page exists, and sets a current revision callback to return a revision with custom content when the current revision of the page is requested.

Since: 1.25

Parameters

Title	$title
Content	$content
User	$user	The user that the fake revision is attributed to

Returns: ScopedCallback to unset the hook

Definition at line 885 of file ParserOptions.php.

References $content, $key, $parser, $title, $user, $wgHooks, global, key, setCurrentRevisionCallback(), LinkCache\singleton(), and use.

ParserOptions::setUserLang ( $x )

Definition at line 537 of file ParserOptions.php.

References Language\factory(), and wfSetVar().

Member Data Documentation

boolean ParserOptions::$allowUnsafeRawHtml = true

private

If the wiki is configured to allow raw html ($wgRawHtml = true) is it allowed in the specific case of parsing this page.

This is meant to disable unsafe parser tags in cases where a malicious user may control the input to the parser.

Note: This is expected to be true for normal pages even if the wiki has $wgRawHtml disabled in general. The setting only signifies that raw html would be unsafe in the current context provided that raw html is allowed at all.

Definition at line 238 of file ParserOptions.php.

Referenced by getAllowUnsafeRawHtml().

ParserOptions::$mAllowExternalImages

private

Allow external images inline?

Definition at line 42 of file ParserOptions.php.

Referenced by getAllowExternalImages().

ParserOptions::$mAllowExternalImagesFrom

private

If not, any exception?

Definition at line 47 of file ParserOptions.php.

Referenced by getAllowExternalImagesFrom().

ParserOptions::$mAllowSpecialInclusion

private

Allow inclusion of special pages?

Definition at line 67 of file ParserOptions.php.

Referenced by getAllowSpecialInclusion().

ParserOptions::$mCleanSignatures

private

Clean up signature texts?

See also: Parser::cleanSig

Definition at line 150 of file ParserOptions.php.

Referenced by getCleanSignatures().

ParserOptions::$mCurrentRevisionCallback

private

Initial value:

=

[ 'Parser', 'statelessFetchRevision' ]

Callback for current revision fetching.

Used as first argument to call_user_func().

Definition at line 122 of file ParserOptions.php.

Referenced by getCurrentRevisionCallback().

ParserOptions::$mDateFormat = null

private

Date format index.

Definition at line 57 of file ParserOptions.php.

Referenced by getDateFormat().

ParserOptions::$mDisableContentConversion

private

Whether content conversion should be disabled.

Definition at line 160 of file ParserOptions.php.

Referenced by getDisableContentConversion().

ParserOptions::$mDisableTitleConversion

private

Whether title conversion should be disabled.

Definition at line 165 of file ParserOptions.php.

Referenced by getDisableTitleConversion().

ParserOptions::$mEditSection = true

private

Create "edit section" links?

Definition at line 62 of file ParserOptions.php.

Referenced by getEditSection().

ParserOptions::$mEnableImageWhitelist

private

If not or it doesn't match, should we check an on-wiki whitelist?

Definition at line 52 of file ParserOptions.php.

Referenced by getEnableImageWhitelist().

ParserOptions::$mEnableLimitReport = false

private

Enable limit report in an HTML comment on output.

Definition at line 134 of file ParserOptions.php.

Referenced by getEnableLimitReport().

ParserOptions::$mExpensiveParserFunctionLimit

private

Maximum number of calls per parse to expensive parser functions.

Definition at line 112 of file ParserOptions.php.

Referenced by getExpensiveParserFunctionLimit().

ParserOptions::$mExternalLinkTarget

private

Target attribute for external links.

Definition at line 144 of file ParserOptions.php.

Referenced by getExternalLinkTarget().

ParserOptions::$mExtraKey = ''

private

Extra key that should be present in the caching key.

Definition at line 211 of file ParserOptions.php.

Referenced by optionsHash().

ParserOptions::$mInterfaceMessage = false

private

Which lang to call for PLURAL and GRAMMAR.

Definition at line 77 of file ParserOptions.php.

Referenced by getInterfaceMessage().

ParserOptions::$mInterwikiMagic

private

Interlanguage links are removed and returned in an array.

Definition at line 37 of file ParserOptions.php.

Referenced by getInterwikiMagic().

ParserOptions::$mIsPreview = false

private

Parsing the page for a "preview" operation?

Definition at line 196 of file ParserOptions.php.

Referenced by getIsPreview().

ParserOptions::$mIsPrintable = false

private

Parsing the printable version of the page?

Definition at line 206 of file ParserOptions.php.

Referenced by getIsPrintable().

ParserOptions::$mIsSectionPreview = false

private

Parsing the page for a "preview" operation on a single section?

Definition at line 201 of file ParserOptions.php.

Referenced by getIsSectionPreview().

ParserOptions::$mMaxGeneratedPPNodeCount

private

Maximum number of nodes generated by Preprocessor::preprocessToObj()

Definition at line 97 of file ParserOptions.php.

Referenced by getMaxGeneratedPPNodeCount().

ParserOptions::$mMaxIncludeSize

private

Maximum size of template expansions, in bytes.

Definition at line 87 of file ParserOptions.php.

Referenced by getMaxIncludeSize().

ParserOptions::$mMaxPPExpandDepth

private

Maximum recursion depth in PPFrame::expand()

Definition at line 102 of file ParserOptions.php.

Referenced by getMaxPPExpandDepth().

ParserOptions::$mMaxPPNodeCount

private

Maximum number of nodes touched by PPFrame::expand()

Definition at line 92 of file ParserOptions.php.

Referenced by getMaxPPNodeCount().

ParserOptions::$mMaxTemplateDepth

private

Maximum recursion depth for templates within templates.

Definition at line 107 of file ParserOptions.php.

Referenced by getMaxTemplateDepth().

ParserOptions::$mNumberHeadings

private

Automatically number headings?

Definition at line 170 of file ParserOptions.php.

Referenced by getNumberHeadings().

ParserOptions::$mPreSaveTransform = true

private

Transform wiki markup when saving the page?

Definition at line 155 of file ParserOptions.php.

Referenced by getPreSaveTransform().

ParserOptions::$mRemoveComments = true

private

Remove HTML comments.

ONLY APPLIES TO PREPROCESS OPERATIONS

Definition at line 117 of file ParserOptions.php.

Referenced by getRemoveComments().

ParserOptions::$mStubThreshold

private

Maximum article size of an article to be marked as "stub".

Definition at line 180 of file ParserOptions.php.

Referenced by getStubThreshold(), and optionsHash().

ParserOptions::$mTargetLanguage = null

private

Overrides $mInterfaceMessage with arbitrary language.

Definition at line 82 of file ParserOptions.php.

Referenced by getTargetLanguage().

ParserOptions::$mTemplateCallback

private

Initial value:

=

[ 'Parser', 'statelessFetchTemplate' ]

Callback for template fetching.

Used as first argument to call_user_func().

Definition at line 128 of file ParserOptions.php.

Referenced by getTemplateCallback().

ParserOptions::$mThumbSize

private

Thumb size preferred by the user.

Definition at line 175 of file ParserOptions.php.

Referenced by getThumbSize(), and optionsHash().

ParserOptions::$mTidy = false

private

Use tidy to cleanup output HTML?

Definition at line 72 of file ParserOptions.php.

Referenced by getTidy().

ParserOptions::$mTimestamp

private

Timestamp used for {{CURRENTDAY}} etc.

Definition at line 139 of file ParserOptions.php.

Referenced by getTimestamp().

User ParserOptions::$mUser

private

Stored user object.

Definition at line 191 of file ParserOptions.php.

Referenced by getUser().

ParserOptions::$mUserLang

private

Language object of the User language.

Definition at line 185 of file ParserOptions.php.

Referenced by getUserLangObj().

ParserOptions::$onAccessCallback = null

private

Function to be called when an option is accessed.

Definition at line 216 of file ParserOptions.php.

Title null ParserOptions::$redirectTarget = null

private

If the page being parsed is a redirect, this should hold the redirect target.

Definition at line 223 of file ParserOptions.php.

Referenced by getRedirectTarget().

The documentation for this class was generated from the following file:

includes/parser/ParserOptions.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation