Stringable
класс Stringable реализует JsonSerializable (Просмотреть исходный код)
Трейты
| Conditionable | |
| Macroable | |
| Tappable |
Свойства
| статический защищенный массив | $macros | Зарегистрированные макросы строк. | из Macroable |
| защищенная строка | $value | Базовое значение строки. |
Методы
| $this|TWhenReturnType | when($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное «значение» истинно. | из Conditionable |
| $this|TUnlessReturnType | unless($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное «значение» ложно. | из Conditionable |
| 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 |
| $this|HigherOrderTapProxy | tap(callable|null $callback = null)
Вызвать заданный замыкание с этим экземпляром, затем вернуть экземпляр. | из Tappable |
| void | __construct(string $value = '')
Создать новый экземпляр класса. | |
| Stringable | after(string $search)
Возвращает оставшуюся часть строки после первого вхождения заданного значения. | |
| Stringable | afterLast(string $search)
Возвращает оставшуюся часть строки после последнего вхождения заданного значения. | |
| Stringable | append(string ...$values)
Добавить заданные значения к строке. | |
| $this | newLine(int $count = 1)
Добавить новую строку к строке. | |
| Stringable | ascii(string $language = 'en')
Транслитерировать значение UTF-8 в ASCII. | |
| Stringable | basename(string $suffix = '')
Получить компонент имени, приходящийся на конец пути. | |
| Stringable | classBasename()
Получить имя файла класса. | |
| Stringable | before(string $search)
Получить часть строки перед первым вхождением заданного значения. | |
| Stringable | beforeLast(string $search)
Получить часть строки перед последним вхождением заданного значения. | |
| Stringable | between(string $from, string $to)
Получить часть строки между двумя заданными значениями. | |
| Stringable | betweenFirst(string $from, string $to)
Получить возможно самую короткую часть строки между двумя заданными значениями. | |
| Stringable | camel()
Преобразовать значение в верблюжью нотацию. | |
| bool | contains(string|iterable<string> $needles, bool $ignoreCase = false)
Определить, содержит ли заданная строка заданную подстроку. | |
| bool | containsAll(iterable<string> $needles, bool $ignoreCase = false)
Определить, содержит ли заданная строка все значения массива. | |
| Stringable | dirname(int $levels = 1)
Получить путь родительского каталога. | |
| bool | endsWith(string|iterable<string> $needles)
Определить, заканчивается ли заданная строка заданной подстрокой. | |
| bool | exactly(Stringable|string $value)
Определить, совпадает ли строка с заданным значением точно. | |
| string|null | excerpt(string $phrase = '', array $options = [])
Извлекает выдержку из текста, соответствующую первому вхождению фразы. | |
| Collection | explode(string $delimiter, int $limit = PHP_INT_MAX)
Разбить строку на массив. | |
| Collection | split(string|int $pattern, int $limit = -1, int $flags = 0)
Разделить строку с помощью регулярного выражения или по длине. | |
| Stringable | finish(string $cap)
Добавить строке окончание с одним экземпляром заданного значения. | |
| bool | is(string|iterable<string> $pattern)
Определить, соответствует ли заданная строка заданному шаблону. | |
| bool | isAscii()
Определить, является ли заданная строка 7-битной ASCII. | |
| bool | isJson()
Определить, является ли заданная строка валидным JSON. | |
| bool | isUuid()
Определить, является ли заданная строка валидным UUID. | |
| bool | isUlid()
Определить, является ли заданная строка валидным ULID. | |
| bool | isEmpty()
Определить, является ли заданная строка пустой. | |
| bool | isNotEmpty()
Определить, не является ли заданная строка пустой. | |
| Stringable | kebab()
Преобразовать строку в кебаб-нотацию. | |
| int | length(string|null $encoding = null)
Возвращает длину заданной строки. |
| Stringable | limit(int $limit = 100, string $end = '...')
Ограничить количество символов в строке. | |
| Stringable | lower()
Преобразовать строку в нижний регистр. | |
| Stringable | markdown(array $options = [])
Преобразовать разметку GitHub Flavored Markdown в HTML. | |
| Stringable | inlineMarkdown(array $options = [])
Преобразовать встроенную разметку Markdown в HTML. | |
| Stringable | mask(string $character, int $index, int|null $length = null, string $encoding = 'UTF-8')
Маскировать часть строки повторяющимся символом. | |
| Stringable | match(string $pattern)
Получить часть строки, соответствующую заданному шаблону. | |
| Collection | matchAll(string $pattern)
Получить все части строки, соответствующие заданному шаблону. | |
| bool | test(string $pattern)
Определить, соответствует ли строка заданному шаблону. | |
| Stringable | padBoth(int $length, string $pad = ' ')
Добавить символы с обеих сторон строки. | |
| Stringable | padLeft(int $length, string $pad = ' ')
Добавить символы слева к строке. | |
| Stringable | padRight(int $length, string $pad = ' ')
Добавить символы справа к строке. | |
| array<int,string|null> | parseCallback(string|null $default = null)
Разделить вызов метода по стилю Class@method на класс и метод. | |
| Stringable | pipe(callable $callback)
Вызвать переданный обратный вызов и вернуть новую строку. | |
| Stringable | plural(int|array|Countable $count = 2)
Получить форму множественного числа английского слова. | |
| Stringable | pluralStudly(int|array|Countable $count = 2)
Сделать множественное число последнего слова в строке с использованием верблюжьей нотации. | |
| Stringable | prepend(string ...$values)
Добавить значения в начало строки. | |
| Stringable | remove(string|iterable<string> $search, bool $caseSensitive = true)
Удалить все вхождения заданной строки. | |
| Stringable | reverse()
Перевернуть строку. | |
| Stringable | repeat(int $times)
Повторить строку. | |
| Stringable | replace(string|iterable<string> $search, string|iterable<string> $replace)
Заменить заданное значение в строке. | |
| Stringable | replaceArray(string $search, iterable<string> $replace)
Последовательно заменить значение в строке массивом. | |
| Stringable | replaceFirst(string $search, string $replace)
Заменить первое вхождение заданного значения в строке. | |
| Stringable | replaceLast(string $search, string $replace)
Заменить последнее вхождение заданного значения в строке. | |
| Stringable | replaceMatches(string $pattern, Closure|string $replace, int $limit = -1)
Заменить все совпадения с заданным регулярным выражением. | |
| Collection | scan(string $format)
Парсинг входных данных из строки в коллекцию по заданному формату. | |
| Stringable | squish()
Удалить лишние пробелы из строки. | |
| Stringable | start(string $prefix)
Начать строку с заданного значения. | |
| Stringable | stripTags(string $allowedTags = null)
Удалить HTML и PHP теги из строки. | |
| Stringable | upper()
Преобразовать строку в верхний регистр. | |
| Stringable | title()
Преобразовать строку в заголовок. | |
| Stringable | headline()
Преобразовать строку в заголовок с использованием заглавных букв в каждом слове. | |
| Stringable | singular()
Получить форму единственного числа английского слова. | |
| Stringable | slug(string $separator = '-', string|null $language = 'en', array<string,string> $dictionary = ['@' => 'at'])
Генерировать URL-дружественный "slug" из заданной строки. | |
| Stringable | snake(string $delimiter = '_')
Преобразовать строку в змеиный регистр. | |
| bool | startsWith(string|iterable<string> $needles)
Определить, начинается ли строка с заданной подстроки. | |
| Stringable | studly()
Преобразовать значение в верблюжью нотацию. | |
| Stringable | substr(int $start, int|null $length = null, string $encoding = 'UTF-8')
Возвращает часть строки, указанную параметрами start и length. | |
| int | substrCount(string $needle, int $offset = 0, int|null $length = null)
Возвращает количество вхождений подстроки. |
| Stringable | substrReplace(string|string[] $replace, int|int[] $offset = 0, int|int[]|null $length = null)
Заменить текст в части строки. | |
| Stringable | swap(array $map)
Заменить несколько ключевых слов в строке на другие. | |
| Stringable | trim(string $characters = null)
Удалить заданные символы с начала и конца строки. | |
| Stringable | ltrim(string $characters = null)
Удалить заданные символы с начала строки. | |
| Stringable | rtrim(string $characters = null)
Удалить заданные символы с конца строки. | |
| Stringable | lcfirst()
Первую букву строки сделать строчной. | |
| Stringable | ucfirst()
Первую букву строки сделать заглавной. | |
| Collection | ucsplit()
Разделить строку по заглавным буквам. | |
| Stringable | whenContains(string|iterable<string> $needles, callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка содержит указанную подстроку. | |
| Stringable | whenContainsAll(array $needles, callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка содержит все значения массива. | |
| Stringable | whenEmpty(callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка пустая. | |
| Stringable | whenNotEmpty(callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка не пустая. | |
| Stringable | whenEndsWith(string|iterable<string> $needles, callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка оканчивается заданной подстрокой. | |
| Stringable | whenExactly(string $value, callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка точно совпадает с заданным значением. | |
| Stringable | whenNotExactly(string $value, callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка не точно совпадает с заданным значением. | |
| Stringable | whenIs(string|iterable<string> $pattern, callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка соответствует заданному шаблону. | |
| Stringable | whenIsAscii(callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка состоит из 7-битных ASCII символов. | |
| Stringable | whenIsUuid(callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка является корректным UUID. | |
| Stringable | whenIsUlid(callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка является корректным ULID. | |
| Stringable | whenStartsWith(string|iterable<string> $needles, callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка начинается с указанной подстроки. | |
| Stringable | whenTest(string $pattern, callable $callback, callable|null $default = null)
Выполнить заданный обработчик, если строка соответствует заданному шаблону. | |
| Stringable | words(int $words = 100, string $end = '...')
Ограничить количество слов в строке. | |
| int | wordCount(string|null $characters = null)
Получить количество слов в строке. | |
| Stringable | wrap(string $before, string|null $after = null)
Обернуть строку в заданные строки. | |
| HtmlString | toHtmlString()
Преобразовать строку в | |
| $this | dump()
Вывести строку в отладку. | |
| never | dd()
Вывести строку в отладку и завершить скрипт. | |
| string | value()
Получить значение строки. | |
| string | toString()
Получить значение строки. | |
| int | toInteger()
Получить значение строки как целое число. | |
| float | toFloat()
Получить значение строки как число с плавающей точкой. | |
| bool | toBoolean()
Получить значение строки как булево значение. | |
| Carbon | toDate(string|null $format = null, string|null $tz = null)
Получить значение строки как экземпляр Carbon. | |
| string | jsonSerialize()
Преобразовать объект в строку при кодировании JSON. | |
| mixed | __get(string $key)
Динамическое обращение к свойствам через методы. | |
| string | __toString()
Получить значение исходной строки. |
Details
$this|TWhenReturnType when($value = null, callable $callback = null, callable $default = null)
Применить обработчик, если заданное "значение" истинно.
$this|TUnlessReturnType unless($value = null, callable $callback = null, callable $default = null)
Применить обратный вызов, если заданное «значение» ложно (или разрешается до ложного).
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)
Динамически обрабатывать вызовы к классу.
$this|HigherOrderTapProxy tap(callable|null $callback = null)
Вызвать переданный замыкание с этим экземпляром, а затем вернуть экземпляр.
void __construct(string $value = '')
Создать новый экземпляр класса.
Stringable after(string $search)
Возвращает остаток строки после первого вхождения заданного значения.
Stringable afterLast(string $search)
Возвращает остаток строки после последнего вхождения заданного значения.
Stringable append(string ...$values)
Добавляет заданные значения к строке.
$this newLine(int $count = 1)
Добавляет новую строку к строке.
Stringable ascii(string $language = 'en')
Транслитерировать значение UTF-8 в ASCII.
Stringable basename(string $suffix = '')
Получить компонент имени в конце пути.
Stringable classBasename()
Получить имя файла класса.
Stringable before(string $search)
Получить часть строки перед первым вхождением заданного значения.
Stringable beforeLast(string $search)
Получить часть строки перед последним вхождением заданного значения.
Stringable between(string $from, string $to)
Получить часть строки между двумя заданными значениями.
Stringable betweenFirst(string $from, string $to)
Получить наименьший возможный фрагмент строки между двумя заданными значениями.
Stringable camel()
Преобразовать значение в верблюжью нотацию.
bool contains(string|iterable<string> $needles, bool $ignoreCase = false)
Определить, содержит ли заданная строка заданную подстроку.
bool containsAll(iterable<string> $needles, bool $ignoreCase = false)
Определить, содержит ли заданная строка все значения массива.
Stringable dirname(int $levels = 1)
Получить путь к родительскому каталогу.
bool endsWith(string|iterable<string> $needles)
Определить, заканчивается ли заданная строка заданной подстрокой.
bool exactly(Stringable|string $value)
Определить, совпадает ли строка с заданным значением точно.
string|null excerpt(string $phrase = '', array $options = [])
Извлекает выдержку из текста, соответствующую первому вхождению фразы.
Collection explode(string $delimiter, int $limit = PHP_INT_MAX)
Разбить строку на массив.
Collection split(string|int $pattern, int $limit = -1, int $flags = 0)
Разделить строку с помощью регулярного выражения или по длине.
Stringable finish(string $cap)
Добавить к строке значение один раз.
bool is(string|iterable<string> $pattern)
Определить, соответствует ли заданная строка заданному шаблону.
bool isAscii()
Определить, является ли заданная строка 7-битной ASCII.
bool isJson()
Определить, является ли заданная строка валидным JSON.
bool isUuid()
Определить, является ли заданная строка валидным UUID.
bool isUlid()
Определить, является ли заданная строка валидным ULID.
bool isEmpty()
Определить, является ли заданная строка пустой.
bool isNotEmpty()
Определить, является ли заданная строка непустой.
Stringable kebab()
Преобразовать строку в kebab-кейс.
int length(string|null $encoding = null)
Возвратить длину заданной строки.
Stringable limit(int $limit = 100, string $end = '...')
Ограничить количество символов в строке.
Stringable lower()
Преобразовать заданную строку в нижний регистр.
Stringable markdown(array $options = [])
Преобразовать Markdown в формате GitHub в HTML.
Stringable inlineMarkdown(array $options = [])
Преобразовать инлайновый Markdown в HTML.
Stringable mask(string $character, int $index, int|null $length = null, string $encoding = 'UTF-8')
Маскирует часть строки повторяющимся символом.
Stringable match(string $pattern)
Получить часть строки, соответствующую заданному шаблону.
Collection matchAll(string $pattern)
Получить все части строки, соответствующие заданному шаблону.
bool test(string $pattern)
Определить, соответствует ли строка заданному шаблону.
Stringable padBoth(int $length, string $pad = ' ')
Добавить символ-заполнитель с обеих сторон строки.
Stringable padLeft(int $length, string $pad = ' ')
Добавить символ-заполнитель слева к строке.
Stringable padRight(int $length, string $pad = ' ')
Добавить символ-заполнитель справа к строке.
array<int,string|null> parseCallback(string|null $default = null)
Разбор обратного вызова в формате Class@method в класс и метод.
Stringable pipe(callable $callback)
Вызов заданного обратного вызова и возврат новой строки.
Stringable plural(int|array|Countable $count = 2)
Получить множественное число для английского слова.
Stringable pluralStudly(int|array|Countable $count = 2)
Сделать множественное число для последнего слова английской строки в стиле studly caps.
Stringable prepend(string ...$values)
Добавить указанные значения в начало строки.
Stringable remove(string|iterable<string> $search, bool $caseSensitive = true)
Удалить все вхождения заданной строки из исходной.
Stringable reverse()
Перевернуть строку.
Stringable repeat(int $times)
Повторить строку.
Stringable replace(string|iterable<string> $search, string|iterable<string> $replace)
Заменить указанное значение в строке.
Stringable replaceArray(string $search, iterable<string> $replace)
Заменить заданное значение в строке последовательно массивом.
Stringable replaceFirst(string $search, string $replace)
Заменить первое вхождение заданного значения в строке.
Stringable replaceLast(string $search, string $replace)
Заменить последнее вхождение заданного значения в строке.
Stringable replaceMatches(string $pattern, Closure|string $replace, int $limit = -1)
Заменить шаблоны, соответствующие заданному регулярному выражению.
Collection scan(string $format)
Разбор входных данных из строки в коллекцию согласно формату.
Stringable squish()
Удалить все "лишние" пробелы из заданной строки.
Stringable start(string $prefix)
Начать строку с единственного экземпляра заданного значения.
Stringable stripTags(string $allowedTags = null)
Удалить HTML и PHP теги из заданной строки.
Stringable upper()
Преобразовать заданную строку в верхний регистр.
Stringable title()
Преобразовать заданную строку в регистр заголовка.
Stringable headline()
Преобразовать заданную строку в регистр заголовка для каждого слова.
Stringable singular()
Получить единственное число английского слова.
Stringable slug(string $separator = '-', string|null $language = 'en', array<string,string> $dictionary = ['@' => 'at'])
Сгенерировать URL-дружественный "slug" из заданной строки.
Stringable snake(string $delimiter = '_')
Преобразовать строку в змеиный регистр.
bool startsWith(string|iterable<string> $needles)
Определить, начинается ли заданная строка с заданной подстроки.
Stringable studly()
Преобразовать значение в регистр studly caps.
Stringable substr(int $start, int|null $length = null, string $encoding = 'UTF-8')
Возвращает часть строки, указанную параметрами start и length.
int substrCount(string $needle, int $offset = 0, int|null $length = null)
Возвращает количество вхождений подстроки.
Stringable substrReplace(string|string[] $replace, int|int[] $offset = 0, int|int[]|null $length = null)
Заменить текст в части строки.
Stringable swap(array $map)
Заменить несколько ключевых слов в строке на другие.
Stringable trim(string $characters = null)
Удалить символы с начала и конца строки.
Stringable ltrim(string $characters = null)
Удалить символы с начала строки.
Stringable rtrim(string $characters = null)
Удалить символы с конца строки.
Stringable lcfirst()
Сделать первый символ строки строчной.
Stringable ucfirst()
Сделать первый символ строки прописной.
Collection ucsplit()
Разбить строку по прописным символам.
Stringable whenContains(string|iterable<string> $needles, callable $callback, callable|null $default = null)
Выполнить заданный обратный вызов, если строка содержит заданную подстроку.
Stringable whenContainsAll(array $needles, callable $callback, callable|null $default = null)
Выполнить заданный обратный вызов, если строка содержит все значения массива.
Stringable whenEmpty(callable $callback, callable|null $default = null)
Выполнить заданный обратный вызов, если строка пустая.
Stringable whenNotEmpty(callable $callback, callable|null $default = null)
Выполнить заданный обратный вызов, если строка не пустая.
Stringable whenEndsWith(string|iterable<string> $needles, callable $callback, callable|null $default = null)
Выполнить заданный обратный вызов, если строка оканчивается заданной подстрокой.
Stringable whenExactly(string $value, callable $callback, callable|null $default = null)
Выполнить заданный обратный вызов, если строка точно совпадает с заданным значением.
Stringable whenNotExactly(string $value, callable $callback, callable|null $default = null)
Выполнить заданный обратный вызов, если строка не совпадает точно с заданным значением.
Stringable whenIs(string|iterable<string> $pattern, callable $callback, callable|null $default = null)
Выполнить заданный обратный вызов, если строка соответствует заданному шаблону.
Stringable whenIsAscii(callable $callback, callable|null $default = null)
Выполнить указанный обработчик, если строка состоит из 7-битных ASCII символов.
Stringable whenIsUuid(callable $callback, callable|null $default = null)
Выполнить указанный обработчик, если строка является корректным UUID.
Stringable whenIsUlid(callable $callback, callable|null $default = null)
Выполнить указанный обработчик, если строка является корректным ULID.
Stringable whenStartsWith(string|iterable<string> $needles, callable $callback, callable|null $default = null)
Выполнить указанный обработчик, если строка начинается с указанной подстроки.
Stringable whenTest(string $pattern, callable $callback, callable|null $default = null)
Выполнить указанный обработчик, если строка соответствует заданному шаблону.
Stringable words(int $words = 100, string $end = '...')
Ограничить количество слов в строке.
int wordCount(string|null $characters = null)
Получить количество слов в строке.
Stringable wrap(string $before, string|null $after = null)
Обернуть строку заданными строками.
HtmlString toHtmlString()
Преобразовать строку в экземпляр HtmlString.
$this dump()
Вывести строку в отладочный вывод.
never dd()
Вывести строку в отладочный вывод и завершить выполнение скрипта.
string value()
Получить базовое значение строки.
string toString()
Получить базовое значение строки.
int toInteger()
Получить базовое значение строки как целое число.
float toFloat()
Получить базовое значение строки как число с плавающей точкой.
bool toBoolean()
Получить базовое значение строки как булево значение.
Возвращает true, если значение равно "1", "true", "on", или "yes". Иначе возвращает false.
Carbon toDate(string|null $format = null, string|null $tz = null)
Получить базовое значение строки как экземпляр Carbon.
string jsonSerialize()
Преобразовать объект в строку при JSON кодировании.
mixed __get(string $key)
Динамический доступ к свойствам через методы.
string __toString()
Получить исходное значение строки.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Support/Stringable.html
