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 sRozšíření:ParserFunctions, což je sbírka jednoduchých funkcí analyzátoru.(VizNápověda:Rozšíření:ParserFunctions.)

Zatímco se očekává, žerozšíř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 jakoparametr šablony nebo při konstrukciodkazu.

Typická syntaxe funkce parseru je:

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

Další informace najdete vdokumentaci proParser::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 sSFH_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 polePPNode, 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átoruif- neboswitch-like je vyhodnocen pouze případtrue.Objekt frame může také hledat 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ýtkouzelné slovo, klíčové slovo, které podporuje aliasy a lokalizaci.

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

Registrace jde doextension.json a kód dosrc/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}

{"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":"onParserFirstCallInit"},"HookHandlers":{"ExampleExtensionHooks":{"class":"MediaWiki\\Extension\\ExampleExtension\\Hooks"}},"manifest_version":1}

<?phpclassExampleExtensionHooks{// Zaregistrujte všechna zpětná volání vykreslení pomocí analyzátorupublicstaticfunctiononParserFirstCallInit(Parser$parser){// Vytvořte funkční háček spojující magické slovo <code>example</code> s renderExample()$parser->setFunctionHook('example',[self::class,'renderExample']);}// Vykreslete výstup {{#example:}}.publicstaticfunctionrenderExample(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;}}

<?phpclassExampleExtensionHooksimplementsParserFirstCallInitHook{// Register any render callbacks with the parserpublicfunctiononParserFirstCallInit($parser){// Create a function hook associating the <code>example</code> magic word with renderExample()$parser->setFunctionHook('example',[$this,'renderExample']);}// Render the output of {{#example:}}.publicfunctionrenderExample($parser,$param1='',$param2='',$param3=''){// The input parameters are wikitext with templates expanded.// The output should be wikitext too.$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 Vaše jméno (YourUserName) */$magicWords=[];/** English * @author Vaše jméno (YourUserName) */$magicWords['en']=['example'=>[0,'example'],];

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

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

zobrazí se:

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

MediaWiki\MediaWikiServices::getInstance()->getContentLanguage()->mMagicExtensions['wikicodeToHtml']=['MAG_CUSTOM','custom'];

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');};functionwikicodeToHtml(Parser$parser,$code=''){$title=$parser->getTitle();$options=$parser->Options();$options->enableLimitReport(false);$parser=$parser->getFreshParser();return[$parser->parse($code,$title,$options)->getText(),'isHTML'=>true];}

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 souboruextension.json:

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

• Viz:Zápis obsluhy události pro další styly.

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

classExampleExtensionHooks{publicstaticfunctiononParserFirstCallInit(Parser$parser){$parser->setFunctionHook('example',[self::class,'renderExample']);}}

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žnostnoparse nafalse:

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

Zdá se, že výchozí hodnotanoparse se změnila zfalse natrue, 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];

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

Při výběru názvu bez předpony mřížky 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.

Další podrobnosti o rozhraní do analyzátoru najdete v dokumentaci k setFunctionHook v includes/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é. Hodnoty:

• SFH_NO_HASH (1) konstanta, pokud funkci voláte bez#.
• SFH_OBJECT_ARGS (2), pokud předáte objekt PPFrame a pole argumentů místo řady argumentů funkcí, pro které [#Description|viz výše]].
• Výchozí hodnota je 0 (žádné příznaky).

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:

functionmyParserFunction($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:

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 náročný, 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 budefalse, pokud byl dosažen nebo překročen limit náročných funkcí.

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:

functionExampleExtensionRenderParserFunction(&$parser){// Předpokládejme, že uživatel vyvolal funkci analyzátoru takto:// {{#myparserfunction: foo=bar | apple=orange | banana }}$options=extractOptions(array_slice(func_get_args(),1));// Nyní máte pole, které vypadá takto:// [foo] => 'bar'// [apple] => 'orange'// [banana] => true// Pokračujte v psaní kódu...}/** * Převede pole hodnot ve tvaru [0] => "jméno=hodnota" * do skutečného asociativního pole ve tvaru [jméno] => hodnota * Pokud není zadáno =, předpokládá se true takto: [name] => true * * @param array string $options * @return array $results */functionextractOptions(array$options){$results=[];foreach($optionsas$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;}

Obecní a související průvodci:

• Příručka:Vývoj rozšíření nebo obecnější informace o rozšířeních vizPříručka:Rozšíření aRozšíření FAQ.
• Příručka:Rozšíření značek (tagů)
• Příručka:Kouzelná slovíčka

Kód:

• Manual:Parser.php
• Příručka:Háčky/Inicializace prvního volání analyzátoru
• Parser function hooks - (neúplný) seznam funkcí analyzátoru poskytovaných jádrem a rozšířeními
• PHP knihovnaParser Hooks, která poskytuje objektově orientované rozhraní pro deklarované háčky parseru
• Manual:Extension data

Příklady:

• Rozšíření ParserFunctions je dobře známá kolekce funkcí analyzátoru.
• Nápověda:Rozšíření:ParserFunctions
• Kategorie:Rozšíření funkcí parseru

• MediaWiki development/cs
• Parser extensions/cs
• Wiki markup/cs
• Customization techniques/cs
• Sample code/cs