MediaWiki

Fonctions d'analyse

This page is a translated version of the page Manual:Parser functions and the translation is 67% complete.
Outdated translations are marked like this.
Languages:
Extensions :
MediaWiki extensions

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 Extension:ParserFunctions , qui est une collection de fonctions parseur simples (voir Aide:Extension:Fonctions d'analyse 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 :

{{ #functionname: param1 | param2 | param3 }}

Pour obtenir plus d'informations, voir la documentation pour Parser::setFunctionHook ( $id, $callback, $flags = 0 ). Cette documentation indique :

La fonction de rappel (callback) devrait ressembler à :
function myParserFunction( $parser, $arg1, $arg2, $arg3 ) { ... }
Ou avec SFH_OBJECT_ARGS:
function myParserFunction( $parser, $frame, $args ) { ... }

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 PPNode s, except for the first ($args[0]), which is currently text, though this may change in the future. Ceci représente le wikicode non développé. The $frame 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 : 

{
	"name": "ExampleExtension",
	"author": "Me",
	"version": "1.0.0",
	"url": "https://www.mediawiki.org/wiki/Extension:ExampleExtension",
	"descriptionmsg": "exampleextension-desc",
	"license-name": "GPL-2.0-or-later",
	"type": "parserhook",
	"MessagesDirs": {
		"ExampleExtension": [
			"i18n"
		]
	},
	"AutoloadClasses": {
		"ExampleExtensionHooks": "src/ExampleExtensionHooks.php"
	},
	"ExtensionMessagesFiles": {
		"ExampleExtensionMagic": "ExampleExtension.i18n.php"
	},
	"Hooks": {
		"ParserFirstCallInit": "ExampleExtensionHooks::onParserFirstCallInit"
	},
	"manifest_version": 1
}

<?php
class ExampleExtensionHooks {
   // Enregistrement et rendu des fonctions de rappel ( callbacks) avec l'analyseur syntaxique
   public static function onParserFirstCallInit( Parser $parser ) {

      // Créer une fonction d'accroche en associant le  mot magique "example" avec renderExample()
      $parser->setFunctionHook( 'example', [ self::class, 'renderExample' ] );
   }

   // Rendu du résultat de {{#example:}}.
   public static function renderExample( Parser $parser, $param1 = '', $param2 = '', $param3 = '' ) {

      // Les paramètres d'entrée sont du texte wiki avec des modèles étendus.
      // La sortie devrait être également un wikitext.
      $output = "param1 is $param1 and param2 is $param2 and param3 is $param3";

      return $output;
   }
}

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

<?php
/**
 * @license GPL-2.0-or-later
 * @author Your Name (YourUserName)
 */

$magicWords = [];

/** English
 * @author Your Name (YourUserName)
 */
$magicWords['en'] = [
   'example' => [ 0, 'example' ],
];

Avec cette extension activée,

  • {{#example: hello | hi | hey}}

produit :

  • param1 is hello and param2 is hi and param3 is hey
Ce tableau de mots magiques n'est pas optionnel. S'il est omis, la fonction parseur ne sera simplement pas exécutée; la variable {{#example: hello | hi}} sera traitée comme si l'extension n'avait pas été installée. Si uniquement le tableau spécifique à la langue est initialisé et pas celui de magicWords, il peut se produire des erreurs d'internationalisation dûes aux traductions venant des autres extensions et en conflit avec les votres. Vous pouvez associer les mots magiques en ligne dans PHP plutôt que par l'intermédiaire d'un fichier i18n. Ceci est utile lorsque vous définissez les accroches dans LocalSettings.php 
MediaWiki\MediaWikiServices::getInstance()->getContentLanguage()->mMagicExtensions['wikicodeToHtml'] = ['MAG_CUSTOM', 'custom'];

Dans LocalSettings.php

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

$wgHooks['ParserFirstCallInit'][] = function ( Parser $parser ) 
{
	MediaWiki\MediaWikiServices::getInstance()->getContentLanguage()->mMagicExtensions['wikicodeToHtml'] = ['wikicodeToHtml', 'wikicodeToHtml'];

	$parser->setFunctionHook( 'wikicodeToHtml', 'wikicodeToHtml' );
};
 
function wikicodeToHtml( Parser $parser, $code = '' ) 
{
	$title = $parser->getTitle();
	$options = $parser->Options();
	$options->enableLimitReport(false);
	$parser = $parser->getFreshParser();
	return [$parser->parse($code, $title, $options)->getText(), 'isHTML' => true];
}

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 $wgAutoloadClasses et appeler les fonctions statiques dans les accrohes; par exemple :

Mettre ceci dans votre fichier extension.json : 

"Hooks": {
	"ParserFirstCallInit": "ExampleExtensionHooks::onParserFirstCallInit"
},
"AutoloadClasses": {
	"ExampleExtensionHooks": "src/ExampleExtensionHooks.php"
}

Puis mettre ceci dans votre fichier src/ExampleExtensionHooks.php : 

class ExampleExtensionHooks {
      public static function onParserFirstCallInit( Parser $parser ) {
           $parser->setFunctionHook( 'example', [ self::class, 'renderExample' ] );
      }
}

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 noparse à faux lors du retour : 

return [ $output, 'noparse' => false ];

Il semblerait que la valeur par défaut de noparse 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 : 

return [ $output, 'noparse' => true, 'isHTML' => true ];

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 [1] 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 "#".

Set it to SFH_OBJECT_ARGS (2) to pass a PPFrame object and array of arguments instead of a series of function arguments, for which see above. Defaults to 0 (no flags).

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

Créer une fonction, par exemple {{#sum:1|2|3}}. La fonction de rappel doit avoir la forme : 

function myParserFunction( $parser, $arg1, $arg2, $arg3 ) { ... }

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 :

Name Type Default Description
found Boolean true Le texte renvoyé est valide, arrêtez le traitement du modèle. Ceci est activé par défaut.
text ? ? The text to return from the function. If isChildObj or isLocalObj are specified, this should be a DOM node instead.
noparse Boolean true Les balises HTML dangereuses ne doivent pas être supprimées, etc.
isHTML Boolean ? Le texte retourné est au format HTML, protégez le contre la transformation en texte wiki. But see discussion
nowiki Boolean usually false La balise Wiki dans la valeur de retour doit être échappée
isChildObj Boolean ? true if the text is a DOM node needing expansion in a child frame.
isLocalObj Boolean ? true if he text is a DOM node needing expansion in the current frame. The default value depends on other values and outcomes.
preprocessFlags ? false Optional PPFrame flags to use when parsing the returned text. This only applies when noparse is false.
title ? false The Title object where the text came from.
forceRawInterwiki Boolean ? true if interwiki transclusion must be forced to be done in raw mode and not rendered.


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 $wgExpensiveParserFunctionLimit 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 $result = $parser->incrementExpensiveFunctionCount();. The return value will be false 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 : 

function ExampleExtensionRenderParserFunction( &$parser ) {
	// Suppose the user invoked the parser function like so:
	// {{#myparserfunction: foo=bar | apple=orange | banana }}

	$options = extractOptions( array_slice( func_get_args(), 1 ) );

	// Now you've got an array that looks like this:
	// [foo] => 'bar'
	// [apple] => 'orange'
	// [banana] => true
	// Continue writing your code...
}

/**
 * Converts an array of values in form [0] => "name=value"
 * into a real associative array in form [name] => value
 * If no = is provided, true is assumed like this: [name] => true
 *
 * @param array string $options
 * @return array $results
 */
function extractOptions( array $options ) {
	$results = [];
	foreach ( $options as $option ) {
		$pair = array_map( 'trim', explode( '=', $option, 2 ) );
		if ( count( $pair ) === 2 ) {
			$results[ $pair[0] ] = $pair[1];
		}
		if ( count( $pair ) === 1 ) {
			$results[ $pair[0] ] = true;
		}
	}
	return $results;
}

Voir aussi

General and related guides:

Code:

Examples:

Retrieved from "https://www.mediawiki.org/w/index.php?title=Manual:Parser_functions/fr&oldid=6466090"