README.md
<a href="https://github.com/phpstan/phpstan"><img src="https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat" alt="PHPStan Enabled"></a>
<a href="https://codeclimate.com/github/jeyroik/extas-workflow/maintainability"><img src="https://api.codeclimate.com/v1/badges/252d9611f230455ea854/maintainability" /></a>
<a href="https://github.com/jeyroik/extas-installer/" title="Extas Installer v3"><img alt="Extas Installer v3" src="https://img.shields.io/badge/installer-v3-green"></a>
[](//packagist.org/packages/jeyroik/extas-workflow)
[](//packagist.org/packages/jeyroik/extas-workflow)
[](//packagist.org/packages/jeyroik/extas-workflow)
# Описание
Пакет предоставляет механизм для организации перевода сущности из одного состояния в другое.
Более подробную информацию можно найти в [wiki](https://github.com/jeyroik/extas-workflow/wiki/%D0%93%D0%BB%D0%B0%D0%B2%D0%BD%D0%B0%D1%8F).
Также реализованы дашборд для управления workflow и docker-compose для запуска всего этого вместе:
- https://github.com/jeyroik/extas-workflow-dashboard - API.
- https://github.com/jeyroik/extas-workflow-dashboard-sapper - UI.
- https://github.com/jeyroik/extas-workflow-docker - Docker-compose.
# Установка пакета
`# composer require jeyroik/extas-workflow:*`
# Тесты
`# composer run-script test`
# Термины
В рамках пакета используется следующее:
- Сущность `IEntity` - объект, который требуется перевести из одного состояния в другое.
- Состояние `IState` - состояние сущности, имеет описание и название.
- Переход `ITransition` - объект, описывающий возможность перехода сущности из одного состояния в другое.
- Кроме переходов из конкретных состояний, допускается переход из любого (`*`) состояния.
- Схема `ISchema` - объект, описывающий все доступные переходы для сущности.
- Обработчик перехода `ITransitionDispatcher` - обработчик, запускающийся для конкретных переходов в конкретных схемах.
- На текущий момент данные обработчики используются для реализации условий, валидаторов и триггеров.
- Условие - проверка до перехода.
- Валидатор - проверка во время перехода.
- Триггер - функция, запускающаяся после перехода.
- Рабочий процесс `IWorkflow` - объект совершающий перевод сущности из одного состояния в другое.
# Краткое описание процесса
При запуске перевода сущности из одного состояния в другое, происходит следующее:
- По схеме определяется возможен ли переход:
- Запускаются все условия для данного перехода.
- Запускаются все валидаторы для данного перехода.
- Если валидация прошла успешно, то у сущности меняется состояние.
- Управление сменой состояния осуществляется с помощью интерфейса `IEntity`. Т.е. все сущности, которые планируются гонять с помощью данного механизма, обязаны реализовывать данный интерфейс.
- После этого запускаются все триггеры для данного перехода.
# Предварительная установка компонентов workflow
Данный пакет предоставляет следующие установщики для extas-совместимой конфигурации (см. `jeyroik/extas-installer`):
- Устанавщик состояния:
```json
{
"workflow_states": [
{
"name": "",
"title": "",
"description": "",
"parameters": [
{
"name": ""
}
]
}
]
}
```
- Установщик переходов:
```json
{
"workflow_transitions": [
{
"name": "",
"title": "",
"description": "",
"state_from": "<state.name>",
"state_to": "<state.name>"
}
]
}
```
- Установщик шаблонов обработчиков переходов:
```json
{
"workflow_transition_dispatcher_samples": [
{
"name": "",
"title": "",
"description": "",
"class": "",
"parameters": []
}
]
}
```
- Установщик схем:
```json
{
"workflow_schemas": [
{
"name": "",
"title": "",
"description": "",
"states": ["<state.name>"],
"transitions": ["<transition.name>"],
"parameters": []
}
]
}
```
- Установщик обработчиков переходов:
```json
{
"workflow_transition_dispatchers": [
{
"type": "trigger|validator",
"name": "",
"template": "<template.name>",
"schema_name": "<schema.name>",
"transition_name": "<transition.name>|*",
"parameters": []
}
]
}
```