Aller au contenu

Module:String/Documentation

Ajouter des liens
Une page de Wikiversité, la communauté pédagogique libre.

Ceci est la page de documentation pour Module:String

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

Utilisation

[modifier le wikicode]

Fonctions exportables :

  • len – renvoie le nombre de caractères dans une chaîne, prend en compte les caractères multi-octets (len ou length signifie taille, longueur)
  • 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…


len

[modifier le wikicode]

Cette fonction renvoie la longueur de la chaîne cible.

Usage: 

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

OU 

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

Paramètres

  • s : la chaîne dont la longueur doit être signalée

Si invoqué à l'aide de paramètres nommés, Mediawiki supprimera automatiquement tout début ou espace blanc de fin de chaîne cible.


sub

[modifier le wikicode]

Cette fonction renvoie une sous-chaîne de la chaîne cible aux indices spécifiés.

Usage: 

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

OU 

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

Paramètres

  • s : la chaîne pour renvoyer un sous-ensemble de
  • i : Le premier index de la sous-chaîne à renvoyer, par défaut 1.
  • j : Le dernier index de la chaîne à renvoyer, par défaut le dernier caractère.

Le premier caractère de la chaîne se voit attribuer un index de 1. Si i ou j est une valeur négative, elle est interprétée de la même manière que la sélection d'un caractère par en comptant à partir de la fin de la chaîne. Ainsi, une valeur de -1 équivaut à sélection du dernier caractère de la chaîne.

Si les indices demandés sont hors de portée pour la chaîne donnée, une erreur est signalé.

match

[modifier le wikicode]

Cette fonction renvoie une sous-chaîne de la chaîne source qui correspond à une modèle spécifié.

Usage: 

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

Paramètres

  • s : la chaîne à rechercher
  • pattern : le modèle ou la chaîne à trouver dans la chaîne
  • start : l'index de la chaîne source pour démarrer la recherche. Le premier caractère de la chaîne a l'index 1. La valeur par défaut est 1.
  • match : Dans certains cas, il est possible d'effectuer plusieurs correspondances sur une même chaîne. Ceci spécifie la correspondance à renvoyer, la première étant match=1. Si un nombre négatif est spécifié, la correspondance est renvoyée à partir de la dernière correspondance. Ainsi, match=-1 revient à demander la dernière correspondance. La valeur par défaut est 1.
  • plain : indicateur indiquant que le motif doit être compris comme du texte brut. La valeur par défaut est « false ».
  • nomatch : si aucune correspondance n'est trouvée, affichez la valeur « nomatch » plutôt qu'une erreur.

Si invoqué à l'aide de paramètres nommés, Mediawiki supprimera automatiquement tout début ou espace à la fin de chaque chaîne. Dans certaines circonstances, cela est souhaitable, par exemple dans d'autres cas, on peut vouloir conserver l'espace blanc.

Si le match_number ou le start_index sont hors de portée pour la chaîne interrogée, alors Cette fonction génère une erreur. Une erreur est également générée si aucune correspondance n'est trouvée. Si l'on ajoute le paramètre ignore_errors=true, alors l'erreur sera supprimée et une chaîne vide sera renvoyée en cas d'échec.

Pour plus d'informations sur la construction de modèles Lua, une forme d'[expression régulière], voir :

pos

[modifier le wikicode]

Cette fonction renvoie un seul caractère de la chaîne cible à la position pos.

Usage: 

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

OU 

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

Paramètres

  • target : la chaîne à rechercher
  • pos : l'index du caractère à renvoyer

Si invoqué à l'aide de paramètres nommés, Mediawiki supprimera automatiquement tout début ou espaces de fin de chaîne cible. Dans certaines circonstances, cela est souhaitable, par exemple dans d'autres cas, on peut vouloir conserver l'espace blanc.

Le premier caractère a une valeur d’index de 1.

Si l'on demande une valeur négative, cette fonction sélectionnera un caractère en comptant à rebours à partir de la fin de la chaîne. Autrement dit, pos = -1 revient à demander le dernier caractère.

Une valeur demandée de zéro ou une valeur supérieure à la longueur de la chaîne renvoie une erreur.

str_find

[modifier le wikicode]

This function duplicates the behavior of Modèle: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

[modifier le wikicode]

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

[modifier le wikicode]

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


simpletitle

[modifier le wikicode]

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

Usage: 

{{#invoke:String|simpletitle}}

OR 

{{#invoke:String|simpletitle|string}}

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

[modifier le wikicode]

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

Utilisation : 

{{#invoke:String|titledisambig}}

OU 

{{#invoke:String|titledisambig|expression}}

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

[modifier le wikicode]

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

[modifier le wikicode]

len

[modifier le wikicode]
{{#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

sub

[modifier le wikicode]
{{#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

[modifier le wikicode]
  • ###{{#invoke:String|trim|abc}}### : ###abc###
  • ###{{#invoke:String|trim| abc}}### : ###abc###
  • ###{{#invoke:String|trim|abc }}### : ###abc###
  • ###{{#invoke:String|trim| abc }}### : ###abc###

Voir aussi

[modifier le wikicode]

Modèle:Traduction/Référence

Récupérée de "https://fr.wikiversity.org/w/index.php?title=Module:String/Documentation&oldid=972346"