Manual:Parser functions/fr

Les fonctions d'analyse syntaxique (fonctions parseur), ajoutées dans MediaWiki 1.7, sont une sorte d'extension en relation directe avec l'analyseur syntaxique (parseur). L'expression "fonction parseur" ne dois pas être confondue avec Extension:ParserFunctions, qui est une collection de fonctions parseur simples. (Voir Help:Extension:ParserFunctions pour obtenir plus d'informations sur celles-ci.)

Description
Alors qu'une balise Extension de balise est conçue pour prendre le texte non traité et retourner le code HTML résultant vers le navigateur, une fonction d'analyse syntaxique (parseur) peut « interagir » avec d'autres éléments wiki dans la page. Par exemple, la sortie d'une fonction d'analyse syntaxique peut être utilisée comme paramètre de modèle ou dans la construction d'un lien.

La syntaxe typique pour une fonction parseur est :

Pour obtenir plus d'informations, voir for. Cette documentation indique :
 * La fonction de rappel devrait ressembler à :
 * Ou avec :
 * Ou avec :

Créer une fonction parseur est légèrement plus compliquée que de créer une nouvelle balise car le nom de la fonction doit être un mot magique, un mot clé qui supporte les alias et la localisation.

Exemple simple
Ci-dessous, un exemple d'une extension qui créé une fonction parseur.

L'enregistrement va dans extension.json, le code dans ExampleExtension.class.php:

Un autre fichier, ExampleExtension.i18n.php, devrait contenir :

Avec cette extension activée,



produit :


 * param1 is hello and param2 is hi and param3 is hey

Ce mot magique "array" n'est pas optionnel. S'il est omis, la fonction parseur ne sera simplement pas exécutée; La variable sera traitée comme si l'extension n'avait pas été installé.

Gardez à l'esprit que les entrées pour  seront ignorées s'il existe une entrée dans   avec la même clé. Pour rester sur la bonne voie, vous pouvez utiliser ce qui suit:

Fonctions complexes
Pour les fonctions plus complexes, vous pouvez diviser les fonctions "hook" sur ​​un fichier _body.php ou un fichier .hooks.php et les définir comme des fonctions statiques d'une classe. Ensuite, vous pouvez charger la classe avec et appeler les fonctions statiques dans les crochets; par exemple :

Mettre ceci dans votre fichier  : Puis mettre ceci dans votre fichier  :
 * Voir: écrire un gestionnaire d'événements pour d'autres styles.

Caching
Idem extensions de balise, $parser->disableCache peut être utilisé pour désactiver le cache pour les extensions dynamiques.

Contrôler l'analyse de la sortie
Pour que le wikitext retourné par la fonction parseur soit complètement analysé (en incluant les expansions des modèles), définissez l'option noparse à "false" lors du retour :

Il semblerait que la valeur par défaut de noparse a changé de "faux" à "vrai", au moins dans certaines situations, parfois aux alentours de la version 1.12.

Inversement, pour faire en sorte que le code HTML retourné par votre fonction parseur reste "non-parsé" (à la place d'avoir du wikitext), utilisez ceci :

However, This is a test. will produce something like this:

This is

Le param1 est "hello", le param2 est "hi" et le param3 est "hey a test".

Cela est dû à un codage en dur des retours à la ligne "\n\n" qui est préfixé à la sortie HTML des fonctions d'analyse. Pour éviter cela et s'assurer que le code HTML soit bien disposé en ligne vers le texte qui l'entoure, vous pouvez utiliser ceci :

Nommage
Par défaut, MW ajoute un caractère dièse (signe dièse, "#") au nom de chaque fonction parseur. Pour supprimer cette ajout (et obtenir une fonction parseur sans préfixe "# "), inclure la constante SFH_NO_HASH dans l'argument optionnel "drapeaux" pour setFunctionHook, comme décrit ci-dessous.

When choosing a name without a hash prefix, note that transclusion of a page with a name starting with that function name followed by a colon is no longer possible. In particular, avoid function names equal to a namespace name. In the case that interwiki transclusion is enabled, also avoid function names equal to an interwiki prefix.

The setFunctionHook hook
For more details of the interface into the parser, see the documentation for setFunctionHook in includes/Parser.php. Here's a (possibly dated) copy of those comments:

function setFunctionHook( $id, $callback, $flags = 0 ) Parameters:


 * string $id - The magic word ID
 * mixed $callback - The callback function (and object) to use
 * integer $flags - Optional, set it to the SFH_NO_HASH constant to call the function without "#".

Return value: The old callback function for this name, if any

Create a function, e.g.,. The callback function should have the form:

The callback may either return the text result of the function, or an array with the text in element 0, and a number of flags in the other elements. The names of the flags are specified in the keys. Valid flags are:


 * found : The text returned is valid, stop processing the template. This is on by default.
 * nowiki : Wiki markup in the return value should be escaped
 * noparse : Unsafe HTML tags should not be stripped, etc.
 * noargs : Don't replace triple-brace arguments in the return value
 * isHTML : The returned text is HTML, armour it against wikitext transformation

Named parameters
Parser functions do not support named parameters the way templates and tag extensions do, but it is occasionally useful to fake it. Users are often accustomed to using vertical bars ( | ) to separate arguments, so it's nice to be able to do that in the parser function context, too. Here's a simple example of how to accomplish this: