Str
класс Str (View source)
Черты
| Macroable |
Свойства
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| static protected array | $snakeCache | Кэш слов в snake_case. | |
| static protected array | $camelCache | Кэш слов в camelCase. | |
| static protected array | $studlyCache | Кэш слов в StudlyCaps. | |
| static protected callable|null | $uuidFactory | Обратный вызов, который должен использоваться для генерации UUID. | |
| static protected callable|null | $ulidFactory | Обратный вызов, который должен использоваться для генерации ULID. | |
| static protected callable|null | $randomStringFactory | Обратный вызов, который должен использоваться для генерации случайных строк. |
Методы
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Включить другой объект в класс. | from Macroable |
| static bool | hasMacro(string $name)
Проверить, зарегистрирован ли макрос. | from Macroable |
| static void | flushMacros()
Очистить существующие макросы. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы класса. | from Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обрабатывать вызовы класса. | from Macroable |
| static Stringable | of(string $string)
Получить новый строковый объект из данной строки. | |
| static string | after(string $subject, string $search)
Вернуть остаток строки после первого вхождения заданного значения. | |
| static string | afterLast(string $subject, string $search)
Вернуть остаток строки после последнего вхождения заданного значения. | |
| static string | ascii(string $value, string $language = 'en')
Транслитерировать значение UTF-8 в ASCII. | |
| static string | transliterate(string $string, string|null $unknown = '?', bool|null $strict = false)
Транслитерировать строку в её ближайшее ASCII представление. | |
| static string | before(string $subject, string $search)
Получить часть строки до первого вхождения заданного значения. | |
| static string | beforeLast(string $subject, string $search)
Получить часть строки до последнего вхождения заданного значения. | |
| static string | between(string $subject, string $from, string $to)
Получить часть строки между двумя заданными значениями. | |
| static string | betweenFirst(string $subject, string $from, string $to)
Получить наименьшую возможную часть строки между двумя заданными значениями. | |
| static string | camel(string $value)
Преобразовать значение в camel case. | |
| static string|false | charAt(string $subject, int $index)
Получить символ по указанному индексу. | |
| static string | chopStart(string $subject, string|array $needle)
Удалить заданную строку(и), если она существует в начале строки. | |
| static string | chopEnd(string $subject, string|array $needle)
Удалить заданную строку(и), если она существует в конце строки. | |
| static bool | contains(string $haystack, string|iterable<string> $needles, bool $ignoreCase = false)
Определить, содержит ли данная строка заданную подстроку. | |
| static bool | containsAll(string $haystack, iterable<string> $needles, bool $ignoreCase = false)
Определить, содержит ли данная строка все значения массива. | |
| static string | convertCase(string $string, int $mode = MB_CASE_FOLD, string|null $encoding = 'UTF-8')
Преобразовать регистр строки. | |
| static bool | endsWith(string $haystack, string|iterable<string> $needles)
Определить, заканчивается ли данная строка заданной подстрокой. | |
| static string|null | excerpt(string $text, string $phrase = '', array $options = [])
Извлекает выдержку из текста, которая соответствует первому вхождению фразы. | |
| static string | finish(string $value, string $cap)
Завершить строку одним экземпляром заданного значения. | |
| static string | wrap(string $value, string $before, string|null $after = null)
Обернуть строку заданными строками. | |
| static string | unwrap(string $value, string $before, string|null $after = null)
Разобрать строку на заданные строки. | |
| static bool | is(string|iterable<string> $pattern, string $value)
Определить, соответствует ли данная строка заданному шаблону. | |
| static bool | isAscii(string $value)
Определить, является ли данная строка 7-битным ASCII. | |
| static bool | isJson(mixed $value)
Определить, является ли данное значение допустимым JSON. | |
| static bool | isUrl(mixed $value, array $protocols = [])
Определить, является ли данное значение допустимым URL. | |
| static bool | isUuid(mixed $value)
Определить, является ли данное значение допустимым UUID. | |
| static bool | isUlid(mixed $value)
Определить, является ли данное значение допустимым ULID. | |
| static string | kebab(string $value)
Преобразовать строку в kebab case. | |
| static int | length(string $value, string|null $encoding = null)
Вернуть длину данной строки. | |
| static string | limit(string $value, int $limit = 100, string $end = '...')
Ограничить количество символов в строке. | |
| static string | lower(string $value)
Преобразовать данную строку в нижний регистр. | |
| static string | words(string $value, int $words = 100, string $end = '...')
Ограничить количество слов в строке. | |
| static string | markdown(string $string, array $options = [], array $extensions = [])
Преобразует Markdown в стиле GitHub в HTML. | |
| static string | inlineMarkdown(string $string, array $options = [])
Преобразует встроенный Markdown в HTML. | |
| static string | mask(string $string, string $character, int $index, int|null $length = null, string $encoding = 'UTF-8')
Маскирует часть строки повторяющимся символом. | |
| static string | match(string $pattern, string $subject)
Получить строку, соответствующую заданному шаблону. |
| static bool | isMatch(string|iterable<string> $pattern, string $value)
Определить, соответствует ли данная строка заданному шаблону. | |
| static Collection | matchAll(string $pattern, string $subject)
Получить строку, соответствующую заданному шаблону. | |
| static string | numbers(string $value)
Удалить все нечисловые символы из строки. | |
| static string | padBoth(string $value, int $length, string $pad = ' ')
Добавить пробелы с обеих сторон строки. | |
| static string | padLeft(string $value, int $length, string $pad = ' ')
Добавить пробелы слева от строки. | |
| static string | padRight(string $value, int $length, string $pad = ' ')
Добавить пробелы справа от строки. | |
| static array<int,string|null> | parseCallback(string $callback, string|null $default = null)
Разбить обратный вызов в стиле Class[@]method на класс и метод. | |
| static string | plural(string $value, int|array|Countable $count = 2)
Получить форму множественного числа английского слова. | |
| static string | pluralStudly(string $value, int|array|Countable $count = 2)
Перевести в форму множественного числа последнее слово английской строки в формате StudlyCaps. | |
| static string | password(int $length = 32, bool $letters = true, bool $numbers = true, bool $symbols = true, bool $spaces = false)
Сгенерировать случайный, безопасный пароль. | |
| static int|false | position(string $haystack, string $needle, int $offset = 0, string|null $encoding = null)
Найти безопасную для многобайтовой кодировки позицию первого вхождения данной подстроки в строку. | |
| static string | random(int $length = 16)
Сгенерировать более действительно "случайную" буквенно-цифровую строку. | |
| static void | createRandomStringsUsing(callable|null $factory = null)
Установить вызываемый объект, который будет использоваться для генерации случайных строк. | |
| static void | createRandomStringsUsingSequence(array $sequence, callable|null $whenMissing = null)
Установить последовательность, которая будет использоваться для генерации случайных строк. | |
| static void | createRandomStringsNormally()
Указать, что случайные строки должны создаваться обычно, а не с использованием пользовательского объекта. | |
| static string | repeat(string $string, int $times)
Повторить данную строку. | |
| static string | replaceArray(string $search, iterable<string> $replace, string $subject)
Последовательно заменить данное значение в строке массивом. | |
| static string|string[] | replace(string|iterable<string> $search, string|iterable<string> $replace, string|iterable<string> $subject, bool $caseSensitive = true)
Заменить данное значение в данной строке. | |
| static string | replaceFirst(string $search, string $replace, string $subject)
Заменить первое вхождение данного значения в строку. | |
| static string | replaceStart(string $search, string $replace, string $subject)
Заменить первое вхождение данного значения, если оно находится в начале строки. | |
| static string | replaceLast(string $search, string $replace, string $subject)
Заменить последнее вхождение данного значения в строку. | |
| static string | replaceEnd(string $search, string $replace, string $subject)
Заменить последнее вхождение данного значения, если оно находится в конце строки. | |
| static string|string[]|null | replaceMatches(array|string $pattern, Closure|string[]|string $replace, array|string $subject, int $limit = -1)
Заменить шаблоны, соответствующие данному регулярному выражению. | |
| static string | remove(string|iterable<string> $search, string|iterable<string> $subject, bool $caseSensitive = true)
Удалить любое вхождение данной строки в subject. | |
| static string | reverse(string $value)
Перевернуть данную строку. | |
| static string | start(string $value, string $prefix)
Начать строку с одного экземпляра данного значения. | |
| static string | upper(string $value)
Преобразовать данную строку в верхний регистр. | |
| static string | title(string $value)
Преобразовать данную строку в надлежащий регистр. | |
| static string | headline(string $value)
Преобразовать данную строку в надлежащий регистр для каждого слова. | |
| static string | apa(string $value)
Преобразовать данную строку в заголовок в стиле APA. | |
| static string | singular(string $value)
Получить форму единственного числа английского слова. | |
| static string | slug(string $title, string $separator = '-', string|null $language = 'en', array<string,string> $dictionary = ['@' => 'at'])
Сгенерировать URL-дружественный "slug" из данной строки. | |
| static string | snake(string $value, string $delimiter = '_')
Преобразовать строку в snake_case. | |
| static string | trim(string $value, string|null $charlist = null)
Удалить все пробелы с обоих концов строки. | |
| static string | ltrim(string $value, string|null $charlist = null)
Удалить все пробелы с начала строки. | |
| static string | rtrim(string $value, string|null $charlist = null)
Удалить все пробелы с конца строки. | |
| static string | squish(string $value)
Удалить все "лишние" пробелы из данной строки. | |
| static bool | startsWith(string $haystack, string|iterable<string> $needles)
Определить, начинается ли данная строка с данной подстроки. | |
| static string | studly(string $value)
Преобразовать значение в регистр StudlyCaps. | |
| static string | substr(string $string, int $start, int|null $length = null, string $encoding = 'UTF-8')
Возвращает часть строки, указанную параметрами start и length. | |
| static int | substrCount(string $haystack, string $needle, int $offset = 0, int|null $length = null)
Возвращает количество вхождений подстроки. |
| static string|string[] | substrReplace(string|string[] $string, string|string[] $replace, int|int[] $offset = 0, int|int[]|null $length = null)
Заменить текст внутри части строки. | |
| static string | swap(array $map, string $subject)
Заменить несколько ключевых слов в строке на другие ключевые слова. | |
| static string | take(string $string, int $limit)
Взять первые или последние {$limit} символов строки. | |
| static string | toBase64(string $string)
Преобразовать заданную строку в кодировку Base64. | |
| static string|false | fromBase64(string $string, bool $strict = false)
Декодировать заданную строку, закодированную в Base64. | |
| static string | lcfirst(string $string)
Сделать первый символ строки строчным. | |
| static string | ucfirst(string $string)
Сделать первый символ строки прописным. | |
| static string[] | ucsplit(string $string)
Разделить строку на части по прописным буквам. | |
| static int | wordCount(string $string, string|null $characters = null)
Получить количество слов, содержащихся в строке. | |
| static string | wordWrap(string $string, int $characters = 75, string $break = "\n", bool $cutLongWords = false)
Разбить строку на строки заданной длины. | |
| static UuidInterface | uuid()
Сгенерировать UUID (версия 4). | |
| static UuidInterface | orderedUuid()
Сгенерировать упорядоченный по времени UUID. | |
| static void | createUuidsUsing(callable|null $factory = null)
Установить вызываемый объект, который будет использоваться для генерации UUID. | |
| static void | createUuidsUsingSequence(array $sequence, callable|null $whenMissing = null)
Установить последовательность, которая будет использоваться для генерации UUID. | |
| static UuidInterface | freezeUuids(Closure|null $callback = null)
Всегда возвращать один и тот же UUID при генерации новых UUID. | |
| static void | createUuidsNormally()
Указать, что UUID должны создаваться обычным образом, а не с использованием пользовательского фабричного метода. | |
| static Ulid | ulid(DateTimeInterface|null $time = null)
Сгенерировать ULID. | |
| static void | createUlidsNormally()
Указать, что ULID должны создаваться обычным образом, а не с использованием пользовательского фабричного метода. | |
| static void | createUlidsUsing(callable|null $factory = null)
Установить вызываемый объект, который будет использоваться для генерации ULID. | |
| static void | createUlidsUsingSequence(array $sequence, callable|null $whenMissing = null)
Установить последовательность, которая будет использоваться для генерации ULID. | |
| static Ulid | freezeUlids(Closure|null $callback = null)
Всегда возвращать один и тот же ULID при генерации новых ULID. | |
| static void | flushCache()
Удалить все строки из кешей регистров. |
Подробности
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверить, зарегистрирован ли макрос.
static void flushMacros()
Очистить существующие макросы.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывать вызовы класса.
static Stringable of(string $string)
Получить новый объект Stringable из данной строки.
static string after(string $subject, string $search)
Вернуть остаток строки после первого вхождения заданного значения.
static string afterLast(string $subject, string $search)
Вернуть остаток строки после последнего вхождения заданного значения.
static string ascii(string $value, string $language = 'en')
Транслитерировать значение UTF-8 в ASCII.
static string transliterate(string $string, string|null $unknown = '?', bool|null $strict = false)
Транслитерировать строку в её ближайшее ASCII представление.
static string before(string $subject, string $search)
Получить часть строки до первого вхождения данного значения.
static string beforeLast(string $subject, string $search)
Получить часть строки до последнего вхождения данного значения.
static string between(string $subject, string $from, string $to)
Получить часть строки между двумя заданными значениями.
static string betweenFirst(string $subject, string $from, string $to)
Получить наименьшую возможную часть строки между двумя заданными значениями.
static string camel(string $value)
Преобразовать значение в camel case.
static string|false charAt(string $subject, int $index)
Получить символ по указанному индексу.
static string chopStart(string $subject, string|array $needle)
Удалить заданную строку(и), если она существует в начале строки.
static string chopEnd(string $subject, string|array $needle)
Удалить заданную строку(и), если она существует в конце строки.
static bool contains(string $haystack, string|iterable<string> $needles, bool $ignoreCase = false)
Определить, содержит ли данная строка заданную подстроку.
static bool containsAll(string $haystack, iterable<string> $needles, bool $ignoreCase = false)
Определить, содержит ли данная строка все значения массива.
static string convertCase(string $string, int $mode = MB_CASE_FOLD, string|null $encoding = 'UTF-8')
Преобразовать регистр строки.
static bool endsWith(string $haystack, string|iterable<string> $needles)
Определить, заканчивается ли данная строка заданной подстрокой.
static string|null excerpt(string $text, string $phrase = '', array $options = [])
Извлекает выдержку из текста, которая соответствует первому вхождению фразы.
static string finish(string $value, string $cap)
Завершить строку одним экземпляром данного значения.
static string wrap(string $value, string $before, string|null $after = null)
Обернуть строку заданными строками.
static string unwrap(string $value, string $before, string|null $after = null)
Разобрать строку с заданными строками.
static bool is(string|iterable<string> $pattern, string $value)
Определить, соответствует ли данная строка заданному шаблону.
static bool isAscii(string $value)
Определить, является ли данная строка 7-битной ASCII.
static bool isJson(mixed $value)
Определить, является ли данное значение допустимым JSON.
static bool isUrl(mixed $value, array $protocols = [])
Определить, является ли данное значение допустимым URL.
static bool isUuid(mixed $value)
Определить, является ли данное значение допустимым UUID.
static bool isUlid(mixed $value)
Определить, является ли данное значение допустимым ULID.
static string kebab(string $value)
Преобразовать строку в kebab-case.
static int length(string $value, string|null $encoding = null)
Возвращает длину данной строки.
static string limit(string $value, int $limit = 100, string $end = '...')
Ограничить количество символов в строке.
static string lower(string $value)
Преобразовать данную строку в нижний регистр.
static string words(string $value, int $words = 100, string $end = '...')
Ограничить количество слов в строке.
static string markdown(string $string, array $options = [], array $extensions = [])
Преобразует Markdown в стиле GitHub в HTML.
static string inlineMarkdown(string $string, array $options = [])
Преобразует встроенный Markdown в HTML.
static string mask(string $string, string $character, int $index, int|null $length = null, string $encoding = 'UTF-8')
Маскирует часть строки повторяющимся символом.
static string match(string $pattern, string $subject)
Получить строку, соответствующую заданному шаблону.
static bool isMatch(string|iterable<string> $pattern, string $value)
Определить, соответствует ли данная строка заданному шаблону.
static Collection matchAll(string $pattern, string $subject)
Получить строку, соответствующую заданному шаблону.
static string numbers(string $value)
Удалить все нецифровые символы из строки.
static string padBoth(string $value, int $length, string $pad = ' ')
Добавить пробелы с обеих сторон строки.
static string padLeft(string $value, int $length, string $pad = ' ')
Добавить пробелы слева от строки.
static string padRight(string $value, int $length, string $pad = ' ')
Добавить справа к строке другую строку.
static array<int,string|null> parseCallback(string $callback, string|null $default = null)
Разбить обратный вызов в стиле Class[@]method на класс и метод.
static string plural(string $value, int|array|Countable $count = 2)
Получить форму множественного числа английского слова.
static string pluralStudly(string $value, int|array|Countable $count = 2)
Поставить в форму множественного числа последнее слово английской строки в стиле StudlyCaps.
static string password(int $length = 32, bool $letters = true, bool $numbers = true, bool $symbols = true, bool $spaces = false)
Сгенерировать случайный, безопасный пароль.
static int|false position(string $haystack, string $needle, int $offset = 0, string|null $encoding = null)
Найти безопасную для многобайтовых символов позицию первого вхождения данной подстроки в строку.
static string random(int $length = 16)
Сгенерировать более по-настоящему "случайную" буквенно-цифровую строку.
static void createRandomStringsUsing(callable|null $factory = null)
Установить вызываемый объект, который будет использоваться для генерации случайных строк.
static void createRandomStringsUsingSequence(array $sequence, callable|null $whenMissing = null)
Установить последовательность, которая будет использоваться для генерации случайных строк.
static void createRandomStringsNormally()
Указать, что случайные строки должны создаваться обычным образом, а не с помощью пользовательского объекта.
static string repeat(string $string, int $times)
Повторить заданную строку.
static string replaceArray(string $search, iterable<string> $replace, string $subject)
Последовательно заменить заданное значение в строке с помощью массива.
static string|string[] replace(string|iterable<string> $search, string|iterable<string> $replace, string|iterable<string> $subject, bool $caseSensitive = true)
Заменить заданное значение в заданной строке.
static string replaceFirst(string $search, string $replace, string $subject)
Заменить первое вхождение заданного значения в строке.
static string replaceStart(string $search, string $replace, string $subject)
Заменить первое вхождение заданного значения, если оно находится в начале строки.
static string replaceLast(string $search, string $replace, string $subject)
Заменить последнее вхождение заданного значения в строке.
static string replaceEnd(string $search, string $replace, string $subject)
Заменить последнее вхождение заданного значения, если оно находится в конце строки.
static string|string[]|null replaceMatches(array|string $pattern, Closure|string[]|string $replace, array|string $subject, int $limit = -1)
Заменить шаблоны, соответствующие заданному регулярному выражению.
static string remove(string|iterable<string> $search, string|iterable<string> $subject, bool $caseSensitive = true)
Удалить любое вхождение заданной строки в исходную строку.
static string reverse(string $value)
Перевернуть заданную строку.
static string start(string $value, string $prefix)
Начать строку с одного экземпляра заданного значения.
static string upper(string $value)
Преобразовать заданную строку в верхний регистр.
static string title(string $value)
Преобразовать заданную строку в надлежащий регистр.
static string headline(string $value)
Преобразовать заданную строку в надлежащий регистр для каждого слова.
static string apa(string $value)
Преобразовать заданную строку в заголовок в стиле APA.
См.: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case
static string singular(string $value)
Получить единственное число английского слова.
static string slug(string $title, string $separator = '-', string|null $language = 'en', array<string,string> $dictionary = ['@' => 'at'])
Создать URL-дружественный "slug" из заданной строки.
static string snake(string $value, string $delimiter = '_')
Преобразовать строку в snake case.
static string trim(string $value, string|null $charlist = null)
Удалить все пробелы с обоих концов строки.
static string ltrim(string $value, string|null $charlist = null)
Удалить все пробелы с начала строки.
static string rtrim(string $value, string|null $charlist = null)
Удалить все пробелы с конца строки.
static string squish(string $value)
Удалить все "лишние" пробелы из заданной строки.
static bool startsWith(string $haystack, string|iterable<string> $needles)
Определить, начинается ли заданная строка с заданной подстроки.
static string studly(string $value)
Преобразовать значение в регистр Studly Caps.
static string substr(string $string, int $start, int|null $length = null, string $encoding = 'UTF-8')
Возвращает часть строки, указанную параметрами start и length.
static int substrCount(string $haystack, string $needle, int $offset = 0, int|null $length = null)
Возвращает количество вхождений подстроки.
static string|string[] substrReplace(string|string[] $string, string|string[] $replace, int|int[] $offset = 0, int|int[]|null $length = null)
Заменить текст в части строки.
static string swap(array $map, string $subject)
Заменить несколько ключевых слов в строке на другие ключевые слова.
static string take(string $string, int $limit)
Взять первые или последние {$limit} символов строки.
static string toBase64(string $string)
Преобразовать данную строку в кодировку Base64.
static string|false fromBase64(string $string, bool $strict = false)
Декодировать данную строку, закодированную в Base64.
static string lcfirst(string $string)
Сделать первый символ строки строчным.
static string ucfirst(string $string)
Сделать первый символ строки прописным.
static string[] ucsplit(string $string)
Разделить строку на части по прописным буквам.
static int wordCount(string $string, string|null $characters = null)
Получить количество слов, содержащихся в строке.
static string wordWrap(string $string, int $characters = 75, string $break = "\n", bool $cutLongWords = false)
Разбить строку на строки заданной длины.
static UuidInterface uuid()
Сгенерировать UUID (версия 4).
static UuidInterface orderedUuid()
Сгенерировать упорядоченный по времени UUID.
static void createUuidsUsing(callable|null $factory = null)
Установить вызываемый объект, который будет использоваться для генерации UUID.
static void createUuidsUsingSequence(array $sequence, callable|null $whenMissing = null)
Установить последовательность, которая будет использоваться для генерации UUID.
static UuidInterface freezeUuids(Closure|null $callback = null)
Всегда возвращать один и тот же UUID при генерации новых UUID.
static void createUuidsNormally()
Указать, что UUID должны создаваться обычным образом, а не с использованием пользовательского фабричного метода.
static Ulid ulid(DateTimeInterface|null $time = null)
Сгенерировать ULID.
static void createUlidsNormally()
Указать, что ULID должны создаваться обычным образом, а не с использованием пользовательского фабричного метода.
static void createUlidsUsing(callable|null $factory = null)
Установить вызываемый объект, который будет использоваться для генерации ULID.
static void createUlidsUsingSequence(array $sequence, callable|null $whenMissing = null)
Установить последовательность, которая будет использоваться для генерации ULID.
static Ulid freezeUlids(Closure|null $callback = null)
Всегда возвращать один и тот же ULID при генерации новых ULID.
static void flushCache()
Удалить все строки из кэшей.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Support/Str.html
