Módulo:String/uso

Na Galipedia, a Wikipedia en galego.
Saltar ata a navegación Saltar á procura

Esta é a páxina de documentación de "Módulo:String"

Uso[editar a fonte]

Este módulo proporciona acceso a funcións básicas sobre cadeas de caracteres (strings).

A maioría destas funcións pódense invocar con parámetros con nome, sen nome ou unha mestura. Se se usan parámetros con nome hai que ter en conta que o Mediawiki elimina os espazos en branco iniciais e finais do valor do parámetro. Segundo o uso previsto pode ser conveniente tanto conservalos como eliminalos.

Algunhas funcións admiten parámetros con patróns Lua que son unha especie de expresións regulares. Véxase no Manual de patróns Ustring .

Opcións globais[editar a fonte]

  • ignore_errors: Posto a 'true' ou 1, en caso de erro retorno unha cadea baleira en lugar da mensaxe de erro.
  • non_category: posto a 'true' ou 1, non engade ningunha categoría se se xera un erro.

Funcións[editar a fonte]

len[editar a fonte]

Devolve a lonxitude da cadea. Sintaxe:

{{#Invoke:String|len|cadea}}

{{#Invoke:String|len|s=cadea}}

Parámetros
s: A cadea a atopar a súa lonxitude

sub[editar a fonte]

Devolve unha subcadea da cadea indicada nos índices especificados. Sintaxe:

{{#Invoke:String|sub|cadea|índice inicial|índice final}}

{{#Invoke:String|sub|s=cadea|i=índice inicial|j = índice final }}

Parámetros
s: a cadea de onde extraer a subcadea
i: índice inicial da subcadea, por defecto 1, o primeiro carácter da cadea.
j: índice final da subcadea, por defecto a lonxitude total, até o último carácter.

Se calquera dos dous índices teñen valor negativo entón contará desde o final da cadea. Así, -1 é o índice do último carácter da cadea. Se os índices son superiores á lonxitude da cadea entón devolverá un erro.

match[editar a fonte]

Devolve unha subcadea da cadea indicada que coincida cun patrón especificado. Sintaxe:

{{#Invoke:String|match|cadea|patrón|índice inicial|número coincidencia|indicador texto limpo|texto non coincidencia}}

{{#Invoke:String|match|s=cadea|pattern = patrón|start=índice inicial|match=número coincidencia|plain=indicador texto limpo|nomatch=texto non coincidencia}}

Parámetros
s: Cadea onde se fai a procura
pattern: Patrón ou cadea a buscar.
start: Índice da cadea onde empezar a buscar, por defecto 1, o primeiro carácter.
match: Se se atopan múltiples coincidencias, especifica cal delas devolver. Por defecto é 1, a primeira coincidencia atopada. Un número negativo conta desde o final, por tanto match = -1 é a última coincidencia.
plain: Indica se o patrón debe interpretarse como texto limpo, por defecto 'false'.
nomatch: En caso de non atopar ningunha coincidencia, devolve o valor de «nomatch» en lugar dun erro.

Se o número match ou o índice start están fóra do rango da cadea, entón a función xera un erro. Tamén xera un erro se non atopa ningunha coincidencia. Co parámetro global ignore_errors = true suprímese o erro e devolve unha cadea baleira.

pos[editar a fonte]

Devolve o carácter da cadea que se atopa na posición indicada. Sintaxe:

{{#Invoke:String|pos|cadea|índice}}

{{#Invoke:String|pos|target=cadea|pos=índice}}

Parámetros
target: Cadea onde buscar
pos: Índice do carácter a devolver

O primeiro carácter ten o índice 1. O último é -1, contando desde o final. Se está fóra do rango da cadea entón devolverá un erro.

find[editar a fonte]

Devolve a posición onde se atopa unha cadea ou patrón buscando noutra cadea.

{{#Invoke:String|find|cadea|procura|índice inicial|indicador texto limpo}}

{{#Invoke:String|find|source=cadea|target=procura|start=índice inicial|plain=indicador texto limpo}}

Parámetros
source: Cadea onde buscar
target: Cadea a buscar ou patrón de procura
start: Índice da cadea fonte onde empezar a buscar, por defecto 1, o primeiro carácter.
plain: Índica se a procura debe interpretarse como texto limpo, pola contra como patrón Lua. Por defecto é 'true'.

Devolve o primeiro índice, maior ou igual que «start», onde «target» atopouse en «source». Se non o atopa devolve 0. Se «source» ou «target» están baleiros ou indefinidos tamén devolve 0. Suponse que funciona ben con cadeas UTF-8.

replace[editar a fonte]

Permite substituír unha cadea ou patrón noutra cadea. Sintaxe:

{{#Invoke:String|replace|cadea|patrón|substitúo|contador|indicador texto limpo}}

Parámetros
source: Cadea onde buscar
pattern: Cadea de procura ou patrón a buscar
replace: Texto de substitución
count: Número de ocorrencias a substituír, por defecto todas.
plain: Indica se a procura debe interpretarse como texto limpo, pola contra como patrón Lua. Por defecto é 'true'.