Spec-Zone.ru › Laravel 9

Str

класс Str (Просмотр исходного кода)

Трейты

Macroable

Свойства

статический защищенный массив $macros

Зарегистрированные макросы строк.

из Macroable
статический защищенный массив $snakeCache

Кэш слов в змеином регистре.

статический защищенный массив $camelCache

Кэш слов в верблюжьем регистре.

статический защищенный массив $studlyCache

Кэш слов в верблюжьем регистре с заглавными буквами.

статический защищенный вызов|null $uuidFactory

Обратный вызов, используемый для генерации UUID.

статический защищенный вызов|null $randomStringFactory

Обратный вызов, используемый для генерации случайных строк.

Методы

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макрос.

из Macroable
static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

из Macroable
static bool hasMacro(string $name)

Проверка, зарегистрировано ли макрос.

из Macroable
static void flushMacros()

Очистить существующие макросы.

из Macroable
static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

из Macroable
mixed __call(string $method, array $parameters)

Динамически обработать вызовы к классу.

из Macroable
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)

Преобразовать значение в верблюжье регистр.

static bool contains(string $haystack, string|iterable<string> $needles, bool $ignoreCase = false)

Определить, содержит ли заданная строка заданную подстроку.

static bool containsAll(string $haystack, iterable<string> $needles, bool $ignoreCase = false)

Определить, содержит ли заданная строка все значения массива.

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 bool is(string|iterable<string> $pattern, string $value)

Определить, соответствует ли заданная строка заданному шаблону.

static bool isAscii(string $value)

Определить, является ли заданная строка 7-битной ASCII.

static bool isJson(string $value)

Определить, является ли заданная строка валидным JSON.

static bool isUuid(string $value)

Определить, является ли заданная строка валидным UUID.

static bool isUlid(string $value)

Определить, является ли заданная строка валидным ULID.

static string kebab(string $value)

Преобразовать строку в регистр kebab.

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 = [])

Преобразует 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 Collection matchAll(string $pattern, string $subject)

Получить все совпадения с заданным шаблоном.

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)

Умножить последнее слово английского слова studly caps на число.

static string random(int $length = 16)

Сгенерировать более истинно «случайную» альфа-цифровую строку.

static void createRandomStringsUsing(callable $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 replace(string|iterable<string> $search, string|iterable<string> $replace, string|iterable<string> $subject)

Заменить заданное значение в заданной строке.

static string replaceFirst(string $search, string $replace, string $subject)

Заменить первое вхождение заданного значения в строке.

static string replaceLast(string $search, string $replace, string $subject)

Заменить последнее вхождение заданного значения в строке.

static string remove(string|iterable<string> $search, 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 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 = '_')

Преобразовать строку в змеиный регистр.

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')

Возвращает часть строки, заданную параметрами начала и длины.

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 lcfirst(string $string)

Сделать первый символ строки строчной.

static string ucfirst(string $string)

Сделать первый символ строки заглавной.

static string[] ucsplit(string $string)

Разбить строку на части по заглавным символам.

static int wordCount(string $string, string|null $characters = null)

Получить количество слов в строке.

static UuidInterface uuid()

Сгенерировать UUID (версия 4).

static UuidInterface orderedUuid()

Сгенерировать UUID с порядком по времени (версия 4).

static void createUuidsUsing(callable $factory = null)

Установить вызываемый объект, который будет использоваться для генерации UUID.

static void createUuidsUsingSequence(array $sequence, callable|null $whenMissing = null)

Установить последовательность, которая будет использоваться для генерации UUID.

static UuidInterface freezeUuids(Closure $callback = null)

Всегда возвращать тот же UUID при генерации новых UUID.

static void createUuidsNormally()

Указать, что UUID должны создаваться стандартным способом, а не с помощью пользовательского объекта.

static Ulid ulid()

Сгенерировать ULID.

static void flushCache()

Удалить все строки из кэшей регистров.

Details

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Встроить другой объект в класс.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрирован ли макрос.

Parameters

string $name

Return Value

bool

static void flushMacros()

Очистить существующие макросы.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static Stringable of(string $string)

Получить новый объект stringable из заданной строки.

Parameters

string $string

Return Value

Stringable

static string after(string $subject, string $search)

Возвращает остаток строки после первого вхождения заданного значения.

Parameters

string $subject
string $search

Return Value

string

static string afterLast(string $subject, string $search)

Возвращает остаток строки после последнего вхождения заданного значения.

Parameters

string $subject
string $search

Return Value

string

static string ascii(string $value, string $language = 'en')

Транслитерировать значение UTF-8 в ASCII.

Parameters

string $value
string $language

Return Value

string

static string transliterate(string $string, string|null $unknown = '?', bool|null $strict = false)

Транслитерировать строку в её ближайшее ASCII представление.

Parameters

string $string
string|null $unknown
bool|null $strict

Return Value

string

static string before(string $subject, string $search)

Получить часть строки перед первым вхождением заданного значения.

Parameters

string $subject
string $search

Return Value

string

static string beforeLast(string $subject, string $search)

Получить часть строки перед последним вхождением заданного значения.

Parameters

string $subject
string $search

Return Value

string

static string between(string $subject, string $from, string $to)

Получить часть строки между двумя заданными значениями.

Parameters

string $subject
string $from
string $to

Return Value

string

static string betweenFirst(string $subject, string $from, string $to)

Получить наименьшую возможную часть строки между двумя заданными значениями.

Parameters

string $subject
string $from
string $to

Return Value

string

static string camel(string $value)

Преобразовать значение в верблюжий регистр.

Parameters

string $value

Return Value

string

static bool contains(string $haystack, string|iterable<string> $needles, bool $ignoreCase = false)

Определить, содержит ли заданная строка заданную подстроку.

Parameters

string $haystack
string|iterable<string> $needles
bool $ignoreCase

Return Value

bool

static bool containsAll(string $haystack, iterable<string> $needles, bool $ignoreCase = false)

Определить, содержит ли заданная строка все значения массива.

Parameters

string $haystack
iterable<string> $needles
bool $ignoreCase

Return Value

bool

static bool endsWith(string $haystack, string|iterable<string> $needles)

Определить, заканчивается ли заданная строка заданной подстрокой.

Parameters

string $haystack
string|iterable<string> $needles

Return Value

bool

static string|null excerpt(string $text, string $phrase = '', array $options = [])

Извлекает выдержку из текста, соответствующую первому вхождению фразы.

Parameters

string $text
string $phrase
array $options

Return Value

string|null

static string finish(string $value, string $cap)

Заканчивает строку одним вхождением заданного значения.

Parameters

string $value
string $cap

Return Value

string

static string wrap(string $value, string $before, string|null $after = null)

Оборачивает строку заданными строками.

Параметры

string $value
string $before
string|null $after

Значение результата

string

static bool is(string|iterable<string> $pattern, string $value)

Определяет, соответствует ли заданная строка заданному шаблону.

Параметры

string|iterable<string> $pattern
string $value

Значение результата

bool

static bool isAscii(string $value)

Определяет, является ли заданная строка 7-битной ASCII.

Параметры

string $value

Значение результата

bool

static bool isJson(string $value)

Определяет, является ли заданная строка валидным JSON.

Параметры

string $value

Значение результата

bool

static bool isUuid(string $value)

Определяет, является ли заданная строка валидным UUID.

Параметры

string $value

Значение результата

bool

static bool isUlid(string $value)

Определяет, является ли заданная строка валидным ULID.

Параметры

string $value

Значение результата

bool

static string kebab(string $value)

Преобразует строку в kebab-кейс.

Параметры

string $value

Значение результата

string

static int length(string $value, string|null $encoding = null)

Возвращает длину заданной строки.

Параметры

string $value
string|null $encoding

Значение результата

int

static string limit(string $value, int $limit = 100, string $end = '...')

Ограничивает количество символов в строке.

Параметры

string $value
int $limit
string $end

Значение результата

string

static string lower(string $value)

Преобразует заданную строку в нижний регистр.

Параметры

string $value

Значение результата

string

static string words(string $value, int $words = 100, string $end = '...')

Ограничивает количество слов в строке.

Параметры

string $value
int $words
string $end

Значение результата

string

static string markdown(string $string, array $options = [])

Преобразует Markdown в формате GitHub в HTML.

Параметры

string $string
array $options

Значение результата

string

static string inlineMarkdown(string $string, array $options = [])

Преобразует встроенный Markdown в HTML.

Параметры

string $string
array $options

Значение результата

string

static string mask(string $string, string $character, int $index, int|null $length = null, string $encoding = 'UTF-8')

Маскирует часть строки повторяющимся символом.

Параметры

string $string
string $character
int $index
int|null $length
string $encoding

Значение результата

string

static string match(string $pattern, string $subject)

Получить строку, соответствующую заданному шаблону.

Параметры

string $pattern
string $subject

Значение результата

string

static Collection matchAll(string $pattern, string $subject)

Получить все строки, соответствующие заданному шаблону.

Параметры

string $pattern
string $subject

Значение результата

Collection

static string padBoth(string $value, int $length, string $pad = ' ')

Дополнить строку с обеих сторон.

Параметры

string $value
int $length
string $pad

Значение результата

string

static string padLeft(string $value, int $length, string $pad = ' ')

Дополнить строку слева.

Параметры

string $value
int $length
string $pad

Значение результата

string

static string padRight(string $value, int $length, string $pad = ' ')

Дополнить строку справа.

Параметры

string $value
int $length
string $pad

Значение результата

string

static array<int,string|null> parseCallback(string $callback, string|null $default = null)

Разбирает callback-стиля Class[@]method в класс и метод.

Параметры

string $callback
string|null $default

Значение результата

array<int,string|null>

static string plural(string $value, int|array|Countable $count = 2)

Получить форму множественного числа английского слова.

Parameters

string $value
int|array|Countable $count

Return Value

string

static string pluralStudly(string $value, int|array|Countable $count = 2)

Склонить последнее слово английской строки в стиле studly caps к множественному числу.

Parameters

string $value
int|array|Countable $count

Return Value

string

static string random(int $length = 16)

Генерировать более "истинно" случайную альфа-числовую строку.

Parameters

int $length

Return Value

string

static void createRandomStringsUsing(callable $factory = null)

Установить вызываемый объект, который будет использоваться для генерации случайных строк.

Parameters

callable $factory

Return Value

void

static void createRandomStringsUsingSequence(array $sequence, callable|null $whenMissing = null)

Установить последовательность, которая будет использоваться для генерации случайных строк.

Parameters

array $sequence
callable|null $whenMissing

Return Value

void

static void createRandomStringsNormally()

Указать, что случайные строки должны создаваться в обычном режиме, а не с использованием пользовательского фабричного метода.

Return Value

void

static string repeat(string $string, int $times)

Повторить заданную строку.

Parameters

string $string
int $times

Return Value

string

static string replaceArray(string $search, iterable<string> $replace, string $subject)

Последовательно заменить заданное значение в строке массивом.

Parameters

string $search
iterable<string> $replace
string $subject

Return Value

string

static string replace(string|iterable<string> $search, string|iterable<string> $replace, string|iterable<string> $subject)

Заменить заданное значение в заданной строке.

Parameters

string|iterable<string> $search
string|iterable<string> $replace
string|iterable<string> $subject

Return Value

string

static string replaceFirst(string $search, string $replace, string $subject)

Заменить первое вхождение заданного значения в строке.

Parameters

string $search
string $replace
string $subject

Return Value

string

static string replaceLast(string $search, string $replace, string $subject)

Заменить последнее вхождение заданного значения в строке.

Parameters

string $search
string $replace
string $subject

Return Value

string

static string remove(string|iterable<string> $search, string $subject, bool $caseSensitive = true)

Удалить все вхождения заданной строки в строке-сущности.

Parameters

string|iterable<string> $search
string $subject
bool $caseSensitive

Return Value

string

static string reverse(string $value)

Перевернуть заданную строку.

Parameters

string $value

Return Value

string

static string start(string $value, string $prefix)

Добавить заданное значение в начало строки.

Parameters

string $value
string $prefix

Return Value

string

static string upper(string $value)

Преобразовать заданную строку в верхний регистр.

Parameters

string $value

Return Value

string

static string title(string $value)

Преобразовать заданную строку в заголовок.

Parameters

string $value

Return Value

string

static string headline(string $value)

Преобразовать каждую часть заданной строки в заголовок.

Parameters

string $value

Return Value

string

static string singular(string $value)

Получить единственное число английского слова.

Parameters

string $value

Return Value

string

static string slug(string $title, string $separator = '-', string|null $language = 'en', array<string,string> $dictionary = ['@' => 'at'])

Сгенерировать URL-дружественный «slug» из заданной строки.

Parameters

string $title
string $separator
string|null $language
array<string,string> $dictionary

Return Value

string

static string snake(string $value, string $delimiter = '_')

Преобразовать строку в змеиный регистр.

Параметры

string $value
string $delimiter

Значение возврата

string

static string squish(string $value)

Удалить все лишние пробелы из заданной строки.

Параметры

string $value

Значение возврата

string

static bool startsWith(string $haystack, string|iterable<string> $needles)

Определить, начинается ли заданная строка с заданной подстроки.

Параметры

string $haystack
string|iterable<string> $needles

Значение возврата

bool

static string studly(string $value)

Преобразовать значение в регистр Studly Caps.

Параметры

string $value

Значение возврата

string

static string substr(string $string, int $start, int|null $length = null, string $encoding = 'UTF-8')

Возвращает часть строки, указанную параметрами start и length.

Параметры

string $string
int $start
int|null $length
string $encoding

Значение возврата

string

static int substrCount(string $haystack, string $needle, int $offset = 0, int|null $length = null)

Возвращает количество вхождений подстроки.

Параметры

string $haystack
string $needle
int $offset
int|null $length

Значение возврата

int

static string|string[] substrReplace(string|string[] $string, string|string[] $replace, int|int[] $offset = 0, int|int[]|null $length = null)

Замена текста в части строки.

Параметры

string|string[] $string
string|string[] $replace
int|int[] $offset
int|int[]|null $length

Значение возврата

string|string[]

static string swap(array $map, string $subject)

Обмен несколькими ключевыми словами в строке на другие ключевые слова.

Параметры

array $map
string $subject

Значение возврата

string

static string lcfirst(string $string)

Преобразовать первый символ строки в нижний регистр.

Параметры

string $string

Значение возврата

string

static string ucfirst(string $string)

Преобразовать первый символ строки в верхний регистр.

Параметры

string $string

Значение возврата

string

static string[] ucsplit(string $string)

Разделить строку на части по символам в верхнем регистре.

Параметры

string $string

Значение возврата

string[]

static int wordCount(string $string, string|null $characters = null)

Получить количество слов в строке.

Параметры

string $string
string|null $characters

Значение возврата

int

static UuidInterface uuid()

Сгенерировать UUID (версия 4).

Значение возврата

UuidInterface

static UuidInterface orderedUuid()

Сгенерировать UUID с упорядоченным по времени (версия 4).

Значение возврата

UuidInterface

static void createUuidsUsing(callable $factory = null)

Установить вызываемый объект, который будет использоваться для генерации UUID.

Параметры

callable $factory

Значение возврата

void

static void createUuidsUsingSequence(array $sequence, callable|null $whenMissing = null)

Установить последовательность, которая будет использоваться для генерации UUID.

Параметры

array $sequence
callable|null $whenMissing

Значение возврата

void

static UuidInterface freezeUuids(Closure $callback = null)

Всегда возвращать тот же UUID при генерации новых UUID.

Параметры

Closure $callback

Значение возврата

UuidInterface

static void createUuidsNormally()

Указать, что UUID должны создаваться стандартным способом, а не с использованием пользовательского фабричного метода.

Значение возврата

void

static Ulid ulid()

Сгенерировать ULID.

Значение возврата

Ulid

static void flushCache()

Удалить все строки из кэшей форматирования.

Значение возврата

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Support/Str.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API