Manual:Parser functions/da

Parserfunktioner, som tilføjedes i MediaWiki version 1.7, er en type udvidelse, der er tæt knyttet til syntaks-analysen, også kaldet parseren. Udtrykket "parserfunktion" må ikke forveksles med Extension:ParserFunctions, som er en samling af simple parserfunktioner.

Beskrivelse
Mærkeudvidelser er bygget til at omdanne uforarbejdet tekst til HTML og har meget lidt til fælles med resten af syntaksanalysen. For eksempel kan resultatet fra en mærkeudvidelse ikke anvendes som skabelon-parameter. Desuden er det muligt at bygge skabeloner ind i en mærkeudvidelse, men det skal gøres manuelt og kan være en fejlbehæftet proces, der skifter fra version til version.

Den typiske syntaks for en parserfunktion er:

Oprettelse af en parserfunktion er lidt mere kompliceret end at skabe et nyt mærke, fordi funktionens navn skal være et magisk ord/da - et nøgleord, der understøtter aliaser og sprogversioner.

Simpelt eksempel
Nedenfor er et eksempel på en udvidelse, der skaber en parserfunktion.

Denne fil skal kaldes ExampleExtension.php, hvis navnet på din udvidelse er ExampleExtension:

En anden fil, ExtensionName.i18n.php, bør indeholde:

Med denne udvidelse aktiveret producerer



resultatet:


 * param1 is hello and param2 is hi

Bemærk: Denne magicWords tabel er ikke valgfri. Hvis den udelades, vil parserfunktionen simpelthen ikke virke og vil blive gengivet som om udvidelsen ikke er blevet installeret.

Længere funktioner
For længere funktioner vil du måske adskille krog-funktionerne til en _body.php eller .hooks.php fil og lave dem til en klasses statiske funktioner. Så kan du hente klassen med $wgAutoloadClasses og kalde de statiske funktioner på krogene:

Sæt dette ind i din  fil:

Så sæt dette i din  fil:

Mellemlagring
Ligesom med mærke-udvidelser kan $parser->disableCache bruges til at afbryde mellemlagringen (cache'en) for dynamiske udvidelser.

Styring af systemanalyse-resultat
For at få wikiteksten, der returneres af din parserfunktion, til være fuldt systemanalyseret (med udvidelse af skabeloner), skal du indstille noparse til false ved returneringen: Det ser ud til at standardværdien for noparse er ændret fra false til true, i hvert fald i nogle situationer, omkring version 1.12.

Omvendt, for at få din parserfunktion til at returnere ikke-gennemgået HTML i stedet for wikitekst, brug dette:

Imidlertid vil Dette er en test. producere noget lignende dette:

Dette er

param1 is hallo and param2 is hej en test.

Dette sker på grund af den hårde kode "\n\n", der er foranstillet til parserfunktioners HTML resultat. For at undgå dette og sørge for, at HTML-koden er vises mellem til den omgivende tekst, kan du bruge denne:

Navngivning
Som standard tilføjer MW en hash karakter (nummertegn, "#") til navnet af hver parserfunktion. For at undertrykke denne tilføjelse (og opnå en parser funktion uden "#" præfiks), indsæt SFH_NO_HASH konstant i den valgfri flag-argument til setFunctionHook, som beskrevet nedenfor.

Når du vælger et navn uden et hash præfiks, vær opmærksom på at indlejring af en side med et navn, der starter med dette funktionsnavn efterfulgt af et kolon, er ikke længere muligt. Undgå især funktionsnavne svarende til et navnerums-navn. I tilfælde af at interwiki indlejring er aktiveret, undgå da også funktionsnavne svarende til et interwiki præfiks.

setFunctionHook krogen
For flere oplysninger om grænsefladen ind i parseren, se dokumentationen for setFunctionHook i includes/Parser.php. Her er en (muligvis dateret) kopi af disse bemærkninger:

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

Parametre:


 * string $id - det magiske ord ID
 * mixed $callback - tilbagekalds-funktionen (og objektet) at bruge
 * integer $flags - valgfri, sættes til SFH_NO_HASH konstanten, for at kalde funktionen uden "#".

Returværdi: navnets gamle tilbagekalds-funktion, hvis der er nogen

Opret en funktion, for eks. . Tilbagekalds-funktionen bør have formen:

Tilbagekaldet kan enten returnere tekstresultatet af funktionen, eller en tabel med teksten i element 0, og et antal flag i de andre elementer. Navnene på flagene er specificeret i nøglerne. Gyldige flag er:


 * found : Den returnerede tekst er gyldig, stop behandlingen af skabelonen. Dette er som standard aktiveret.
 * nowiki : Wiki-opmærkning i resultatet skal udelades
 * noparse : Usikre HTML-mærker bør ikke gennemgås osv.
 * noargs : Erstat ikke triple-tuborgklamme argumenter i den returnerede værdi
 * isHTML : Den returnerede tekst er HTML og skal værnes mod wikitekst forandring

Navngivne parametre
Parserfunktioner understøtter ikke navngivne parametre på samme måde som skabeloner og mærke-udvidelser, men det er til tider nyttigt at lade som om. Brugerne er ofte vant til at bruge lodrette streger ( | ) til at adskille argumenter, så det er rart også at kunne gøre det i parserfunktionens kontekst. Her er et simpelt eksempel på hvordan det gøres.

Din tilbagekaldsfunktion ser typisk sådan ud:

For at snyde navngivne parametre, udelad simpelthen alle argumenter efter  og par den med. Her er et eksempel:

Se også

 * Manual:Hooks/ParserFirstCallInit
 * Manual:Extensions/da
 * Manual:Tag extensions/da
 * Manual:Magic words/da
 * Manual:Parser.php/da
 * Extensions FAQ/da
 * Help:Extension:ParserFunctions/da
 * ParserFunctions-udvidelsen er en velkendt samling af parserfunktioner.