Added ability to archive projects and clients, fixes ST-37

app/Http/Controllers/Api/V1/ClientController.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 namespace App\Http\Controllers\Api\V1;
 
 use App\Exceptions\Api\EntityStillInUseApiException;
+use App\Http\Requests\V1\Client\ClientIndexRequest;
 use App\Http\Requests\V1\Client\ClientStoreRequest;
 use App\Http\Requests\V1\Client\ClientUpdateRequest;
 use App\Http\Resources\V1\Client\ClientCollection;
@@ -13,6 +14,7 @@ use App\Models\Client;
 use App\Models\Organization;
 use Illuminate\Auth\Access\AuthorizationException;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Carbon;
 
 class ClientController extends Controller
 {
@@ -33,14 +35,22 @@ class ClientController extends Controller
      *
      * @operationId getClients
      */
-    public function index(Organization $organization): ClientCollection
+    public function index(Organization $organization, ClientIndexRequest $request): ClientCollection
     {
         $this->checkPermission($organization, 'clients:view');
 
-        $clients = Client::query()
+        $clientsQuery = Client::query()
             ->whereBelongsTo($organization, 'organization')
-            ->orderBy('created_at', 'desc')
-            ->paginate(config('app.pagination_per_page_default'));
+            ->orderBy('created_at', 'desc');
+
+        $filterArchived = $request->getFilterArchived();
+        if ($filterArchived === 'true') {
+            $clientsQuery->whereNotNull('archived_at');
+        } elseif ($filterArchived === 'false') {
+            $clientsQuery->whereNull('archived_at');
+        }
+
+        $clients = $clientsQuery->paginate(config('app.pagination_per_page_default'));
 
         return new ClientCollection($clients);
     }
@@ -76,6 +86,9 @@ class ClientController extends Controller
         $this->checkPermission($organization, 'clients:update', $client);
 
         $client->name = $request->input('name');
+        if ($request->has('is_archived')) {
+            $client->archived_at = $request->getIsArchived() ? Carbon::now() : null;
+        }
         $client->save();
 
         return new ClientResource($client);

app/Http/Controllers/Api/V1/ProjectController.php

@@ -13,11 +13,11 @@ use App\Http\Resources\V1\Project\ProjectResource;
 use App\Models\Organization;
 use App\Models\Project;
 use App\Models\ProjectMember;
-use App\Models\User;
 use App\Service\BillableRateService;
 use Illuminate\Auth\Access\AuthorizationException;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\DB;
 
 class ProjectController extends Controller
@@ -51,6 +51,12 @@ class ProjectController extends Controller
         if (! $canViewAllProjects) {
             $projectsQuery->visibleByEmployee($user);
         }
+        $filterArchived = $request->getFilterArchived();
+        if ($filterArchived === 'true') {
+            $projectsQuery->whereNotNull('archived_at');
+        } elseif ($filterArchived === 'false') {
+            $projectsQuery->whereNull('archived_at');
+        }
 
         $projects = $projectsQuery->paginate(config('app.pagination_per_page_default'));
 
@@ -108,6 +114,9 @@ class ProjectController extends Controller
         $project->name = $request->input('name');
         $project->color = $request->input('color');
         $project->is_billable = (bool) $request->input('is_billable');
+        if ($request->has('is_archived')) {
+            $project->archived_at = $request->getIsArchived() ? Carbon::now() : null;
+        }
         $project->billable_rate = $request->getBillableRate();
         $project->client_id = $request->input('client_id');
         $project->save();

app/Http/Requests/V1/Client/ClientIndexRequest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Requests\V1\Client;
+
+use Illuminate\Contracts\Validation\ValidationRule;
+use Illuminate\Foundation\Http\FormRequest;
+
+class ClientIndexRequest extends FormRequest
+{
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, array<string|ValidationRule>>
+     */
+    public function rules(): array
+    {
+        return [
+            'page' => [
+                'integer',
+                'min:1',
+            ],
+            'archived' => [
+                'string',
+                'in:true,false,all',
+            ],
+        ];
+    }
+
+    public function getFilterArchived(): string
+    {
+        return $this->input('archived', 'false');
+    }
+}

app/Http/Requests/V1/Client/ClientUpdateRequest.php

@@ -35,6 +35,16 @@ class ClientUpdateRequest extends FormRequest
                     return $builder->whereBelongsTo($this->organization, 'organization');
                 }))->ignore($this->client->getKey())->withCustomTranslation('validation.client_name_already_exists'),
             ],
+            'is_archived' => [
+                'boolean',
+            ],
         ];
     }
+
+    public function getIsArchived(): bool
+    {
+        assert($this->has('is_archived'));
+
+        return (bool) $this->input('is_archived');
+    }
 }

app/Http/Requests/V1/Project/ProjectIndexRequest.php

@@ -21,6 +21,15 @@ class ProjectIndexRequest extends FormRequest
                 'integer',
                 'min:1',
             ],
+            'archived' => [
+                'string',
+                'in:true,false,all',
+            ],
         ];
     }
+
+    public function getFilterArchived(): string
+    {
+        return $this->input('archived', 'false');
+    }
 }

app/Http/Requests/V1/Project/ProjectUpdateRequest.php

@@ -47,6 +47,9 @@ class ProjectUpdateRequest extends FormRequest
                 'required',
                 'boolean',
             ],
+            'is_archived' => [
+                'boolean',
+            ],
             'client_id' => [
                 'nullable',
                 new ExistsEloquent(Client::class, null, function (Builder $builder): Builder {
@@ -66,6 +69,13 @@ class ProjectUpdateRequest extends FormRequest
         ];
     }
 
+    public function getIsArchived(): bool
+    {
+        assert($this->has('is_archived'));
+
+        return (bool) $this->input('is_archived');
+    }
+
     public function getBillableRate(): ?int
     {
         $input = $this->input('billable_rate');

app/Http/Resources/V1/Client/ClientResource.php

@@ -25,6 +25,8 @@ class ClientResource extends BaseResource
             'id' => $this->resource->id,
             /** @var string $name Name */
             'name' => $this->resource->name,
+            /** @var bool $is_archived Whether the client is archived */
+            'is_archived' => $this->resource->is_archived,
             /** @var string $created_at When the tag was created */
             'created_at' => $this->formatDateTime($this->resource->created_at),
             /** @var string $updated_at When the tag was last updated */

app/Http/Resources/V1/Project/ProjectResource.php

@@ -29,6 +29,8 @@ class ProjectResource extends BaseResource
             'color' => $this->resource->color,
             /** @var string|null $client_id ID of client */
             'client_id' => $this->resource->client_id,
+            /** @var bool $is_archived Whether the client is archived */
+            'is_archived' => $this->resource->is_archived,
             /** @var int|null $billable_rate Billable rate in cents per hour */
             'billable_rate' => $this->resource->billable_rate,
             /** @var bool $is_billable Project time entries billable default */