Разработка:workflows/accentryes
Плагин | |
Название | accentryes |
Тип | workflows |
Содержание
Возможные статусы:
- Активная (active) - транзакция активна.
- Возврат (canceled) - возврат перведенной суммы.
- Отменена (rejected) - транзакция отклонена и больше не учитывается при подсчете баланса, но по ней можно увидеть информацию.
- Удалена (deleted) - транзакция удалена из системы и скрыта от просмотра.
Метастатусы
- Активный:active
- Актуальный: active
- Реальный: active, canceled, rejected
- Мусорный: deleted
Маршруты статусов
Правила описания маршрутов: описания возможностей перехода в новый статус на основании текущего статуса и условия, действительные только при переходе в новый статус из текущего статуса, группируются по текущему статусу, описания возможностей перехода в новый статус не зависящие от текущего статуса группируются по новому статусу.
Активная
Возможные переходы ИЗ этого статуса:
- Возврат
- Отменена
- Удалена
Возврат
Это конечный статус.
Отменена
Это конечный статус.
Удалена
Это конечный статус.
API
get_list()
Получить список всех возможных статусов для проводки
Аргументы:
- (нет)
Возвращаемые значения:
- Массив, со списком всех возможных статусов в формате "обозначение" => "Перевод"
get_name()
Получить название статуса по его обозначению в базе данных
Аргументы:
- (string) $status - обозначение статуса латинскими буквами
Возвращаемые значения:
- (string|bool) - перевод для этого статуса, либо false, если он не обнаружен в списке допустимых
get_available()
Получить список статусов, в которые может перейти указанная проводка.
Аргументы:
- $id - id проводки в таблице accentryes
Возвращаемые значения:
- (array|bool) - массив возможных состояний в формате ('обозначение' => 'первод') или false в случае когда запись не найдена. В случае, когда переход из этого статуса невозможен - возвращается пустой массив.
change()
Сменить статус на указанный.
Аргументы:
- (int) $id - id проводки в таблице accentryes
- (string) $status - обозначение статуса латинскими буквами
- (array) $opt - Массив, где содержатся дополнительные параметры для смены статуса. По умолчанию null.
Возвращаемые значения:
- (bool) true - если статус удалось изменить, или false в случае ошибки
При обращении к функции change() выполняются дополнительные действия, указанные выше, в разделе "Маршруты статусов". При каждом изменении статуса данные записываются в таблицу statushistory.
init()
Запускается при вставке в таблицу accentryes новой записи. Автоматически назначает созданной транзакции статус "Актуальная" (actual).
Аргументы:
- $id - id только что созданногой транзакции в таблице accentryes
Возвращаемые значения:
- (bool) true если статус успешно назначен или false в случае ошибки
Перехватываемые события
Тип плагина | Код плагина | Код события | Пояснение |
---|---|---|---|