Module:String/Documentation

Ceci est la documentation de Module:String [modifier] [purger].
Cette sous-page contient les instructions, les catégories de son module d'origine et elle n'est pas destinée à être visualisée directement.

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

Utilisation

Fonctions exportables :

• sub – renvoie une partie de la chaîne de caractères (sub ou sub-string signifie sous-chaîne)
• trim – renvoie la chaîne de caractères en supprimant les éventuels espaces au début et/ou à la fin

Autres fonctions :
À compléter…

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

sub

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

Usage:

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

OR

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

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:

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

OR

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

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.

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

find

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

Usage:

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

OR

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

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:

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

OR

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

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

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 :

{{#invoke:String|trim|texte}}

Paramètres :

• texte : le texte à nettoyer de ses espaces et sauts de ligne au début / à la fin

Exemples

sub

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

trim

• ###{{#invoke:String|trim|abc}}### : ###abc###
• ###{{#invoke:String|trim| abc}}### : ###abc###
• ###{{#invoke:String|trim|abc }}### : ###abc###
• ###{{#invoke:String|trim| abc }}### : ###abc###