Разработка:lib/workflow.php

Материал из DOF
Версия от 11:26, 16 мая 2017; Agadzhanyan (обсуждение | вклад) (get_available($))
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к: навигация, поиск
Плагин
Название core
Тип core


Описание

Родительский класс интерфейса рабочих процессов. Вносит дополнительную характеристику конкретных объектов в виде текущего статуса объекта. Выполняет контроль перехода объекта в новый статус, а также устанавливает начальный статус созданного объекта при инициализации объекта.

API

get_storage()

Получить название хранилища, которое обслуживает текущий учебный процесс

Возвращаемые значения:

  • (string) - название хранилища

get_list()

Возвращает массив всех состояний, в которых может находиться экземпляр объекта, обрабатываемый этим плагином

Возвращаемые значения:

  • (array) - массив статусов

get_name()

Получить локализованное имя статуса

Аргументы:

  • (string) $status - код статуса

Возвращаемые значения:

  • (string) - локализованное имя статус

get_available()

Получить список статусов, в которые текущий объект может перейти

Аргументы:

  • (int) $id - id записи в таблице

Возвращаемые значения:

  • (array) - массив доступных статусов
  • (false) - отсутствуют доступные статусы

change()

Перевод текущего объекта в указанный статус

Аргументы:

  • (int) $id - ID объекта
  • (string) $newstatus - Статус, в который требуется перевести объект
  • (array) $options - Массив дополнительных опций

Возвращаемые значения:

  • (bool) - результат перевода объекта в новый статус

init()

Первичная инициализация объекта

Аргументы:

  • (int) $id - id записи объекта

Возвращаемые значения:

  • (bool) - статус иницилизации объекта