FOUR-18078-FOUR-18130: [FALL] Cases Details & Enhancing Performance

ProcessMaker/Console/Commands/CasesSync.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace ProcessMaker\Console\Commands;
+
+use Illuminate\Console\Command;
+use ProcessMaker\Repositories\CaseSyncRepository;
+
+class CasesSync extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'cases:sync
+                            {--request_ids= : Comma-separated list of request IDs to sync}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Sync requests with the cases tables';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle()
+    {
+        $requestIds = $this->option('request_ids');
+        $requestIds = $requestIds ? explode(',', $requestIds) : [];
+
+        if (count($requestIds) > 0) {
+            $data = CaseSyncRepository::syncCases($requestIds);
+
+            foreach ($data['successes'] as $value) {
+                $this->info('Case started synced ' . $value);
+            }
+
+            foreach ($data['errors'] as $value) {
+                $this->error('Error syncing case started ' . $value);
+            }
+        } else {
+            $this->error('Please specify a list of request IDs.');
+        }
+    }
+}

ProcessMaker/Contracts/CaseApiRepositoryInterface.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace ProcessMaker\Contracts;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\Request;
+
+interface CaseApiRepositoryInterface
+{
+    /**
+     * Get all cases
+     *
+     * @param Request $request
+     *
+     * @return Builder
+     */
+    public function getAllCases(Request $request): Builder;
+    /**
+     * Get all cases in progress
+     *
+     * @param Request $request
+     *
+     * @return Builder
+     */
+    public function getInProgressCases(Request $request): Builder;
+    /**
+     * Get all completed cases
+     *
+     * @param Request $request
+     *
+     * @return Builder
+     */
+    public function getCompletedCases(Request $request): Builder;
+    /**
+     * Search by case number or case title.
+
+     * @param Request $request: Query parameter format: search=keyword
+     * @param Builder $query
+     *
+     * @return void
+     */
+    public function search(Request $request, Builder $query): void;
+    /**
+     * Filter the query.
+     *
+     * @param Request $request: Query parameter format: filterBy[field]=value&filterBy[field2]=value2&...
+     * @param Builder $query
+     * @param array $dateFields List of date fields in current model
+     *
+     * @return void
+     */
+    public function filterBy(Request $request, Builder $query): void;
+    /**
+     * Sort the query.
+     *
+     * @param Request $request: Query parameter format: sortBy=field:asc,field2:desc,...
+     * @param Builder $query
+     *
+     * @return void
+     */
+    public function sortBy(Request $request, Builder $query): void;
+}

ProcessMaker/Contracts/CaseRepositoryInterface.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace ProcessMaker\Contracts;
+
+use ProcessMaker\Nayra\Contracts\Bpmn\TokenInterface;
+use ProcessMaker\Nayra\Contracts\Engine\ExecutionInstanceInterface;
+
+interface CaseRepositoryInterface
+{
+    /**
+     * Store a new case started.
+     *
+     * @param ExecutionInstanceInterface $instance
+     * @return void
+     */
+    public function create(ExecutionInstanceInterface $instance): void;
+    /**
+     * Update the case started.
+     *
+     * @param ExecutionInstanceInterface $instance
+     * @param TokenInterface $token
+     * @return void
+     */
+    public function update(ExecutionInstanceInterface $instance, TokenInterface $token): void;
+    /**
+     * Update the status of a case started.
+     *
+     * @param ExecutionInstanceInterface $instance
+     * @return void
+     */
+    public function updateStatus(ExecutionInstanceInterface $instance): void;
+}

ProcessMaker/Exception/CaseValidationException.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace ProcessMaker\Exception;
+
+use Exception;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+
+class CaseValidationException extends Exception
+{
+    /**
+     * Render the exception as an HTTP response.
+     */
+    public function render(Request $request): JsonResponse
+    {
+        return response()->json([
+            'message' => $this->getMessage(),
+        ], JsonResponse::HTTP_UNPROCESSABLE_ENTITY);
+    }
+}