FOUR-18604 cases participated table and view the list of cases the user is involved in ep

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/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);
+ }
+}

ProcessMaker/Http/Controllers/Api/V1_1/CaseController.php

@@ -3,65 +3,25 @@
 namespace ProcessMaker\Http\Controllers\Api\V1_1;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use ProcessMaker\Http\Controllers\Controller;
-use ProcessMaker\Http\Requests\GetAllCasesRequest;
+use ProcessMaker\Http\Requests\CaseListRequest;
 use ProcessMaker\Http\Resources\V1_1\CaseResource;
-use ProcessMaker\Models\CaseStarted;
+use ProcessMaker\Repositories\CaseApiRepository;
 
 class CaseController extends Controller
 {
- /**
- * Default fields used in the query select statement.
- */
- protected $defaultFields = [
- 'case_number',
- 'user_id',
- 'case_title',
- 'case_title_formatted',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $sortableFields = [
- 'case_number',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $filterableFields = [
- 'case_number',
- 'case_title',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
+ protected $caseRepository;
 
- protected $searchableFields = [
- 'case_number',
- 'case_title',
- ];
+ const DEFAULT_PAGE_SIZE = 15;
 
- protected $dateFields = [
- 'initiated_at',
- 'completed_at',
- 'created_at',
- 'updated_at',
- ];
-
- const DEFAULT_SORT_DIRECTION = 'asc';
+ public function __construct(private Request $request, CaseApiRepository $caseRepository) {
+ $this->caseRepository = $caseRepository;
+ }
 
+ /* The comment block you provided is a PHPDoc block. It is used to document the purpose and usage of a method in PHP
+ code. In this specific block: */
  /**
  * Get a list of all started cases.
  *
@@ -77,128 +37,72 @@ class CaseController extends Controller
  *
  * @return array
  */
- public function getAllCases(GetAllCasesRequest $request): array
+ public function getAllCases(CaseListRequest $request): JSonResponse
  {
- $pageSize = $request->get('pageSize', 15);
-
- $query = CaseStarted::select($this->defaultFields);
-
- $this->filters($request, $query);
-
- $pagination = CaseResource::collection($query->paginate($pageSize));
-
- return [
- 'data' => $pagination->items(),
- 'meta' => [
- 'total' => $pagination->total(),
- 'perPage' => $pagination->perPage(),
- 'currentPage' => $pagination->currentPage(),
- 'lastPage' => $pagination->lastPage(),
- ],
- ];
+ $query = $this->caseRepository->getAllCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Apply filters to the query.
+ * Get a list of all started cases.
  *
  * @param Request $request
- * @param Builder $query
- *
- * @return void
- */
- private function filters(Request $request, Builder $query): void
- {
- if ($request->has('userId')) {
- $query->where('user_id', $request->get('userId'));
- }
-
- if ($request->has('status')) {
- $query->where('case_status', $request->get('status'));
- }
-
- $this->search($request, $query);
- $this->filterBy($request, $query);
- $this->sortBy($request, $query);
- }
-
- /**
- * Sort the query.
  *
- * @param Request $request: Query parameter format: sortBy=field:asc,field2:desc,...
- * @param Builder $query
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
  *
- * @return void
+ * @return array
  */
-private function sortBy(Request $request, Builder $query): void
+public function getInProgress(CaseListRequest $request): JSonResponse
  {
- $sort = explode(',', $request->get('sortBy'));
-
- foreach ($sort as $value) {
- if (!preg_match('/^[a-zA-Z_]+:(asc|desc)$/', $value)) {
- continue;
- }
-
- $sort = explode(':', $value);
- $field = $sort[0];
- $order = $sort[1] ?? self::DEFAULT_SORT_DIRECTION;
-
- if (in_array($field, $this->sortableFields)) {
- $query->orderBy($field, $order);
- }
- }
+ $query = $this->caseRepository->getInProgressCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Filter the query.
+ * Get a list of all started cases.
  *
- * @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
+ * @param Request $request
  *
- * @return void
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
+ *
+ * @return array
  */
-private function filterBy(Request $request, Builder $query): void
+public function getCompleted(CaseListRequest $request): JSonResponse
  {
- if ($request->has('filterBy')) {
- $filterByValue = $request->get('filterBy');
-
- foreach ($filterByValue as $key => $value) {
- if (!in_array($key, $this->filterableFields)) {
- continue;
- }
-
- if (in_array($key, $this->dateFields)) {
- $query->whereDate($key, $value);
- continue;
- }
-
- $query->where($key, $value);
- }
- }
+ $query = $this->caseRepository->getCompletedCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Search by case number or case title.
-
- * @param Request $request: Query parameter format: search=keyword
+ * Handle pagination and return JSON response.
+ *
  * @param Builder $query
  *
- * @return void
+ * @return JsonResponse
  */
- private function search(Request $request, Builder $query): void
+ private function paginateResponse(Builder $query): JsonResponse
  {
-if ($request->has('search')) {
- $search = $request->get('search');
+$pageSize = $this->request->get('pageSize', self::DEFAULT_PAGE_SIZE);
+$pagination = CaseResource::collection($query->paginate($pageSize));
 
- $query->where(function ($q) use ($search) {
- foreach ($this->searchableFields as $field) {
- if ($field === 'case_number') {
- $q->orWhere($field, $search);
- } else {
- $q->orWhereFullText($field, $search . '*', ['mode' => 'boolean']);
- }
- }
- });
- }
+ return response()->json([
+ 'data' => $pagination->items(),
+ 'meta' => [
+ 'total' => $pagination->total(),
+ 'perPage' => $pagination->perPage(),
+ 'currentPage' => $pagination->currentPage(),
+ 'lastPage' => $pagination->lastPage(),
+ ],
+ ]);
  }
 }

ProcessMaker/Http/Requests/GetAllCasesRequest.php → ProcessMaker/Http/Requests/CaseListRequest.php

@@ -5,7 +5,7 @@
 use Illuminate\Foundation\Http\FormRequest;
 use ProcessMaker\Rules\SortBy;
 
-class GetAllCasesRequest extends FormRequest
+class CaseListRequest extends FormRequest
 {
  /**
  * Determine if the user is authorized to make this request.

ProcessMaker/Models/CaseParticipated.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace ProcessMaker\Models;
+
+use Database\Factories\CaseParticipatedFactory;
+use Illuminate\Database\Eloquent\Casts\AsArrayObject;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use ProcessMaker\Models\ProcessMakerModel;
+
+class CaseParticipated extends ProcessMakerModel
+{
+ use HasFactory;
+
+ protected $table = 'cases_participated';
+
+ protected $fillable = [
+ 'user_id',
+ 'case_number',
+ 'case_title',
+ 'case_title_formatted',
+ 'case_status',
+ 'processes',
+ 'requests',
+ 'request_tokens',
+ 'tasks',
+ 'participants',
+ 'initiated_at',
+ 'completed_at',
+ 'keywords',
+ ];
+
+ protected $casts = [
+ 'processes' => AsArrayObject::class,
+ 'requests' => AsArrayObject::class,
+ 'request_tokens' => AsArrayObject::class,
+ 'tasks' => AsArrayObject::class,
+ 'participants' => AsArrayObject::class,
+ 'initiated_at' => 'datetime',
+ 'completed_at' => 'datetime',
+ ];
+
+ protected static function newFactory(): Factory
+ {
+ return CaseParticipatedFactory::new();
+ }
+
+ /**
+ * Get the user that owns the case.
+ */
+ public function user()
+ {
+ return $this->belongsTo(User::class);
+ }
+}

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/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);
+ }
+}

ProcessMaker/Http/Controllers/Api/V1_1/CaseController.php

@@ -3,65 +3,25 @@
 namespace ProcessMaker\Http\Controllers\Api\V1_1;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use ProcessMaker\Http\Controllers\Controller;
-use ProcessMaker\Http\Requests\GetAllCasesRequest;
+use ProcessMaker\Http\Requests\CaseListRequest;
 use ProcessMaker\Http\Resources\V1_1\CaseResource;
-use ProcessMaker\Models\CaseStarted;
+use ProcessMaker\Repositories\CaseApiRepository;
 
 class CaseController extends Controller
 {
- /**
- * Default fields used in the query select statement.
- */
- protected $defaultFields = [
- 'case_number',
- 'user_id',
- 'case_title',
- 'case_title_formatted',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $sortableFields = [
- 'case_number',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $filterableFields = [
- 'case_number',
- 'case_title',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
+ protected $caseRepository;
 
- protected $searchableFields = [
- 'case_number',
- 'case_title',
- ];
+ const DEFAULT_PAGE_SIZE = 15;
 
- protected $dateFields = [
- 'initiated_at',
- 'completed_at',
- 'created_at',
- 'updated_at',
- ];
-
- const DEFAULT_SORT_DIRECTION = 'asc';
+ public function __construct(private Request $request, CaseApiRepository $caseRepository) {
+ $this->caseRepository = $caseRepository;
+ }
 
+ /* The comment block you provided is a PHPDoc block. It is used to document the purpose and usage of a method in PHP
+ code. In this specific block: */
  /**
  * Get a list of all started cases.
  *
@@ -77,128 +37,72 @@ class CaseController extends Controller
  *
  * @return array
  */
- public function getAllCases(GetAllCasesRequest $request): array
+ public function getAllCases(CaseListRequest $request): JSonResponse
  {
- $pageSize = $request->get('pageSize', 15);
-
- $query = CaseStarted::select($this->defaultFields);
-
- $this->filters($request, $query);
-
- $pagination = CaseResource::collection($query->paginate($pageSize));
-
- return [
- 'data' => $pagination->items(),
- 'meta' => [
- 'total' => $pagination->total(),
- 'perPage' => $pagination->perPage(),
- 'currentPage' => $pagination->currentPage(),
- 'lastPage' => $pagination->lastPage(),
- ],
- ];
+ $query = $this->caseRepository->getAllCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Apply filters to the query.
+ * Get a list of all started cases.
  *
  * @param Request $request
- * @param Builder $query
- *
- * @return void
- */
- private function filters(Request $request, Builder $query): void
- {
- if ($request->has('userId')) {
- $query->where('user_id', $request->get('userId'));
- }
-
- if ($request->has('status')) {
- $query->where('case_status', $request->get('status'));
- }
-
- $this->search($request, $query);
- $this->filterBy($request, $query);
- $this->sortBy($request, $query);
- }
-
- /**
- * Sort the query.
  *
- * @param Request $request: Query parameter format: sortBy=field:asc,field2:desc,...
- * @param Builder $query
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
  *
- * @return void
+ * @return array
  */
-private function sortBy(Request $request, Builder $query): void
+public function getInProgress(CaseListRequest $request): JSonResponse
  {
- $sort = explode(',', $request->get('sortBy'));
-
- foreach ($sort as $value) {
- if (!preg_match('/^[a-zA-Z_]+:(asc|desc)$/', $value)) {
- continue;
- }
-
- $sort = explode(':', $value);
- $field = $sort[0];
- $order = $sort[1] ?? self::DEFAULT_SORT_DIRECTION;
-
- if (in_array($field, $this->sortableFields)) {
- $query->orderBy($field, $order);
- }
- }
+ $query = $this->caseRepository->getInProgressCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Filter the query.
+ * Get a list of all started cases.
  *
- * @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
+ * @param Request $request
  *
- * @return void
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
+ *
+ * @return array
  */
-private function filterBy(Request $request, Builder $query): void
+public function getCompleted(CaseListRequest $request): JSonResponse
  {
- if ($request->has('filterBy')) {
- $filterByValue = $request->get('filterBy');
-
- foreach ($filterByValue as $key => $value) {
- if (!in_array($key, $this->filterableFields)) {
- continue;
- }
-
- if (in_array($key, $this->dateFields)) {
- $query->whereDate($key, $value);
- continue;
- }
-
- $query->where($key, $value);
- }
- }
+ $query = $this->caseRepository->getCompletedCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Search by case number or case title.
-
- * @param Request $request: Query parameter format: search=keyword
+ * Handle pagination and return JSON response.
+ *
  * @param Builder $query
  *
- * @return void
+ * @return JsonResponse
  */
- private function search(Request $request, Builder $query): void
+ private function paginateResponse(Builder $query): JsonResponse
  {
-if ($request->has('search')) {
- $search = $request->get('search');
+$pageSize = $this->request->get('pageSize', self::DEFAULT_PAGE_SIZE);
+$pagination = CaseResource::collection($query->paginate($pageSize));
 
- $query->where(function ($q) use ($search) {
- foreach ($this->searchableFields as $field) {
- if ($field === 'case_number') {
- $q->orWhere($field, $search);
- } else {
- $q->orWhereFullText($field, $search . '*', ['mode' => 'boolean']);
- }
- }
- });
- }
+ return response()->json([
+ 'data' => $pagination->items(),
+ 'meta' => [
+ 'total' => $pagination->total(),
+ 'perPage' => $pagination->perPage(),
+ 'currentPage' => $pagination->currentPage(),
+ 'lastPage' => $pagination->lastPage(),
+ ],
+ ]);
  }
 }

ProcessMaker/Http/Requests/GetAllCasesRequest.php → ProcessMaker/Http/Requests/CaseListRequest.php

@@ -5,7 +5,7 @@
 use Illuminate\Foundation\Http\FormRequest;
 use ProcessMaker\Rules\SortBy;
 
-class GetAllCasesRequest extends FormRequest
+class CaseListRequest extends FormRequest
 {
  /**
  * Determine if the user is authorized to make this request.

ProcessMaker/Models/CaseParticipated.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace ProcessMaker\Models;
+
+use Database\Factories\CaseParticipatedFactory;
+use Illuminate\Database\Eloquent\Casts\AsArrayObject;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use ProcessMaker\Models\ProcessMakerModel;
+
+class CaseParticipated extends ProcessMakerModel
+{
+ use HasFactory;
+
+ protected $table = 'cases_participated';
+
+ protected $fillable = [
+ 'user_id',
+ 'case_number',
+ 'case_title',
+ 'case_title_formatted',
+ 'case_status',
+ 'processes',
+ 'requests',
+ 'request_tokens',
+ 'tasks',
+ 'participants',
+ 'initiated_at',
+ 'completed_at',
+ 'keywords',
+ ];
+
+ protected $casts = [
+ 'processes' => AsArrayObject::class,
+ 'requests' => AsArrayObject::class,
+ 'request_tokens' => AsArrayObject::class,
+ 'tasks' => AsArrayObject::class,
+ 'participants' => AsArrayObject::class,
+ 'initiated_at' => 'datetime',
+ 'completed_at' => 'datetime',
+ ];
+
+ protected static function newFactory(): Factory
+ {
+ return CaseParticipatedFactory::new();
+ }
+
+ /**
+ * Get the user that owns the case.
+ */
+ public function user()
+ {
+ return $this->belongsTo(User::class);
+ }
+}

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/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);
+ }
+}

ProcessMaker/Http/Controllers/Api/V1_1/CaseController.php

@@ -3,65 +3,25 @@
 namespace ProcessMaker\Http\Controllers\Api\V1_1;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use ProcessMaker\Http\Controllers\Controller;
-use ProcessMaker\Http\Requests\GetAllCasesRequest;
+use ProcessMaker\Http\Requests\CaseListRequest;
 use ProcessMaker\Http\Resources\V1_1\CaseResource;
-use ProcessMaker\Models\CaseStarted;
+use ProcessMaker\Repositories\CaseApiRepository;
 
 class CaseController extends Controller
 {
- /**
- * Default fields used in the query select statement.
- */
- protected $defaultFields = [
- 'case_number',
- 'user_id',
- 'case_title',
- 'case_title_formatted',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $sortableFields = [
- 'case_number',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $filterableFields = [
- 'case_number',
- 'case_title',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
+ protected $caseRepository;
 
- protected $searchableFields = [
- 'case_number',
- 'case_title',
- ];
+ const DEFAULT_PAGE_SIZE = 15;
 
- protected $dateFields = [
- 'initiated_at',
- 'completed_at',
- 'created_at',
- 'updated_at',
- ];
-
- const DEFAULT_SORT_DIRECTION = 'asc';
+ public function __construct(private Request $request, CaseApiRepository $caseRepository) {
+ $this->caseRepository = $caseRepository;
+ }
 
+ /* The comment block you provided is a PHPDoc block. It is used to document the purpose and usage of a method in PHP
+ code. In this specific block: */
  /**
  * Get a list of all started cases.
  *
@@ -77,128 +37,72 @@ class CaseController extends Controller
  *
  * @return array
  */
- public function getAllCases(GetAllCasesRequest $request): array
+ public function getAllCases(CaseListRequest $request): JSonResponse
  {
- $pageSize = $request->get('pageSize', 15);
-
- $query = CaseStarted::select($this->defaultFields);
-
- $this->filters($request, $query);
-
- $pagination = CaseResource::collection($query->paginate($pageSize));
-
- return [
- 'data' => $pagination->items(),
- 'meta' => [
- 'total' => $pagination->total(),
- 'perPage' => $pagination->perPage(),
- 'currentPage' => $pagination->currentPage(),
- 'lastPage' => $pagination->lastPage(),
- ],
- ];
+ $query = $this->caseRepository->getAllCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Apply filters to the query.
+ * Get a list of all started cases.
  *
  * @param Request $request
- * @param Builder $query
- *
- * @return void
- */
- private function filters(Request $request, Builder $query): void
- {
- if ($request->has('userId')) {
- $query->where('user_id', $request->get('userId'));
- }
-
- if ($request->has('status')) {
- $query->where('case_status', $request->get('status'));
- }
-
- $this->search($request, $query);
- $this->filterBy($request, $query);
- $this->sortBy($request, $query);
- }
-
- /**
- * Sort the query.
  *
- * @param Request $request: Query parameter format: sortBy=field:asc,field2:desc,...
- * @param Builder $query
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
  *
- * @return void
+ * @return array
  */
-private function sortBy(Request $request, Builder $query): void
+public function getInProgress(CaseListRequest $request): JSonResponse
  {
- $sort = explode(',', $request->get('sortBy'));
-
- foreach ($sort as $value) {
- if (!preg_match('/^[a-zA-Z_]+:(asc|desc)$/', $value)) {
- continue;
- }
-
- $sort = explode(':', $value);
- $field = $sort[0];
- $order = $sort[1] ?? self::DEFAULT_SORT_DIRECTION;
-
- if (in_array($field, $this->sortableFields)) {
- $query->orderBy($field, $order);
- }
- }
+ $query = $this->caseRepository->getInProgressCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Filter the query.
+ * Get a list of all started cases.
  *
- * @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
+ * @param Request $request
  *
- * @return void
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
+ *
+ * @return array
  */
-private function filterBy(Request $request, Builder $query): void
+public function getCompleted(CaseListRequest $request): JSonResponse
  {
- if ($request->has('filterBy')) {
- $filterByValue = $request->get('filterBy');
-
- foreach ($filterByValue as $key => $value) {
- if (!in_array($key, $this->filterableFields)) {
- continue;
- }
-
- if (in_array($key, $this->dateFields)) {
- $query->whereDate($key, $value);
- continue;
- }
-
- $query->where($key, $value);
- }
- }
+ $query = $this->caseRepository->getCompletedCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Search by case number or case title.
-
- * @param Request $request: Query parameter format: search=keyword
+ * Handle pagination and return JSON response.
+ *
  * @param Builder $query
  *
- * @return void
+ * @return JsonResponse
  */
- private function search(Request $request, Builder $query): void
+ private function paginateResponse(Builder $query): JsonResponse
  {
-if ($request->has('search')) {
- $search = $request->get('search');
+$pageSize = $this->request->get('pageSize', self::DEFAULT_PAGE_SIZE);
+$pagination = CaseResource::collection($query->paginate($pageSize));
 
- $query->where(function ($q) use ($search) {
- foreach ($this->searchableFields as $field) {
- if ($field === 'case_number') {
- $q->orWhere($field, $search);
- } else {
- $q->orWhereFullText($field, $search . '*', ['mode' => 'boolean']);
- }
- }
- });
- }
+ return response()->json([
+ 'data' => $pagination->items(),
+ 'meta' => [
+ 'total' => $pagination->total(),
+ 'perPage' => $pagination->perPage(),
+ 'currentPage' => $pagination->currentPage(),
+ 'lastPage' => $pagination->lastPage(),
+ ],
+ ]);
  }
 }

ProcessMaker/Http/Requests/GetAllCasesRequest.php → ProcessMaker/Http/Requests/CaseListRequest.php

@@ -5,7 +5,7 @@
 use Illuminate\Foundation\Http\FormRequest;
 use ProcessMaker\Rules\SortBy;
 
-class GetAllCasesRequest extends FormRequest
+class CaseListRequest extends FormRequest
 {
  /**
  * Determine if the user is authorized to make this request.

ProcessMaker/Models/CaseParticipated.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace ProcessMaker\Models;
+
+use Database\Factories\CaseParticipatedFactory;
+use Illuminate\Database\Eloquent\Casts\AsArrayObject;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use ProcessMaker\Models\ProcessMakerModel;
+
+class CaseParticipated extends ProcessMakerModel
+{
+ use HasFactory;
+
+ protected $table = 'cases_participated';
+
+ protected $fillable = [
+ 'user_id',
+ 'case_number',
+ 'case_title',
+ 'case_title_formatted',
+ 'case_status',
+ 'processes',
+ 'requests',
+ 'request_tokens',
+ 'tasks',
+ 'participants',
+ 'initiated_at',
+ 'completed_at',
+ 'keywords',
+ ];
+
+ protected $casts = [
+ 'processes' => AsArrayObject::class,
+ 'requests' => AsArrayObject::class,
+ 'request_tokens' => AsArrayObject::class,
+ 'tasks' => AsArrayObject::class,
+ 'participants' => AsArrayObject::class,
+ 'initiated_at' => 'datetime',
+ 'completed_at' => 'datetime',
+ ];
+
+ protected static function newFactory(): Factory
+ {
+ return CaseParticipatedFactory::new();
+ }
+
+ /**
+ * Get the user that owns the case.
+ */
+ public function user()
+ {
+ return $this->belongsTo(User::class);
+ }
+}

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/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);
+ }
+}

ProcessMaker/Http/Controllers/Api/V1_1/CaseController.php

@@ -3,65 +3,25 @@
 namespace ProcessMaker\Http\Controllers\Api\V1_1;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use ProcessMaker\Http\Controllers\Controller;
-use ProcessMaker\Http\Requests\GetAllCasesRequest;
+use ProcessMaker\Http\Requests\CaseListRequest;
 use ProcessMaker\Http\Resources\V1_1\CaseResource;
-use ProcessMaker\Models\CaseStarted;
+use ProcessMaker\Repositories\CaseApiRepository;
 
 class CaseController extends Controller
 {
- /**
- * Default fields used in the query select statement.
- */
- protected $defaultFields = [
- 'case_number',
- 'user_id',
- 'case_title',
- 'case_title_formatted',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $sortableFields = [
- 'case_number',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $filterableFields = [
- 'case_number',
- 'case_title',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
+ protected $caseRepository;
 
- protected $searchableFields = [
- 'case_number',
- 'case_title',
- ];
+ const DEFAULT_PAGE_SIZE = 15;
 
- protected $dateFields = [
- 'initiated_at',
- 'completed_at',
- 'created_at',
- 'updated_at',
- ];
-
- const DEFAULT_SORT_DIRECTION = 'asc';
+ public function __construct(private Request $request, CaseApiRepository $caseRepository) {
+ $this->caseRepository = $caseRepository;
+ }
 
+ /* The comment block you provided is a PHPDoc block. It is used to document the purpose and usage of a method in PHP
+ code. In this specific block: */
  /**
  * Get a list of all started cases.
  *
@@ -77,128 +37,72 @@ class CaseController extends Controller
  *
  * @return array
  */
- public function getAllCases(GetAllCasesRequest $request): array
+ public function getAllCases(CaseListRequest $request): JSonResponse
  {
- $pageSize = $request->get('pageSize', 15);
-
- $query = CaseStarted::select($this->defaultFields);
-
- $this->filters($request, $query);
-
- $pagination = CaseResource::collection($query->paginate($pageSize));
-
- return [
- 'data' => $pagination->items(),
- 'meta' => [
- 'total' => $pagination->total(),
- 'perPage' => $pagination->perPage(),
- 'currentPage' => $pagination->currentPage(),
- 'lastPage' => $pagination->lastPage(),
- ],
- ];
+ $query = $this->caseRepository->getAllCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Apply filters to the query.
+ * Get a list of all started cases.
  *
  * @param Request $request
- * @param Builder $query
- *
- * @return void
- */
- private function filters(Request $request, Builder $query): void
- {
- if ($request->has('userId')) {
- $query->where('user_id', $request->get('userId'));
- }
-
- if ($request->has('status')) {
- $query->where('case_status', $request->get('status'));
- }
-
- $this->search($request, $query);
- $this->filterBy($request, $query);
- $this->sortBy($request, $query);
- }
-
- /**
- * Sort the query.
  *
- * @param Request $request: Query parameter format: sortBy=field:asc,field2:desc,...
- * @param Builder $query
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
  *
- * @return void
+ * @return array
  */
-private function sortBy(Request $request, Builder $query): void
+public function getInProgress(CaseListRequest $request): JSonResponse
  {
- $sort = explode(',', $request->get('sortBy'));
-
- foreach ($sort as $value) {
- if (!preg_match('/^[a-zA-Z_]+:(asc|desc)$/', $value)) {
- continue;
- }
-
- $sort = explode(':', $value);
- $field = $sort[0];
- $order = $sort[1] ?? self::DEFAULT_SORT_DIRECTION;
-
- if (in_array($field, $this->sortableFields)) {
- $query->orderBy($field, $order);
- }
- }
+ $query = $this->caseRepository->getInProgressCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Filter the query.
+ * Get a list of all started cases.
  *
- * @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
+ * @param Request $request
  *
- * @return void
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
+ *
+ * @return array
  */
-private function filterBy(Request $request, Builder $query): void
+public function getCompleted(CaseListRequest $request): JSonResponse
  {
- if ($request->has('filterBy')) {
- $filterByValue = $request->get('filterBy');
-
- foreach ($filterByValue as $key => $value) {
- if (!in_array($key, $this->filterableFields)) {
- continue;
- }
-
- if (in_array($key, $this->dateFields)) {
- $query->whereDate($key, $value);
- continue;
- }
-
- $query->where($key, $value);
- }
- }
+ $query = $this->caseRepository->getCompletedCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Search by case number or case title.
-
- * @param Request $request: Query parameter format: search=keyword
+ * Handle pagination and return JSON response.
+ *
  * @param Builder $query
  *
- * @return void
+ * @return JsonResponse
  */
- private function search(Request $request, Builder $query): void
+ private function paginateResponse(Builder $query): JsonResponse
  {
-if ($request->has('search')) {
- $search = $request->get('search');
+$pageSize = $this->request->get('pageSize', self::DEFAULT_PAGE_SIZE);
+$pagination = CaseResource::collection($query->paginate($pageSize));
 
- $query->where(function ($q) use ($search) {
- foreach ($this->searchableFields as $field) {
- if ($field === 'case_number') {
- $q->orWhere($field, $search);
- } else {
- $q->orWhereFullText($field, $search . '*', ['mode' => 'boolean']);
- }
- }
- });
- }
+ return response()->json([
+ 'data' => $pagination->items(),
+ 'meta' => [
+ 'total' => $pagination->total(),
+ 'perPage' => $pagination->perPage(),
+ 'currentPage' => $pagination->currentPage(),
+ 'lastPage' => $pagination->lastPage(),
+ ],
+ ]);
  }
 }

ProcessMaker/Http/Requests/GetAllCasesRequest.php → ProcessMaker/Http/Requests/CaseListRequest.php

@@ -5,7 +5,7 @@
 use Illuminate\Foundation\Http\FormRequest;
 use ProcessMaker\Rules\SortBy;
 
-class GetAllCasesRequest extends FormRequest
+class CaseListRequest extends FormRequest
 {
  /**
  * Determine if the user is authorized to make this request.

ProcessMaker/Models/CaseParticipated.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace ProcessMaker\Models;
+
+use Database\Factories\CaseParticipatedFactory;
+use Illuminate\Database\Eloquent\Casts\AsArrayObject;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use ProcessMaker\Models\ProcessMakerModel;
+
+class CaseParticipated extends ProcessMakerModel
+{
+ use HasFactory;
+
+ protected $table = 'cases_participated';
+
+ protected $fillable = [
+ 'user_id',
+ 'case_number',
+ 'case_title',
+ 'case_title_formatted',
+ 'case_status',
+ 'processes',
+ 'requests',
+ 'request_tokens',
+ 'tasks',
+ 'participants',
+ 'initiated_at',
+ 'completed_at',
+ 'keywords',
+ ];
+
+ protected $casts = [
+ 'processes' => AsArrayObject::class,
+ 'requests' => AsArrayObject::class,
+ 'request_tokens' => AsArrayObject::class,
+ 'tasks' => AsArrayObject::class,
+ 'participants' => AsArrayObject::class,
+ 'initiated_at' => 'datetime',
+ 'completed_at' => 'datetime',
+ ];
+
+ protected static function newFactory(): Factory
+ {
+ return CaseParticipatedFactory::new();
+ }
+
+ /**
+ * Get the user that owns the case.
+ */
+ public function user()
+ {
+ return $this->belongsTo(User::class);
+ }
+}

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/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);
+ }
+}

ProcessMaker/Http/Controllers/Api/V1_1/CaseController.php

@@ -3,65 +3,25 @@
 namespace ProcessMaker\Http\Controllers\Api\V1_1;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use ProcessMaker\Http\Controllers\Controller;
-use ProcessMaker\Http\Requests\GetAllCasesRequest;
+use ProcessMaker\Http\Requests\CaseListRequest;
 use ProcessMaker\Http\Resources\V1_1\CaseResource;
-use ProcessMaker\Models\CaseStarted;
+use ProcessMaker\Repositories\CaseApiRepository;
 
 class CaseController extends Controller
 {
- /**
- * Default fields used in the query select statement.
- */
- protected $defaultFields = [
- 'case_number',
- 'user_id',
- 'case_title',
- 'case_title_formatted',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $sortableFields = [
- 'case_number',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $filterableFields = [
- 'case_number',
- 'case_title',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
+ protected $caseRepository;
 
- protected $searchableFields = [
- 'case_number',
- 'case_title',
- ];
+ const DEFAULT_PAGE_SIZE = 15;
 
- protected $dateFields = [
- 'initiated_at',
- 'completed_at',
- 'created_at',
- 'updated_at',
- ];
-
- const DEFAULT_SORT_DIRECTION = 'asc';
+ public function __construct(private Request $request, CaseApiRepository $caseRepository) {
+ $this->caseRepository = $caseRepository;
+ }
 
+ /* The comment block you provided is a PHPDoc block. It is used to document the purpose and usage of a method in PHP
+ code. In this specific block: */
  /**
  * Get a list of all started cases.
  *
@@ -77,128 +37,72 @@ class CaseController extends Controller
  *
  * @return array
  */
- public function getAllCases(GetAllCasesRequest $request): array
+ public function getAllCases(CaseListRequest $request): JSonResponse
  {
- $pageSize = $request->get('pageSize', 15);
-
- $query = CaseStarted::select($this->defaultFields);
-
- $this->filters($request, $query);
-
- $pagination = CaseResource::collection($query->paginate($pageSize));
-
- return [
- 'data' => $pagination->items(),
- 'meta' => [
- 'total' => $pagination->total(),
- 'perPage' => $pagination->perPage(),
- 'currentPage' => $pagination->currentPage(),
- 'lastPage' => $pagination->lastPage(),
- ],
- ];
+ $query = $this->caseRepository->getAllCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Apply filters to the query.
+ * Get a list of all started cases.
  *
  * @param Request $request
- * @param Builder $query
- *
- * @return void
- */
- private function filters(Request $request, Builder $query): void
- {
- if ($request->has('userId')) {
- $query->where('user_id', $request->get('userId'));
- }
-
- if ($request->has('status')) {
- $query->where('case_status', $request->get('status'));
- }
-
- $this->search($request, $query);
- $this->filterBy($request, $query);
- $this->sortBy($request, $query);
- }
-
- /**
- * Sort the query.
  *
- * @param Request $request: Query parameter format: sortBy=field:asc,field2:desc,...
- * @param Builder $query
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
  *
- * @return void
+ * @return array
  */
-private function sortBy(Request $request, Builder $query): void
+public function getInProgress(CaseListRequest $request): JSonResponse
  {
- $sort = explode(',', $request->get('sortBy'));
-
- foreach ($sort as $value) {
- if (!preg_match('/^[a-zA-Z_]+:(asc|desc)$/', $value)) {
- continue;
- }
-
- $sort = explode(':', $value);
- $field = $sort[0];
- $order = $sort[1] ?? self::DEFAULT_SORT_DIRECTION;
-
- if (in_array($field, $this->sortableFields)) {
- $query->orderBy($field, $order);
- }
- }
+ $query = $this->caseRepository->getInProgressCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Filter the query.
+ * Get a list of all started cases.
  *
- * @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
+ * @param Request $request
  *
- * @return void
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
+ *
+ * @return array
  */
-private function filterBy(Request $request, Builder $query): void
+public function getCompleted(CaseListRequest $request): JSonResponse
  {
- if ($request->has('filterBy')) {
- $filterByValue = $request->get('filterBy');
-
- foreach ($filterByValue as $key => $value) {
- if (!in_array($key, $this->filterableFields)) {
- continue;
- }
-
- if (in_array($key, $this->dateFields)) {
- $query->whereDate($key, $value);
- continue;
- }
-
- $query->where($key, $value);
- }
- }
+ $query = $this->caseRepository->getCompletedCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Search by case number or case title.
-
- * @param Request $request: Query parameter format: search=keyword
+ * Handle pagination and return JSON response.
+ *
  * @param Builder $query
  *
- * @return void
+ * @return JsonResponse
  */
- private function search(Request $request, Builder $query): void
+ private function paginateResponse(Builder $query): JsonResponse
  {
-if ($request->has('search')) {
- $search = $request->get('search');
+$pageSize = $this->request->get('pageSize', self::DEFAULT_PAGE_SIZE);
+$pagination = CaseResource::collection($query->paginate($pageSize));
 
- $query->where(function ($q) use ($search) {
- foreach ($this->searchableFields as $field) {
- if ($field === 'case_number') {
- $q->orWhere($field, $search);
- } else {
- $q->orWhereFullText($field, $search . '*', ['mode' => 'boolean']);
- }
- }
- });
- }
+ return response()->json([
+ 'data' => $pagination->items(),
+ 'meta' => [
+ 'total' => $pagination->total(),
+ 'perPage' => $pagination->perPage(),
+ 'currentPage' => $pagination->currentPage(),
+ 'lastPage' => $pagination->lastPage(),
+ ],
+ ]);
  }
 }

ProcessMaker/Http/Requests/GetAllCasesRequest.php → ProcessMaker/Http/Requests/CaseListRequest.php

@@ -5,7 +5,7 @@
 use Illuminate\Foundation\Http\FormRequest;
 use ProcessMaker\Rules\SortBy;
 
-class GetAllCasesRequest extends FormRequest
+class CaseListRequest extends FormRequest
 {
  /**
  * Determine if the user is authorized to make this request.

ProcessMaker/Models/CaseParticipated.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace ProcessMaker\Models;
+
+use Database\Factories\CaseParticipatedFactory;
+use Illuminate\Database\Eloquent\Casts\AsArrayObject;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use ProcessMaker\Models\ProcessMakerModel;
+
+class CaseParticipated extends ProcessMakerModel
+{
+ use HasFactory;
+
+ protected $table = 'cases_participated';
+
+ protected $fillable = [
+ 'user_id',
+ 'case_number',
+ 'case_title',
+ 'case_title_formatted',
+ 'case_status',
+ 'processes',
+ 'requests',
+ 'request_tokens',
+ 'tasks',
+ 'participants',
+ 'initiated_at',
+ 'completed_at',
+ 'keywords',
+ ];
+
+ protected $casts = [
+ 'processes' => AsArrayObject::class,
+ 'requests' => AsArrayObject::class,
+ 'request_tokens' => AsArrayObject::class,
+ 'tasks' => AsArrayObject::class,
+ 'participants' => AsArrayObject::class,
+ 'initiated_at' => 'datetime',
+ 'completed_at' => 'datetime',
+ ];
+
+ protected static function newFactory(): Factory
+ {
+ return CaseParticipatedFactory::new();
+ }
+
+ /**
+ * Get the user that owns the case.
+ */
+ public function user()
+ {
+ return $this->belongsTo(User::class);
+ }
+}

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/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);
+ }
+}

ProcessMaker/Http/Controllers/Api/V1_1/CaseController.php

@@ -3,65 +3,25 @@
 namespace ProcessMaker\Http\Controllers\Api\V1_1;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use ProcessMaker\Http\Controllers\Controller;
-use ProcessMaker\Http\Requests\GetAllCasesRequest;
+use ProcessMaker\Http\Requests\CaseListRequest;
 use ProcessMaker\Http\Resources\V1_1\CaseResource;
-use ProcessMaker\Models\CaseStarted;
+use ProcessMaker\Repositories\CaseApiRepository;
 
 class CaseController extends Controller
 {
- /**
- * Default fields used in the query select statement.
- */
- protected $defaultFields = [
- 'case_number',
- 'user_id',
- 'case_title',
- 'case_title_formatted',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $sortableFields = [
- 'case_number',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $filterableFields = [
- 'case_number',
- 'case_title',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
+ protected $caseRepository;
 
- protected $searchableFields = [
- 'case_number',
- 'case_title',
- ];
+ const DEFAULT_PAGE_SIZE = 15;
 
- protected $dateFields = [
- 'initiated_at',
- 'completed_at',
- 'created_at',
- 'updated_at',
- ];
-
- const DEFAULT_SORT_DIRECTION = 'asc';
+ public function __construct(private Request $request, CaseApiRepository $caseRepository) {
+ $this->caseRepository = $caseRepository;
+ }
 
+ /* The comment block you provided is a PHPDoc block. It is used to document the purpose and usage of a method in PHP
+ code. In this specific block: */
  /**
  * Get a list of all started cases.
  *
@@ -77,128 +37,72 @@ class CaseController extends Controller
  *
  * @return array
  */
- public function getAllCases(GetAllCasesRequest $request): array
+ public function getAllCases(CaseListRequest $request): JSonResponse
  {
- $pageSize = $request->get('pageSize', 15);
-
- $query = CaseStarted::select($this->defaultFields);
-
- $this->filters($request, $query);
-
- $pagination = CaseResource::collection($query->paginate($pageSize));
-
- return [
- 'data' => $pagination->items(),
- 'meta' => [
- 'total' => $pagination->total(),
- 'perPage' => $pagination->perPage(),
- 'currentPage' => $pagination->currentPage(),
- 'lastPage' => $pagination->lastPage(),
- ],
- ];
+ $query = $this->caseRepository->getAllCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Apply filters to the query.
+ * Get a list of all started cases.
  *
  * @param Request $request
- * @param Builder $query
- *
- * @return void
- */
- private function filters(Request $request, Builder $query): void
- {
- if ($request->has('userId')) {
- $query->where('user_id', $request->get('userId'));
- }
-
- if ($request->has('status')) {
- $query->where('case_status', $request->get('status'));
- }
-
- $this->search($request, $query);
- $this->filterBy($request, $query);
- $this->sortBy($request, $query);
- }
-
- /**
- * Sort the query.
  *
- * @param Request $request: Query parameter format: sortBy=field:asc,field2:desc,...
- * @param Builder $query
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
  *
- * @return void
+ * @return array
  */
-private function sortBy(Request $request, Builder $query): void
+public function getInProgress(CaseListRequest $request): JSonResponse
  {
- $sort = explode(',', $request->get('sortBy'));
-
- foreach ($sort as $value) {
- if (!preg_match('/^[a-zA-Z_]+:(asc|desc)$/', $value)) {
- continue;
- }
-
- $sort = explode(':', $value);
- $field = $sort[0];
- $order = $sort[1] ?? self::DEFAULT_SORT_DIRECTION;
-
- if (in_array($field, $this->sortableFields)) {
- $query->orderBy($field, $order);
- }
- }
+ $query = $this->caseRepository->getInProgressCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Filter the query.
+ * Get a list of all started cases.
  *
- * @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
+ * @param Request $request
  *
- * @return void
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
+ *
+ * @return array
  */
-private function filterBy(Request $request, Builder $query): void
+public function getCompleted(CaseListRequest $request): JSonResponse
  {
- if ($request->has('filterBy')) {
- $filterByValue = $request->get('filterBy');
-
- foreach ($filterByValue as $key => $value) {
- if (!in_array($key, $this->filterableFields)) {
- continue;
- }
-
- if (in_array($key, $this->dateFields)) {
- $query->whereDate($key, $value);
- continue;
- }
-
- $query->where($key, $value);
- }
- }
+ $query = $this->caseRepository->getCompletedCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Search by case number or case title.
-
- * @param Request $request: Query parameter format: search=keyword
+ * Handle pagination and return JSON response.
+ *
  * @param Builder $query
  *
- * @return void
+ * @return JsonResponse
  */
- private function search(Request $request, Builder $query): void
+ private function paginateResponse(Builder $query): JsonResponse
  {
-if ($request->has('search')) {
- $search = $request->get('search');
+$pageSize = $this->request->get('pageSize', self::DEFAULT_PAGE_SIZE);
+$pagination = CaseResource::collection($query->paginate($pageSize));
 
- $query->where(function ($q) use ($search) {
- foreach ($this->searchableFields as $field) {
- if ($field === 'case_number') {
- $q->orWhere($field, $search);
- } else {
- $q->orWhereFullText($field, $search . '*', ['mode' => 'boolean']);
- }
- }
- });
- }
+ return response()->json([
+ 'data' => $pagination->items(),
+ 'meta' => [
+ 'total' => $pagination->total(),
+ 'perPage' => $pagination->perPage(),
+ 'currentPage' => $pagination->currentPage(),
+ 'lastPage' => $pagination->lastPage(),
+ ],
+ ]);
  }
 }

ProcessMaker/Http/Requests/GetAllCasesRequest.php → ProcessMaker/Http/Requests/CaseListRequest.php

@@ -5,7 +5,7 @@
 use Illuminate\Foundation\Http\FormRequest;
 use ProcessMaker\Rules\SortBy;
 
-class GetAllCasesRequest extends FormRequest
+class CaseListRequest extends FormRequest
 {
  /**
  * Determine if the user is authorized to make this request.

ProcessMaker/Models/CaseParticipated.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace ProcessMaker\Models;
+
+use Database\Factories\CaseParticipatedFactory;
+use Illuminate\Database\Eloquent\Casts\AsArrayObject;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use ProcessMaker\Models\ProcessMakerModel;
+
+class CaseParticipated extends ProcessMakerModel
+{
+ use HasFactory;
+
+ protected $table = 'cases_participated';
+
+ protected $fillable = [
+ 'user_id',
+ 'case_number',
+ 'case_title',
+ 'case_title_formatted',
+ 'case_status',
+ 'processes',
+ 'requests',
+ 'request_tokens',
+ 'tasks',
+ 'participants',
+ 'initiated_at',
+ 'completed_at',
+ 'keywords',
+ ];
+
+ protected $casts = [
+ 'processes' => AsArrayObject::class,
+ 'requests' => AsArrayObject::class,
+ 'request_tokens' => AsArrayObject::class,
+ 'tasks' => AsArrayObject::class,
+ 'participants' => AsArrayObject::class,
+ 'initiated_at' => 'datetime',
+ 'completed_at' => 'datetime',
+ ];
+
+ protected static function newFactory(): Factory
+ {
+ return CaseParticipatedFactory::new();
+ }
+
+ /**
+ * Get the user that owns the case.
+ */
+ public function user()
+ {
+ return $this->belongsTo(User::class);
+ }
+}

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/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);
+ }
+}

ProcessMaker/Http/Controllers/Api/V1_1/CaseController.php

@@ -3,65 +3,25 @@
 namespace ProcessMaker\Http\Controllers\Api\V1_1;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use ProcessMaker\Http\Controllers\Controller;
-use ProcessMaker\Http\Requests\GetAllCasesRequest;
+use ProcessMaker\Http\Requests\CaseListRequest;
 use ProcessMaker\Http\Resources\V1_1\CaseResource;
-use ProcessMaker\Models\CaseStarted;
+use ProcessMaker\Repositories\CaseApiRepository;
 
 class CaseController extends Controller
 {
- /**
- * Default fields used in the query select statement.
- */
- protected $defaultFields = [
- 'case_number',
- 'user_id',
- 'case_title',
- 'case_title_formatted',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $sortableFields = [
- 'case_number',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $filterableFields = [
- 'case_number',
- 'case_title',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
+ protected $caseRepository;
 
- protected $searchableFields = [
- 'case_number',
- 'case_title',
- ];
+ const DEFAULT_PAGE_SIZE = 15;
 
- protected $dateFields = [
- 'initiated_at',
- 'completed_at',
- 'created_at',
- 'updated_at',
- ];
-
- const DEFAULT_SORT_DIRECTION = 'asc';
+ public function __construct(private Request $request, CaseApiRepository $caseRepository) {
+ $this->caseRepository = $caseRepository;
+ }
 
+ /* The comment block you provided is a PHPDoc block. It is used to document the purpose and usage of a method in PHP
+ code. In this specific block: */
  /**
  * Get a list of all started cases.
  *
@@ -77,128 +37,72 @@ class CaseController extends Controller
  *
  * @return array
  */
- public function getAllCases(GetAllCasesRequest $request): array
+ public function getAllCases(CaseListRequest $request): JSonResponse
  {
- $pageSize = $request->get('pageSize', 15);
-
- $query = CaseStarted::select($this->defaultFields);
-
- $this->filters($request, $query);
-
- $pagination = CaseResource::collection($query->paginate($pageSize));
-
- return [
- 'data' => $pagination->items(),
- 'meta' => [
- 'total' => $pagination->total(),
- 'perPage' => $pagination->perPage(),
- 'currentPage' => $pagination->currentPage(),
- 'lastPage' => $pagination->lastPage(),
- ],
- ];
+ $query = $this->caseRepository->getAllCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Apply filters to the query.
+ * Get a list of all started cases.
  *
  * @param Request $request
- * @param Builder $query
- *
- * @return void
- */
- private function filters(Request $request, Builder $query): void
- {
- if ($request->has('userId')) {
- $query->where('user_id', $request->get('userId'));
- }
-
- if ($request->has('status')) {
- $query->where('case_status', $request->get('status'));
- }
-
- $this->search($request, $query);
- $this->filterBy($request, $query);
- $this->sortBy($request, $query);
- }
-
- /**
- * Sort the query.
  *
- * @param Request $request: Query parameter format: sortBy=field:asc,field2:desc,...
- * @param Builder $query
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
  *
- * @return void
+ * @return array
  */
-private function sortBy(Request $request, Builder $query): void
+public function getInProgress(CaseListRequest $request): JSonResponse
  {
- $sort = explode(',', $request->get('sortBy'));
-
- foreach ($sort as $value) {
- if (!preg_match('/^[a-zA-Z_]+:(asc|desc)$/', $value)) {
- continue;
- }
-
- $sort = explode(':', $value);
- $field = $sort[0];
- $order = $sort[1] ?? self::DEFAULT_SORT_DIRECTION;
-
- if (in_array($field, $this->sortableFields)) {
- $query->orderBy($field, $order);
- }
- }
+ $query = $this->caseRepository->getInProgressCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Filter the query.
+ * Get a list of all started cases.
  *
- * @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
+ * @param Request $request
  *
- * @return void
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
+ *
+ * @return array
  */
-private function filterBy(Request $request, Builder $query): void
+public function getCompleted(CaseListRequest $request): JSonResponse
  {
- if ($request->has('filterBy')) {
- $filterByValue = $request->get('filterBy');
-
- foreach ($filterByValue as $key => $value) {
- if (!in_array($key, $this->filterableFields)) {
- continue;
- }
-
- if (in_array($key, $this->dateFields)) {
- $query->whereDate($key, $value);
- continue;
- }
-
- $query->where($key, $value);
- }
- }
+ $query = $this->caseRepository->getCompletedCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Search by case number or case title.
-
- * @param Request $request: Query parameter format: search=keyword
+ * Handle pagination and return JSON response.
+ *
  * @param Builder $query
  *
- * @return void
+ * @return JsonResponse
  */
- private function search(Request $request, Builder $query): void
+ private function paginateResponse(Builder $query): JsonResponse
  {
-if ($request->has('search')) {
- $search = $request->get('search');
+$pageSize = $this->request->get('pageSize', self::DEFAULT_PAGE_SIZE);
+$pagination = CaseResource::collection($query->paginate($pageSize));
 
- $query->where(function ($q) use ($search) {
- foreach ($this->searchableFields as $field) {
- if ($field === 'case_number') {
- $q->orWhere($field, $search);
- } else {
- $q->orWhereFullText($field, $search . '*', ['mode' => 'boolean']);
- }
- }
- });
- }
+ return response()->json([
+ 'data' => $pagination->items(),
+ 'meta' => [
+ 'total' => $pagination->total(),
+ 'perPage' => $pagination->perPage(),
+ 'currentPage' => $pagination->currentPage(),
+ 'lastPage' => $pagination->lastPage(),
+ ],
+ ]);
  }
 }

ProcessMaker/Http/Requests/GetAllCasesRequest.php → ProcessMaker/Http/Requests/CaseListRequest.php

@@ -5,7 +5,7 @@
 use Illuminate\Foundation\Http\FormRequest;
 use ProcessMaker\Rules\SortBy;
 
-class GetAllCasesRequest extends FormRequest
+class CaseListRequest extends FormRequest
 {
  /**
  * Determine if the user is authorized to make this request.

ProcessMaker/Models/CaseParticipated.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace ProcessMaker\Models;
+
+use Database\Factories\CaseParticipatedFactory;
+use Illuminate\Database\Eloquent\Casts\AsArrayObject;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use ProcessMaker\Models\ProcessMakerModel;
+
+class CaseParticipated extends ProcessMakerModel
+{
+ use HasFactory;
+
+ protected $table = 'cases_participated';
+
+ protected $fillable = [
+ 'user_id',
+ 'case_number',
+ 'case_title',
+ 'case_title_formatted',
+ 'case_status',
+ 'processes',
+ 'requests',
+ 'request_tokens',
+ 'tasks',
+ 'participants',
+ 'initiated_at',
+ 'completed_at',
+ 'keywords',
+ ];
+
+ protected $casts = [
+ 'processes' => AsArrayObject::class,
+ 'requests' => AsArrayObject::class,
+ 'request_tokens' => AsArrayObject::class,
+ 'tasks' => AsArrayObject::class,
+ 'participants' => AsArrayObject::class,
+ 'initiated_at' => 'datetime',
+ 'completed_at' => 'datetime',
+ ];
+
+ protected static function newFactory(): Factory
+ {
+ return CaseParticipatedFactory::new();
+ }
+
+ /**
+ * Get the user that owns the case.
+ */
+ public function user()
+ {
+ return $this->belongsTo(User::class);
+ }
+}

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/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);
+ }
+}

ProcessMaker/Http/Controllers/Api/V1_1/CaseController.php

@@ -3,65 +3,25 @@
 namespace ProcessMaker\Http\Controllers\Api\V1_1;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use ProcessMaker\Http\Controllers\Controller;
-use ProcessMaker\Http\Requests\GetAllCasesRequest;
+use ProcessMaker\Http\Requests\CaseListRequest;
 use ProcessMaker\Http\Resources\V1_1\CaseResource;
-use ProcessMaker\Models\CaseStarted;
+use ProcessMaker\Repositories\CaseApiRepository;
 
 class CaseController extends Controller
 {
- /**
- * Default fields used in the query select statement.
- */
- protected $defaultFields = [
- 'case_number',
- 'user_id',
- 'case_title',
- 'case_title_formatted',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $sortableFields = [
- 'case_number',
- 'initiated_at',
- 'completed_at',
- ];
-
- protected $filterableFields = [
- 'case_number',
- 'case_title',
- 'case_status',
- 'processes',
- 'requests',
- 'request_tokens',
- 'tasks',
- 'participants',
- 'initiated_at',
- 'completed_at',
- ];
+ protected $caseRepository;
 
- protected $searchableFields = [
- 'case_number',
- 'case_title',
- ];
+ const DEFAULT_PAGE_SIZE = 15;
 
- protected $dateFields = [
- 'initiated_at',
- 'completed_at',
- 'created_at',
- 'updated_at',
- ];
-
- const DEFAULT_SORT_DIRECTION = 'asc';
+ public function __construct(private Request $request, CaseApiRepository $caseRepository) {
+ $this->caseRepository = $caseRepository;
+ }
 
+ /* The comment block you provided is a PHPDoc block. It is used to document the purpose and usage of a method in PHP
+ code. In this specific block: */
  /**
  * Get a list of all started cases.
  *
@@ -77,128 +37,72 @@ class CaseController extends Controller
  *
  * @return array
  */
- public function getAllCases(GetAllCasesRequest $request): array
+ public function getAllCases(CaseListRequest $request): JSonResponse
  {
- $pageSize = $request->get('pageSize', 15);
-
- $query = CaseStarted::select($this->defaultFields);
-
- $this->filters($request, $query);
-
- $pagination = CaseResource::collection($query->paginate($pageSize));
-
- return [
- 'data' => $pagination->items(),
- 'meta' => [
- 'total' => $pagination->total(),
- 'perPage' => $pagination->perPage(),
- 'currentPage' => $pagination->currentPage(),
- 'lastPage' => $pagination->lastPage(),
- ],
- ];
+ $query = $this->caseRepository->getAllCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Apply filters to the query.
+ * Get a list of all started cases.
  *
  * @param Request $request
- * @param Builder $query
- *
- * @return void
- */
- private function filters(Request $request, Builder $query): void
- {
- if ($request->has('userId')) {
- $query->where('user_id', $request->get('userId'));
- }
-
- if ($request->has('status')) {
- $query->where('case_status', $request->get('status'));
- }
-
- $this->search($request, $query);
- $this->filterBy($request, $query);
- $this->sortBy($request, $query);
- }
-
- /**
- * Sort the query.
  *
- * @param Request $request: Query parameter format: sortBy=field:asc,field2:desc,...
- * @param Builder $query
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
  *
- * @return void
+ * @return array
  */
-private function sortBy(Request $request, Builder $query): void
+public function getInProgress(CaseListRequest $request): JSonResponse
  {
- $sort = explode(',', $request->get('sortBy'));
-
- foreach ($sort as $value) {
- if (!preg_match('/^[a-zA-Z_]+:(asc|desc)$/', $value)) {
- continue;
- }
-
- $sort = explode(':', $value);
- $field = $sort[0];
- $order = $sort[1] ?? self::DEFAULT_SORT_DIRECTION;
-
- if (in_array($field, $this->sortableFields)) {
- $query->orderBy($field, $order);
- }
- }
+ $query = $this->caseRepository->getInProgressCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Filter the query.
+ * Get a list of all started cases.
  *
- * @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
+ * @param Request $request
  *
- * @return void
+ * @queryParam userId int Filter by user ID.
+ * @queryParam sortBy string Sort by field:asc,field2:desc,...
+ * @queryParam filterBy array Filter by field=value&field2=value2&...
+ * @queryParam search string Search by case number or case title.
+ * @queryParam pageSize int Number of items per page.
+ * @queryParam page int Page number.
+ *
+ * @return array
  */
-private function filterBy(Request $request, Builder $query): void
+public function getCompleted(CaseListRequest $request): JSonResponse
  {
- if ($request->has('filterBy')) {
- $filterByValue = $request->get('filterBy');
-
- foreach ($filterByValue as $key => $value) {
- if (!in_array($key, $this->filterableFields)) {
- continue;
- }
-
- if (in_array($key, $this->dateFields)) {
- $query->whereDate($key, $value);
- continue;
- }
-
- $query->where($key, $value);
- }
- }
+ $query = $this->caseRepository->getCompletedCases($request);
+ return $this->paginateResponse($query);
  }
 
  /**
- * Search by case number or case title.
-
- * @param Request $request: Query parameter format: search=keyword
+ * Handle pagination and return JSON response.
+ *
  * @param Builder $query
  *
- * @return void
+ * @return JsonResponse
  */
- private function search(Request $request, Builder $query): void
+ private function paginateResponse(Builder $query): JsonResponse
  {
-if ($request->has('search')) {
- $search = $request->get('search');
+$pageSize = $this->request->get('pageSize', self::DEFAULT_PAGE_SIZE);
+$pagination = CaseResource::collection($query->paginate($pageSize));
 
- $query->where(function ($q) use ($search) {
- foreach ($this->searchableFields as $field) {
- if ($field === 'case_number') {
- $q->orWhere($field, $search);
- } else {
- $q->orWhereFullText($field, $search . '*', ['mode' => 'boolean']);
- }
- }
- });
- }
+ return response()->json([
+ 'data' => $pagination->items(),
+ 'meta' => [
+ 'total' => $pagination->total(),
+ 'perPage' => $pagination->perPage(),
+ 'currentPage' => $pagination->currentPage(),
+ 'lastPage' => $pagination->lastPage(),
+ ],
+ ]);
  }
 }

ProcessMaker/Http/Requests/GetAllCasesRequest.php → ProcessMaker/Http/Requests/CaseListRequest.php

@@ -5,7 +5,7 @@
 use Illuminate\Foundation\Http\FormRequest;
 use ProcessMaker\Rules\SortBy;
 
-class GetAllCasesRequest extends FormRequest
+class CaseListRequest extends FormRequest
 {
  /**
  * Determine if the user is authorized to make this request.

ProcessMaker/Models/CaseParticipated.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace ProcessMaker\Models;
+
+use Database\Factories\CaseParticipatedFactory;
+use Illuminate\Database\Eloquent\Casts\AsArrayObject;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use ProcessMaker\Models\ProcessMakerModel;
+
+class CaseParticipated extends ProcessMakerModel
+{
+ use HasFactory;
+
+ protected $table = 'cases_participated';
+
+ protected $fillable = [
+ 'user_id',
+ 'case_number',
+ 'case_title',
+ 'case_title_formatted',
+ 'case_status',
+ 'processes',
+ 'requests',
+ 'request_tokens',
+ 'tasks',
+ 'participants',
+ 'initiated_at',
+ 'completed_at',
+ 'keywords',
+ ];
+
+ protected $casts = [
+ 'processes' => AsArrayObject::class,
+ 'requests' => AsArrayObject::class,
+ 'request_tokens' => AsArrayObject::class,
+ 'tasks' => AsArrayObject::class,
+ 'participants' => AsArrayObject::class,
+ 'initiated_at' => 'datetime',
+ 'completed_at' => 'datetime',
+ ];
+
+ protected static function newFactory(): Factory
+ {
+ return CaseParticipatedFactory::new();
+ }
+
+ /**
+ * Get the user that owns the case.
+ */
+ public function user()
+ {
+ return $this->belongsTo(User::class);
+ }
+}