This is a documentation subpage for Module:String/doc. It contains usage information, categories and other content that is not part of the original Module page.

Aviso:

Esta página é compartilhada entre múltiplas wikis. Todas as modificações a esta página serão automaticamente copiadas para todas as wikis listadas na barra lateral esquerda.

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

This module is subject to page protection. It is a highly visible module in use by a very large number of pages. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

Este módulo destina-se a fornecer acesso às funções de string básicas.

A maioria das funções fornecidas aqui podem ser invocadas com parâmetros nomeados, parâmetros sem nome, ou uma mistura. Se os parâmetros nomeados forem utilizados, o MediaWiki removerá automaticamente qualquer espaço branco anterior ou posterior do parâmetro. Dependendo da utilização destinada, pode ser vantajoso preservar ou remover tal espaço em branco.

Opções globais

ignore_errors

Se definido para true ou 1, qualquer condição de erro resultará numa string vazia sendo devolvida em vez de uma mensagem de erro.

error_category

Se ocorrer um erro, especifica o nome de uma categoria para incluir com a mensagem de erro. A categoria predefinida é Category:Errors reported by Module String .

no_category

If set to true or 1, no category will be added if an error is generated.

len

Utilização:

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

ou

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

Parâmetros:

s

A string cujo comprimento a reportar

sub

This function returns a substring of the target string at specified indices.

Utilização:

{{#invoke:String|sub|target_string|start_index|end_index}}

OU

{{#invoke:String|sub|s= target_string |i= start_index |j= end_index }}

Parâmetros:

s

The string to return a subset of

i

The first index of the substring to return, defaults to 1.

j

The last index of the string to return, defaults to the last character.

The first character of the string is assigned an index of 1. If either i or j is a negative value, it is interpreted the same as selecting a character by counting from the end of the string. Hence, a value of -1 is the same as selecting the last character of the string.

match

Utilização:

{{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}}

OU

{{#invoke:String|match|s= source_string |pattern= pattern_string |start= start_index |match= match_number |plain= plain_flag |nomatch= nomatch_output }}

Parâmetros:

s

The string to search

pattern

The pattern or string to find within the string

start

The index within the source string to start the search. The first character of the string has index 1. Defaults to 1.

match

In some cases it may be possible to make multiple matches on a single string. This specifies which match to return, where the first match is match = 1. If a negative number is specified then a match is returned counting from the last match. Hence match = -1 is the same as requesting the last match. Defaults to 1.

plain

Boolean flag indicating that pattern should be understood as plain text and not as a Lua-style regular expression. Defaults to false.

nomatch

If no match is found, output the "nomatch" value rather than an error.

If the match or start are out of range for the string being queried, then this function generates an error. An error is also generated if no match is found. If one adds the parameter ignore_errors=true, then the error will be suppressed and an empty string will be returned on any failure.

• Referência Lua: Padrões - as of version 5.1
• Scribunto patterns
• Scribunto Unicode string patterns

pos

Utilização:

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

OU

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

Parâmetros:

target

The string to search

pos

The index for the character to return

If one requests a negative value, this function will select a character by counting backwards from the end of the string. In other words pos = -1 is the same as asking for the last character.

find

Utilização:

{{#invoke:String|find|source_str|target_string|start_index|plain_flag}}

OU

{{#invoke:String|find|source= source_str |target= target_str |start= start_index |plain= plain_flag }}

Parâmetros:

source

The string to search

target

The string or pattern to find within source

start

The index within the source string to start the search, defaults to 1

plain

Boolean flag indicating that target should be understood as plain text and not as a Lua-style regular expression, defaults to true

This function returns the first index >= "start" where "target" can be found within "source". Indices are 1-based. If "target" is not found, then this function returns 0. If either "source" or "target" are missing / empty, this function also returns 0.

replace

Utilização:

{{#invoke:String|replace|source_str|pattern_string|replace_string|replacement_count|plain_flag}}

OU

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

Parâmetros:

source

A string a pesquisar

pattern

A string ou padrão para encontrar dentro da fonte

replace

O texto de substituição

count

O número de ocorrências a substituir; predefine para tudo

plain

O sinalizador 'Booliano' indica que o padrão deverá ser compreendido como texto sem formatação e não como padrão scribunto ustring (uma expressão regular) amigável estilo Lua; resulta em true

rep

Repete uma string "n" vezes.

Utilização:

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

Parâmetros:

source

A string a repetir

count

O número de repetições.

Exemplo {{#invoke:String|rep|hello|3}} produz hellohellohello Category:Module documentation pages/pt