Разработка:lib/workflow.php — различия между версиями
Строка 15: | Строка 15: | ||
* (string) - название хранилища | * (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) - результат перевода объекта в новый статус | |
− | * (bool) | ||
− | ==== | + | ==== init() ==== |
− | + | Первичная инициализация объекта | |
''Аргументы:'' | ''Аргументы:'' | ||
− | * | + | * (int) $id - id записи объекта |
− | |||
− | |||
− | |||
''Возвращаемые значения:'' | ''Возвращаемые значения:'' | ||
− | + | * (bool) - статус иницилизации объекта | |
− | * (bool) |
Версия 11:21, 16 мая 2017
Плагин | |
Название | 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) - статус иницилизации объекта