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

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

array

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

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

array

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

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

array

all(string|null $format = null)

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

array

unique(string $format = null)

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

array

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

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

string

checkFormat(string $format)

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

array

messages()

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

array

getMessages()

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

MessageBag

getMessageBag()

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

string

getFormat()

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

$this

setFormat(string $format = ':message')

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

bool

isEmpty()

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

bool

isNotEmpty()

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

bool

any()

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

int

count()

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

array

toArray()

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

array

jsonSerialize()

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

string

toJson(int $options = 0)

Преобразовать объект в его представление 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|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 $format = null)

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

Параметры

string

$format

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

array

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

array toArray()

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

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

array

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