Module:String/doc/ja

警告:	このページは複数のウィキ間で共有されています。 このページへのすべての変更は、左側のサイドバーに列挙されているすべてのウィキに自動的にコピーされます。

このモジュールは、基礎的な文字列関数へのアクセスを提供することを目的としています。

ここで提供されているほとんどの関数は、名前付きのパラメーター、無名のパラメーター、またはその混合で呼び出せます。 名前付きパラメーターが使用される場合、MediaWiki はパラメーターの先頭または末尾の空白類を自動的に除去します。 使用目的に応じて、そのような空白類を残したり、除去したりすることが有利な場合があります。

グローバル オプション

ignore_errors

true または 1 を設定した場合、いかなるエラー状態でも、エラー メッセージではなく、空の文字列が返されます。

error_category

エラーが発生した場合にエラー メッセージに含めるカテゴリ名を指定します。 既定のカテゴリは Category:Errors reported by Module String です。

no_category

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

Unit tests for this module are available at Module:String/testcases.

len

This function returns the length of the target string.

使用法:

{{#invoke:String|len|対象文字列}}

または

{{#invoke:String|len|s= 対象文字列 }}

パラメーター:

s

長さを報告する文字列

sub

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

使用法:

{{#invoke:String|sub|対象文字列|始点の添字|終点の添字}}

または

{{#invoke:String|sub|s= 対象文字列 |i= 始点の添字 |j= 終点の添字 }}

パラメーター:

s

部分文字列を求める元の文字列

i

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

j

返す文字列の最後の添字であり、既定値は最後の文字です。

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.

使用法:

{{#invoke:String|match|source_string|pattern_string|始点の添字|match_number|平文フラグ|nomatch_output}}

または

{{#invoke:String|match|s= source_string |pattern= pattern_string |start= 始点の添字 |match= match_number |plain= 平文フラグ |nomatch= nomatch_output }}

パラメーター:

s

検索する文字列

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. 既定値は 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. 既定値は 1 です。

plain

Boolean flag indicating that pattern should be understood as plain text and not as a Lua-style regular expression. 既定値は 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.

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

• Lua reference: Patterns - as of version 5.1
• Scribunto patterns
• Scribunto Unicode string patterns

pos

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

使用法:

{{#invoke:String|pos|対象文字列|添字の値}}

または

{{#invoke:String|pos|target= 対象文字列 |pos= 添字の値 }}

パラメーター:

target

検索する文字列

pos

The index for the character to return

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.

使用法:

{{#invoke:String|find|source_str|対象文字列|始点の添字|平文フラグ}}

または

{{#invoke:String|find|source= source_str |target= 対象文字列 |start= 始点の添字 |plain= 平文フラグ }}

パラメーター:

source

検索する文字列

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.

This function should be safe for UTF-8 strings.

replace

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

使用法:

{{#invoke:String|replace|source_str|pattern_string|replace_string|置換回数|平文フラグ}}

または

{{#invoke:String|replace|source= source_string |pattern= pattern_string |replace= replace_string |count= 置換回数 |plain= 平文フラグ }}

パラメーター:

source

検索する文字列

pattern

The string or pattern to find within source

replace

The replacement text

count

The number of occurrences to replace; defaults to all

plain

Boolean flag indicating that pattern should be understood as plain text and not as a Scribunto ustring pattern (a unicode-friendly Lua-style regular expression); defaults to true

rep

Repeats a string n times.

使用法:

{{#invoke:String|rep|source|回数}}

パラメーター:

source

繰り返す文字列

count

繰り返しの回数。

例えば {{#invoke:String|rep|こんにちは|3}} は こんにちはこんにちはこんにちは になります。