Spec-Zone.ru › Laravel 6

MessageBag

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

Свойства

protected array $messages

Все зарегистрированные сообщения.

protected string $format

Формат по умолчанию для вывода сообщений.

Методы

void __construct(array $messages = [])

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

array keys()

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

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

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

bool isUnique(string $key, string $message)

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

$this merge(MessageProvider|array $messages)

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

bool has(string|array $key)

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

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

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

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 $format = null)

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

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

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

array 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

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

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

Параметры

string $key
string $message

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

bool

$this merge(MessageProvider|array $messages)

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

Параметры

MessageProvider|array $messages

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

$this

bool has(string|array $key)

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

Параметры

string|array $key

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

bool

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

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

Параметры

array|string $keys

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

bool
END_OF_DOCUMENT_MARKER

строка first(строка|null $key = null, строка|null $format = null)

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

Параметры

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

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

строка

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

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

Параметры

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

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

массив

protected массив getMessagesForWildcardKey(строка $key, строка|null $format)

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

Параметры

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

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

массив

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

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

Параметры

строка|null $format

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

массив

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

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

Параметры

строка $format

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

массив

protected массив transform(массив $messages, строка $format, строка $messageKey)

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

Параметры

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

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

массив

protected строка checkFormat(строка $format)

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

Параметры

строка $format

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

строка

массив messages()

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

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

массив

массив getMessages()

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

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

массив

MessageBag getMessageBag()

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

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

MessageBag

строка getFormat()

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

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

строка

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

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

Параметры

строка $format

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

$this

логический тип isEmpty()

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

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

логический тип

логический тип isNotEmpty()

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

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

логический тип

логический тип any()

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

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

логический тип

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

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

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

целое число

массив toArray()

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

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

массив

массив jsonSerialize()

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

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

массив

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

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

Параметры

целое число $options

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

строка

строка __toString()

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

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

строка

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

Spec-Zone.ru

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