Módulo:String/uso

Obxectivo

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

• ignore_errors: Posto a 'true' ou 1, en caso de erro retorno unha cadea baleira en lugar da mensaxe de erro.

• erro_category: Se se detecta un erro especifica o nome da categoría a incluír coa mensaxe de erro. Por defecto é Categoría:Wikipedia:Erros no módulo string.

• non_category: posto a 'true' ou 1, non engade ningunha categoría se se xera un erro.

len

Devolve a lonxitude da cadea. >>> {{Str len}}

Sintaxe

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

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

Parámetros

s: A cadea a atopar a súa lonxitude

Exemplos

{{str len|}} retorna 0

{{str len| }} retorna 1

{{str len|s= }} retorna 0, Non conta espazos porque se usa o nome do parámetro

{{str len| ab cde }} retorna 6

{{str len|1234567}} retorna 7

{{str len|café åäö}} retorna 8

{{str len| 499-caràcters... }} retorna 499

sub

Devolve unha subcadea da cadea indicada nos índices especificados. >>> {{Str sub}}

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 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.

Exemplos

• {{str sub|1234567890|3|7}} responde 34567
• {{str sub|1234567890|3|-3}} responde 345678
• {{str sub|1234567890|3}} responde 34567890
• {{str sub|1234567890|12}} responde
• {{str sub|1234567890|6|7}} responde 67

}}

match

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.

Exemples

• {{#invoke:string|match|john-smith-1|[a-z][a-z-]+[a-z0-9]}} responde john-smith-1
• {{#invoke:string|match|s=/john-smith|pattern=[a-z][a-z-]+[a-z0-9]}} responde john-smith

pos

Devolve o carácter da cadea que se atopa na posición indicada. >>> {{Str index}}

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.

Exemples

• {{str index|0123456789ABCDEF|0}} →
• {{str index|0123456789ABCDEF|1}} → 0
• {{str index|0123456789ABCDEF|15}} → E
• {{str index|0123456789ABCDEF|18}} →

find

Devolve a posición onde se atopa unha cadea ou patrón buscando noutra cadea. >>> {{Str find}}

{{#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.

Exemplos

• {{str find|abcdef|bcd}}      → 2
• {{str find|Fast Forward (film)|(}}    → 14
• {{str find|Fast Forward Longer (film)|(}} → 21

• {{str find|A Funny Thing Happened on the Way to the Forum (film)|(}}    → 48

• {{str find|abcdef|x}}    → 0
• {{str find|abcdef|xyz}}    → 0

replace

Permite substituír unha cadea ou patrón noutra cadea. >>> {{Str rep}}

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'.

Exemplos

• {{str rep|Dogs chase cats|chase|love}} = Dogs love cats

rep

Repite unha cadea n veces. >>> {{Loop}}

Sintaxe

{{#invoke:String|rep|source|count}}

Parámetros

source

Cadea a repetir

count

Número de repeticións

Exemplos

• "{{#invoke:String|rep|hello|3}}" → "hellohellohello"
• "{{#invoke:String|rep| hello | 3 }}" → " hello hello hello "

strip

Suprime caracteres da cadea.

Sintaxe

{{#invoke:StringFunc|strip|cadea|caracteres|texto_plano}}

{{#invoke:StringFunc|strip|source=cadea|chars=caracteres|plain=texto_plano}}

Parámetros:

source: A cadea a tratar.

chars: O patrón ou lista de caracteres a suprimir da cadea.

plain: Indicador sobre se o parámetro chars ten que ser entendido como texto plano (se é true) ou se ten que ser entendido como expresión regular de tipo Lua (se é false). Por defecto é true.

Os espazos en branco do comezo e o final tamén se suprimen d cadea.

split

• Divide unha cadea segundo un separador, e devolve o anaco n-ésimo, segundo o índice dado. >>> {{Str split}}

Sintaxe

{{#invoke:StringFunc|split|cadea|separador|índice}}

{{#invoke:StringFunc|split|source=cadea|separator=separador|count=índice}}

Parámetros:

source: A cadea a tratar.

separator: O separador polo cal se ten que dividir a cadea.

count: O índice do anaco a devolver.

Exemplos

• {{Str split |This is a piece of text to be split | }} → This is a piece of text to be split
• {{Str split |This is a piece of text to be split | |4}} → This is a piece of text to be split

isNumber

Establece se a cadea é un número. >>> {{Str IsNumber}}

Sintaxe

{{#invoke:StringFunc|isNumber|cadea}}

{{#invoke:StringFunc|isNumber|source=cadea}}

Parámetros:

source: A cadea a tratar

Exemplos

• {{Str IsNumber|1.327,50}} --> false
• {{Str IsNumber|{{formatnum:1.327,50|R}} }} --> true
• {{Str IsNumber|9,999 (1950)}} --> false
• {{Str IsNumber|9999999999999}} --> true
• {{Str IsNumber|500 metres}} --> false
• {{Str IsNumber|500*500}} --> false
• {{Str IsNumber|e<>pi}} --> false
• {{Str IsNumber|9.999e50}} --> true
• {{Str IsNumberr|1+1}} --> false

escapePattern

Permite o uso ce carácteres especiais nun padrón de Lua

Uso

• {{#invoke:String|escapePattern|pattern_string}}

Parámetros:

pattern_string

cadea padrón

Exemplos

• "{{#invoke:String|escapePattern|A.D.}}" → "A%.D%."
• "{{#invoke:String|escapePattern|10%}}" → "10%%"

count

Conta o número de veces que aparece un padrón.

Uso

{{#invoke:String|count|source_str|pattern_string|plain_flag}}

OU

{{#invoke:String|count|source= source_string |pattern= pattern_string|plain= plain_flag }}

Exemplos

• "{{#invoke:String|count|aabbcc|a}}" → "2"
• "{{#invoke:String|count|aabbcc|[ac]|plain=false}}" → "4"
• "{{#invoke:String|count|aaabaaac|[^a]|plain=false}}" → "2"
• "{{#invoke:String|count|aaabaaac|^a|plain=false}}" → "1"

join

Une as cadeas pasadas como argumentos nunha cadea, tratando o primeiro parámetro como separador

Uso

{{#invoke:String|join|separator|string1|string2|...}}

Exemplos

• "{{#invoke:String|join|x|foo|bar|baz}}" → "fooxbarxbaz"
• "{{#invoke:String|join||a|b|c|d|e|f|g}}" → "abcdefg"
• "{{#invoke:String|join|,|a|b|c|d|e|f|g}}" → "a,b,c,d,e,f,g"
• "{{#invoke:String|join|, |a|b|c|d|e|f|g}}" → "a, b, c, d, e, f, g"
• "{{#invoke:String|join| – |a|b|c|d|e|f|g}}" → "a – b – c – d – e – f – g"

endswith

Devolve "yes" se a cadea fonte termina co padrón indicado.

Uso

{{#invoke:String|endswith|source_str|pattern_string}}

OU

{{#invoke:String|endswith|source= source_string |pattern= pattern_string}}

Exemplos

• "{{#invoke:String|endswith|xxxyyy|y}}" → "yes"
• "{{#invoke:String|endswith|xxxyyy|z}}" → ""