Метод substr()

Определение

Метод substr() возвращает подстроку символов из строки вызова метода. Аргументами передается начальный индекс символа и количество считываемых символов.

Синтаксис

string.substr(start[, length])

start

Начальная позиция подстроки. Если аргумент отрицателен, он обозначает позицию, измеряемую от конца строки: –1 обозначает последний символ, –2 – второй символ с конца и т. д.

length

Необязательный параметр. Количество символов в подстроке. Если этот аргумент отсутствует, возвращаемая строка включает все символы от начальной позиции до конца строки.

Описание

Метод substr() возвращает подстроку исходной строки, начальный индекс и длина которой указываются параметрами.

Метод substr() начинает извлекать символы начиная с позиции start и собирёт количество length символов, если он не достигнет раньше конца строки.

Если атрибут start больше либо равен длине строки, метод substr() вернёт пустую строку.

Если атрибут start – отрицательное число, позиция определяется начиная с конца строки.

Если атрибут start – отрицательное число и по модулю больше длины строки, метод substr() будет использовать 0 в качестве начального индекса.

Если атрибут length равен нулю или отрицателен, метод substr() вернёт пустую строку. Если length не указан, substr извлечёт все символы до конца строки.

Возвращаемое значение

Копия фрагмента строки, начиная с символа, находящегося в позиции start (включительно); имеет длину, равную аргументу length, или заканчивается концом строки, если длина length не указана.

Примеры