Spec-Zone.ru › Laravel 8

Stringable

класс Stringable реализует JsonSerializable (Просмотреть исходный код)

Трейты

Conditionable
Macroable
Tappable

Свойства

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

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

из Macroable
защищенная строка $value

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

Методы

$this|mixed when(mixed $value, callable $callback, callable|null $default = null)

Применить обработчик, если заданное «значение» истинно.

из Conditionable
$this|mixed unless(mixed $value, callable $callback, callable|null $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(array ...$values)

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

Stringable ascii(string $language = 'en')

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

Stringable basename(string $suffix = '')

Получить компонент имени, следующего за путем.

Stringable classBasename()

Получить basename пути класса.

Stringable before(string $search)

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

Stringable beforeLast(string $search)

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

Stringable between(string $from, string $to)

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

Stringable camel()

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

bool contains(string|array $needles)

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

bool containsAll(array $needles)

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

Stringable dirname(int $levels = 1)

Получить путь к родительскому каталогу.

bool endsWith(string|array $needles)

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

bool exactly(string $value)

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

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|array $pattern)

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

bool isAscii()

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

bool isUuid()

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

bool isEmpty()

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

bool isNotEmpty()

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

Stringable kebab()

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

int length(string $encoding = null)

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

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

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

Stringable lower()

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

Stringable markdown(array $options = [])

Преобразовать разметку Markdown в HTML в стиле GitHub.

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

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

Stringable match(string $pattern)

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

Коллекция matchAll(string $pattern)

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

bool test(string $pattern)

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

Строка padBoth(int $length, string $pad = ' ')

Заполнить обе стороны строки другой строкой.

Строка padLeft(int $length, string $pad = ' ')

Заполнить левую сторону строки другой строкой.

Строка padRight(int $length, string $pad = ' ')

Заполнить правую сторону строки другой строкой.

array parseCallback(string|null $default = null)

Разбирать обратный вызов в стиле Class@method в класс и метод.

Строка pipe(callable $callback)

Вызвать переданный обратный вызов и вернуть новую строку.

Строка plural(int $count = 2)

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

Строка pluralStudly(int $count = 2)

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

Строка prepend(array ...$values)

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

Строка remove(string|string[] $search, bool $caseSensitive = true)

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

Строка reverse()

Перевернуть строку.

Строка repeat(int $times)

Повторить строку.

Строка replace(string|string[] $search, string|string[] $replace)

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

Строка replaceArray(string $search, array $replace)

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

Строка replaceFirst(string $search, string $replace)

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

Строка replaceLast(string $search, string $replace)

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

Строка replaceMatches(string $pattern, Closure|string $replace, int $limit = -1)

Заменить совпадения, соответствующие заданному регулярному выражению.

Коллекция scan(string $format)

Разбирать входные данные из строки в коллекцию в соответствии с форматом.

Строка start(string $prefix)

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

Строка stripTags(string $allowedTags = null)

Удалить HTML и PHP теги из заданной строки.

Строка upper()

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

Строка title()

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

Строка headline()

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

Строка singular()

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

Строка slug(string $separator = '-', string|null $language = 'en')

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

Строка snake(string $delimiter = '_')

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

bool startsWith(string|array $needles)

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

Строка studly()

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

Строка substr(int $start, int|null $length = null)

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

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

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

Строка substrReplace(string|array $replace, array|int $offset = 0, array|int|null $length = null)

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

Строка swap(array $map)

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

Строка trim(string $characters = null)

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

Строка ltrim(string $characters = null)

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

Строка rtrim(string $characters = null)

Удалить заданные символы с конца строки.

Строка ucfirst()

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

Коллекция ucsplit()

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

Строка whenContains(string|array $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|array $needles, callable $callback, callable|null $default = null)

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

Stringable whenExactly(string $value, callable $callback, callable|null $default = null)

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

Stringable whenIs(string|array $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 whenStartsWith(string|array $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()

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

HtmlString toHtmlString()

Преобразовать строку в HtmlString экземпляр.

$this dump()

Вывести строку.

never dd()

Вывести строку и завершить выполнение скрипта.

string jsonSerialize()

Преобразовать объект в строку при кодировании в JSON.

mixed __get(string $key)

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

string __toString()

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

Подробности

$this|mixed when(mixed $value, callable $callback, callable|null $default = null)

Применить обратный вызов, если заданное "значение" истинно.

Параметры

mixed $value
callable $callback
callable|null $default

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

$this|mixed

$this|mixed unless(mixed $value, callable $callback, callable|null $default = null)

Применить обратный вызов, если заданное "значение" ложно.

Параметры

mixed $value
callable $callback
callable|null $default

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

$this|mixed

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

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

Параметры

string $name
object|callable $macro

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

void

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

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

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

static void flushMacros()

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

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

void

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

$this|HigherOrderTapProxy tap(callable|null $callback = null)

Вызвать заданный замыкание с этим экземпляром, а затем вернуть экземпляр.

Параметры

callable|null $callback

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

$this|HigherOrderTapProxy

void __construct(string $value = '')

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

Параметры

string $value

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

void
END_OF_DOCUMENT_MARKER

Stringable after(string $search)

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

Параметры

строка $search

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

Stringable

Stringable afterLast(string $search)

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

Параметры

строка $search

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

Stringable

Stringable append(array ...$values)

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

Параметры

массив ...$values

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

Stringable

Stringable ascii(string $language = 'en')

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

Параметры

строка $language

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

Stringable

Stringable basename(string $suffix = '')

Получить имя файла (компонент пути).

Параметры

строка $suffix

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

Stringable

Stringable classBasename()

Получить имя класса из пути.

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

Stringable

Stringable before(string $search)

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

Параметры

строка $search

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

Stringable

Stringable beforeLast(string $search)

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

Параметры

строка $search

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

Stringable

Stringable between(string $from, string $to)

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

Параметры

строка $from
строка $to

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

Stringable

Stringable camel()

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

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

Stringable

bool contains(string|array $needles)

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

Параметры

строка|массив $needles

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

bool

bool containsAll(array $needles)

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

Параметры

массив $needles

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

bool

Stringable dirname(int $levels = 1)

Получить путь родительского каталога.

Параметры

int $levels

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

Stringable

bool endsWith(string|array $needles)

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

Параметры

строка|массив $needles

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

bool

bool exactly(string $value)

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

Параметры

строка $value

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

bool

Collection explode(string $delimiter, int $limit = PHP_INT_MAX)

Разбить строку на массив.

Параметры

строка $delimiter
int $limit

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

Collection

Collection split(string|int $pattern, int $limit = -1, int $flags = 0)

Разделить строку с помощью регулярного выражения или по длине.

Параметры

строка|int $pattern
int $limit
int $flags

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

Collection

Stringable finish(string $cap)

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

Параметры

строка $cap

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

Stringable

bool is(string|array $pattern)

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

Параметры

строка|массив $pattern

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

bool

bool isAscii()

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

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

bool

bool isUuid()

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

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

bool

bool isEmpty()

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

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

bool

bool isNotEmpty()

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

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

bool

Stringable kebab()

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

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

Stringable

int length(string $encoding = null)

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

Параметры

string $encoding

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

int

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

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

Параметры

int $limit
string $end

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

Stringable

Stringable lower()

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

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

Stringable

Stringable markdown(array $options = [])

Преобразовать Markdown в HTML, используя форматирование GitHub.

Параметры

array $options

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

Stringable

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

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

Параметры

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

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

Stringable

Stringable match(string $pattern)

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

Параметры

string $pattern

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

Stringable

Collection matchAll(string $pattern)

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

Параметры

string $pattern

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

Collection

bool test(string $pattern)

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

Параметры

string $pattern

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

bool

Stringable padBoth(int $length, string $pad = ' ')

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

Параметры

int $length
string $pad

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

Stringable

Stringable padLeft(int $length, string $pad = ' ')

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

Параметры

int $length
string $pad

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

Stringable

Stringable padRight(int $length, string $pad = ' ')

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

Параметры

int $length
string $pad

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

Stringable

array parseCallback(string|null $default = null)

Разбить callback в формате Class@method на класс и метод.

Параметры

string|null $default

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

array

Stringable pipe(callable $callback)

Вызвать заданный callback и вернуть новую строку.

Параметры

callable $callback

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

Stringable

Stringable plural(int $count = 2)

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

Параметры

int $count

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

Stringable

Stringable pluralStudly(int $count = 2)

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

Параметры

int $count

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

Stringable

Stringable prepend(array ...$values)

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

Параметры

array ...$values

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

Stringable
END_OF_DOCUMENT_MARKER

Stringable remove(string|string[] $search, bool $caseSensitive = true)

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

Parameters

string|string[] $search
bool $caseSensitive

Return Value

Stringable

Stringable reverse()

Перевернуть строку.

Return Value

Stringable

Stringable repeat(int $times)

Повторить строку.

Parameters

int $times

Return Value

Stringable

Stringable replace(string|string[] $search, string|string[] $replace)

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

Parameters

string|string[] $search
string|string[] $replace

Return Value

Stringable

Stringable replaceArray(string $search, array $replace)

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

Parameters

string $search
array $replace

Return Value

Stringable

Stringable replaceFirst(string $search, string $replace)

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

Parameters

string $search
string $replace

Return Value

Stringable

Stringable replaceLast(string $search, string $replace)

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

Parameters

string $search
string $replace

Return Value

Stringable

Stringable replaceMatches(string $pattern, Closure|string $replace, int $limit = -1)

Заменить шаблоны, соответствующие заданному регулярному выражению.

Parameters

string $pattern
Closure|string $replace
int $limit

Return Value

Stringable

Collection scan(string $format)

Проанализировать входные данные из строки в коллекцию в соответствии с форматом.

Parameters

string $format

Return Value

Collection

Stringable start(string $prefix)

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

Parameters

string $prefix

Return Value

Stringable

Stringable stripTags(string $allowedTags = null)

Удалить HTML и PHP теги из данной строки.

Parameters

string $allowedTags

Return Value

Stringable

Stringable upper()

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

Return Value

Stringable

Stringable title()

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

Return Value

Stringable

Stringable headline()

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

Return Value

Stringable

Stringable singular()

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

Return Value

Stringable

Stringable slug(string $separator = '-', string|null $language = 'en')

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

Parameters

string $separator
string|null $language

Return Value

Stringable

Stringable snake(string $delimiter = '_')

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

Parameters

string $delimiter

Return Value

Stringable

bool startsWith(string|array $needles)

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

Parameters

string|array $needles

Return Value

bool

Stringable studly()

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

Return Value

Stringable

Stringable substr(int $start, int|null $length = null)

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

Parameters

int $start
int|null $length

Return Value

Stringable

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

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

Parameters

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

Return Value

int

Stringable substrReplace(string|array $replace, array|int $offset = 0, array|int|null $length = null)

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

Parameters

string|array $replace
array|int $offset
array|int|null $length

Return Value

Stringable

Stringable swap(array $map)

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

Parameters

array $map

Return Value

Stringable

Stringable trim(string $characters = null)

Удалить символы с начала и конца строки.

Parameters

string $characters

Return Value

Stringable

Stringable ltrim(string $characters = null)

Удалить символы слева (с начала) строки.

Parameters

string $characters

Return Value

Stringable

Stringable rtrim(string $characters = null)

Удалить символы справа (с конца) строки.

Parameters

string $characters

Return Value

Stringable

Stringable ucfirst()

Первая буква строки в верхнем регистре.

Return Value

Stringable

Collection ucsplit()

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

Return Value

Collection

Stringable whenContains(string|array $needles, callable $callback, callable|null $default = null)

Выполнить заданный callback, если строка содержит заданную подстроку.

Parameters

string|array $needles
callable $callback
callable|null $default

Return Value

Stringable

Stringable whenContainsAll(array $needles, callable $callback, callable|null $default = null)

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

Parameters

array $needles
callable $callback
callable|null $default

Return Value

Stringable

Stringable whenEmpty(callable $callback, callable|null $default = null)

Выполнить заданный callback, если строка пустая.

Parameters

callable $callback
callable|null $default

Return Value

Stringable

Stringable whenNotEmpty(callable $callback, callable|null $default = null)

Выполнить заданный callback, если строка не пустая.

Parameters

callable $callback
callable|null $default

Return Value

Stringable

Stringable whenEndsWith(string|array $needles, callable $callback, callable|null $default = null)

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

Parameters

string|array $needles
callable $callback
callable|null $default

Return Value

Stringable

Stringable whenExactly(string $value, callable $callback, callable|null $default = null)

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

Parameters

string $value
callable $callback
callable|null $default

Return Value

Stringable

Stringable whenIs(string|array $pattern, callable $callback, callable|null $default = null)

Выполнить заданный callback, если строка соответствует заданному шаблону.

Parameters

string|array $pattern
callable $callback
callable|null $default

Return Value

Stringable

Stringable whenIsAscii(callable $callback, callable|null $default = null)

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

Parameters

callable $callback
callable|null $default

Return Value

Stringable

Stringable whenIsUuid(callable $callback, callable|null $default = null)

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

Parameters

callable $callback
callable|null $default

Return Value

Stringable

Stringable whenStartsWith(string|array $needles, callable $callback, callable|null $default = null)

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

Parameters

string|array $needles
callable $callback
callable|null $default

Return Value

Stringable

Stringable whenTest(string $pattern, callable $callback, callable|null $default = null)

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

Parameters

string $pattern
callable $callback
callable|null $default

Return Value

Stringable

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

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

Parameters

int $words
string $end

Return Value

Stringable

int wordCount()

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

Return Value

int

HtmlString toHtmlString()

Преобразовать строку в экземпляр HtmlString.

Return Value

HtmlString

$this dump()

Вывести строку.

Return Value

$this

never dd()

Вывести строку и завершить сценарий.

Return Value

never

string jsonSerialize()

Преобразовать объект в строку при кодировании JSON.

Return Value

string

mixed __get(string $key)

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

Parameters

string $key

Return Value

mixed

string __toString()

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

Return Value

string

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

Spec-Zone.ru

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