Manual:Parser functions/cs

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, což je sbírka jednoduchých funkcí analyzátoru. (Viz .)

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:

Další informace najdete v pro. Tato dokumentace uvádí:


 * Funkce zpětného volání by měla mít tvar:
 * Nebo s :
 * Nebo s :

První varianta volání předává všechny argumenty jako prostý text. 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. Ty představují nerozbalený wikitext. Parametr  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:

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

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



zobrazí se:


 * param1 je hello a param2 je hi a param3 je hey



V rámci LocalSettings.php
Magická slova a jejich funkce analyzátoru mohou být zcela definovány v LocalSettings.php.



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í a volat statické funkce v háčcích. Např.:

Vložte toto do svého souboru :
 * Viz: Zápis obsluhy události pro další styly.

Pak to vložte do svého souboru :

Ukládání do mezipaměti
Stejně jako u rozšíření značek lze použít k deaktivaci mezipaměti pro dynamická rozšíření.

To má významný negativní dopad na výkon, proto jej používejte pouze v případě potřeby.



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  na false:

Zdá se, že výchozí hodnota  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:

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, 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ř. . Funkce zpětného volání by měla mít tvar:

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:


 * forceRawInterwiki
 * Vynutí transkluzi interwiki, aby bylo provedeno v nezpracovaném režimu, nikoli vykreslení.


 * found
 * Vrácený text je platný, zastavte zpracování šablony. Toto je ve výchozím nastavení zapnuto.


 * isChildObj
 * Text je uzel DOM, který potřebuje rozšíření v podřízeném rámci.


 * isHTML
 * Vrácený text je HTML, obrněný proti transformaci wikitextu. Ale viz diskuze


 * isLocalObj
 * Text je uzel DOM, který potřebuje rozšíření v aktuálním rámci.


 * noparse
 * Nebezpečné HTML tagy by neměly být odstraňovány atd.


 * nowiki
 * Označení wiki v návratové hodnotě by mělo být zakódováno.


 * preprocessFlags
 * Tyto příznaky použijte při analýze vráceného textu. To platí pouze v případě, že noparse je.


 * text
 * Text vrácený funkcí. Pokud je zadáno isChildObj nebo isLocalObj, měl by to být uzel DOM.


 * title
 * Objekt Title, ze kterého text pochází.



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. 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. Vrácená hodnota bude, 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:



Související odkazy

 * Rozšíření ParserFunctions je dobře známá kolekce funkcí analyzátoru.
 * - (neúplný) seznam funkcí analyzátoru poskytovaných jádrem a rozšířeními
 * PHP knihovna Parser Hooks, která poskytuje objektově orientované rozhraní pro deklarativní háčky parseru
 * Rozšíření ParserFunctions je dobře známá kolekce funkcí analyzátoru.
 * - (neúplný) seznam funkcí analyzátoru poskytovaných jádrem a rozšířeními
 * PHP knihovna Parser Hooks, která poskytuje objektově orientované rozhraní pro deklarativní háčky parseru
 * Rozšíření ParserFunctions je dobře známá kolekce funkcí analyzátoru.
 * - (neúplný) seznam funkcí analyzátoru poskytovaných jádrem a rozšířeními
 * PHP knihovna Parser Hooks, která poskytuje objektově orientované rozhraní pro deklarativní háčky parseru
 * PHP knihovna Parser Hooks, která poskytuje objektově orientované rozhraní pro deklarativní háčky parseru