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'')
* <code>trim</code> – renvoie la chaîne de caractères en supprimant les éventuels espaces au début et/ou à la fin

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

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


=== len ===

This function returns the length of the target string.

Usage:
<pre>{{#invoke:String|len|target_string|}}</pre>
OR
<pre>{{#invoke:String|len|s=target_string}}</pre>

Parameters
*s: The string whose length to report

If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from the target string.


=== sub ===

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

Usage:
<pre>{{#invoke:String|sub|target_string|start_index|end_index}}</pre>
OR
<pre>{{#invoke:String|sub|s=target_string|i=start_index|j=end_index}}</pre>

Parameters
*s: The string to return a subset of
*i: The fist 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.

If the requested indices are out of range for the given string, an error is 
reported.

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

=== str_find ===

This function duplicates the behavior of {{str_find}}, including all of its quirks.
This is provided in order to support existing templates, but is NOT RECOMMENDED for 
new code and templates. New code is recommended to use the "find" function instead.

Returns the first index in "source" that is a match to "target". Indexing is 1-based,
and the function returns -1 if the "target" string is not present in "source".

Important Note: If the "target" string is empty / missing, this function returns a
value of "1", which is generally unexpected behavior, and must be accounted for
separatetly.

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


=== simpletitle ===

This function returns the current page title without the homonymy part (the part in parenthesis).

Usage:
<pre>{{#invoke:String|simpletitle}}</pre>
OR
<pre>{{#invoke:String|simpletitle|string}}</pre>

Parameters
*string: if present this function will treat this string as the title of the page and remove
homonymy part if present in it. If not given the function uses the page title (without namespace)

=== titledisambig ===

Cette fonction renvoie la partie entre parenthèses du titre utilisée pour résoudre les cas d'homonymie.

Utilisation :
<pre>{{#invoke:String|titledisambig}}</pre>
OU
<pre>{{#invoke:String|titledisambig|expression}}</pre>

Paramètres :
* expression : si ce paramètre est présent, la fonction l'utilisera comme titre plutôt que de prendre le titre de la page.

=== trim ===

Cette fonction renvoie la chaîne passée en paramètre (non nommé) en supprimant au passage les éventuels espaces et sauts de ligne au début et/ou à la fin de celle-ci.

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

Paramètres :
* texte : le texte à nettoyer de ses espaces et sauts de ligne au début / à la fin

== Exemples ==

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

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

===trim===
* <code><nowiki>###{{#invoke:String|trim|abc}}###</nowiki></code> : ###{{#invoke:String|trim|abc}}###
* <code><nowiki>###{{#invoke:String|trim|  abc}}###</nowiki></code> : ###{{#invoke:String|trim|  abc}}###
* <code><nowiki>###{{#invoke:String|trim|abc  }}###</nowiki></code> : ###{{#invoke:String|trim|abc  }}###
* <code><nowiki>###{{#invoke:String|trim|  abc  }}###</nowiki></code> : ###{{#invoke:String|trim|  abc  }}###

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

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

<includeonly>
{{Projet Scribunto}}
</includeonly><noinclude>
[[Catégorie:Documentation de module]]
</noinclude>