Разработка: workflows/tasks - История изменений

Polikarpov в 12:17, 11 декабря 2014

2014-12-11T12:17:06Z

Polikarpov: /* Перехватываемые события */

2014-12-11T11:41:34Z

‎Перехватываемые события

Polikarpov в 11:26, 11 декабря 2014

2014-12-11T11:26:01Z

Polikarpov: Новая страница: «{{Infobox_Plugin | name = tasks | type = workflows }} =workflow/tasks - Статусы задач= Плагин рабочих процессов предназна...»

2014-12-11T10:57:15Z

Новая страница: «{{Infobox_Plugin | name = tasks | type = workflows }} =workflow/tasks - Статусы задач= Плагин рабочих процессов предназна...»

Новая страница

{{Infobox_Plugin
| name = tasks
| type = workflows
}}
=workflow/tasks - Статусы задач=
Плагин рабочих процессов предназначенный для смены статусов задач.
Работает в паре с модулем storage/tasks.
Позволяет организовать смену статуса задачи в зависимости от текущего статуса.

==Возможные статусы:==
* Не просчитанный (new) - новый тег, для которого еще не производился просчет связей.
* Активный (active) - тег, который был успешно просчитан.
* Идет просчет (notavailable) - тег, для которого в данный момент производится просчет связей.
* Ошибка при просчете (failed) - тег, при просчете ссылок которого произошла ошибка.
* Удален (deleted) - удаленный тег.

==Метастатусы==
* Активный: new, active, notavailable, failed
* Актуальный: new, active, notavailable, failed
* Реальный: new, active, notavailable, failed
* Мусорный: deleted

== Маршруты статусов==
Правила описания маршрутов: описания возможностей перехода в новый статус на основании текущего статуса и условия, действительные только при переходе в новый статус из текущего статуса, группируются по текущему статусу, описания возможностей перехода в новый статус не зависящие от текущего статуса группируются по новому статусу.

=== Не просчитанный ===
Возможные переходы ИЗ этого статуса:
* Не просчитанный
* Активный
* Идет просчет
* Ошибка при просчете
* Удален

=== Активный ===
Возможные переходы ИЗ этого статуса:
* Активный
* Идет просчет
* Ошибка при просчете
* Удален

=== Идет просчет ===
Возможные переходы ИЗ этого статуса:
* Активный
* Идет просчет
* Ошибка при просчете
* Удален

=== Ошибка при просчете ===
Возможные переходы ИЗ этого статуса:
* Активный
* Идет просчет
* Ошибка при просчете
* Удален

=== Удален ===
Это конечный статус.

== API ==

==== get_list() ====
Получить список всех возможных статусов для проводки

''Аргументы:''
* (нет)
''Возвращаемые значения:''
* Массив, со списком всех возможных статусов в формате "Обозначение" => "Название статуса"

==== get_name() ====
Получить название статуса по его обозначению в Базе Данных

''Аргументы:''
* (string) $status - обозначение статуса латинскими буквами
''Возвращаемые значения:''
* (string|bool) - имя этого статуса, либо false, если он не обнаружен в списке допустимых

==== get_available() ====
Получить список статусов, в которые может перейти объект.

''Аргументы:''
* $id - id объекта в таблице
''Возвращаемые значения:''
* (array|bool) - массив возможных состояний в формате ('Обозначение' => 'Название статуса') или false в случае когда запись не найдена. В случае, когда переход из этого статуса невозможен - возвращается пустой массив.

==== change() ====
Сменить статус на указанный.

''Аргументы:''
* (int) $id - id объекта в Базе Данных
* (string) $status - обозначение статуса латинскими буквами
* (array) $opt - Массив, где содержатся дополнительные параметры для смены статуса. По умолчанию null.
''Возвращаемые значения:''
* (bool) true - если статус удалось изменить, или false в случае ошибки

При обращении к функции change() выполняются дополнительные действия, указанные выше, в разделе "Маршруты статусов". При каждом изменении статуса данные записываются в таблицу [[Разработка:storages/statushistory|statushistory]].

==== init() ====
Запускается при вставке в Базу Данных новой записи. Автоматически назначает добавленной записи статус "Не просчитанный" (new).

''Аргументы:''
* $id - id только что созданной записи в таблице
''Возвращаемые значения:''
* (bool) true если статус успешно назначен или false в случае ошибки

==Перехватываемые события==
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Пояснение
|-
| storage
| tags
| insert
| Событие добавления записи, произведем инициализацию объекта - добавим начальный статус new
|-
| storage
| tags
| soft_delete
| Событие мягкого удаления записи, произведем смену статуса объекта на deleted
|}

@@ Строка 15: / Строка 15: @@
 * Активна (active) - активная задача.
 * Заморожена (suspend) - задача заморожена.
 * Завершена (completed) - задача завершена.
 * Удалена (deleted) - задача удалена.
@@ Строка 21: / Строка 22: @@
 * Активный: active
 * Актуальный: active, suspend
-* Реальный: active, suspend, completed
+* Реальный: active, suspend, failed, completed
 * Мусорный: deleted
@@ Строка 30: / Строка 31: @@
 Возможные переходы ИЗ этого статуса:
 * Заморожена
 * Завершена
 * Удалена
@@ Строка 36: / Строка 38: @@
 Возможные переходы ИЗ этого статуса:
 * Активна
-* Завершена
+* Удалена
 * Удалена

@@ Строка 103: / Строка 103: @@
   | tasks
   | insert
-  | Событие добавления записи, произведем инициализацию объекта - добавим начальный статус new
+  | Событие добавления записи, произведем инициализацию объекта - добавим начальный статус active
   |-
   | storage

@@ Строка 6: / Строка 6: @@
 Плагин рабочих процессов предназначенный для смены статусов задач.
 Работает в паре с модулем storage/tasks.
-Позволяет организовать смену статуса задачи в зависимости от текущего статуса.
+Позволяет организовать смену статуса задач в зависимости от текущего статуса.
 ==Возможные статусы:==
-* Не просчитанный (new) - новый тег, для которого еще не производился просчет связей.
+* Активна (active) - активная задача.
-* Активный (active) - тег, который был успешно просчитан.
+* Заморожена (suspend) - задача заморожена.
-* Идет просчет (notavailable) - тег, для которого в данный момент производится просчет связей.
+* Завершена (completed) - задача завершена.
-* Ошибка при просчете (failed) - тег, при просчете ссылок которого произошла ошибка.
+* Удалена (deleted) - задача удалена.
 ==Метастатусы==
-* Активный: new, active, notavailable, failed
+* Активный: active
-* Актуальный: new, active, notavailable, failed
+* Актуальный: active, suspend
-* Реальный: new, active, notavailable, failed
+* Реальный: active, suspend, completed
 * Мусорный: deleted
@@ Строка 24: / Строка 27: @@
 Правила описания маршрутов: описания возможностей перехода в новый статус на основании текущего статуса и условия, действительные только при переходе в новый статус из текущего статуса, группируются по текущему статусу, описания возможностей перехода в новый статус не зависящие от текущего статуса группируются по новому статусу.
-=== Не просчитанный ===
+=== Активна ===
 Возможные переходы ИЗ этого статуса:
-* Активный
+* Заморожена
-* Идет просчет
+* Завершена
-* Ошибка при просчете
+* Удалена
-=== Идет просчет ===
+=== Заморожена ===
 Возможные переходы ИЗ этого статуса:
-* Активный
+* Активна
-* Идет просчет
+* Завершена
-* Ошибка при просчете
+* Удалена
-=== Ошибка при просчете ===
+=== Завершена ===
 Возможные переходы ИЗ этого статуса:
-* Активный
+* Удалена
-=== Удален ===
+=== Удалена ===
 Это конечный статус.
@@ Строка 95: / Строка 85: @@
 ==== init() ====
-Запускается при вставке в Базу Данных новой записи. Автоматически назначает добавленной записи статус "Не просчитанный" (new).
+Запускается при вставке в Базу Данных новой записи. Автоматически назначает добавленной записи статус "Активна" (active).
 ''Аргументы:''
@@ Строка 111: / Строка 101: @@
   |-
   | storage
-  | tags
+  | tasks
   | insert
   | Событие добавления записи, произведем инициализацию объекта - добавим начальный статус new
   |-
   | storage
-  | tags
+  | tasks
   | soft_delete
   | Событие мягкого удаления записи, произведем смену статуса объекта на deleted
   |}