Voir la source de Module:String/Documentation

Le module String (un mot [[anglais]] signifiant ''chaîne de caractères'') permet de manipuler des chaînes de caractères.

== Utilisation ==

Fonctions exportables :
* <code>len</code> – renvoie le nombre de caractères dans une chaîne, prend en compte les caractères multi-octets (''len'' ou ''length'' signifie ''taille'', ''longueur'')
* <code>sub</code> – renvoie une partie de la chaîne de caractères (''sub'' ou ''sub-string'' signifie ''sous-chaîne'')

Autres fonctions : <br/>
À compléter…

Modules externes et autres éléments dont ce module a besoin pour fonctionner : <br/>
À compléter…


=== len ===
Cette fonction renvoie la longueur de la chaîne de caractère cible.

;Fonctionnement :
<pre>{{#invoke:String|len|chaîne_de_caractère_cible}}</pre>
OU
<pre>{{#invoke:String|len|s=chaîne_de_caractère_cible}}</pre>

;Paramètres :
*<code>s</code> : la chaîne de caractère dont la longueur doit être signalée

S'il est appelé à l'aide de paramètres nommés, MediaWiki supprimera automatiquement tout espace blanc de début ou de fin de la chaîne de caractère cible.

=== sub ===
Cette fonction renvoie une sous-chaîne de caractère spécifiée par des indices numériques d'une chaîne cible.

;Fonctionnement :
<pre>{{#invoke:String|sub|chaîne_de_caractère_cible|index_de_départ|index_de_fin}}</pre>
OU
<pre>{{#invoke:String|sub|s=chaîne_de_caractère_cible|i=index_de_départ|j=index_de_fin}}</pre>

;Paramètres :
*<code>s</code> : la chaîne de caractère de départ
*<code>i</code> : le début de la sous-chaîne de caractère commence à l'entier indiqué par ce paramètre, par défaut à 1.
*<code>j</code> : la fin de la sous-chaîne de caractère finit à l'entier indiqué par ce paramètre.
 
Le premier caractère de la chaîne se voit attribuer un index de 1. Si <code>i</code> ou <code>j</code> est une valeur négative, cela est interprété comme la sélection d'un caractère en comptant à rebours à partir de la fin de la chaîne de caractère cible. Par conséquent, une valeur de -1 revient à sélectionner le dernier caractère de la chaîne.

Si les indices demandés sont hors limites pour la chaîne donnée, une erreur est signalée. Si un paramètre d'index est omis, la chaîne de caractère cible est reprise à l'identique, au commencement ou à la fin suivant l'omission et le signe du paramètre restant.

=== match ===

This function returns a substring from the source string that matches a 
specified pattern.

Usage:
<pre>{{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}}</pre>
OR
<pre>{{#invoke:String|match|s=source_string|pattern=pattern_string|start=start_index
    |match=match_number|plain=plain_flag|nomatch=nomatch_output}}</pre>

Parameters
*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: A flag indicating that the pattern should be understood as plain text. Defaults to false.
*nomatch: If no match is found, output the "nomatch" value rather than an error.

If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from each string. In some circumstances this is desirable, in 
other cases one may want to preserve the whitespace.

If the match_number or start_index 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.

For information on constructing Lua patterns, a form of [regular expression], see:

* http://www.lua.org/manual/5.1/manual.html#5.4.1
* http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Patterns
* http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Ustring_patterns

=== pos ===

This function returns a single character from the target string at position pos.

Usage:
<pre>{{#invoke:String|pos|target_string|index_value}}</pre>
OR
<pre>{{#invoke:String|pos|target=target_string|pos=index_value}}</pre>

Parameters
*target: The string to search
*pos: The index for the character to return

If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from the target string. In some circumstances this is desirable, in 
other cases one may want to preserve the whitespace.

The first character has an index value of 1.

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.

A requested value of zero, or a value greater than the length of the string returns an error.

=== find ===

This function allows one to search for a target string or pattern within another
string.

Usage:
<pre>{{#invoke:String|find|source_str|target_string|start_index|plain_flag}}</pre>
OR
<pre>{{#invoke:String|find|source=source_str|target=target_str|start=start_index|plain=plain_flag}}</pre>

Parameters
*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

If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from the parameter. In some circumstances this is desirable, in 
other cases one may want to preserve the whitespace.

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.

This function should be safe for UTF-8 strings.


=== replace ===

This function allows one to replace a target string or pattern within another
string.

Usage:
<pre>{{#invoke:String|replace|source_str|pattern_string|replace_string|replacement_count|plain_flag}}</pre>
OR
<pre>{{#invoke:String|replace|source=source_string|pattern=pattern_string|replace=replace_string|
   count=replacement_count|plain=plain_flag}}</pre>

Parameters
*source: The string to search
*pattern: The string or pattern to find within source
*replace: The replacement text
*count: The number of occurences to replace, defaults to all.
*plain: Boolean flag indicating that pattern should be understood as plain text and not as a Lua style regular expression, defaults to true 


=== rep ===

Cette fonction répète la même chaîne de multiple fois.

Utilisation :
<pre>{{#invoke:String|rep|texte|nombre}}</pre>

Paramètres :
* texte : le texte à répeter
* nombre : le nombre de répétition

=== count ===
Cette fonction compte le nombre de fois qu'un motif apparaît dans la chaîne de caractère. 

Utilisation :
<pre>{{#invoke:String|count|texte|motif|plain_flag}}</pre>

Paramètres :
* texte : la chaîne de caracère
* motif: le motif (ou ''pattern'') a rechercher
* plain_flag: Indicateur booléen indiquant que le modèle doit être compris comme du texte brut et non comme une expression régulière de style Lua compatible Unicode; la valeur par défaut est ''true''

== Exemples ==

===len===
<pre>{{#invoke:String|len|ABCDEFGHIJ}}</pre>           renvoie {{#invoke:String|len|ABCDEFGHIJ}}     
<pre>{{#invoke:String|len|É}} </pre>                   renvoie {{#invoke:String|len|É}}, même si É occupe 2 octets
<pre>{{#invoke:String|len| }}  </pre>                  renvoie {{#invoke:String|len| }}  , les espaces blancs sont pris en compte

===sub===
<pre>
{{#invoke:String|sub|ABCDEFGHIJ|0}}        renvoie une erreur, ici l'index commence à 1 (contrairement à d'autres langages de programmation)
{{#invoke:String|sub|ABCDEFGHIJ|5}}        renvoie EFGHIJ, on commence à partir du 5ème caractère et on prend le reste
{{#invoke:String|sub|ABCDEFGHIJ|1|3}}      renvoie ABC, on commence à partir du 1er jusqu'au 3ème
{{#invoke:String|sub|ABCDEFGHIJ|1|1}}      renvoie A
{{#invoke:String|sub|ABCDEFGHIJ|-1}}       renvoie J, l'index est inversé on commence à la fin
{{#invoke:String|sub|ABCDEFGHIJ|-5|-2}}    renvoie FGHI
{{#invoke:String|sub|ABCDEFGHIJ|-5|2}}     renvoie une erreur, l'index de fin doit être après l'index de début (2 est placé avant -5) 
{{#invoke:String|sub|ABCDEFGHIJ|-5|7}}     renvoie FGHI, l'index de fin est bien après l'index de début
</pre>

===count===

Exemples:
* <code><nowiki>###{#invoke:String|count|aabbcc|a}}###</nowiki></code> : ###{{#invoke:String|count|aabbcc|a}}### --nombre de a
* <code><nowiki>###{#invoke:String|count|aabbcc|z}}###</nowiki></code> : ###{{#invoke:String|count|aabbcc|z}}### --nombre de z
* <code><nowiki>###{#invoke:String|count|aabbcc|[ac]|plain=false}}###</nowiki></code> : ###{{#invoke:String|count|aabbcc|[ac]|plain=false}}### --nombre de a ou de c
* <code><nowiki>###{#invoke:String|count|11-aa-2587|[0-9]|plain=false}}###</nowiki></code> : ###{{#invoke:String|count|11-aa-2587|[0-9]|plain=false}}### --nombre de chiffres
* <code><nowiki>###{#invoke:String|count|Il était une fois| |plain=true}}###</nowiki></code> : ###{{#invoke:String|count|Il était une fois| |plain=true}}### --nombre de blancs
* <code><nowiki>###{#invoke:String|count|Il était une fois|[ ]|plain=false}}###</nowiki></code> : ###{{#invoke:String|count|Il était une fois|[ ]|plain=false}}### --nombre de blancs

== Voir aussi ==
* [[:Catégorie:Modèle de manipulation de chaîne]]

{{Traduction/Référence|en|Module:String/doc}}

{{Projet Scribunto}}

<includeonly>
[[Catégorie:Module en langage Lua]]
</includeonly>