• Главная
• Krucas
• Notification
• NotificationsBag

PHP Класс Krucas\Notification\NotificationsBag

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$container	string	NotificationBag container name.
$defaultFormat	string	Default format for all message types.
$formats	array	Default formats for types.
$groupForRender	array	Sequence of how messages should be rendered by its type.
$matcher	array	Array of matcher for extracting types.
$notification	Krucas\Notification\Notification	Notification library instance.
$notifications	Krucas\Notification\Collection | null	Collection to store all instant notification messages.
$types	array	Available message types in container.

Открытые методы

Метод	Описание
__call ( $name, $arguments ) : NotificationsBag | string	Execute short version of function calls.
__construct ( $container, array $types = [], null $defaultFormat = null, array $formats = [] )	Creates new NotificationBag object.
__toString ( ) : string	Convert the Bag to its string representation.
add ( $type, string | Krucas\Notification\Message | Closure $message, boolean $flash = true, null $format = null ) : NotificationsBag	Adds new notification message to one of collections.
addToGrouping ( $type ) : NotificationsBag	Adds type for rendering.
addType ( $type ) : NotificationsBag	Add new available type of message to bag.
all ( ) : Krucas\Notification\Collection	Returns all messages in bag.
clear ( null $type = null ) : NotificationsBag	Clears message for a given type.
clearAll ( ) : NotificationsBag	Clears all messages.
clearFormat ( $type ) : NotificationsBag	Clear format for a given type.
clearFormats ( ) : NotificationsBag	Clear all formats.
clearTypes ( ) : NotificationsBag	Resets types values.
count ( ) : integer	Count the number of colections.
first ( ) : Krucas\Notification\Message	Returns first message object for given type.
get ( $type ) : Krucas\Notification\Collection	Returns all messages for given type.
getDefaultFormat ( ) : string	Return default format.
getFormat ( $type ) : boolean | string	Return format for a given type.
getGroupingForRender ( ) : array	Return array with groups list for rendering.
getName ( ) : string	Returns assigned container name.
getNotification ( ) : Krucas\Notification\Notification	Get notification instance.
getTypes ( ) : array	Return available types of messages in container.
group ( ) : NotificationsBag	Set order to render types.
has ( $type = null ) : boolean	Check if a message is set for given type.
removeFromGrouping ( $type ) : NotificationsBag	Removes type from rendering.
setDefaultFormat ( $format ) : NotificationsBag	Set default format for all message types.
setFormat ( $type, $format ) : NotificationsBag	Set format for a given type.
setFormats ( $formats ) : NotificationsBag	Set formats for a given types.
setNotification ( Krucas\Notification\Notification $notification ) : void	Set notification instance.
show ( null $type = null, null $format = null ) : string	Returns generated output of non flash messages.
showAll ( null $format = null ) : string	Renders all messages.
toArray ( ) : array	Get the instance as an array.
toJson ( integer $options ) : string	Convert the object to its JSON representation.
typeIsAvailable ( $type ) : boolean	Determines if type is available in container.
unsetNotification ( ) : void	Unset notification instance.

Защищенные методы

Метод	Описание
addInstance ( Krucas\Notification\Message $message, string $type, boolean $flash = true, null $format = null )	Add message by instance.
checkFormat ( $format, null $type = null ) : null	Returns valid format.
extractType ( $name ) : boolean | array	Extract type from a given string.
fireEvent ( $event, $message ) : boolean	Fire event for a given message.
getMessagesForRender ( null $type = null ) : Krucas\Notification\Collection	Resolves which messages should be returned for rendering.

Описание методов

Описание свойств