Spec-Zone.ru › Laravel 5.3

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)

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

$this merge(MessageProvider|array $messages)

Слить новый массив сообщений в пакет.

bool isUnique(string $key, string $message)

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

bool has(string|array $key)

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

bool hasAny(array $keys = [])

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

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

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

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

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

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

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

array all(string $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 any()

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

int count()

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

array toArray()

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

array jsonSerialize()

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

string toJson(int $options)

Преобразовать объект в его представление 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 merge(MessageProvider|array $messages)

Слить новый массив сообщений в пакет.

Параметры

MessageProvider|array $messages

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

$this

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

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

Параметры

string $key
string $message

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

bool

bool has(string|array $key)

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

Параметры

string|array $key

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

bool

bool hasAny(array $keys = [])

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

Параметры

array $keys

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

bool

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

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

Параметры

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

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

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

логическое

логическое 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.3/Illuminate/Support/MessageBag.html

Spec-Zone.ru

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