ParserFactory Class Reference

Public Member Functions
	__construct (ServiceOptions $svcOptions, MagicWordFactory $magicWordFactory, Language $contLang, UrlUtils $urlUtils, SpecialPageFactory $spFactory, LinkRendererFactory $linkRendererFactory, NamespaceInfo $nsInfo, LoggerInterface $logger, BadFileLookup $badFileLookup, LanguageConverterFactory $languageConverterFactory, HookContainer $hookContainer, TidyDriverBase $tidy, WANObjectCache $wanCache, UserOptionsLookup $userOptionsLookup, UserFactory $userFactory, TitleFormatter $titleFormatter, HttpRequestFactory $httpRequestFactory, TrackingCategories $trackingCategories, SignatureValidatorFactory $signatureValidatorFactory, UserNameUtils $userNameUtils)
	create ()
	Creates a new parser.
	getInstance ()
	Get the main shared instance, or if it is locked, get a new instance.
	getMainInstance ()
	Get the main shared instance.

Static Public Attributes
static int	$inParserFactory = 0
	Track calls to Parser constructor to aid in deprecation of direct Parser invocation.

Detailed Description

Since

1.32

Definition at line 45 of file ParserFactory.php.

Constructor & Destructor Documentation

__construct()

ParserFactory::__construct	(	ServiceOptions	$svcOptions,
		MagicWordFactory	$magicWordFactory,
		Language	$contLang,
		UrlUtils	$urlUtils,
		SpecialPageFactory	$spFactory,
		LinkRendererFactory	$linkRendererFactory,
		NamespaceInfo	$nsInfo,
		LoggerInterface	$logger,
		BadFileLookup	$badFileLookup,
		LanguageConverterFactory	$languageConverterFactory,
		HookContainer	$hookContainer,
		TidyDriverBase	$tidy,
		WANObjectCache	$wanCache,
		UserOptionsLookup	$userOptionsLookup,
		UserFactory	$userFactory,
		TitleFormatter	$titleFormatter,
		HttpRequestFactory	$httpRequestFactory,
		TrackingCategories	$trackingCategories,
		SignatureValidatorFactory	$signatureValidatorFactory,
		UserNameUtils	$userNameUtils )

Parameters

ServiceOptions	$svcOptions
MagicWordFactory	$magicWordFactory
Language	$contLang	Content language
UrlUtils	$urlUtils
SpecialPageFactory	$spFactory
LinkRendererFactory	$linkRendererFactory
NamespaceInfo	$nsInfo
LoggerInterface	$logger
BadFileLookup	$badFileLookup
LanguageConverterFactory	$languageConverterFactory
HookContainer	$hookContainer
TidyDriverBase	$tidy
WANObjectCache	$wanCache
UserOptionsLookup	$userOptionsLookup
UserFactory	$userFactory
TitleFormatter	$titleFormatter
HttpRequestFactory	$httpRequestFactory
TrackingCategories	$trackingCategories
SignatureValidatorFactory	$signatureValidatorFactory
UserNameUtils	$userNameUtils

Since

1.32

Access: internal

Definition at line 143 of file ParserFactory.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), and wfDebug().

Member Function Documentation

create()

ParserFactory::create

(

)

Creates a new parser.

Note

Use this function to get a new Parser instance to store in a local class property. Where possible use lazy creation and create the Parser only when needed, not directly in service wiring.

Returns

Parser

Since

1.32

Definition at line 201 of file ParserFactory.php.

getInstance()

ParserFactory::getInstance

(

)

Get the main shared instance, or if it is locked, get a new instance.

Note

This function was used to parse wikitext. The instance it returned should be used only in local scope. Do not hold a reference to this parser in class properties. In general, avoid using this method and use ::create() instead.

Since

1.39

Returns

Parser

Definition at line 262 of file ParserFactory.php.

getMainInstance()

ParserFactory::getMainInstance

(

)

Get the main shared instance.

This is unsafe when the caller is not in a top-level context, because re-entering the parser will throw an exception.

Note

This function is used to get metadata from the parser. Avoid using this function to parse wikitext. (Generally avoid using this function at all in new code.)

Since

1.39

Returns

Parser

Definition at line 244 of file ParserFactory.php.

Member Data Documentation

$inParserFactory

int ParserFactory::$inParserFactory = 0

static

Track calls to Parser constructor to aid in deprecation of direct Parser invocation.

This is temporary: it will be removed once the deprecation notice period is over and the underlying method calls are refactored.

Access: internal

Definition at line 105 of file ParserFactory.php.

Referenced by MediaWiki\Parser\Parser\__construct().

---

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

• includes/parser/ParserFactory.php