Module:String/doc/nl

Deze module is bedoeld om toegang te bieden tot de basisfuncties met teksten (strings).

De meeste functies hier kunnen worden aangeroepen met benoemde parameters, onbenoemde parameters of een mengvorm. Als benoemde parameters worden gebruikt, verwijdert MediaWiki automatisch alle voor- of achterliggende spaties uit de inhoud van de parameter. Afhankelijk van het beoogde gebruik kan het voordelig zijn om deze spaties te behouden of te verwijderen.

ignore_errors

Indien ingesteld op true of 1, wordt bij een fout een lege tekst teruggegeven in plaats van een foutmelding.

error_category

Als er een fout optreedt, wordt de naam van een categorie gespecificeerd om bij de foutmelding te worden opgenomen. De standaardcategorie is Category:Errors reported by Module String .

no_category

Als deze optie is ingesteld op true of 1, wordt er geen categorie toegevoegd als er een fout wordt gegenereerd.

Unittesten voor deze module zijn beschikbaar op Module:String/testcases.

De functie retourneert de lengte van de gegeven tekenreeks.

Gebruik:

{{#invoke:String|len|gegeven_tekenreeks}}

of

{{#invoke:String|len|s= gegeven_tekenreeks }}

Parameters:

s

De tekenreeks waarvan de lengte moet worden teruggegeven

Deze functie retourneert een subtekenreeks van de gegeven tekenreeks mer de opgegeven indices.

Gebruik:

{{#invoke:String|sub|gegeven_tekenreeks|start_index|eind_index}}

OF

{{#invoke:String|sub|s= gegeven_tekenreeks |i= start_index |j= eind_index }}

Parameters:

s

De tekenreeks om een gedeelte van terug te geven

i

De eerste index van de subtekenreeks die wordt teruggegeven, standaardwaarde is 1.

j

De laatste index van de tekenreeks die moet worden teruggegeven, standaardwaarde tot en met het laatste teken van de tekenreeks.

Het eerste teken van de tekenreeks krijgt de index 1. Als i of j een negatieve waarde is, wordt deze geïnterpreteerd als het selecteren van een teken door het tellen vanaf het einde van de tekenreeks. Een waarde van -1 is dus hetzelfde als het selecteren van het laatste teken van de tekenreeks.

Als de gevraagde index buiten het bereik ligt voor de gegeven tekenreeks, wordt een fout gemeld.

Deze functie retourneert een subtekenreeks van de gegeven tekenreeks die overeenkomt met een opgegeven patroon (pattern).

Gebruik:

{{#invoke:String|match|bron_tekenreeks|patroon_tekenreeks|start_index|aantal_overeenkomsten|platte_tekst_vlag|geen_overeenkomst_uitvoer}}

OF

{{#invoke:String|match|s= bron_tekenreeks |pattern= patroon_tekenreeks |start= start_index |match= aantal_overeenkomsten |plain= platte_tekst_vlag |nomatch= geen_overeenkomst_uitvoer }}

Parameters:

s

De tekenreeks om te doorzoeken

pattern

Het patroon of de tekenreeks die binnen de tekenreeks moet worden gevonden

start

De index binnen de bron_tekenreeks om het zoeken te beginnen. Het eerste teken van de tekenreeks heeft de index 1. Standaardwaarde is 1.

match

In sommige gevallen is het mogelijk om meerdere matches (overeenkomst) op een enkele tekenreeks te maken. Dit geeft aan welke match moet worden teruggegeven, waarbij de eerste match match = 1 is. Als er een negatief getal is opgegeven, wordt er een match teruggegeven die telt vanaf de laatste match. Daarom is match = -1 het vragen naar de laatste match. Standaardwaarde is 1.

plain

Booleaanse vlag die aangeeft dat het patroon moet worden opgevat als platte tekst en niet als een Lua-stijl reguliere expressie. Standaardwaarde is false.

nomatch

Als er geen overeenkomst wordt gevonden, is de uitvoer de waarde "nomatch", er is dan dus geen foutmelding.

Als de match of start buiten het bereik vallen voor de betreffende tekenreeks, genereert deze functie een fout. Er wordt ook een foutmelding gegenereerd als er geen overeenkomst wordt gevonden. Als men de parameter ignore_errors=true gebruikt, wordt de foutmelding onderdrukt en wordt er bij een fout een lege tekenreeks teruggegeven.

Voor informatie over het construeren van Lua-patronen, een vorm van reguliere expressie, zie:

• Lua referentie: Patterns - vanaf versie 5.1
• Scribunto patterns
• Scribunto Unicode-tekenreeks patronen

Deze functie geeft een enkel teken op de positie pos van de doeltekenreeks terug.

Gebruik:

{{#invoke:String|pos|gegeven_tekenreeks|index_value}}

OF

{{#invoke:String|pos|target= gegeven_tekenreeks |pos= index_value }}

Parameters:

target

De tekenreeks om te doorzoeken

pos

De index voor het teken dat moet worden teruggegeven

Het eerste teken heeft een indexwaarde van 1.

Als men een negatieve waarde opgeeft, zal deze functie een teken selecteren door terug te tellen vanaf het einde van de tekenreeks. Met andere woorden, pos = -1 is hetzelfde als vragen om het laatste teken .

Een aangevraagde waarde van nul, of een waarde die groter is dan de lengte van de tekenreeks, geeft een fout terug.

Met deze functie kan men zoeken naar een tekenreeks of patroon in een andere tekenreeks.

Gebruik:

{{#invoke:String|find|source_str|gegeven_tekenreeks|start_index|platte_tekst_vlag}}

OF

{{#invoke:String|find|source= source_str |target= gegeven_tekenreeks |start= start_index |plain= platte_tekst_vlag }}

Parameters:

source

De tekenreeks om te doorzoeken

target

De tekenreeks of het patroon om binnen de brontekenreeks te vinden

start

De index binnen de bron_tekenreeks om het zoeken te beginnen, standaardwaarde is 1.

plain

Vlag die aangeeft dat het patroon moet worden opgevat als platte tekst en niet als een Lua-stijl reguliere expressie. Standaardwaarde true

Deze functie geeft de eerste index >= "start" terug waar "target" binnen "source" is gevonden. Indices zijn gebaseerd op 1. Als "target" niet gevonden wordt, geeft deze functie 0 terug. Ook als "source" of "target" ontbreekt / leeg is, geeft deze functie 0 terug.

Deze functie moet veilig zijn voor UTF-8 tekenreeksen.

Met deze functie kan men een tekenreeks of patroon in een andere tekenreeks vervangen.

Gebruik:

{{#invoke:String|replace|source_str|patroon_tekenreeks|replace_string|replacement_count|platte_tekst_vlag}}

OF

{{#invoke:String|replace|source= bron_tekenreeks |pattern= patroon_tekenreeks |replace= replace_string |count= replacement_count |plain= platte_tekst_vlag }}

Parameters:

source

De tekenreeks om te doorzoeken

pattern

De tekenreeks of het patroon om binnen de brontekenreeks te vinden

replace

De vervangende tekst

count

Het aantal overeenkomsten dat moet worden vervangen; Standaard ingesteld op allemaal (all)

plain

Vlag die aangeeft dat het patroon moet worden opgevat als platte tekst en niet als een Scribunto ustring patroon (een unicode-vriendelijk Lua-stijl reguliere expressie). Standaardwaarde true

Herhaalt een tekenreeks n keer.

Gebruik:

{{#invoke:String|rep|bron|aantal}}

Parameters:

source

De tekenreeks om te herhalen

count

Het aantal keer herhalen.

Voorbeeld {{#invoke:String|rep|hallo|3}} geeft hallohallohallo

• Module documentation pages/nl