MessageBag

class MessageBag implements 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

addIf(bool $boolean, string $key, string $message)

Добавить сообщение в пакет сообщений, если заданное условие равно "true".

bool

isUnique(string $key, string $message)

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

$this

merge(MessageProvider|array $messages)

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

bool

has(string|array $key)

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

bool

hasAny(array|string|null $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|null $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()

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

toArray()

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

array

jsonSerialize()

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

string

toJson(int $options = 0)

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

string

__toString()

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

Подробности

void __construct(array $messages = [])

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

Параметры

массив

$messages

Значение возврата

void

массив keys()

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

Значение возврата

массив

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

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

Параметры

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

Значение возврата

$this

$this addIf(bool $boolean, string $key, string $message)

Добавить сообщение в пакет сообщений, если заданное условие «истина».

Параметры

bool	$boolean
строка	$key
строка	$message

Значение возврата

$this

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

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

Параметры

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

Значение возврата

bool

$this merge(MessageProvider|array $messages)

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

Параметры

MessageProvider|массив

$messages

Значение возврата

$this

bool has(string|array $key)

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

Параметры

строка|массив

$key

Значение возврата

bool

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

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

Parameters

array|string|null

$keys

Return Value

bool

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

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

Parameters

string\|null	$key
string\|null	$format

Return Value

string

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

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

Parameters

string	$key
string\|null	$format

Return Value

array

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

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

Parameters

string	$key
string\|null	$format

Return Value

array

array all(string|null $format = null)

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

Parameters

string|null

$format

Return Value

array

array unique(string|null $format = null)

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

Parameters

string|null

$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

string

$format

Return Value

string

array messages()

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

Return Value

array

array getMessages()

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

Return Value

array

MessageBag getMessageBag()

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

Return Value

MessageBag

string getFormat()

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

Return Value

string

$this setFormat(string $format = ':message')

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

Parameters

string

$format

Return Value

$this

bool isEmpty()

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

Return Value

bool

bool isNotEmpty()

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

Return Value

bool

bool any()

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

Return Value

bool

int count()

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

Return Value

int

toArray()

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

array jsonSerialize()

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

Return Value

array

string toJson(int $options = 0)

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

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