Разработка:lib/message.php
| Плагин | |
| Название | core |
| Тип | core |
Содержание
Описание
Класс потока сообщений Деканата
Предназначен для формирования единого потока пользовательских сообщений. Позволяет вывести все сообщения, которые были получены в процессе обработки страницы, единым блоком.
Отображение очереди сообщений не прерывает процесс отображения данных на странице.
Вся очередь разделяется на 3 уровня:
- Массив ошибок - Все ошибки, которые требуется отобразить пользователю. Пример: Ошибка доступа к подразделению.
- Массив уведомлений - Нейтральные напоминания для пользователя. Пример: Напоминание о несоответствии часового пояса персоны с его подразделением или несоответствие нагрузки шаблонов расписания
- Массив сообщений - Пояснения для всех успешных событий в системе. Пример: Успешное сохранение данных о подразделении.
За счет наличия большого количества CSS классов имеется возможность гибко настроить визуальную часть. В общем же случае поток приспособлен под стандартные сообщения Bootstrap.
Поток автоматически выводится системой в шапке (Позиция секций top)
API
display($opt = array())
Отображение потока сообщений для пользователя. Имеет встроенную защиту от множественного вызова, которая не позволит отобразить поток сообщений несколько раз
Аргументы:
- $opt (array) - Дополнительные опции отображения потока сообщений
Возвращаемые значения:
- (bool) - true/false - Результат отображения потока
add($text, $type = 'notice')
Добавление в поток.
Выбрасывает исключение при попытке добавить неизвестный тип сообщения Аргументы:
- $text (string) - Текст сообщения
- $type (string) - Тип сообщения (message, notice, error)
Возвращаемые значения:
- (void)
errors_exists()
Наличие ошибок в очереди сообщений
Аргументы:
Возвращаемые значения:
- (bool) - true/false - Наличие ошибок в очереди
notices_exists()
Наличие уведомлений в очереди сообщений
Аргументы:
Возвращаемые значения:
- (bool) - true/false - Наличие уведомлений в очереди сообщений
messages_exists()
Наличие сообщений в очереди
Аргументы:
Возвращаемые значения:
- (bool) - true/false - Наличие сообщений в очереди
