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

Lorsque l'on choisit un nom sans préfixe #, notez que la "transclusion" d'une page avec un nom commençant par le nom de cette fonction suivi par deux points n'est plus possible. En particulier, évitez les noms de fonction identiques à un nom d'espace de noms. Dans le cas où cette "transclusion" Interwiki est activée, évitez également les noms de fonctions identiques à un préfixe interwiki.

Le crochet setFunctionHook
Pour plus de détails sur l'interface dans l'analyseur syntaxique, consultez la documentation de setFunctionHook dans le fichier includes/parser.php. Voici une (peut-être datée) copie de ces observations :

function setFunctionHook( $id, $callback, $flags = 0 ) Paramètres:


 * string $id - L'identificateur (ID) du mot magique
 * mixed $callback - La fonction de rappel (et l'objet) à utiliser
 * integer $flags - Optionnel, la définir sur la constante SFH_NO_HASH pour appeler la fonction sans "#".

Return value: L'ancienne fonction de rappel pour ce nom, le cas échéant.

Créer une fonction, par exemple. La fonction de rappel doit avoir la forme :

Le rappel peut soit renvoyer le résultat de la fonction sous la forme d'une chaîne de caractères, soit renvoyer un tableau avec le texte dans l'élément 0 et un certain nombre de drapeaux dans les autres éléments. Les noms des drapeaux sont spécifiés dans les clés. Les drapeaux valides sont:


 * found : Le texte renvoyé est valide, arrêtez le traitement du modèle. Ceci est activé par défaut.
 * nowiki : La balise Wiki dans la valeur de retour doit être échappée.
 * noparse : Les balises HTML dangereuses ne doivent pas être supprimées, etc.
 * noargs : Ne pas remplacer les arguments triple accolade dans la valeur de retour.
 * isHTML : Le texte retourné est au format HTML, protégé contre la transformation en texte wiki.

Paramètres nommés
Les fonctions d'analyse syntaxique ne prennent pas en charge les paramètres nommés comme le font les modèles et les balises extensions, mais il est parfois utile de les imiter. Les utilisateurs sont souvent habitués à utiliser des barres verticales ( | ) pour séparer les arguments, il est donc aussi intéressant de pouvoir le faire dans le contexte de la fonction de l'analyseur syntaxique. Voici un exemple simple pour illustrer ceci :

Voir aussi

 * L' Extension des fonctions Parseur est une collection bien connue des fonctions d'analyse syntaxique.
 * L' Extension des fonctions Parseur est une collection bien connue des fonctions d'analyse syntaxique.
 * L' Extension des fonctions Parseur est une collection bien connue des fonctions d'analyse syntaxique.
 * L' Extension des fonctions Parseur est une collection bien connue des fonctions d'analyse syntaxique.
 * L' Extension des fonctions Parseur est une collection bien connue des fonctions d'analyse syntaxique.
 * L' Extension des fonctions Parseur est une collection bien connue des fonctions d'analyse syntaxique.
 * L' Extension des fonctions Parseur est une collection bien connue des fonctions d'analyse syntaxique.
 * L' Extension des fonctions Parseur est une collection bien connue des fonctions d'analyse syntaxique.