From 2497556c84d7c3b6ac28100302cb297d5c7cc48c Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Thu, 21 Apr 2022 23:52:00 +0200 Subject: [PATCH] doc fixes --- Admin/Installer.php | 2 +- CONTRIBUTING.md | 2 +- Controller/ApiController.php | 11 ++++++----- Controller/BackendController.php | 13 +++++++------ Controller/CliController.php | 5 ++++- Models/WorkflowControllerInterface.php | 27 ++++++++++++++++++++++++++ Models/WorkflowInstanceMapper.php | 2 +- Models/WorkflowTemplateMapper.php | 2 +- 8 files changed, 48 insertions(+), 16 deletions(-) diff --git a/Admin/Installer.php b/Admin/Installer.php index 64f796f..08c1a1c 100755 --- a/Admin/Installer.php +++ b/Admin/Installer.php @@ -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 } diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9b4371..4bbb819 100755 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/Controller/ApiController.php b/Controller/ApiController.php index 20a504e..d3b30ab 100644 --- a/Controller/ApiController.php +++ b/Controller/ApiController.php @@ -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 { } } diff --git a/Controller/BackendController.php b/Controller/BackendController.php index dc9ce6b..d58a159 100755 --- a/Controller/BackendController.php +++ b/Controller/BackendController.php @@ -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') diff --git a/Controller/CliController.php b/Controller/CliController.php index 3ab1487..9cae9f7 100644 --- a/Controller/CliController.php +++ b/Controller/CliController.php @@ -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(); diff --git a/Models/WorkflowControllerInterface.php b/Models/WorkflowControllerInterface.php index eae345d..e5ffe91 100644 --- a/Models/WorkflowControllerInterface.php +++ b/Models/WorkflowControllerInterface.php @@ -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; } diff --git a/Models/WorkflowInstanceMapper.php b/Models/WorkflowInstanceMapper.php index ba63366..48bbfb1 100644 --- a/Models/WorkflowInstanceMapper.php +++ b/Models/WorkflowInstanceMapper.php @@ -43,7 +43,7 @@ final class WorkflowInstanceMapper extends DataMapperFactory /** * Belongs to. * - * @var array + * @var array * @since 1.0.0 */ public const BELONGS_TO = [ diff --git a/Models/WorkflowTemplateMapper.php b/Models/WorkflowTemplateMapper.php index 2de1b87..8e2c26c 100644 --- a/Models/WorkflowTemplateMapper.php +++ b/Models/WorkflowTemplateMapper.php @@ -61,7 +61,7 @@ final class WorkflowTemplateMapper extends DataMapperFactory /** * Belongs to. * - * @var array + * @var array * @since 1.0.0 */ public const BELONGS_TO = [