Manuel:Fonctions d'analyse

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Parser functions and the translation is 100% complete.

Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Tiếng Việt • ‎dansk • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎русский • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어
OOjs UI icon puzzle-ltr.svg Extensions: Développement Extensions de balise Manuel:Fonctions d'analyse Points d’accroche Pages spéciales Manuel:Habillage Manuel:Mots magiques API Content models
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 Help: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 ) { ... }"

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

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' ] );
      }
}


Mise en cache

De la même façon que pour les extensions de balise, $parser->disableCache() peut être utilisé pour désactiver le cache pour les extensions dynamiques.

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 ];

Cependant, This is {{#example:hello | hi | hey }} a test. produira quelque chose comme ceci :

This is

Le param1 est "hello", le param2 est "hi" et le param3 est "hey" un 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 syntaxique. Pour éviter cela et s'assurer que le code HTML soit bien disposé en ligne dans le texte qui l'entoure, vous pouvez utiliser ceci :

return $parser->insertStripItem( $output, $parser->mStripState );

Nommage

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

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 :

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égez le 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 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) );

	#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 = array();

	foreach ( $options as $option ) {
		$pair = explode( '=', $option, 2 );
		if ( count( $pair ) === 2 ) {
			$name = trim( $pair[0] );
			$value = trim( $pair[1] );
			$results[$name] = $value;
		}

		if ( count( $pair ) === 1 ) {
			$name = trim( $pair[0] );
			$results[$name] = true;
		}
	}
	//Now you've got an array that looks like this:
	//  [foo] => "bar"
	//	[apple] => "orange"
	//	[banana] => true

	return $results;
}

Voir aussi