MessageBag

class MessageBag implements ArrayableInterface, Countable, JsonableInterface, MessageProviderInterface, JsonSerializable (View source)

Свойства

protected array	$messages	Все зарегистрированные сообщения.
protected string	$format	Формат вывода сообщения по умолчанию.

Методы

void

__construct(array $messages = array())

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

$this

add(string $key, string $message)

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

$this

merge(MessageProviderInterface|array $messages)

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

bool

isUnique(string $key, string $message)

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

bool

has(string $key = null)

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

string

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

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

array

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

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

array

all(string $format = null)

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

array

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

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

string

checkFormat(string $format)

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

array

getMessages()

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

MessageBag

getMessageBag()

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

string

getFormat()

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

MessageBag

setFormat(string $format = ':message')

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

bool

isEmpty()

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

bool

any()

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

int

count()

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

array

toArray()

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

array

jsonSerialize()

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

string

toJson(int $options)

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

string

__toString()

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

Details

void __construct(array $messages = array())

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

Parameters

array

$messages

Return Value

void

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

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

Параметры

string	$key
string	$message

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

$this

$this merge(MessageProviderInterface|array $messages)

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

Параметры

MessageProviderInterface|array

$messages

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

$this

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

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

Параметры

string	$key
string	$message

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

bool

bool has(string $key = null)

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

Параметры

string

$key

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

bool

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

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

Параметры

string	$key
string	$format

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

string

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

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

Параметры

string	$key
string	$format

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

array

array all(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 getMessages()

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

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

array

СообщениеBag getMessageBag()

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

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

СообщениеBag

string getFormat()

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

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

string

СообщениеBag setFormat(string $format = ':message')

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

Параметры

string

$format

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

СообщениеBag

bool isEmpty()

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

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

bool

bool any()

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

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

bool

int count()

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

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

int

array toArray()

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

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

array

array jsonSerialize()

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

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

array

string toJson(int $options)

Преобразовать объект в его представление в формате 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/4.2/Illuminate/Support/MessageBag.html