Manuel:ParserOptions.php
| Fichier MediaWiki : ParserOptions.php | |
|---|---|
| Emplacement : | includes/parser/ |
| Code source : | master • 1.43.1 • 1.42.6 • 1.39.12 |
| Classes : | ParserOptions |
Description
Ce fichier initialise les paramètres de Parser. Il contient un nombre de variables et des fonctions pour obtenir et pour initialiser ces paramètres. Toutes les variables sont supposées être privées en théorie, bien qu'en pratique ce ne soit pas le cas. Les attributs de ParserOptions sont initialisés à l'aide d'un objet User.
Méthodes publiques
Méthodes publiques, à l'exclusion des méthodes obsolètes depuis longtemps et des méthodes uniquement à usage interne :
- getOption() - rechercher une option et tracer son utilisation
- setOption() - définir une option de manière générique
- getInterwikiMagic() - s'il faut extraire les liens interlangues (booléen)
- setInterwikiMagic() - spécifier s'il faut extraire les liens interlangue.
- getAllowExternalImages() - si toutes les images externes sont autorisées en ligne
- getAllowExternalImagesFrom() - quelles images externes autoriser
- getEnableImageWhitelist() - s'il faut utiliser la liste blanche du wiki des images externes
- getAllowSpecialInclusion() - si l'inclusion des pages spéciales est autorisée
- setAllowSpecialInclusion()
- getInterfaceMessage() - s'il faut analyser syntaxiquement un message d'interface
- setInterfaceMessage()
- getTargetLanguage()
- setTargetLanguage()
- getMaxIncludeSize()
- setMaxIncludeSize()
- getMaxPPNodeCount()
- setMaxPPNodeCount() - nombre maximum de nœuds couverts par PPFrame::expand()
- getMaxPPExpandDepth() - profondeur maximale de récursion dans PPFrame::expand()
- getMaxTemplateDepth() - profondeur maximale de récursion des modèles dans les modèles
- setMaxTemplateDepth()
- getExpensiveParserFunctionLimit()
- setExpensiveParserFunctionLimit()
- getRemoveComments()
- setRemoveComments()
- getCleanSignatures()
- setCleanSignatures()
- getExternalLinkTarget() - attribut cible pour les liens externes.
- setExternalLinkTarget()
- getDisableContentConversion()
- disableContentConversion()
- getDisableTitleConversion()
- disableTitleConversion()
- getThumbSize() - obtenir la taille des vignettes préférée de l'utilisateur.
- setThumbSize()
- getIsPreview() - s'il faut analyser syntaxiquement la page lors de la création de l'aperçu.
- setIsPreview()
- getIsSectionPreview() - s'il faut analyser syntaxiquement la page lors de la création de l'aperçu pour une section unique.
- setIsSectionPreview()
- getIsPrintable() - si la version imprimable de la page doit être analysée syntaxiquement.
- setIsPrintable()
- getPreSaveTransform() - si le balisage du wiki doit être transformé lors du sauvegarde de la page
- setPreSaveTransform()
- getDateFormat()
- setDateFormat()
- getUserLangObj() - obtenir la langue de utilisateur utilisée par l'analyseur syntaxique pour cette page et segmenter le cache de l'analyseur.
- setUserLangObj()
- getUserLang() - identique à getUserLangObj() mais renvoie une chaîne de caractères à la place.
- setUserLang()
- getMagicISBNLinks()
- getMagicPMIDLinks()
- getMagicRFCLinks()
- getSuppressTOC() - depuis la version 1.39. Doit-on supprimer la table des matières ?
- setSuppressTOC() - depuis la version 1.39.
- getAllowUnsafeRawHtml()
- setAllowUnsafeRawHtml()
- getWrapOutputClass()
- setWrapOutputClass()
- getCurrentRevisionRecordCallback()
- setCurrentRevisionRecordCallback()
- getTemplateCallback() - procédure de rappel pour retrouver le modèle; premier argument de call_user_func().
- setTemplateCallback()
- getSpeculativeRevId()
- setSpeculativeRevIdCallback()
- getSpeculativePageId()
- setSpeculativePageIdCallback()
- getTimestamp()
- setTimestamp()
- getRedirectTarget()
- setRedirectTarget()
- addExtraKey()
- getUserIdentity()
Obtenir les objets ParserOptions :
- newFromAnon()
- newFromUser() - obtenir un objet ParserOptions à partir d'un utilisateur donné.
- newFromUserAndLang() - obtenir un objet de ParserOptions d'un utilisateur donné et d'une langue donnée.
- newFromContext() - obtenir un objet ParserOptions à partir d'un objet IContextSource.
- newFromUserAndLang()
- newCanonical() - obsolète.
Contrôles et divers :
- matches() - vérifier si ces options correspondent à celles d'un autre ensemble d'options
- matchesForCacheKey()
- registerWatcher() - enregistrer une procédure de rappel pour suivre les ParserOptions utilisés.
- optionUsed() - enregistrer qu'une option a été accédée en interne.
- allCacheVaryingOptions()
- optionsHash() - générer une chaîne de hachage avec les valeurs définies sur ces ParserOptions
- isSafeToCache() - vérifier si ces options sont sécurisées pour être mises en cache.
- setupFakeRevision()