MediaWiki
1.27.1
|
Set options of the Parser. More...
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 | |
$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... | |
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.
ParserOptions::__construct | ( | $user = null , |
|
$lang = null |
|||
) |
Constructor.
Definition at line 583 of file ParserOptions.php.
References $lang, $user, $wgLang, $wgUser, global, initialiseFromUser(), StubObject\isRealObject(), and User.
ParserOptions::addExtraKey | ( | $key | ) |
Extra key that should be present in the parser cache key.
string | $key |
Definition at line 574 of file ParserOptions.php.
References $key.
ParserOptions::disableContentConversion | ( | $x = true | ) |
Definition at line 506 of file ParserOptions.php.
References wfSetVar().
ParserOptions::disableTitleConversion | ( | $x = true | ) |
Definition at line 510 of file ParserOptions.php.
References wfSetVar().
ParserOptions::enableLimitReport | ( | $x = true | ) |
Definition at line 490 of file ParserOptions.php.
References wfSetVar().
ParserOptions::getAllowExternalImages | ( | ) |
Definition at line 229 of file ParserOptions.php.
References $mAllowExternalImages.
ParserOptions::getAllowExternalImagesFrom | ( | ) |
Definition at line 233 of file ParserOptions.php.
References $mAllowExternalImagesFrom.
ParserOptions::getAllowSpecialInclusion | ( | ) |
Definition at line 251 of file ParserOptions.php.
References $mAllowSpecialInclusion.
ParserOptions::getCleanSignatures | ( | ) |
Definition at line 309 of file ParserOptions.php.
References $mCleanSignatures.
ParserOptions::getCurrentRevisionCallback | ( | ) |
Definition at line 297 of file ParserOptions.php.
References $mCurrentRevisionCallback.
ParserOptions::getDateFormat | ( | ) |
Definition at line 359 of file ParserOptions.php.
References $mDateFormat, and optionUsed().
Referenced by matches(), and optionsHash().
ParserOptions::getDisableContentConversion | ( | ) |
Definition at line 317 of file ParserOptions.php.
References $mDisableContentConversion.
ParserOptions::getDisableTitleConversion | ( | ) |
Definition at line 321 of file ParserOptions.php.
References $mDisableTitleConversion.
Referenced by Parser\parse().
ParserOptions::getEditSection | ( | ) |
Definition at line 241 of file ParserOptions.php.
References $mEditSection.
ParserOptions::getEnableImageWhitelist | ( | ) |
Definition at line 237 of file ParserOptions.php.
References $mEnableImageWhitelist.
ParserOptions::getEnableLimitReport | ( | ) |
Definition at line 305 of file ParserOptions.php.
References $mEnableLimitReport.
ParserOptions::getExpensiveParserFunctionLimit | ( | ) |
Definition at line 288 of file ParserOptions.php.
References $mExpensiveParserFunctionLimit.
ParserOptions::getExternalLinkTarget | ( | ) |
Definition at line 313 of file ParserOptions.php.
References $mExternalLinkTarget.
ParserOptions::getInterfaceMessage | ( | ) |
Definition at line 259 of file ParserOptions.php.
References $mInterfaceMessage.
ParserOptions::getInterwikiMagic | ( | ) |
Definition at line 225 of file ParserOptions.php.
References $mInterwikiMagic.
ParserOptions::getIsPreview | ( | ) |
Definition at line 337 of file ParserOptions.php.
References $mIsPreview.
Referenced by ApiStashEdit\stashEditFromPreview().
ParserOptions::getIsPrintable | ( | ) |
Definition at line 345 of file ParserOptions.php.
References $mIsPrintable, and optionUsed().
ParserOptions::getIsSectionPreview | ( | ) |
Definition at line 341 of file ParserOptions.php.
References $mIsSectionPreview.
Referenced by ApiStashEdit\stashEditFromPreview().
ParserOptions::getMaxGeneratedPPNodeCount | ( | ) |
Definition at line 275 of file ParserOptions.php.
References $mMaxGeneratedPPNodeCount.
ParserOptions::getMaxIncludeSize | ( | ) |
Definition at line 267 of file ParserOptions.php.
References $mMaxIncludeSize.
ParserOptions::getMaxPPExpandDepth | ( | ) |
Definition at line 279 of file ParserOptions.php.
References $mMaxPPExpandDepth.
ParserOptions::getMaxPPNodeCount | ( | ) |
Definition at line 271 of file ParserOptions.php.
References $mMaxPPNodeCount.
ParserOptions::getMaxTemplateDepth | ( | ) |
Definition at line 283 of file ParserOptions.php.
References $mMaxTemplateDepth.
ParserOptions::getNumberHeadings | ( | ) |
Definition at line 245 of file ParserOptions.php.
References $mNumberHeadings, and optionUsed().
ParserOptions::getPreSaveTransform | ( | ) |
Definition at line 355 of file ParserOptions.php.
References $mPreSaveTransform.
Referenced by Parser\preSaveTransform().
ParserOptions::getRedirectTarget | ( | ) |
Get the previously-set redirect target.
Definition at line 566 of file ParserOptions.php.
References $redirectTarget.
ParserOptions::getRemoveComments | ( | ) |
Definition at line 292 of file ParserOptions.php.
References $mRemoveComments.
ParserOptions::getStubThreshold | ( | ) |
Definition at line 331 of file ParserOptions.php.
References $mStubThreshold, and optionUsed().
Referenced by WikiPage\getParserOutput(), and WikiPage\shouldCheckParserCache().
ParserOptions::getTargetLanguage | ( | ) |
Definition at line 263 of file ParserOptions.php.
References $mTargetLanguage.
ParserOptions::getTemplateCallback | ( | ) |
Definition at line 301 of file ParserOptions.php.
References $mTemplateCallback.
ParserOptions::getThumbSize | ( | ) |
Definition at line 325 of file ParserOptions.php.
References $mThumbSize, and optionUsed().
ParserOptions::getTidy | ( | ) |
Definition at line 255 of file ParserOptions.php.
References $mTidy.
ParserOptions::getTimestamp | ( | ) |
Definition at line 367 of file ParserOptions.php.
References $mTimestamp, and wfTimestampNow().
Referenced by ApiStashEdit\stashEditFromPreview().
ParserOptions::getUser | ( | ) |
Definition at line 351 of file ParserOptions.php.
References $mUser.
Referenced by optionsHash(), ApiStashEdit\stashEditFromPreview(), and Parser\testPst().
ParserOptions::getUserLang | ( | ) |
Same as getUserLangObj() but returns a string instead.
Definition at line 408 of file ParserOptions.php.
References getUserLangObj().
ParserOptions::getUserLangObj | ( | ) |
Get the user language used by the parser for this page and split the parser cache.
Definition at line 391 of file ParserOptions.php.
References $mUserLang, and optionUsed().
Referenced by getUserLang().
|
private |
Get user options.
Definition at line 650 of file ParserOptions.php.
References $lang, $user, $wgDisableLangConversion, $wgDisableTitleConversion, $wgInterwikiMagic, $wgMaxArticleSize, and global.
Referenced by __construct().
|
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.
Definition at line 738 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
ParserOptions | $other |
Definition at line 691 of file ParserOptions.php.
References as, and getDateFormat().
Referenced by ApiStashEdit\stashEditFromPreview().
|
static |
Get a ParserOptions object for an anonymous user.
Definition at line 607 of file ParserOptions.php.
References $wgContLang, and global.
Referenced by MessageCache\getParserOptions(), and OutputPage\parserOptions().
|
static |
Get a ParserOptions object from a IContextSource object.
IContextSource | $context |
Definition at line 640 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 |
Get a ParserOptions object from a given user.
Language will be taken from $wgLang.
User | $user |
Definition at line 619 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().
Get a ParserOptions object from a given user and language.
Definition at line 630 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.
array | $forOptions | |
Title | $title | Used to get the content language of the page (since r97636) |
Definition at line 765 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().
string | $optionName | Name of the option |
Definition at line 726 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.
callable | $callback |
Definition at line 714 of file ParserOptions.php.
ParserOptions::setAllowExternalImages | ( | $x | ) |
Definition at line 416 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setAllowExternalImagesFrom | ( | $x | ) |
Definition at line 420 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setAllowSpecialInclusion | ( | $x | ) |
Definition at line 440 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setCleanSignatures | ( | $x | ) |
Definition at line 498 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setCurrentRevisionCallback | ( | $x | ) |
Definition at line 482 of file ParserOptions.php.
References wfSetVar().
Referenced by setupFakeRevision().
ParserOptions::setDateFormat | ( | $x | ) |
Definition at line 428 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setEditSection | ( | $x | ) |
Definition at line 432 of file ParserOptions.php.
References wfSetVar().
Referenced by MessageCache\getParserOptions().
ParserOptions::setEnableImageWhitelist | ( | $x | ) |
Definition at line 424 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setExpensiveParserFunctionLimit | ( | $x | ) |
Definition at line 473 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setExternalLinkTarget | ( | $x | ) |
Definition at line 502 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setInterfaceMessage | ( | $x | ) |
Definition at line 448 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setInterwikiMagic | ( | $x | ) |
Definition at line 412 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setIsPreview | ( | $x | ) |
Definition at line 534 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setIsPrintable | ( | $x | ) |
Definition at line 542 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setIsSectionPreview | ( | $x | ) |
Definition at line 538 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setMaxGeneratedPPNodeCount | ( | $x | ) |
Definition at line 464 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setMaxIncludeSize | ( | $x | ) |
Definition at line 456 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setMaxPPNodeCount | ( | $x | ) |
Definition at line 460 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setMaxTemplateDepth | ( | $x | ) |
Definition at line 468 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setNumberHeadings | ( | $x | ) |
Definition at line 436 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setPreSaveTransform | ( | $x | ) |
Definition at line 530 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.
Title | null | $title |
Definition at line 556 of file ParserOptions.php.
References $title.
ParserOptions::setRemoveComments | ( | $x | ) |
Definition at line 477 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setStubThreshold | ( | $x | ) |
Definition at line 526 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setTargetLanguage | ( | $x | ) |
Definition at line 452 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setTemplateCallback | ( | $x | ) |
Definition at line 486 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setThumbSize | ( | $x | ) |
Definition at line 522 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setTidy | ( | $x | ) |
Definition at line 444 of file ParserOptions.php.
References wfSetVar().
ParserOptions::setTimestamp | ( | $x | ) |
Definition at line 494 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.
Definition at line 853 of file ParserOptions.php.
References $content, $key, $parser, $title, $user, $wgHooks, global, key, setCurrentRevisionCallback(), LinkCache\singleton(), and use.
ParserOptions::setUserLang | ( | $x | ) |
Definition at line 514 of file ParserOptions.php.
References Language\factory(), and wfSetVar().
|
private |
Allow external images inline?
Definition at line 42 of file ParserOptions.php.
Referenced by getAllowExternalImages().
|
private |
If not, any exception?
Definition at line 47 of file ParserOptions.php.
Referenced by getAllowExternalImagesFrom().
|
private |
Allow inclusion of special pages?
Definition at line 67 of file ParserOptions.php.
Referenced by getAllowSpecialInclusion().
|
private |
Clean up signature texts?
Definition at line 150 of file ParserOptions.php.
Referenced by getCleanSignatures().
|
private |
Callback for current revision fetching.
Used as first argument to call_user_func().
Definition at line 122 of file ParserOptions.php.
Referenced by getCurrentRevisionCallback().
|
private |
|
private |
Whether content conversion should be disabled.
Definition at line 160 of file ParserOptions.php.
Referenced by getDisableContentConversion().
|
private |
Whether title conversion should be disabled.
Definition at line 165 of file ParserOptions.php.
Referenced by getDisableTitleConversion().
|
private |
Create "edit section" links?
Definition at line 62 of file ParserOptions.php.
Referenced by getEditSection().
|
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().
|
private |
Enable limit report in an HTML comment on output.
Definition at line 134 of file ParserOptions.php.
Referenced by getEnableLimitReport().
|
private |
Maximum number of calls per parse to expensive parser functions.
Definition at line 112 of file ParserOptions.php.
Referenced by getExpensiveParserFunctionLimit().
|
private |
Target attribute for external links.
Definition at line 144 of file ParserOptions.php.
Referenced by getExternalLinkTarget().
|
private |
Extra key that should be present in the caching key.
Definition at line 211 of file ParserOptions.php.
Referenced by optionsHash().
|
private |
Which lang to call for PLURAL and GRAMMAR.
Definition at line 77 of file ParserOptions.php.
Referenced by getInterfaceMessage().
|
private |
Interlanguage links are removed and returned in an array.
Definition at line 37 of file ParserOptions.php.
Referenced by getInterwikiMagic().
|
private |
Parsing the page for a "preview" operation?
Definition at line 196 of file ParserOptions.php.
Referenced by getIsPreview().
|
private |
Parsing the printable version of the page?
Definition at line 206 of file ParserOptions.php.
Referenced by getIsPrintable().
|
private |
Parsing the page for a "preview" operation on a single section?
Definition at line 201 of file ParserOptions.php.
Referenced by getIsSectionPreview().
|
private |
Maximum number of nodes generated by Preprocessor::preprocessToObj()
Definition at line 97 of file ParserOptions.php.
Referenced by getMaxGeneratedPPNodeCount().
|
private |
Maximum size of template expansions, in bytes.
Definition at line 87 of file ParserOptions.php.
Referenced by getMaxIncludeSize().
|
private |
Maximum recursion depth in PPFrame::expand()
Definition at line 102 of file ParserOptions.php.
Referenced by getMaxPPExpandDepth().
|
private |
Maximum number of nodes touched by PPFrame::expand()
Definition at line 92 of file ParserOptions.php.
Referenced by getMaxPPNodeCount().
|
private |
Maximum recursion depth for templates within templates.
Definition at line 107 of file ParserOptions.php.
Referenced by getMaxTemplateDepth().
|
private |
Automatically number headings?
Definition at line 170 of file ParserOptions.php.
Referenced by getNumberHeadings().
|
private |
Transform wiki markup when saving the page?
Definition at line 155 of file ParserOptions.php.
Referenced by getPreSaveTransform().
|
private |
Remove HTML comments.
ONLY APPLIES TO PREPROCESS OPERATIONS
Definition at line 117 of file ParserOptions.php.
Referenced by getRemoveComments().
|
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().
|
private |
Overrides $mInterfaceMessage with arbitrary language.
Definition at line 82 of file ParserOptions.php.
Referenced by getTargetLanguage().
|
private |
Callback for template fetching.
Used as first argument to call_user_func().
Definition at line 128 of file ParserOptions.php.
Referenced by getTemplateCallback().
|
private |
Thumb size preferred by the user.
Definition at line 175 of file ParserOptions.php.
Referenced by getThumbSize(), and optionsHash().
|
private |
Use tidy to cleanup output HTML?
Definition at line 72 of file ParserOptions.php.
Referenced by getTidy().
|
private |
Timestamp used for {{CURRENTDAY}} etc.
Definition at line 139 of file ParserOptions.php.
Referenced by getTimestamp().
|
private |
|
private |
Language object of the User language.
Definition at line 185 of file ParserOptions.php.
Referenced by getUserLangObj().
|
private |
Function to be called when an option is accessed.
Definition at line 216 of file ParserOptions.php.
|
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().