Jingga/oms-Workflow
1
0
Fork 0
mirror of https://github.com/Karaka-Management/oms-Workflow.git synced 2026-01-11 14:58:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc fixes

Browse Source
This commit is contained in:
Dennis Eichhorn 2022-04-21 23:52:00 +02:00
parent 88d6e391fc
commit 2497556c84
8 changed files with 48 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Admin/Installer.php
View File

@ -61,7 +61,7 @@ final class Installer extends InstallerAbstract
}
$workflowData = \json_decode($workflowFile, true) ?? [];
if ($workflowData === false) {
if (!\is_array($workflowData)) {
throw new \Exception(); // @codeCoverageIgnore
}

2
CONTRIBUTING.md
View File

@ -16,7 +16,7 @@ Generally, the development philosophy is result orientated. This means that anyo
Developers are encouraged to pick open tasks with high priorities according to their own skill level. Senior developers may directly assign tasks to developers based on their importance. New developers may find it easier to start with a task that has a low priority as they often also have a lower difficulty.
Open tasks can be found in the project overview: [PROJECT.md](../Project/PROJECT.md)
Open tasks can be found in the project overview: [PROJECT.md](https://github.com/Karaka-Management/Organization-Guide/blob/master/Project/PROJECT.md)
Tasks currently in development are prefixed in the priority column with an asterisk `*` and a name tag in the task description of the developer who is working on the task.

11
Controller/ApiController.php
View File

@ -84,6 +84,7 @@ final class ApiController extends Controller
}
foreach ($hooks as $hook) {
/** @var array{:triggerGroup?:string} $data */
$triggerIsRegex = \stripos($data[':triggerGroup'], '/') === 0;
$matched = false;
@ -135,7 +136,7 @@ final class ApiController extends Controller
*
* @since 1.0.0
*/
public function apiWorkflowExport(HttpRequest $request, HttpResponse $response, $data = null) : void
public function apiWorkflowExport(HttpRequest $request, HttpResponse $response, mixed $data = null) : void
{
if (!empty($val = $this->validateExport($request))) {
$response->set('export', new FormValidation($val));
@ -383,7 +384,7 @@ final class ApiController extends Controller
*
* @since 1.0.0
*/
public function apiWorkflowTemplateCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
public function apiWorkflowTemplateCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{
$uploadedFiles = $request->getFiles();
$files = [];
@ -586,7 +587,7 @@ final class ApiController extends Controller
*
* @since 1.0.0
*/
public function apiWorkflowInstanceCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
public function apiWorkflowInstanceCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{
if (!empty($val = $this->validateInstanceCreate($request))) {
$response->set('instance_create', new FormValidation($val));
@ -630,7 +631,7 @@ final class ApiController extends Controller
* Method to create interface from request.
*
* @param WorkflowTemplate $template Workflow template
* @param RequestAbstract $request Request
* @param RequestAbstract $request Request
*
* @return WorkflowInstanceAbstract
*
@ -666,7 +667,7 @@ final class ApiController extends Controller
*
* @since 1.0.0
*/
public function apiWorkflowImport(HttpRequest $request, HttpResponse $response, $data = null) : void
public function apiWorkflowImport(HttpRequest $request, HttpResponse $response, mixed $data = null) : void
{
}
}

13
Controller/BackendController.php
View File

@ -46,7 +46,7 @@ final class BackendController extends Controller
* @since 1.0.0
* @codeCoverageIgnore
*/
public function viewWorkflowTemplateList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
public function viewWorkflowTemplateList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{
$view = new View($this->app->l11nManager, $request, $response);
$view->setTemplate('/Modules/Workflow/Theme/Backend/workflow-template-list');
@ -84,7 +84,7 @@ final class BackendController extends Controller
* @since 1.0.0
* @codeCoverageIgnore
*/
public function viewWorkflowTemplate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
public function viewWorkflowTemplate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{
$view = new View($this->app->l11nManager, $request, $response);
$view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005501001, $request, $response));
@ -123,7 +123,7 @@ final class BackendController extends Controller
* @since 1.0.0
* @codeCoverageIgnore
*/
public function viewWorkflowTemplateCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
public function viewWorkflowTemplateCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{
$view = new View($this->app->l11nManager, $request, $response);
$view->setTemplate('/Modules/Workflow/Theme/Backend/workflow-template-create');
@ -144,7 +144,7 @@ final class BackendController extends Controller
* @since 1.0.0
* @codeCoverageIgnore
*/
public function viewDashboard(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
public function viewDashboard(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{
$view = new View($this->app->l11nManager, $request, $response);
$view->setTemplate('/Modules/Workflow/Theme/Backend/workflow-dashboard');
@ -165,7 +165,7 @@ final class BackendController extends Controller
* @since 1.0.0
* @codeCoverageIgnore
*/
public function viewInstanceList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
public function viewInstanceList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{
$view = new View($this->app->l11nManager, $request, $response);
$view->setTemplate('/Modules/Workflow/Theme/Backend/workflow-instance-list');
@ -191,11 +191,12 @@ final class BackendController extends Controller
* @since 1.0.0
* @codeCoverageIgnore
*/
public function viewInstance(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
public function viewInstance(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{
$view = new View($this->app->l11nManager, $request, $response);
$view->addData('nav', $this->app->moduleManager->get('Navigation')->createNavigationMid(1005501001, $request, $response));
/** @var \Modules\Workflow\Models\WorkflowTemplate $template */
$template = WorkflowTemplateMapper::get()
->with('source')
->with('source/sources')

5
Controller/CliController.php
View File

@ -49,11 +49,13 @@ final class CliController extends Controller
*/
public function runWorkflowFromHook(...$data) : void
{
/** @var \Modules\Workflow\Models\WorkflowTemplate[] $workflows */
$workflows = WorkflowTemplateMapper::getAll()->where('status', WorkflowStatus::ACTIVE)->execute();
foreach ($workflows as $workflow) {
$hooks = $workflow->getHooks();
foreach ($hooks as $hook) {
/** @var array{\\:triggerGroup?:string} $data */
$triggerIsRegex = \stripos($data[':triggerGroup'], '/') === 0;
$matched = false;
@ -104,7 +106,7 @@ final class CliController extends Controller
* @since 1.0.0
* @codeCoverageIgnore
*/
public function cliWorkflowInstanceCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
public function cliWorkflowInstanceCreate(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{
$view = new View($this->app->l11nManager, $request, $response);
@ -150,6 +152,7 @@ final class CliController extends Controller
*/
private function createInstanceFromRequest(RequestAbstract $request) : WorkflowInstanceAbstract
{
/** @var \Modules\Workflow\Models\WorkflowTemplate $template */
$template = WorkflowTemplateMapper::get()
->where('id', (int) $request->getData('j'))
->execute();

27
Models/WorkflowControllerInterface.php
View File

@ -16,6 +16,7 @@ namespace Modules\Workflow\Models;
use phpOMS\Message\RequestAbstract;
use phpOMS\Message\ResponseAbstract;
use phpOMS\Views\View;
/**
* Controller interface.
@ -72,4 +73,30 @@ interface WorkflowControllerInterface
* @since 1.0.0
*/
public function createInstanceDbModel(WorkflowInstanceAbstract $instance) : void;
/**
* Create view for instance
*
* @param View $view View to populate
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
*
* @return void
*
* @since 1.0.0
*/
public function createInstanceViewFromRequest(View $view, RequestAbstract $request, ResponseAbstract $response) : void;
/**
* Create view for template
*
* @param View $view View to populate
* @param RequestAbstract $request Request
* @param ResponseAbstract $response Response
*
* @return void
*
* @since 1.0.0
*/
public function createTemplateViewFromRequest(View $view, RequestAbstract $request, ResponseAbstract $response) : void;
}

2
Models/WorkflowInstanceMapper.php
View File

@ -43,7 +43,7 @@ final class WorkflowInstanceMapper extends DataMapperFactory
/**
* Belongs to.
*
* @var array<string, array{mapper:string, external:string}>
* @var array<string, array{mapper:string, external:string, column?:string, by?:string}>
* @since 1.0.0
*/
public const BELONGS_TO = [

2
Models/WorkflowTemplateMapper.php
View File

@ -61,7 +61,7 @@ final class WorkflowTemplateMapper extends DataMapperFactory
/**
* Belongs to.
*
* @var array<string, array{mapper:string, external:string}>
* @var array<string, array{mapper:string, external:string, column?:string, by?:string}>
* @since 1.0.0
*/
public const BELONGS_TO = [