MessageBag

класс MessageBag реализует Jsonable, JsonSerializable, MessageBag, MessageProvider (View source)

Свойства

protected array	$messages	Все зарегистрированные сообщения.
protected string	$format	Формат вывода сообщений по умолчанию.

Методы

void

__construct(array $messages = [])

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

array

keys()

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

$this

add(string $key, string $message)

Добавить сообщение в контейнер сообщений.

$this

addIf(bool $boolean, string $key, string $message)

Добавить сообщение в контейнер сообщений, если заданное условие истинно.

bool

isUnique(string $key, string $message)

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

$this

merge(MessageProvider|array $messages)

Объединить новый массив сообщений в контейнер сообщений.

bool

has(string|array $key)

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

bool

hasAny(array|string|null $keys = [])

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

bool

missing(array|string|null $key)

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

string

first(string|null $key = null, string|null $format = null)

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

array

get(string $key, string|null $format = null)

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

array

getMessagesForWildcardKey(string $key, string|null $format)

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

array

all(string|null $format = null)

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

array

unique(string|null $format = null)

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

$this

forget(string $key)

Удалить сообщение из контейнера сообщений.

array

transform(array $messages, string $format, string $messageKey)

Отформатировать массив сообщений.

string

checkFormat(string $format)

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

array

messages()

Получить необработанные сообщения из контейнера сообщений.

array

getMessages()

Получить необработанные сообщения из контейнера сообщений.

MessageBag

getMessageBag()

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

string

getFormat()

Получить формат сообщения по умолчанию.

$this

setFormat(string $format = ':message')

Установить формат сообщения по умолчанию.

bool

isEmpty()

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

bool

isNotEmpty()

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

bool

any()

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

int

count()

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

toArray()

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

array

jsonSerialize()

Преобразовать объект в формат, пригодный для сериализации JSON.

string

toJson(int $options = 0)

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

string

__toString()

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

Подробности

void __construct(array $messages = [])

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

Параметры

array

$messages

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

void

array keys()

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

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

array

$this add(string $key, string $message)

Добавить сообщение в контейнер сообщений.

Параметры

string	$key
string	$message

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

$this

$this addIf(bool $boolean, string $key, string $message)

Добавить сообщение в контейнер сообщений, если заданное условие истинно.

Параметры

bool	$boolean
string	$key
string	$message

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

$this

protected bool isUnique(string $key, string $message)

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

Параметры

string	$key
string	$message

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

bool

$this merge(MessageProvider|array $messages)

Объединить новый массив сообщений в контейнер сообщений.

Параметры

MessageProvider|array

$messages

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

$this

END_OF_DOCUMENT_MARKER

bool has(string|array $key)

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

Параметры

string|array

$key

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

bool

bool hasAny(array|string|null $keys = [])

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

Параметры

array|string|null

$keys

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

bool

bool missing(array|string|null $key)

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

Параметры

array|string|null

$key

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

bool

string first(string|null $key = null, string|null $format = null)

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

Параметры

string\|null	$key
string\|null	$format

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

string

array get(string $key, string|null $format = null)

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

Параметры

string	$key
string\|null	$format

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

array

protected array getMessagesForWildcardKey(string $key, string|null $format)

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

Параметры

string	$key
string\|null	$format

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

array

array all(string|null $format = null)

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

Параметры

string|null

$format

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

array

array unique(string|null $format = null)

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

Параметры

string|null

$format

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

array

$this forget(string $key)

Удалить сообщение из пакета сообщений.

Параметры

string

$key

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

$this

protected array transform(array $messages, string $format, string $messageKey)

Отформатировать массив сообщений.

Параметры

array	$messages
string	$format
string	$messageKey

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

array

protected string checkFormat(string $format)

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

Параметры

string

$format

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

string

array messages()

Получить исходные сообщения в пакете сообщений.

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

array

array getMessages()

Получить исходные сообщения в пакете сообщений.

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

array

MessageBag getMessageBag()

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

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

MessageBag

string getFormat()

Получить стандартный формат сообщений.

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

string

$this setFormat(string $format = ':message')

Установить стандартный формат сообщений.

Параметры

string

$format

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

$this

bool isEmpty()

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

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

bool

bool isNotEmpty()

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

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

bool

bool any()

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

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

bool

int count()

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

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

int

toArray()

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

array jsonSerialize()

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

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

array

string toJson(int $options = 0)

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

Параметры

int

$options

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

string

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/MessageBag.html