Spec-Zone.ru › Laravel 7

Stringable

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

Трейты

Macroable

Свойства

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

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

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

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

Методы

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 mixed __callStatic(string $method, array $parameters)

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

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

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

из Macroable
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 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 $pattern, int $limit = -1, int $flags = 0)

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

Stringable finish(string $cap)

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

bool is(string|array $pattern)

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

bool isAscii()

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

bool isEmpty()

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

bool isNotEmpty()

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

Stringable kebab()

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

int length(string $encoding = null)

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

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

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

Stringable lower()

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

Stringable|null match(string $pattern)

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

Collection matchAll(string $pattern)

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

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

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

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

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

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

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

array parseCallback(string|null $default = null)

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

Stringable plural(int $count = 2)

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

Stringable pluralStudly(int $count = 2)

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

Stringable prepend(array ...$values)

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

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

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

Stringable replaceArray(string $search, array $replace)

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

Stringable replaceFirst(string $search, string $replace)

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

Stringable replaceLast(string $search, string $replace)

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

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

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

Stringable start(string $prefix)

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

Stringable upper()

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

Stringable title()

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

Stringable singular()

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

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

Сгенерировать URL-адрес из заданной строки.

Stringable snake(string $delimiter = '_')

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

bool startsWith(string|array $needles)

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

Stringable studly()

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

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

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

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

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

Stringable trim(string $characters = null)

Удалить пробелы с начала и конца строки.

Stringable ltrim(string $characters = null)

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

Stringable rtrim(string $characters = null)

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

Stringable ucfirst()

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

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

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

Stringable whenEmpty(callable $callback)

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

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

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

$this dump()

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

void dd()

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

mixed __get(string $key)

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

string __toString()

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

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

void __construct(string $value = '')

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

Parameters

string $value

Return Value

void

Stringable after(string $search)

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

Parameters

string $search

Return Value

Stringable
END_OF_DOCUMENT_MARKER

Stringable afterLast(string $search)

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

Параметры

string $search

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

Stringable

Stringable append(array ...$values)

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

Параметры

array ...$values

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

Stringable

Stringable ascii(string $language = 'en')

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

Параметры

string $language

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

Stringable

Stringable basename(string $suffix = '')

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

Параметры

string $suffix

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

Stringable

Stringable before(string $search)

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

Параметры

string $search

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

Stringable

Stringable beforeLast(string $search)

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

Параметры

string $search

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

Stringable

Stringable between(string $from, string $to)

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

Параметры

string $from
string $to

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

Stringable

Stringable camel()

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

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

Stringable

bool contains(string|array $needles)

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

Параметры

string|array $needles

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

bool

bool containsAll(array $needles)

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

Параметры

array $needles

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

bool

Stringable dirname(int $levels = 1)

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

Параметры

int $levels

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

Stringable

bool endsWith(string|array $needles)

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

Параметры

string|array $needles

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

bool

bool exactly(string $value)

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

Параметры

string $value

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

bool

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

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

Параметры

string $delimiter
int $limit

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

Collection

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

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

Параметры

string $pattern
int $limit
int $flags

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

Collection

Stringable finish(string $cap)

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

Параметры

string $cap

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

Stringable

bool is(string|array $pattern)

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

Параметры

string|array $pattern

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

bool

bool isAscii()

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

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

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|null match(string $pattern)

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

Параметры

string $pattern

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

Stringable|null

Collection matchAll(string $pattern)

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

Параметры

string $pattern

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

Collection

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)

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

Параметры

string|null $default

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

array

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

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

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

Параметры

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

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

Stringable

Stringable replaceArray(string $search, array $replace)

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

Параметры

string $search
array $replace

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

Stringable

Stringable replaceFirst(string $search, string $replace)

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

Параметры

string $search
string $replace

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

Stringable

Stringable replaceLast(string $search, string $replace)

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

Параметры

string $search
string $replace

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

Stringable

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

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

Параметры

string $pattern
Closure|string $replace
int $limit

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

Stringable

Stringable start(string $prefix)

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

Параметры

string $prefix

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

Stringable

Stringable upper()

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

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

Stringable

Stringable title()

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

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

Stringable

Stringable singular()

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

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

Stringable

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

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

Параметры

string $separator
string|null $language

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

Stringable

Stringable snake(string $delimiter = '_')

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

Параметры

string $delimiter

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

Stringable

bool startsWith(string|array $needles)

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

Параметры

string|array $needles

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

bool

Stringable studly()

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

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

Stringable

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

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

Параметры

int $start
int|null $length

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

Stringable

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

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

Параметры

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

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

int

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 ucfirst()

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

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

Stringable

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

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

Параметры

mixed $value
callable $callback
callable|null $default

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

mixed|$this

Stringable whenEmpty(callable $callback)

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

Параметры

callable $callback

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

Stringable

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

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

Параметры

int $words
string $end

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

Stringable

$this dump()

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

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

$this

void dd()

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

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

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/7.x/Illuminate/Support/Stringable.html

Spec-Zone.ru

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