Příručka:Parsovací funkce

This page is a translated version of the page Manual:Parser functions and the translation is 100% complete.
MediaWiki extensions

Funkce analyzátoru, přidané v MediaWiki 1.7, jsou typem rozšíření, které se úzce integruje s analyzátorem. Fráze "funkce analyzátoru" by se neměla zaměňovat s Rozšíření:ParserFunctions , což je sbírka jednoduchých funkcí analyzátoru. (Viz Nápověda:Rozšíření:ParserFunctions .)

Popis

Zatímco se očekává, že rozšíření tagu vezme nezpracovaný text a vrátí HTML do prohlížeče, funkce analyzátoru může "interagovat" s ostatními prvky wiki na stránce. Například výstup funkce analyzátoru lze použít jako parametr šablony nebo při konstrukci odkazu.

Typická syntaxe funkce parseru je:

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

Další informace najdete v the dokumentaci pro Parser::setFunctionHook ( $id, $callback, $flags = 0 ). Tato dokumentace uvádí:

Funkce zpětného volání by měla mít tvar:
function myParserFunction( $parser, $arg1, $arg2, $arg3 ) { ... }
Nebo s SFH_OBJECT_ARGS:
function myParserFunction( $parser, $frame, $args ) { ... }

První varianta volání předává všechny argumenty jako prostý text. Druhý předá všechny argumenty jako pole PPNode , kromě prvního ($args[0]), který je aktuálně textový, i když se to může v budoucnu změnit. Ty představují nerozbalený wikitext. Parametr $frame lze použít k rozšíření těchto argumentů podle potřeby. To se běžně používá pro podmíněné zpracování, takže pomocí funkce analyzátoru typu if nebo switch se vyhodnotí pouze "skutečný" případ. Objekt frame může také vylézt po stromě dokumentu, aby získal informace o volajícím, a má funkce pro určení a správu hloubky volání, doby trvání a toho, zda je výsledek funkce analyzátoru nestálý.

Vytvoření funkce analyzátoru je o něco složitější než vytvoření nového tagu, protože název funkce musí být kouzelné slovo, klíčové slovo, které podporuje aliasy a lokalizaci.

Jednoduchý příklad

Níže je uveden příklad rozšíření, které vytváří funkci analyzátoru.

Registrace jde do extension.json a kód do 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 {
   // Zaregistrujte všechna zpětná volání vykreslení pomocí analyzátoru
   public static function onParserFirstCallInit( Parser $parser ) {

      // Vytvořte funkční háček spojující magické slovo "example" s renderExample()
      $parser->setFunctionHook( 'example', [ self::class, 'renderExample' ] );
   }

   // Vykreslete výstup {{#example:}}.
   public static function renderExample( Parser $parser, $param1 = '', $param2 = '', $param3 = '' ) {

      // Vstupními parametry jsou wikitext s rozšířenými šablonami.
      // Výstupem by měl být také wikitext.
      $output = "param1 is $param1 and param2 is $param2 and param3 is $param3";

      return $output;
   }
}

Další soubor, ExampleExtension.i18n.php, ve vašem adresáři rozšíření (ne v podadresáři src/) by měl obsahovat:

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

$magicWords = [];

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

S povoleným tímto rozšířením,

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

zobrazí se:

  • param1 je hello a param2 je hi a param3 je hey
Toto pole magicWords není volitelné. Pokud je vynecháno, funkce analyzátoru jednoduše nebude fungovat. {{#example: hello | hi}} bude vykresleno, jako by rozšíření nebylo nainstalováno. Pokud je inicializováno pouze pole specifické pro daný jazyk a nikoli samotné pole magicWords, může to způsobit chyby lokalizace, protože překlady z jiných rozšíření pronikají do vašeho. Kouzelná slova můžete přidružit inline v PHP spíše než prostřednictvím souboru i18n. To je užitečné při definování háčků v LocalSettings.php
MediaWiki\MediaWikiServices::getInstance()->getContentLanguage()->mMagicExtensions['wikicodeToHtml'] = ['MAG_CUSTOM', 'custom'];

V rámci LocalSettings.php

Magická slova a jejich funkce analyzátoru mohou být zcela definovány v 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];
}

Delší funkce

Pro delší funkce můžete chtít rozdělit funkce háčku do souboru _body.php nebo .hooks.php a vytvořit z nich statické funkce třídy. Poté můžete načíst třídu pomocí $wgAutoloadClasses a volat statické funkce v háčcích. Např.:

Vložte toto do svého souboru extension.json:

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

Pak to vložte do svého souboru src/ExampleExtensionHooks.php:

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

Rozhraní analyzátoru

Řízení analýzy výstupu

Chcete-li, aby byl wikitext vrácený vaší funkcí analýzy plně analyzován (včetně rozšíření šablon), nastavte při návratu možnost noparse na false:

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

Zdá se, že výchozí hodnota noparse se změnila z false na true, alespoň v některých situacích, někdy kolem verze 1.12.

A naopak, chcete-li, aby vaše funkce analyzátoru vracela HTML, který zůstane neanalyzovaný, namísto vracení wikitextu, použijte toto:

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

Pojmenování

Ve výchozím nastavení přidává MW k názvu každé funkce analyzátoru znak hash (znak čísla, "#"). Chcete-li toto přidání potlačit (a získat funkci analyzátoru bez předpony "#"), zahrňte konstantu SFH_NO_HASH do volitelného argumentu flags pro setFunctionHook, jak je popsáno níže.

Při výběru názvu bez předpony hash si uvědomte, že transkluze stránky s názvem začínajícím tímto názvem funkce následovaným dvojtečkou již není možné. Zejména se vyhněte názvům funkcí rovným názvu oboru názvů. V případě, že je povoleno interwiki transkluze [1], vyhněte se také názvům funkcí rovným interwiki prefixu.

Háček setFunctionHook

Další podrobnosti o rozhraní do analyzátoru najdete v dokumentaci k setFunctionHook v include/Parser.php. Zde je (pravděpodobně datovaná) kopie těchto komentářů:

funkce setFunctionHook( $id, $callback, $flags = 0 )

Parametry:

  • string $id – ID kouzelného slova
  • smíšené $callback - Funkce zpětného volání (a objekt), která se má použít
  • integer $flags - Volitelné, nastavte jej na konstantu SFH_NO_HASH pro volání funkce bez "#".

Vrácená hodnota: Stará funkce zpětného volání pro toto jméno, pokud existuje

Vytvořte funkci, např. {{#sum:1|2|3}}. Funkce zpětného volání by měla mít tvar:

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

Zpětné volání může buď vrátit textový výsledek funkce, nebo pole s textem v prvku 0 a řadou příznaků v ostatních prvcích. Názvy příznaků jsou uvedeny v klíčích. Platné příznaky jsou:

Name Type Default Description
found Boolean true true, pokud je vrácený text platný a zpracování šablony se musí zastavit.
text ? ? Text vrácený funkcí. Pokud je zadáno isChildObj nebo isLocalObj, měl by to být uzel DOM.
noparse Boolean true true, pokud by text neměl být předzpracován do stromu DOM, např. nebezpečné HTML tagy by neměly být odstraněny atd.
isHTML Boolean ? true, pokud je vrácený text HTML a musí být chráněn proti transformaci wikitextu. Ale viz diskuze
nowiki Boolean usually false true, pokud má být označení wiki v návratové hodnotě (textu) escapováno.
isChildObj Boolean ? true, pokud je text uzel DOM, který potřebuje rozšíření v podřízeném rámci.
isLocalObj Boolean ? true, pokud je text uzlem DOM, který potřebuje rozšíření v aktuálním rámci. Výchozí hodnota závisí na dalších hodnotách a výsledcích.
preprocessFlags ? false Volitelné příznaky PPFrame , které se mají použít při analýze vráceného textu. To platí pouze v případě, že noparse je false.
title ? false Objekt Title , ze kterého text pochází.
forceRawInterwiki Boolean ? true, pokud musí být transkluze interwiki vynucena k provedení v nezpracovaném režimu a nikoli k vykreslení.

Nároččné funkce analyzátoru

Některé funkce analyzátoru představují významné využití zdrojů wiki a měly by být označeny jako "náročné". Počet náročných funkcí analyzátoru na dané stránce je omezen nastavením $wgExpensiveParserFunctionLimit . To, co se považuje za náročné, je ponecháno na samotné funkci, ale obvykle by se mělo zvážit vše, co pravděpodobně způsobí zpoždění přesahující pouhé zpracování dat. To zahrnuje věci jako čtení a zápis databáze, synchronní spouštění skriptu shellu nebo manipulaci se soubory. Na druhou stranu ne všechny takové funkce by měly být nutně označeny. Například sémantická MediaWiki označuje za náročné pouze procento přečtení své databáze. To je způsobeno skutečností, že na některých datově náročných stránkách může snadno překročit běžné limity funkce náročného analyzátoru. V případech, jako je tento, je potenciál znatelně pomalejšího výkonu, který není označen jako nnáročý, kompromisem za funkcionalitu, kterou SMW nabízí.

Chcete-li funkci analyzátoru označit jako náročnou, v těle kódu funkce použijte $result = $parser->incrementExpensiveFunctionCount();. Vrácená hodnota bude false, pokud byl dosažen nebo překročen limit náročných funkcí.

Pojmenované parametry

Funkce analyzátoru nepodporují pojmenované parametry jako šablony a rozšíření značek, ale občas je užitečné je předstírat. Uživatelé jsou často zvyklí používat k oddělení argumentů svislé čáry ( | ), takže je hezké, že to lze udělat i v kontextu funkce analyzátoru. Zde je jednoduchý příklad, jak toho dosáhnout:

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

Související odkazy

General and related guides:

Code:

Examples: