Notify
in package
Класс для Уведомлений
Class Notify
Tags
Table of Contents
- EVENTS = [ "client.add" => "Клиент. Новый", "client.edit" => "Клиент. Изменен", "client.userchange" => "Клиент. Передан сотруднику", "client.delete" => "Клиент. Удален", "client.double" => "Клиент. Проверен на дубли", "person.send" => "Контакт. Передан сотруднику", "deal.add" => "Сделка. Новая", "deal.edit" => "Сделка. Изменена", "deal.userchange" => "Сделка. Передана сотруднику", "deal.step" => "Сделка. Смена этапа", "deal.close" => "Сделка. Закрыта", "invoice.doit" => "Счет. Проведен", "lead.add" => "Заявка. Новая", "lead.setuser" => "Заявка. Назначен ответственный", "lead.do" => "Заявка. Обработана", "cp.add" => "Контрольная точка. Новая", "cp.edit" => "Контрольная точка. Изменена", //"cp.delete" => "Контрольная точка. Удалена", "cp.doit" => "Контрольная точка. Обработана", //"cp.undoit" => "Контрольная точка. Восстановлена", "comment.new" => "Обсуждение. Новая тема или ответ", "comment.close" => "Обсуждение. Закрыто", "task.add" => "Напоминание. Новое", "task.edit" => "Напоминание. Изменено", "task.doit" => "Напоминание. Выполнено", //"sklad" => "События склада", "self" => "Событие произвольное", ]
- набор стандартных событий
- ICONS = [ "client" => ["icon" => "icon-building", "color" => "blue"], "deal" => ["icon" => "icon-briefcase", "color" => "broun"], "person" => ["icon" => "icon-user-1", "color" => "green"], "invoice" => ["icon" => "icon-rouble", "color" => "red"], "comment" => ["icon" => "icon-chat", "color" => "orange"], "lead" => ["icon" => "icon-paper-plane", "color" => "fiolet"], "todo" => ["icon" => "icon-calendar-1", "color" => "deepblue"], /*"project" => [ "icon" => "icon-tools", "color" => "deepblue" ],*/ "note" => ["icon" => "icon-bell-alt", "color" => "gray2"], "phone" => ["icon" => "icon-phone-squared", "color" => "green"], "cp" => ["icon" => "icon-check", "color" => "indigo"], ]
- набор цветных иконок для выбора нужно указать соответствующий tip события
- Changes() : array<string|int, mixed>
- Формирование блока измененных данных по Клиенту, Контакту, Сделке. Из плагина UserNotifier
- deleteOld() : string
- Удаление уведомлений, которым более 3 суток
- edit() : array<string|int, mixed>
- Редактирование уведомления
- eventNotify() : array<string|int, mixed>
- Формирование массива данных для уведомления по его типу
- events() : mixed
- Добавляет свои типы уведомлений через Hook
- fire() : array<string|int, mixed>
- Добавление уведомления по событию
- icons() : mixed
- Добавляет свою иконку из набора fontello через Hook
- info() : array<string|int, mixed>
- Информация об уведомлении
- items() : array<string|int, mixed>
- Список уведомлений для пользователя
- readit() : array<string|int, mixed>
- Пометка уведомления прочитанным
- readitAll() : string
- Пометка всех уведомлений прочитанными
- Tags() : array<string|int, mixed>
- Формирование сообщения уведомления. Из плагина UserNotifier
- userSubscription() : array<string|int, mixed>
- Возвращает список уведомлений, на которые подписан пользователь
Constants
EVENTS
набор стандартных событий
public
mixed
EVENTS
= [
"client.add" => "Клиент. Новый",
"client.edit" => "Клиент. Изменен",
"client.userchange" => "Клиент. Передан сотруднику",
"client.delete" => "Клиент. Удален",
"client.double" => "Клиент. Проверен на дубли",
"person.send" => "Контакт. Передан сотруднику",
"deal.add" => "Сделка. Новая",
"deal.edit" => "Сделка. Изменена",
"deal.userchange" => "Сделка. Передана сотруднику",
"deal.step" => "Сделка. Смена этапа",
"deal.close" => "Сделка. Закрыта",
"invoice.doit" => "Счет. Проведен",
"lead.add" => "Заявка. Новая",
"lead.setuser" => "Заявка. Назначен ответственный",
"lead.do" => "Заявка. Обработана",
"cp.add" => "Контрольная точка. Новая",
"cp.edit" => "Контрольная точка. Изменена",
//"cp.delete" => "Контрольная точка. Удалена",
"cp.doit" => "Контрольная точка. Обработана",
//"cp.undoit" => "Контрольная точка. Восстановлена",
"comment.new" => "Обсуждение. Новая тема или ответ",
"comment.close" => "Обсуждение. Закрыто",
"task.add" => "Напоминание. Новое",
"task.edit" => "Напоминание. Изменено",
"task.doit" => "Напоминание. Выполнено",
//"sklad" => "События склада",
"self" => "Событие произвольное",
]
ICONS
набор цветных иконок для выбора нужно указать соответствующий tip события
public
mixed
ICONS
= [
"client" => ["icon" => "icon-building", "color" => "blue"],
"deal" => ["icon" => "icon-briefcase", "color" => "broun"],
"person" => ["icon" => "icon-user-1", "color" => "green"],
"invoice" => ["icon" => "icon-rouble", "color" => "red"],
"comment" => ["icon" => "icon-chat", "color" => "orange"],
"lead" => ["icon" => "icon-paper-plane", "color" => "fiolet"],
"todo" => ["icon" => "icon-calendar-1", "color" => "deepblue"],
/*"project" => [
"icon" => "icon-tools",
"color" => "deepblue"
],*/
"note" => ["icon" => "icon-bell-alt", "color" => "gray2"],
"phone" => ["icon" => "icon-phone-squared", "color" => "green"],
"cp" => ["icon" => "icon-check", "color" => "indigo"],
]
Methods
Changes()
Формирование блока измененных данных по Клиенту, Контакту, Сделке. Из плагина UserNotifier
public
Changes( $tip, $params) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed> —deleteOld()
Удаление уведомлений, которым более 3 суток
public
static deleteOld() : string
Return values
string —edit()
Редактирование уведомления
public
static edit( $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —eventNotify()
Формирование массива данных для уведомления по его типу
public
static eventNotify( $event[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $event :
-
-
стандартные: client.add, client.edit, client.userchange, client.delete, client.double, person.send, deal.add, deal.edit, deal.userchange, deal.step, deal.close, invoice.doit, lead.add, lead.setuser, lead.do, comment.new, comment.close, task.add, task.edit, task.doit,
-
собственное событие: $event = 'self' - произвольное событие (все данные передаются напрямую через $params)
- $params['url'] - ссылка для открытия сущности в виде url или в виде функции js ( вида openClient('125') )
- $params['title'] - заголовок уведомления
- $params['content'] - содержимое уведомления (допускается html-оформление)
- $params['tip'] - тип события (влияет на иконку) - стандартные: client, person, deal, invoice, comment, lead, todo, project
- $params['id'] - идентификатор сущности
- $params['users'] - массив идентификаторов сотрудников, которым отправляется уведомление
-
- $params : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed> —events()
Добавляет свои типы уведомлений через Hook
public
static events() : mixed
Return values
mixed —fire()
Добавление уведомления по событию
public
static fire( $event, $autor[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed> —icons()
Добавляет свою иконку из набора fontello через Hook
public
static icons() : mixed
Return values
mixed —info()
Информация об уведомлении
public
static info(int $id) : array<string|int, mixed>
Parameters
- $id : int
Return values
array<string|int, mixed> —items()
Список уведомлений для пользователя
public
static items( $iduser[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —readit()
Пометка уведомления прочитанным
public
static readit( $id) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —readitAll()
Пометка всех уведомлений прочитанными
public
static readitAll() : string
Return values
string —Tags()
Формирование сообщения уведомления. Из плагина UserNotifier
public
Tags( $tip, $params) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed> —userSubscription()
Возвращает список уведомлений, на которые подписан пользователь
public
static userSubscription( $iduser) : array<string|int, mixed>