MessageBag

class MessageBag implements Arrayable, Countable, Jsonable, JsonSerializable, MessageBag, MessageProvider (View source)

Свойства

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

Методы

void

__construct(array $messages = [])

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

array

keys()

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

$this

add(string $key, string $message)

Добавить сообщение в MessageBag.

bool

isUnique(string $key, string $message)

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

$this

merge(MessageProvider|array $messages)

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

bool

has(string|array $key)

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

bool

hasAny(array|string $keys = [])

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

string

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

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

array

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

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

array

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

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

array

all(string $format = null)

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

array

unique(string $format = null)

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

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

Определить, пуст ли MessageBag.

bool

isNotEmpty()

Определить, содержит ли MessageBag сообщения.

bool

any()

Определить, содержит ли MessageBag сообщения.

int

count()

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

array

toArray()

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

array

jsonSerialize()

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

string

toJson(int $options)

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

string

__toString()

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

Подробности

void __construct(array $messages = [])

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

Параметры

array

$messages

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

void

array keys()

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

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

array

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

Добавить сообщение в MessageBag.

Параметры

string	$key
string	$message

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

$this

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

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

Параметры

string	$key
string	$message

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

bool

$this merge(MessageProvider|array $messages)

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

Параметры

MessageProvider|array

$messages

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

$this

bool has(string|array $key)

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

Параметры

string|array

$key

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

bool

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

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

Параметры

array|string

$keys

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

bool

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

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

Параметры

string	$key
string	$format

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

string

массив get(строка $key, строка $format = null)

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

Параметры

строка	$key
строка	$format

Значение результата

массив

защищённый массив getMessagesForWildcardKey(строка $key, строка|null $format)

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

Параметры

строка	$key
строка\|null	$format

Значение результата

массив

массив all(строка $format = null)

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

Параметры

строка

$format

Значение результата

массив

массив unique(строка $format = null)

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

Параметры

строка

$format

Значение результата

массив

защищённый массив transform(массив $messages, строка $format, строка $messageKey)

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

Параметры

массив	$messages
строка	$format
строка	$messageKey

Значение результата

массив

защищённый строка checkFormat(строка $format)

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

Параметры

строка

$format

Значение результата

строка

массив messages()

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

Значение результата

массив

массив getMessages()

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

Значение результата

массив

MessageBag getMessageBag()

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

Значение результата

MessageBag

строка getFormat()

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

Значение результата

строка

$this setFormat(строка $format = ':message')

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

Параметры

строка

$format

Значение результата

$this

логическое значение isEmpty()

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

Значение результата

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

логическое значение isNotEmpty()

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

Значение результата

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

логическое значение any()

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

Значение результата

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

целое число count()

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

Значение результата

целое число

массив toArray()

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

Значение результата

массив

массив jsonSerialize()

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

Значение результата

массив

строка toJson(целое число $options)

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

Параметры

целое число

$options

Значение результата

строка

строка __toString()

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

Значение результата

строка

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