ComponentAttributeBag

class ComponentAttributeBag implements ArrayAccess, IteratorAggregate, JsonSerializable, Htmlable (View source)

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	from Macroable
protected array	$attributes	Исходный массив атрибутов.

Методы

Особенности

Conditionable

Macroable

$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
void	__construct(array $attributes = []) Создать новый экземпляр хранилища атрибутов компонента.
mixed	first(mixed $default = null) Получить значение первого атрибута.
mixed	get(string $key, mixed $default = null) Получить заданный атрибут из массива атрибутов.
bool	has(array\|string $key) Определить, существует ли заданный атрибут в массиве атрибутов.
bool	hasAny(array\|string $key) Определить, существуют ли какие-либо ключи в массиве атрибутов.
bool	missing(string $key) Определить, отсутствует ли заданный атрибут в массиве атрибутов.
ComponentAttributeBag	only(mixed $keys) Включить только указанные атрибуты из массива атрибутов.
ComponentAttributeBag	except(mixed\|array $keys) Исключить указанные атрибуты из массива атрибутов.
ComponentAttributeBag	filter(callable $callback) Отфильтровать атрибуты, вернув хранилище атрибутов, прошедших фильтр.
ComponentAttributeBag	whereStartsWith(string\|string[] $needles) Возвратить хранилище атрибутов, ключи которых начинаются с заданного значения/шаблона.
ComponentAttributeBag	whereDoesntStartWith(string\|string[] $needles) Возвратить хранилище атрибутов с ключами, которые не начинаются с заданного значения/шаблона.
ComponentAttributeBag	thatStartWith(string\|string[] $needles) Возвратить хранилище атрибутов, ключи которых начинаются с заданного значения/шаблона.
ComponentAttributeBag	onlyProps(mixed\|array $keys) Включить только указанные атрибуты из массива атрибутов.
ComponentAttributeBag	exceptProps(mixed\|array $keys) Исключить указанные атрибуты из массива атрибутов.
array	extractPropNames(mixed\|array $keys) Извлечь имена свойств из заданных ключей.
ComponentAttributeBag	class(mixed\|array $classList) Условно объединить классы в хранилище атрибутов.
ComponentAttributeBag	style(mixed\|array $styleList) Условно объединить стили в хранилище атрибутов.
ComponentAttributeBag	merge(array $attributeDefaults = [], bool $escape = true) Объединить дополнительные атрибуты/значения в хранилище атрибутов.
bool	shouldEscapeAttributeValue(bool $escape, mixed $value) Определить, должен ли быть экранировано конкретное значение атрибута.
AppendableAttributeValue	prepends(mixed $value) Создать новое значение атрибута, допускающее добавление.
mixed	resolveAppendableAttributeDefault(array $attributeDefaults, string $key, bool $escape) Разрешить значение по умолчанию для атрибута, допускающего добавление.
bool	isEmpty() Определить, пусто ли хранилище атрибутов.
bool	isNotEmpty() Определить, не пусто ли хранилище атрибутов.
array	getAttributes() Получить все исходные атрибуты.
void	setAttributes(array $attributes) Установить базовые атрибуты.
string	toHtml() Получить содержимое в виде строки HTML.
HtmlString	__invoke(array $attributeDefaults = []) Объединить дополнительные атрибуты/значения в хранилище атрибутов.
bool	offsetExists(string $offset) Определить, существует ли указанный смещение.
mixed	offsetGet(string $offset) Получить значение по указанному смещению.
void	offsetSet(string $offset, mixed $value) Установить значение по указанному смещению.
void	offsetUnset(string $offset) Удалить значение по указанному смещению.

Traversable	getIterator() Получить итератор для элементов.
mixed	jsonSerialize() Преобразовать объект в сериализуемую в JSON форму.
string	__toString() Объединить атрибуты в одну строку, готовую для HTML.

Подробное описание

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

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

Параметры

	$value
callable	$callback
callable	$default

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

$this|TWhenReturnType

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

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

Параметры

	$value
callable	$callback
callable	$default

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

$this|TUnlessReturnType

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

void __construct(array $attributes = [])

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

Параметры

array

$attributes

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

void

mixed first(mixed $default = null)

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

Параметры

mixed

$default

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

mixed

mixed get(string $key, mixed $default = null)

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

Параметры

string	$key
mixed	$default

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

mixed

bool has(array|string $key)

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

Параметры

array|string

$key

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

bool

bool hasAny(array|string $key)

Определить, существуют ли какие-либо ключи в массиве атрибутов.

Параметры

array|string

$key

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

bool

bool missing(string $key)

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

Параметры

string

$key

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

bool

ComponentAttributeBag only(mixed $keys)

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

Параметры

mixed

$keys

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

ComponentAttributeBag

ComponentAttributeBag except(mixed|array $keys)

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

Параметры

mixed|array

$keys

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

ComponentAttributeBag

ComponentAttributeBag filter(callable $callback)

Отфильтровать атрибуты, вернув набор атрибутов, прошедших фильтрацию.

Параметры

callable

$callback

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

ComponentAttributeBag

ComponentAttributeBag whereStartsWith(string|string[] $needles)

Возвращает набор атрибутов, ключи которых начинаются с заданного значения/шаблона.

Параметры

string|string[]

$needles

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

ComponentAttributeBag

ComponentAttributeBag whereDoesntStartWith(string|string[] $needles)

Возвращает набор атрибутов с ключами, которые не начинаются с заданного значения/шаблона.

Параметры

string|string[]

$needles

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

ComponentAttributeBag

ComponentAttributeBag thatStartWith(string|string[] $needles)

Возвращает набор атрибутов, ключи которых начинаются с заданного значения/шаблона.

Параметры

string|string[]

$needles

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

ComponentAttributeBag

ComponentAttributeBag onlyProps(mixed|array $keys)

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

Параметры

mixed|array

$keys

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

ComponentAttributeBag

ComponentAttributeBag exceptProps(mixed|array $keys)

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

Параметры

mixed|array

$keys

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

ComponentAttributeBag

protected array extractPropNames(mixed|array $keys)

Извлекает имена свойств из заданных ключей.

Параметры

mixed|array

$keys

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

array

ComponentAttributeBag class(mixed|array $classList)

Условное объединение классов в набор атрибутов.

Параметры

mixed|array

$classList

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

ComponentAttributeBag

ComponentAttributeBag style(mixed|array $styleList)

Условное объединение стилей в набор атрибутов.

Параметры

mixed|array

$styleList

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

ComponentAttributeBag

ComponentAttributeBag merge(array $attributeDefaults = [], bool $escape = true)

Объединение дополнительных атрибутов/значений в набор атрибутов.

Параметры

array	$attributeDefaults
bool	$escape

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

ComponentAttributeBag

protected bool shouldEscapeAttributeValue(bool $escape, mixed $value)

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

Параметры

bool	$escape
mixed	$value

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

bool

AppendableAttributeValue prepends(mixed $value)

Создание нового значения атрибута, которое можно добавить.

Параметры

mixed

$value

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

AppendableAttributeValue

protected mixed resolveAppendableAttributeDefault(array $attributeDefaults, string $key, bool $escape)

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

Параметры

array	$attributeDefaults
string	$key
bool	$escape

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

mixed

bool isEmpty()

Определение, пуст ли набор атрибутов.

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

bool

bool isNotEmpty()

Определение, не пуст ли набор атрибутов.

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

bool

array getAttributes()

Получение всех исходных атрибутов.

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

array

void setAttributes(array $attributes)

Установка базовых атрибутов.

Параметры

array

$attributes

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

void

string toHtml()

Получение содержимого в виде строки HTML.

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

string

HtmlString __invoke(array $attributeDefaults = [])

Объединение дополнительных атрибутов/значений в набор атрибутов.

Параметры

array

$attributeDefaults

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

HtmlString

bool offsetExists(string $offset)

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

Параметры

string

$offset

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

bool

mixed offsetGet(string $offset)

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

Параметры

string

$offset

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

mixed

void offsetSet(string $offset, mixed $value)

Установка значения по заданному индексу.

Параметры

string	$offset
mixed	$value

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

void

void offsetUnset(string $offset)

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

Параметры

string

$offset

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

void

Traversable getIterator()

Получить итератор для элементов.

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

Traversable

mixed jsonSerialize()

Преобразовать объект в сериализуемую в JSON форму.

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

mixed

string __toString()

Объединить атрибуты в одну строку, готовую для HTML.

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

string

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