PHP Класс Bluz\Messages\Messages

См. ссылку: https://github.com/bluzphp/framework/wiki/Messages
Автор: Anton Shevchuk
Наследование: use trait Bluz\Common\Options
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$types list of messages types

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

Метод Описание
addError ( string $message, variadic $text ) : void Add error
addNotice ( string $message, variadic $text ) : void Add notice
addSuccess ( string $message, variadic $text ) : void Add success
count ( ) : integer Get size of messages container
pop ( string $type = null ) : stdClass | null Pop a message
popAll ( ) : array Pop all messages
reset ( ) : void Reset messages

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

Метод Описание
add ( string $type, string $message, variadic $text ) : void Add message to container
createEmptyMessagesStore ( ) : ArrayObject Creates a new empty store for messages
getMessagesStore ( ) : ArrayObject | null Returns current messages store
init ( ) : Messages Initialize Messages container

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

add() защищенный Метод

Add message to container
protected add ( string $type, string $message, variadic $text ) : void
$type string One of error, notice or success
$message string
$text variadic
Результат void

addError() публичный Метод

Add error
С версии: 1.0.0 added $text
public addError ( string $message, variadic $text ) : void
$message string
$text variadic
Результат void

addNotice() публичный Метод

Add notice
С версии: 1.0.0 added $text
public addNotice ( string $message, variadic $text ) : void
$message string
$text variadic
Результат void

addSuccess() публичный Метод

Add success
С версии: 1.0.0 added $text
public addSuccess ( string $message, variadic $text ) : void
$message string
$text variadic
Результат void

count() публичный Метод

Get size of messages container
public count ( ) : integer
Результат integer

createEmptyMessagesStore() защищенный Метод

Creates a new empty store for messages
protected createEmptyMessagesStore ( ) : ArrayObject
Результат ArrayObject

getMessagesStore() защищенный Метод

Returns current messages store
protected getMessagesStore ( ) : ArrayObject | null
Результат ArrayObject | null Returns null if store not exists yet

init() защищенный Метод

Initialize Messages container
protected init ( ) : Messages
Результат Messages

pop() публичный Метод

Pop a message
public pop ( string $type = null ) : stdClass | null
$type string
Результат stdClass | null

popAll() публичный Метод

Pop all messages
public popAll ( ) : array
Результат array

reset() публичный Метод

Reset messages
public reset ( ) : void
Результат void

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

$types защищенное свойство

list of messages types
protected $types