|
MediaWiki master
|
Site-level configuration for Parsoid. More...
Inherits ISiteConfig.

Public Member Functions | |
| __construct (private readonly ServiceOptions $config, private readonly array $parsoidSettings, private readonly ObjectFactory $objectFactory, private readonly Language $contLang, private readonly StatsdDataFactoryInterface $stats, private readonly StatsFactory $statsFactory, private readonly MagicWordFactory $magicWordFactory, private readonly NamespaceInfo $namespaceInfo, private readonly SpecialPageFactory $specialPageFactory, private readonly InterwikiLookup $interwikiLookup, private readonly UserOptionsLookup $userOptionsLookup, private readonly LanguageFactory $languageFactory, private readonly LanguageConverterFactory $languageConverterFactory, private readonly LanguageNameUtils $languageNameUtils, private readonly UrlUtils $urlUtils, private readonly IContentHandlerFactory $contentHandlerFactory, private readonly array $extensionParsoidModules, private readonly ParserFactory $parserFactory, private readonly Config $mwConfig, private readonly bool $isTimedMediaHandlerLoaded,) | |
| allowedExternalImagePrefixes () | |
| baseURI () | |
| bswRegexp () | |
| canonicalNamespaceId (string $name) | |
| categoryRegexp () | |
| clearDeprecationFilters () | |
| deprecated (string $function, string $version, int $callerOffset=2) | |
| exportMetadataToHeadBcp47 (Document $document, ContentMetadataCollector $metadata, string $defaultTitle, Bcp47Code $lang) | |
| filterDeprecationForTest (string $regex) | |
| galleryOptions () | |
| getAsyncFallbackMessageKey () | |
| Return the localization key we should use for asynchronous fallback content. | |
| getExternalLinkTarget () | |
| getHistogramBuckets (float $mean, int $skip) | |
| Generate buckets based on skip and mean. | |
| getLogger () | |
| getMagicWordMatcher (string $id) | |
| getMaxTemplateDepth () | |
| getMWConfigValue (string $key) | |
| Lookup config. | |
| getNoFollowConfig () | |
| getObjectFactory () | |
| getParameterizedAliasMatcher (array $words) | |
| incrementCounter (string $name, array $labels, float $amount=1) | |
| Increment a counter metric. | |
| interwikiMagic () | |
| interwikiMap () | |
| iwp () | |
| langBcp47 () | |
| langConverterEnabledBcp47 (Bcp47Code $lang) | |
| legalTitleChars () | |
| linkPrefixRegex () | |
| magicLinkEnabled (string $which) | |
| mainpage () | |
| mainPageLinkTarget () | |
| metrics () | |
| namespaceCase (int $ns) | |
| namespaceHasSubpages (int $ns) | |
| namespaceId (string $name) | |
| namespaceIsTalk (int $ns) | |
| namespaceName (int $ns) | |
| observeHistogram (string $name, float $value, array $buckets, array $labels) | |
| Record a histogram metric. | |
| observeTiming (string $name, float $value, array $labels) | |
| Record a timing metric. | |
| prefixedStatsFactory () | |
| Create a prefixed StatsFactory for parsoid stats. | |
| redirectRegexp () | |
| relativeLinkPrefix () | |
| rtl () | |
| script () | |
| scriptpath () | |
| server () | |
| setMaxTemplateDepth (int $depth) | |
| Overrides the max template depth in the MediaWiki configuration. | |
| specialPageLocalName (string $alias) | |
| supportsContentModel (string $model) | |
| Returns true iff Parsoid natively supports the given content model. | |
| timezoneOffset () | |
| ucfirst (string $str) | |
| variants () | |
| Language variant information. | |
| variantsFor (Bcp47Code $code) | |
| Language variant information for the given language (or null if unknown). | |
| widthOption () | |
Public Attributes | |
| const | CONSTRUCTOR_OPTIONS |
Protected Member Functions | |
| getDoubleUnderscoreIDs () | |
| Return list of magic word IDs used for behavior switches. | |
| getFunctionSynonyms () | |
| getMagicWords () | |
| getNonNativeExtensionTags () | |
| getProtocols () | |
| getSpecialNSAliases () | |
| getSpecialPageAliases (string $specialPage) | |
| getVariableIDs () | |
| Return list of magic word IDs used for magic variables (memoized zero-argument parser functions). | |
| linkTrail () | |
| shouldValidateExtConfig () | |
Site-level configuration for Parsoid.
This includes both global configuration and wiki-level configuration.
Definition at line 59 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::__construct | ( | private readonly ServiceOptions | $config, |
| private readonly array | $parsoidSettings, | ||
| private readonly ObjectFactory | $objectFactory, | ||
| private readonly Language | $contLang, | ||
| private readonly StatsdDataFactoryInterface | $stats, | ||
| private readonly StatsFactory | $statsFactory, | ||
| private readonly MagicWordFactory | $magicWordFactory, | ||
| private readonly NamespaceInfo | $namespaceInfo, | ||
| private readonly SpecialPageFactory | $specialPageFactory, | ||
| private readonly InterwikiLookup | $interwikiLookup, | ||
| private readonly UserOptionsLookup | $userOptionsLookup, | ||
| private readonly LanguageFactory | $languageFactory, | ||
| private readonly LanguageConverterFactory | $languageConverterFactory, | ||
| private readonly LanguageNameUtils | $languageNameUtils, | ||
| private readonly UrlUtils | $urlUtils, | ||
| private readonly IContentHandlerFactory | $contentHandlerFactory, | ||
| private readonly array | $extensionParsoidModules, | ||
| private readonly ParserFactory | $parserFactory, | ||
| private readonly Config | $mwConfig, | ||
| private readonly bool | $isTimedMediaHandlerLoaded ) |
Definition at line 94 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::allowedExternalImagePrefixes | ( | ) |
Definition at line 242 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::baseURI | ( | ) |
Definition at line 290 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::bswRegexp | ( | ) |
Definition at line 339 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::canonicalNamespaceId | ( | string | $name | ) |
Definition at line 349 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::categoryRegexp | ( | ) |
Definition at line 325 of file SiteConfig.php.
References NS_CATEGORY.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::clearDeprecationFilters | ( | ) |
Definition at line 836 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::deprecated | ( | string | $function, |
| string | $version, | ||
| int | $callerOffset = 2 ) |
Definition at line 826 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::exportMetadataToHeadBcp47 | ( | Document | $document, |
| ContentMetadataCollector | $metadata, | ||
| string | $defaultTitle, | ||
| Bcp47Code | $lang ) |
| Document | $document | |
| ContentMetadataCollector | $metadata | |
| string | $defaultTitle | |
| Bcp47Code | $lang |
Definition at line 540 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::filterDeprecationForTest | ( | string | $regex | ) |
Definition at line 831 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::galleryOptions | ( | ) |
Definition at line 238 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::getAsyncFallbackMessageKey | ( | ) |
Return the localization key we should use for asynchronous fallback content.
Definition at line 793 of file SiteConfig.php.
|
protected |
Return list of magic word IDs used for behavior switches.
Definition at line 663 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::getExternalLinkTarget | ( | ) |
Definition at line 785 of file SiteConfig.php.
|
protected |
Definition at line 668 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::getHistogramBuckets | ( | float | $mean, |
| int | $skip ) |
Generate buckets based on skip and mean.
| float | $mean | |
| int | $skip |
Definition at line 221 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::getLogger | ( | ) |
Definition at line 146 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::getMagicWordMatcher | ( | string | $id | ) |
Definition at line 678 of file SiteConfig.php.
|
protected |
Definition at line 673 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::getMaxTemplateDepth | ( | ) |
Definition at line 723 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::getMWConfigValue | ( | string | $key | ) |
Lookup config.
| string | $key |
Definition at line 500 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::getNoFollowConfig | ( | ) |
Definition at line 776 of file SiteConfig.php.
|
protected |
Definition at line 708 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::getObjectFactory | ( | ) |
Definition at line 141 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::getParameterizedAliasMatcher | ( | array | $words | ) |
Definition at line 683 of file SiteConfig.php.
|
protected |
Definition at line 772 of file SiteConfig.php.
|
protected |
Definition at line 746 of file SiteConfig.php.
References NS_SPECIAL.
|
protected |
Definition at line 765 of file SiteConfig.php.
|
protected |
Return list of magic word IDs used for magic variables (memoized zero-argument parser functions).
Definition at line 655 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::incrementCounter | ( | string | $name, |
| array | $labels, | ||
| float | $amount = 1 ) |
Increment a counter metric.
| string | $name | |
| array | $labels | |
| float | $amount |
Definition at line 232 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::interwikiMagic | ( | ) |
Definition at line 391 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::interwikiMap | ( | ) |
Definition at line 401 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::iwp | ( | ) |
Definition at line 461 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::langBcp47 | ( | ) |
Definition at line 481 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::langConverterEnabledBcp47 | ( | Bcp47Code | $lang | ) |
Definition at line 508 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::legalTitleChars | ( | ) |
Definition at line 465 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::linkPrefixRegex | ( | ) |
Definition at line 469 of file SiteConfig.php.
|
protected |
Definition at line 477 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::magicLinkEnabled | ( | string | $which | ) |
Definition at line 396 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::mainpage | ( | ) |
Definition at line 485 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::mainPageLinkTarget | ( | ) |
Definition at line 490 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::metrics | ( | ) |
Definition at line 167 of file SiteConfig.php.
Referenced by MediaWiki\Rest\Handler\ParsoidHandler\__construct().
| MediaWiki\Parser\Parsoid\Config\SiteConfig::namespaceCase | ( | int | $ns | ) |
Definition at line 371 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::namespaceHasSubpages | ( | int | $ns | ) |
Definition at line 366 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::namespaceId | ( | string | $name | ) |
Definition at line 354 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::namespaceIsTalk | ( | int | $ns | ) |
Definition at line 376 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::namespaceName | ( | int | $ns | ) |
Definition at line 360 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::observeHistogram | ( | string | $name, |
| float | $value, | ||
| array | $buckets, | ||
| array | $labels ) |
Record a histogram metric.
| string | $name | |
| float | $value | A time value in milliseconds |
| array | $buckets | The buckets used in this histogram |
| array | $labels | The metric labels |
Definition at line 207 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::observeTiming | ( | string | $name, |
| float | $value, | ||
| array | $labels ) |
Record a timing metric.
| string | $name | |
| float | $value | A time value in milliseconds |
| array | $labels |
Definition at line 193 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::prefixedStatsFactory | ( | ) |
Create a prefixed StatsFactory for parsoid stats.
Definition at line 181 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::redirectRegexp | ( | ) |
Definition at line 320 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::relativeLinkPrefix | ( | ) |
Definition at line 297 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::rtl | ( | ) |
Definition at line 504 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::script | ( | ) |
Definition at line 521 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::scriptpath | ( | ) |
Definition at line 525 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::server | ( | ) |
Definition at line 529 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::setMaxTemplateDepth | ( | int | $depth | ) |
Overrides the max template depth in the MediaWiki configuration.
Definition at line 730 of file SiteConfig.php.
|
protected |
Definition at line 716 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::specialPageLocalName | ( | string | $alias | ) |
Definition at line 386 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::supportsContentModel | ( | string | $model | ) |
Returns true iff Parsoid natively supports the given content model.
| string | $model | content model identifier |
Definition at line 804 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::timezoneOffset | ( | ) |
Definition at line 567 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::ucfirst | ( | string | $str | ) |
Definition at line 381 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::variants | ( | ) |
Language variant information.
Definition at line 579 of file SiteConfig.php.
References wfDeprecated().
| MediaWiki\Parser\Parsoid\Config\SiteConfig::variantsFor | ( | Bcp47Code | $code | ) |
Language variant information for the given language (or null if unknown).
| Bcp47Code | $code | The language for which you want variant information |
Definition at line 627 of file SiteConfig.php.
| MediaWiki\Parser\Parsoid\Config\SiteConfig::widthOption | ( | ) |
Definition at line 643 of file SiteConfig.php.
| const MediaWiki\Parser\Parsoid\Config\SiteConfig::CONSTRUCTOR_OPTIONS |
Definition at line 61 of file SiteConfig.php.