Manual:Parser functions/fr

Les fonctions d'analyse syntaxique (fonctions parseur), ajoutées dans MediaWiki 1.7, sont un type d'extension en relation directe avec l'analyseur syntaxique (parseur). L'expression "fonction parseur" ne doit pas être confondue avec, qui est une collection de fonctions parseur simples (voir pour plus d'informations).

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 pour. Cette documentation indique :


 * La fonction de rappel (callback) devrait ressembler à :
 * Ou avec :
 * Ou avec :

La première version de l'appel passe tous les argument en tant que texte brut. The second passes all arguments as an array of s, except for the first, which is currently text, though this may change in the future. Ceci représente le wikicode non développé. The  parameter can be used to expand these arguments as needed. Ceci est utilisé habituellement pour le traitement conditionnel pour que le cas true soit évalué avec une fonction d'analyse du type si (if) ou sélecteur (switch). L'objet de trame peut également remonter l'arborescence du document pour obtenir les informations concernant l'appelant et possède des fonctions pour déterminer et gérer la profondeur des appels, la durée de validité, et indiquer si le résultat de la fonction d'analyse est volatile.

Créer une fonction parseur est légèrement plus compliqué 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éée une fonction parseur.

L'enregistrement va respectivement dans extension.json et le code dans src/ExampleExtensionHooks.php :

Un autre fichier, ExampleExtension.i18n.php, dans le répertoire de votre extension (et non pas dans le dossier src/) devrait contenir :

Avec cette extension activée,



produit :


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



Dans LocalSettings.php
Magic words and their handling parser functions can be defined entirely in LocalSettings.php.



Fonctions complexes
Pour les fonctions plus complexes, vous pouvez séparer les fonctions d'accroche en ​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 accrohes; par exemple :

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

Puis mettre ceci dans votre fichier  :

Mise en cache
De la même façon que pour les extensions de balise, peut être utilisé pour désactiver le cache pour les extensions dynamiques.

Ceci a un impact négatif significatif sur les performances, donc à n'utiliser que si c'est nécessaire.



Interface Parser


Contrôler l'analyse de la sortie
Pour que le texte wiki retourné par la fonction d'analyse soit complètement analysé (en incluant les expansions des modèles), mettez l'option  à faux lors du retour :

Il semblerait que la valeur par défaut de  ait changé de faux à vrai, tout du 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 analysé, plutôt que de retourner du texte wiki utilisez ceci :

Nommage
Par défaut, MediaWiki ajoute un caractère dièse (signe dièse, "#") au nom de chaque fonction d'analyse. Pour supprimer cet ajout (et obtenir une fonction d'analyse syntaxique sans préfixe "#"), incluez la constante SFH_NO_HASH dans l'argument optionnel de type drapeau 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.



L'accroche 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 copie (peut-être ancienne) 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 :


 * forceRawInterwiki
 * Force interwiki transclusion to be done in raw mode, not rendered.


 * found
 * Le texte renvoyé est valide, arrêtez le traitement du modèle. Ceci est activé par défaut.


 * isChildObj
 * The text is a DOM node needing expansion in a child frame.


 * isHTML
 * Le texte retourné est au format HTML, protégez le contre la transformation en texte wiki. But see discussion


 * isLocalObj
 * The text is a DOM node needing expansion in the current frame.


 * noparse
 * Les balises HTML dangereuses ne doivent pas être supprimées, etc.


 * nowiki
 * La balise Wiki dans la valeur de retour doit être échappée


 * preprocessFlags
 * Use these flags when parsing the returned text. This only applies when noparse is.


 * text
 * The text returned from the function. If isChildObj or isLocalObj are specified, this should be a DOM node instead.


 * title
 * The Title object where the text came from.



Fonctions d'analyse coûteuses
Some parser functions represent a significant use of a wiki's resources and should be marked as "expensive". The number of expensive parser functions on any given page is limited by the setting. What counts as expensive is left up to the function itself, but typically, anything that is likely to cause a delay that extends beyond simple processing of data should be considered. This includes things like database reads and writes, launching a shell script synchronously, or file manipulation. On the other hand, not all such functions should necessarily be tagged. Semantic MediaWiki, for example, only marks a percentage of its database reads as expensive. This is due to the fact that on certain data-intensive pages, it could easily overflow the normal expensive parser function limits. In cases like this, the potential for noticeably slower performance that doesn't get flagged as expensive is a trade-off to having the functionality that SMW offers.

To mark your parser function as expensive, from within the body of the function's code, use. The return value will be if the expensive function limit has been reached or exceeded.



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 d'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.
 * - liste (incomplète) des fonctions d'analyse fournies par le noyau et les extensions
 * La bibliothèque PHP Parser Hooks, qui fournit une interface orientée objet pour les accroches déclaratives de l'analyseur syntaxique
 * L' Extension des fonctions Parseur est une collection bien connue des fonctions d'analyse syntaxique.
 * - liste (incomplète) des fonctions d'analyse fournies par le noyau et les extensions
 * La bibliothèque PHP Parser Hooks, qui fournit une interface orientée objet pour les accroches déclaratives de l'analyseur syntaxique
 * L' Extension des fonctions Parseur est une collection bien connue des fonctions d'analyse syntaxique.
 * - liste (incomplète) des fonctions d'analyse fournies par le noyau et les extensions
 * La bibliothèque PHP Parser Hooks, qui fournit une interface orientée objet pour les accroches déclaratives de l'analyseur syntaxique
 * La bibliothèque PHP Parser Hooks, qui fournit une interface orientée objet pour les accroches déclaratives de l'analyseur syntaxique