[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/parser/ -> ParserOptions.php (summary)

Options for the PHP parser This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 778 lines (19 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ParserOptions:: (77 methods):
  getInterwikiMagic()
  getAllowExternalImages()
  getAllowExternalImagesFrom()
  getEnableImageWhitelist()
  getEditSection()
  getNumberHeadings()
  getAllowSpecialInclusion()
  getTidy()
  getInterfaceMessage()
  getTargetLanguage()
  getMaxIncludeSize()
  getMaxPPNodeCount()
  getMaxGeneratedPPNodeCount()
  getMaxPPExpandDepth()
  getMaxTemplateDepth()
  getExpensiveParserFunctionLimit()
  getRemoveComments()
  getTemplateCallback()
  getEnableLimitReport()
  getCleanSignatures()
  getExternalLinkTarget()
  getDisableContentConversion()
  getDisableTitleConversion()
  getThumbSize()
  getStubThreshold()
  getIsPreview()
  getIsSectionPreview()
  getIsPrintable()
  getUser()
  getPreSaveTransform()
  getDateFormat()
  getTimestamp()
  getUserLangObj()
  getUserLang()
  setInterwikiMagic()
  setAllowExternalImages()
  setAllowExternalImagesFrom()
  setEnableImageWhitelist()
  setDateFormat()
  setEditSection()
  setNumberHeadings()
  setAllowSpecialInclusion()
  setTidy()
  setInterfaceMessage()
  setTargetLanguage()
  setMaxIncludeSize()
  setMaxPPNodeCount()
  setMaxGeneratedPPNodeCount()
  setMaxTemplateDepth()
  setExpensiveParserFunctionLimit()
  setRemoveComments()
  setTemplateCallback()
  enableLimitReport()
  setTimestamp()
  setCleanSignatures()
  setExternalLinkTarget()
  disableContentConversion()
  disableTitleConversion()
  setUserLang()
  setThumbSize()
  setStubThreshold()
  setPreSaveTransform()
  setIsPreview()
  setIsSectionPreview()
  setIsPrintable()
  setRedirectTarget()
  getRedirectTarget()
  addExtraKey()
  __construct()
  newFromUser()
  newFromUserAndLang()
  newFromContext()
  initialiseFromUser()
  registerWatcher()
  optionUsed()
  legacyOptions()
  optionsHash()


Class: ParserOptions  - X-Ref


getInterwikiMagic()   X-Ref
If the page being parsed is a redirect, this should hold the redirect
target.


getAllowExternalImages()   X-Ref
No description

getAllowExternalImagesFrom()   X-Ref
No description

getEnableImageWhitelist()   X-Ref
No description

getEditSection()   X-Ref
No description

getNumberHeadings()   X-Ref
No description

getAllowSpecialInclusion()   X-Ref
No description

getTidy()   X-Ref
No description

getInterfaceMessage()   X-Ref
No description

getTargetLanguage()   X-Ref
No description

getMaxIncludeSize()   X-Ref
No description

getMaxPPNodeCount()   X-Ref
No description

getMaxGeneratedPPNodeCount()   X-Ref
No description

getMaxPPExpandDepth()   X-Ref
No description

getMaxTemplateDepth()   X-Ref
No description

getExpensiveParserFunctionLimit()   X-Ref
No description

getRemoveComments()   X-Ref
No description

getTemplateCallback()   X-Ref
No description

getEnableLimitReport()   X-Ref
No description

getCleanSignatures()   X-Ref
No description

getExternalLinkTarget()   X-Ref
No description

getDisableContentConversion()   X-Ref
No description

getDisableTitleConversion()   X-Ref
No description

getThumbSize()   X-Ref
No description

getStubThreshold()   X-Ref
No description

getIsPreview()   X-Ref
No description

getIsSectionPreview()   X-Ref
No description

getIsPrintable()   X-Ref
No description

getUser()   X-Ref
No description

getPreSaveTransform()   X-Ref
No description

getDateFormat()   X-Ref
No description

getTimestamp()   X-Ref
No description

getUserLangObj()   X-Ref
Get the user language used by the parser for this page.

You shouldn't use this. Really. $parser->getFunctionLang() is all you need.

To avoid side-effects where the page will be rendered based on the language
of the user who last saved, this function will triger a cache fragmentation.
Usage of this method is discouraged for that reason.

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).

return: Language

getUserLang()   X-Ref
Same as getUserLangObj() but returns a string instead.

return: string Language code

setInterwikiMagic( $x )   X-Ref
No description

setAllowExternalImages( $x )   X-Ref
No description

setAllowExternalImagesFrom( $x )   X-Ref
No description

setEnableImageWhitelist( $x )   X-Ref
No description

setDateFormat( $x )   X-Ref
No description

setEditSection( $x )   X-Ref
No description

setNumberHeadings( $x )   X-Ref
No description

setAllowSpecialInclusion( $x )   X-Ref
No description

setTidy( $x )   X-Ref
No description

setInterfaceMessage( $x )   X-Ref
No description

setTargetLanguage( $x )   X-Ref
No description

setMaxIncludeSize( $x )   X-Ref
No description

setMaxPPNodeCount( $x )   X-Ref
No description

setMaxGeneratedPPNodeCount( $x )   X-Ref
No description

setMaxTemplateDepth( $x )   X-Ref
No description

setExpensiveParserFunctionLimit( $x )   X-Ref
No description

setRemoveComments( $x )   X-Ref
No description

setTemplateCallback( $x )   X-Ref
No description

enableLimitReport( $x = true )   X-Ref
No description

setTimestamp( $x )   X-Ref
No description

setCleanSignatures( $x )   X-Ref
No description

setExternalLinkTarget( $x )   X-Ref
No description

disableContentConversion( $x = true )   X-Ref
No description

disableTitleConversion( $x = true )   X-Ref
No description

setUserLang( $x )   X-Ref
No description

setThumbSize( $x )   X-Ref
No description

setStubThreshold( $x )   X-Ref
No description

setPreSaveTransform( $x )   X-Ref
No description

setIsPreview( $x )   X-Ref
No description

setIsSectionPreview( $x )   X-Ref
No description

setIsPrintable( $x )   X-Ref
No description

setRedirectTarget( $title )   X-Ref
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.

param: Title|null $title

getRedirectTarget()   X-Ref
Get the previously-set redirect target.

return: Title|null

addExtraKey( $key )   X-Ref
Extra key that should be present in the parser cache key.

param: string $key

__construct( $user = null, $lang = null )   X-Ref
Constructor

param: User $user
param: Language $lang

newFromUser( $user )   X-Ref
Get a ParserOptions object from a given user.
Language will be taken from $wgLang.

param: User $user
return: ParserOptions

newFromUserAndLang( User $user, Language $lang )   X-Ref
Get a ParserOptions object from a given user and language

param: User $user
param: Language $lang
return: ParserOptions

newFromContext( IContextSource $context )   X-Ref
Get a ParserOptions object from a IContextSource object

param: IContextSource $context
return: ParserOptions

initialiseFromUser( $user, $lang )   X-Ref
Get user options

param: User $user
param: Language $lang

registerWatcher( $callback )   X-Ref
Registers a callback for tracking which ParserOptions which are used.
This is a private API with the parser.

param: callable $callback

optionUsed( $optionName )   X-Ref
Called when an option is accessed.

param: string $optionName Name of the option

legacyOptions()   X-Ref
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.

return: array

optionsHash( $forOptions, $title = null )   X-Ref
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.

param: array $forOptions
param: Title $title Used to get the content language of the page (since r97636)
return: string Page rendering hash



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1