Spec-Zone.ru › Laravel 10

Stringable

class Stringable implements JsonSerializable, ArrayAccess (View source)

Свойства

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(array|string ...$values)

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

$this newLine(int $count = 1)

Добавить новую строку к строке.

Stringable ascii(string $language = 'en')

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

Stringable basename(string $suffix = '')

Получить компонент имени, приходящийся на конец пути.

string|false charAt(int $index)

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

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 convertCase(int $mode = MB_CASE_FOLD, string|null $encoding = 'UTF-8')

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

Stringable dirname(int $levels = 1)

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

bool endsWith(string|iterable<string> $needles)

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

bool exactly(Stringable|string $value)

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

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

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

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

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

Collection<int,string> 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 isUrl()

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

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

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

Stringable inlineMarkdown(array $options = [])

Преобразовать встроенную разметку Markdown в HTML.

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

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

Stringable match(string $pattern)

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

bool isMatch(string|iterable<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.

int|false position(string $needle, int $offset = 0, string|null $encoding = null)

Найти позицию первого вхождения заданной подстроки с учётом многобайтовых символов.

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, bool $caseSensitive = true)

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

Stringable replaceArray(string $search, iterable<string> $replace)

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

Stringable replaceFirst(string $search, string $replace)

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

Stringable replaceStart(string $search, string $replace)

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

Stringable replaceLast(string $search, string $replace)

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

Stringable replaceEnd(string $search, string $replace)

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

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

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

Collection scan(string $format)

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

Stringable squish()

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

Stringable start(string $prefix)

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

Stringable stripTags(string[]|string|null $allowedTags = null)

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

Stringable upper()

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

Stringable title()

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

Stringable headline()

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

Stringable apa()

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

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

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

Stringable singular()

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

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

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

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 take(int $limit)

Взять первые или последние {$limit} символов.

Stringable trim(string $characters = null)

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

Stringable ltrim(string $characters = null)

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

Stringable rtrim(string $characters = null)

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

Stringable lcfirst()

Сделать первую букву строки строчной.

Stringable ucfirst()

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

Collection<int,string> 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 wordWrap(int $characters = 75, string $break = "\n", bool $cutLongWords = false)

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

Stringable wrap(string $before, string|null $after = null)

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

Stringable unwrap(string $before, string|null $after = null)

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

HtmlString toHtmlString()

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

Stringable toBase64()

Преобразовать строку в кодировку Base64.

Stringable fromBase64(bool $strict = false)

Декодировать строку, закодированную в Base64.

$this dump()

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

never dd()

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

string value()

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

string toString()

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

int toInteger(int $base = 10)

Получить базовое значение строки как целое число.

float toFloat()

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

bool toBoolean()

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

Carbon toDate(string|null $format = null, string|null $tz = null)

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

string jsonSerialize()

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

bool offsetExists(mixed $offset)

Определить, существует ли заданный смещение.

string offsetGet(mixed $offset)

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

void offsetSet(mixed $offset, mixed $value)

Установить значение по заданному смещению.

void offsetUnset(mixed $offset)

Удалить значение по заданному смещению.

mixed __get(string $key)

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

string __toString()

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

Подробности

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

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

Параметры

$value
обратный вызов $callback
обратный вызов $default

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

$this|TWhenReturnType

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

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

Параметры

$value
обратный вызов $callback
обратный вызов $default

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

$this|TUnlessReturnType

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

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

Параметры

строка $name
объект|обратный вызов $macro

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

void

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

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

Параметры

объект $mixin
логическое $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

строка $name

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

логическое

static void flushMacros()

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

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

void

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

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

Параметры

строка $method
массив $parameters

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

смешанный тип

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

строка $method
массив $parameters

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

смешанный тип

Исключения

BadMethodCallException

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

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

Параметры

обратный вызов|null $callback

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

$this|HigherOrderTapProxy

void __construct(string $value = '')

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

Параметры

строка $value

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

void

Stringable after(string $search)

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

Параметры

строка $search

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

Stringable

Stringable afterLast(string $search)

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

Параметры

строка $search

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

Stringable
END_OF_DOCUMENT_MARKER

Строка append(массив|строка ...$значения)

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

Параметры

массив|строка ...$значения

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

Строка

$this newLine(целое число $количество = 1)

Добавить новую строку к строке.

Параметры

целое число $количество

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

$this

Строка ascii(строка $язык = 'en')

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

Параметры

строка $язык

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

Строка

Строка basename(строка $суффикс = '')

Получить последнюю часть имени пути.

Параметры

строка $суффикс

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

Строка

строка|ложь charAt(целое число $индекс)

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

Параметры

целое число $индекс

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

строка|ложь

Строка classBasename()

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

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

Строка

Строка before(строка $поиск)

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

Параметры

строка $поиск

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

Строка

Строка beforeLast(строка $поиск)

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

Параметры

строка $поиск

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

Строка

Строка between(строка $от, строка $до)

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

Параметры

строка $от
строка $до

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

Строка

Строка betweenFirst(строка $от, строка $до)

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

Параметры

строка $от
строка $до

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

Строка

Строка camel()

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

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

Строка

логическое значение contains(строка|iterable<строка> $искомые, логическое значение $регистронезависимо = ложь)

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

Параметры

строка|iterable<строка> $искомые
логическое значение $регистронезависимо

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

логическое значение

логическое значение containsAll(iterable<строка> $искомые, логическое значение $регистронезависимо = ложь)

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

Параметры

iterable<строка> $искомые
логическое значение $регистронезависимо

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

логическое значение

Строка convertCase(целое число $режим = MB_CASE_FOLD, строка|null $кодировка = 'UTF-8')

Преобразовать регистр символов строки.

Параметры

целое число $режим
строка|null $кодировка

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

Строка

Строка dirname(целое число $уровни = 1)

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

Параметры

целое число $уровни

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

Строка

логическое значение endsWith(строка|iterable<строка> $искомые)

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

Параметры

строка|iterable<строка> $искомые

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

логическое значение

логическое значение exactly(Строка|строка $значение)

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

Параметры

Строка|строка $значение

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

логическое значение

строка|null excerpt(строка $фраза = '', массив $опции = [])

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

Параметры

строка $фраза
массив $опции

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

строка|null

Коллекция<целое число,строка> explode(строка $разделитель, целое число $предел = PHP_INT_MAX)

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

Параметры

строка $разделитель
целое число $предел

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

Коллекция<целое число,строка>

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

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

Parameters

string|int $pattern
int $limit
int $flags

Return Value

Collection<int,string>

Stringable finish(string $cap)

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

Parameters

string $cap

Return Value

Stringable

bool is(string|iterable<string> $pattern)

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

Parameters

string|iterable<string> $pattern

Return Value

bool

bool isAscii()

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

Return Value

bool

bool isJson()

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

Return Value

bool

bool isUrl()

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

Return Value

bool

bool isUuid()

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

Return Value

bool

bool isUlid()

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

Return Value

bool

bool isEmpty()

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

Return Value

bool

bool isNotEmpty()

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

Return Value

bool

Stringable kebab()

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

Return Value

Stringable

int length(string|null $encoding = null)

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

Parameters

string|null $encoding

Return Value

int

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

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

Parameters

int $limit
string $end

Return Value

Stringable

Stringable lower()

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

Return Value

Stringable

Stringable markdown(array $options = [])

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

Parameters

array $options

Return Value

Stringable

Stringable inlineMarkdown(array $options = [])

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

Parameters

array $options

Return Value

Stringable

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

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

Parameters

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

Return Value

Stringable

Stringable match(string $pattern)

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

Parameters

string $pattern

Return Value

Stringable

bool isMatch(string|iterable<string> $pattern)

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

Parameters

string|iterable<string> $pattern

Return Value

bool

Collection matchAll(string $pattern)

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

Parameters

string $pattern

Return Value

Collection

bool test(string $pattern)

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

Parameters

string $pattern

Return Value

bool

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

Добавить пробелы с обеих сторон строки до указанной длины.

Parameters

int $length
string $pad

Return Value

Stringable

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

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

Параметры

int $length
string $pad

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

Stringable

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

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

Параметры

int $length
string $pad

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

Stringable

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

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

Параметры

string|null $default

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

array<int,string|null>

Stringable pipe(callable $callback)

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

Параметры

callable $callback

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

Stringable

Stringable plural(int|array|Countable $count = 2)

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

Параметры

int|array|Countable $count

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

Stringable

Stringable pluralStudly(int|array|Countable $count = 2)

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

Параметры

int|array|Countable $count

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

Stringable

int|false position(string $needle, int $offset = 0, string|null $encoding = null)

Найти позицию первого вхождения заданной подстроки, поддерживая многобайтовые символы.

Параметры

string $needle
int $offset
string|null $encoding

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

int|false

Stringable prepend(string ...$values)

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

Параметры

string ...$values

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

Stringable

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

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

Параметры

string|iterable<string> $search
bool $caseSensitive

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

Stringable

Stringable reverse()

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

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

Stringable

Stringable repeat(int $times)

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

Параметры

int $times

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

Stringable

Stringable replace(string|iterable<string> $search, string|iterable<string> $replace, bool $caseSensitive = true)

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

Параметры

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

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

Stringable

Stringable replaceArray(string $search, iterable<string> $replace)

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

Параметры

string $search
iterable<string> $replace

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

Stringable

Stringable replaceFirst(string $search, string $replace)

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

Параметры

string $search
string $replace

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

Stringable

Stringable replaceStart(string $search, string $replace)

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

Параметры

string $search
string $replace

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

Stringable

Stringable replaceLast(string $search, string $replace)

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

Параметры

string $search
string $replace

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

Stringable

Stringable replaceEnd(string $search, string $replace)

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

Параметры

string $search
string $replace

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

Stringable

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

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

Параметры

array|string $pattern
Closure|string $replace
int $limit

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

Stringable

Collection scan(string $format)

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

Параметры

string $format

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

Collection

Stringable squish()

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

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

Stringable

Stringable start(string $prefix)

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

Параметры

string $prefix

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

Stringable

Stringable stripTags(string[]|string|null $allowedTags = null)

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

Параметры

string[]|string|null $allowedTags

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

Stringable

Stringable upper()

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

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

Stringable

Stringable title()

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

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

Stringable

Stringable headline()

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

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

Stringable

Stringable apa()

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

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

Stringable

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

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

Параметры

string|null $unknown
bool|null $strict

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

Stringable

Stringable singular()

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

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

Stringable

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

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

Параметры

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

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

Stringable

Stringable snake(string $delimiter = '_')

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

Параметры

string $delimiter

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

Stringable

bool startsWith(string|iterable<string> $needles)

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

Параметры

string|iterable<string> $needles

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

bool

Stringable studly()

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

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

Stringable

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

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

Параметры

int $start
int|null $length
string $encoding

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

Stringable

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

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

Параметры

string $needle
int $offset
int|null $length

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

int

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

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

Параметры

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

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

Stringable

Stringable swap(array $map)

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

Параметры

array $map

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

Stringable

Stringable take(int $limit)

Взять первые или последние {$limit} символов.

Параметры

int $limit

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

Stringable

Stringable trim(string $characters = null)

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

Параметры

string $characters

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

Stringable

Stringable ltrim(string $characters = null)

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

Параметры

string $characters

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

Stringable

Stringable rtrim(string $characters = null)

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

Параметры

string $characters

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

Stringable

Stringable lcfirst()

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

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

Stringable

Stringable ucfirst()

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

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

Stringable

Collection<int,string> ucsplit()

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

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

Collection<int,string>

Stringable whenContains(string|iterable<string> $needles, callable $callback, callable|null $default = null)

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

Параметры

string|iterable<string> $needles
callable $callback
callable|null $default

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

Stringable

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

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

Параметры

array $needles
callable $callback
callable|null $default

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

Stringable

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

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

Параметры

callable $callback
callable|null $default

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

Stringable

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

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

Параметры

callable $callback
callable|null $default

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

Stringable

Stringable whenEndsWith(string|iterable<string> $needles, callable $callback, callable|null $default = null)

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

Параметры

string|iterable<string> $needles
callable $callback
callable|null $default

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

Stringable

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

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

Параметры

string $value
callable $callback
callable|null $default

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

Stringable

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

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

Параметры

string $value
callable $callback
callable|null $default

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

Stringable

Stringable whenIs(string|iterable<string> $pattern, callable $callback, callable|null $default = null)

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

Параметры

string|iterable<string> $pattern
callable $callback
callable|null $default

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

Stringable

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

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

Параметры

callable $callback
callable|null $default

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

Stringable

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

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

Параметры

callable $callback
callable|null $default

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

Stringable

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

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

Parameters

callable $callback
callable|null $default

Return Value

Stringable

Stringable whenStartsWith(string|iterable<string> $needles, callable $callback, callable|null $default = null)

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

Parameters

string|iterable<string> $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(string|null $characters = null)

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

Parameters

string|null $characters

Return Value

int

Stringable wordWrap(int $characters = 75, string $break = "\n", bool $cutLongWords = false)

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

Parameters

int $characters
string $break
bool $cutLongWords

Return Value

Stringable

Stringable wrap(string $before, string|null $after = null)

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

Parameters

string $before
string|null $after

Return Value

Stringable

Stringable unwrap(string $before, string|null $after = null)

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

Parameters

string $before
string|null $after

Return Value

Stringable

HtmlString toHtmlString()

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

Return Value

HtmlString

Stringable toBase64()

Преобразовать строку в кодировку Base64.

Return Value

Stringable

Stringable fromBase64(bool $strict = false)

Декодировать строку, закодированную в Base64.

Parameters

bool $strict

Return Value

Stringable

$this dump()

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

Return Value

$this

never dd()

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

Return Value

never

string value()

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

Return Value

string

string toString()

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

Return Value

string

int toInteger(int $base = 10)

Получить базовое значение строки как целое число.

Parameters

int $base

Return Value

int

float toFloat()

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

Return Value

float

bool toBoolean()

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

Возвращает true, когда значение равно "1", "true", "on", и "yes". В противном случае возвращает false.

Return Value

bool

Carbon toDate(string|null $format = null, string|null $tz = null)

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

Parameters

string|null $format
string|null $tz

Return Value

Carbon

Exceptions

InvalidFormatException

string jsonSerialize()

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

Return Value

string

bool offsetExists(mixed $offset)

Определить, существует ли заданный смещение.

Parameters

mixed $offset

Return Value

bool
END_OF_DOCUMENT_MARKER

string offsetGet(mixed $offset)

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

Параметры

mixed $offset

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

string

void offsetSet(mixed $offset, mixed $value)

Установить значение по заданному смещению.

Параметры

mixed $offset
mixed $value

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

void

void offsetUnset(mixed $offset)

Удалить значение по заданному смещению.

Параметры

mixed $offset

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

void

mixed __get(string $key)

Динамический доступ к свойствам через методы.

Параметры

string $key

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

mixed

string __toString()

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

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

string

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

Spec-Zone.ru

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