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

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

bool

hasAny(array $keys = [])

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

string

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

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

array

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

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

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

string

$key

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

bool

bool hasAny(array $keys = [])

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

Параметры

array

$keys

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

bool

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

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

Параметры

string	$key
string	$format

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

string

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

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

Parameters

string	$key
string	$format

Return Value

array

array all(string $format = null)

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

Parameters

string

$format

Return Value

array

array unique(string $format = null)

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

Parameters

string

$format

Return Value

array

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

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

Parameters

array	$messages
string	$format
string	$messageKey

Return Value

array

protected string checkFormat(string $format)

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

Parameters

$format

Parameters

int

$options

Return Value

string

string __toString()

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

Return Value

string

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