Модуль:String/doc
Это страница документации Модуль:String.
Этот модуль предназначен для обеспечения доступа к основным строковым функциям.
Большая часть функций, имеющихся в модуле, может быть вызвана именованными, неименованными параметрами или обоими вариантами. Если используются именованные параметры, движок Mediawiki автоматически удаляет любые начальные или конечные пробелы из параметра. В зависимости от предполагаемого использования может быть предпочтительным либо сохранение, либо удаление таких пропусков. Экспериментировать с модулем можно на странице Модуль:String/Песочница.
Глобальные параметры[править код]
Шаблон:Code: | Если параметру присвоено значение Шаблон:Code или Шаблон:Code, вместо любого сообщения об ошибке выводится пустая строка. |
Шаблон:Code: | В случае возникновения ошибки определяет название категории, в которую помещается страница с сообщением об ошибке. По умолчанию помещается в Шаблон:C. |
Шаблон:Code: | Если параметру присвоено значение Шаблон:Code или Шаблон:Code, то в случае сообщения об ошибке страница не будет помещена в соответствующую категорию. |
len[править код]
Функция возвращает длину целевой строки.
- Использование
{{#invoke:String|len|целевая_строка}}
- или
{{#invoke:String|len|s= целевая_строка }}
- Параметры
Шаблон:Code: | Строка, длину которой необходимо найти. |
sub[править код]
Функция возвращает часть целевой стоки между указанными индексами (порядковыми номерами символов в целевой строке)
- Использование
{{#invoke:String|sub|целевая_строка|начальный_индекс|конечный_индекс}}
- или
{{#invoke:String|sub|s= целевая_строка |i= начальный_индекс |j= конечный_индекс }}
- Параметры
Шаблон:Code: | Строка, часть которой необходимо вывести. |
Шаблон:Code: | Порядковый номер символа, начиная с которого необходимо вывести строку. Значение по умолчанию — 1. |
Шаблон:Code: | Порядковый номер символа, до которого необходимо вывести строку. Значение по умолчанию — порядковый номер последнего символа. |
Первому символу строки присваивается индекс Шаблон:Code. Если параметрам Шаблон:Code или Шаблон:Code присвоено отрицательное значение, то оно распознается модулем как порядковый номер символа, отсчитываемый с конца строки. Другими словами, значение Шаблон:Code распознается модулем как порядковый номер последнего символа в строке.
Если введённые индексы по модулю больше длины целевой строки, то выводится сообщение об ошибке.
sublength[править код]
С помощью этой функции реализован шаблон {{Str sub}}, она сохраняется для поддержания его работоспособности.
match[править код]
Функция возвращает часть целевой строки, которая соответствует заданной строке.
- Использование
{{#invoke:String|match|исходная_строка|заданная_строка|начальный_индекс|номер_совпадения|простой_флаг|значение_если_нет_совпадений}}
- или
{{#invoke:String|match|s= исходная_строка |pattern= заданная_строка |start= начальный_индекс|match= номер_совпадения|plain= флаг_простоты |nomatch= значение_если_нет_совпадений }}
- Параметры
Шаблон:Code: | Целевая строка, часть которой необходимо найти. |
Шаблон:Code: | Строка, совпадение с которой необходимо найти в целевой строке. |
Шаблон:Code: | Порядковый номер символа, начиная с которого необходимо произвести поиск совпадения. По умолчанию — Шаблон:Code. Если начиная с заданного символа совпадений не найдено, функция возвращает сообщение об ошибке. |
Шаблон:Code: | В некоторых случаях может оказаться несколько совпадений с заданной строкой в одной целевой строке. Параметр задает номер совпадения, которое необходимо вывести. Если параметру присвоено отрицательное значение, то оно распознается модулем как порядковый номер совпадения, отсчитываемый с конца строки. Другими словами, значение Шаблон:Code распознается модулем как порядковый номер последнего совпадения в строке. По умолчанию — 1. |
Шаблон:Code: | Если параметру присвоено значение Шаблон:Code, функция воспринимает заданную строку как обычный текст. По умолчанию — Шаблон:Code. |
Шаблон:Code: | Последовательность символов, выводимая строкой в случае отсутствия совпадений вместо сообщения об ошибке. |
Если введённый индекс по модулю больше длины целевой строки или совпадений найдено меньше, чем число, заданное в параметре Шаблон:Code, то выводится сообщение об ошибке. Если добавить параметр Шаблон:Code, то вместо любого из сообщений об ошибке будет возвращена пустая строка.
Подробнее регулярных выражениях, используемых в Lua, см.:
pos[править код]
Функция возвращает один символ из целевой строки под заданным порядковым номером.
- Использование
{{#invoke:String|pos|целевая_строка|значение_индекса}}
- или
{{#invoke:String|pos|target= целевая_строка |pos= значение_индекса }}
- Параметры
Шаблон:Code: | Строка, в которой производится поиск символа. |
Шаблон:Code: | Порядковый номер возвращаемого символа |
Если параметру Шаблон:Code присвоено отрицательное значение, то оно распознается модулем как порядковый номер символа, отсчитываемый с конца строки. Другими словами, значение Шаблон:Code распознается модулем как порядковый номер последнего символа в строке.
Если заданный порядковый номер равен 0 или больше длины строки, функция возвращает сообщение об ошибке.
str_find[править код]
Эта фунция предназначена для поддержания функционирования шаблона {{str find}}. Она сохраняется для того, чтобы поддерживать существующие шаблоны, но она крайне не рекомендуется для использования в новых шаблонах. Рекомендуется вместо неё использовать функцию Шаблон:Code.
Возвращает порядковый номер символа, начиная с которого целевая строка, заданная параметром Шаблон:Code совпадает со строкой в параметре Шаблон:Code. Функция возвращает −1, если совпадений между строками не найдено.
Важно: Если в параметре Шаблон:Code не задана строка, либо отсутствует сам параметр, функция возвращает 1, что, как правило, является полной неожиданностью для пользователей.
find[править код]
Функция позволяет выполнить поиск целевой строки в другой строке.
- Использование
{{#invoke:String|find|искомая_строка|целевая_строка|начальный_индекс|флаг_простоты}}
- или
{{#invoke:String|find|source= искомая_строка |target= целевая_строка |start= начальный_индекс|plain= флаг_простоты }}
- Параметры
Шаблон:Code: | Строка, в которой ведется поиск целевой строки. |
Шаблон:Code: | Целевая строка, которая ищется в другой строке. |
Шаблон:Code: | Порядковый номер символа, начиная с которого ведется поиск совпадений. Значение по умолчанию — 1. |
Шаблон:Code: | Если параметру присвоено значение Шаблон:Code, функция воспринимает заданную строку как обычный текст. По умолчанию — Шаблон:Code. |
Функция возвращает значение, большее либо равное значению параметра Шаблон:Code. Если совпадений не найдено, функция возвращает 0, если одна из строк пустая или не задана, функция также возвращает 0.
Функция должна быть безопасна для строк кодировки UTF-8.
replace[править код]
Функция позволяет заменить целевую строку в другой строке.
- Использование
{{#invoke:String|replace|искомая_строка|целевая_строка|заменяющая_строка|количество_замен|флаг_простоты}}
- или
{{#invoke:String|replace|source= искомая_строка |pattern= целевая_строка|replace= заменяющая_строка |count= количество_замен |plain= флаг_простоты }}
- Параметры
Шаблон:Code: | Строка, в которой ведется поиск. |
Шаблон:Code: | Строка, которая ищется в искомой строке. |
Шаблон:Code: | Строка, заменяющая целевую. |
Шаблон:Code: | Количество заменяемых совпадений; по умолчанию — все. |
Шаблон:Code: | Если параметру присвоено значение Шаблон:Code, функция воспринимает заданную строку как обычный текст. По умолчанию — Шаблон:Code. |
rep[править код]
Функция возвращает строку, состоящую из повторений n раз исходной строки. Простая функция для подключения string.rep к шаблонам.
- Использование
{{#invoke:String|rep|строка|количество_повторов}}
- Параметры
Шаблон:Code: | Строка, которую необходимо повторить n раз. |
Шаблон:Code: | Количество повторов. |
Пример: {{#invoke:String|rep|привет!|3}}
→ привет!привет!привет!