class MessageBag implements Arrayable, Countable, Jsonable, JsonSerializable, MessageBag, MessageProvider (View source)

Properties

protected array $messages All of the registered messages.
protected string $format Default format for message output.

Methods

void
__construct(array $messages = [])

Create a new message bag instance.

array
keys()

Get the keys present in the message bag.

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

Add a message to the message bag.

bool
isUnique(string $key, string $message)

Determine if a key and message combination already exists.

$this
merge(MessageProvider|array $messages)

Merge a new array of messages into the message bag.

bool
has(string|array $key)

Determine if messages exist for all of the given keys.

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

Determine if messages exist for any of the given keys.

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

Get the first message from the message bag for a given key.

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

Get all of the messages from the message bag for a given key.

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

Get the messages for a wildcard key.

array
all(string $format = null)

Get all of the messages for every key in the message bag.

array
unique(string $format = null)

Get all of the unique messages for every key in the message bag.

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

Format an array of messages.

string
checkFormat(string $format)

Get the appropriate format based on the given format.

array
messages()

Get the raw messages in the message bag.

array
getMessages()

Get the raw messages in the message bag.

getMessageBag()

Get the messages for the instance.

string
getFormat()

Get the default message format.

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

Set the default message format.

bool
isEmpty()

Determine if the message bag has any messages.

bool
isNotEmpty()

Determine if the message bag has any messages.

bool
any()

Determine if the message bag has any messages.

int
count()

Get the number of messages in the message bag.

array
toArray()

Get the instance as an array.

array
jsonSerialize()

Convert the object into something JSON serializable.

string
toJson(int $options = 0)

Convert the object to its JSON representation.

string
__toString()

Convert the message bag to its string representation.

Details

void __construct(array $messages = [])

Create a new message bag instance.

Parameters

array $messages

Return Value

void

array keys()

Get the keys present in the message bag.

Return Value

array

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

Add a message to the message bag.

Parameters

string $key
string $message

Return Value

$this

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

Determine if a key and message combination already exists.

Parameters

string $key
string $message

Return Value

bool

$this merge(MessageProvider|array $messages)

Merge a new array of messages into the message bag.

Parameters

MessageProvider|array $messages

Return Value

$this

bool has(string|array $key)

Determine if messages exist for all of the given keys.

Parameters

string|array $key

Return Value

bool

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

Determine if messages exist for any of the given keys.

Parameters

array|string $keys

Return Value

bool

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

Get the first message from the message bag for a given key.

Parameters

string $key
string $format

Return Value

string

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

Get all of the messages from the message bag for a given key.

Parameters

string $key
string $format

Return Value

array

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

Get the messages for a wildcard key.

Parameters

string $key
string|null $format

Return Value

array

array all(string $format = null)

Get all of the messages for every key in the message bag.

Parameters

string $format

Return Value

array

array unique(string $format = null)

Get all of the unique messages for every key in the message bag.

Parameters

string $format

Return Value

array

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

Format an array of messages.

Parameters

array $messages
string $format
string $messageKey

Return Value

array

protected string checkFormat(string $format)

Get the appropriate format based on the given format.

Parameters

string $format

Return Value

string

array messages()

Get the raw messages in the message bag.

Return Value

array

array getMessages()

Get the raw messages in the message bag.

Return Value

array

MessageBag getMessageBag()

Get the messages for the instance.

Return Value

MessageBag

string getFormat()

Get the default message format.

Return Value

string

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

Set the default message format.

Parameters

string $format

Return Value

$this

bool isEmpty()

Determine if the message bag has any messages.

Return Value

bool

bool isNotEmpty()

Determine if the message bag has any messages.

Return Value

bool

bool any()

Determine if the message bag has any messages.

Return Value

bool

int count()

Get the number of messages in the message bag.

Return Value

int

array toArray()

Get the instance as an array.

Return Value

array

array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

string toJson(int $options = 0)

Convert the object to its JSON representation.

Parameters

int $options

Return Value

string

string __toString()

Convert the message bag to its string representation.

Return Value

string