feat: add list announcement controller logic,service,rule, resources.

app/Classes/Modules/Announcements/ControllersLogic/ListAnnouncementsLogic.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace App\Classes\Modules\Announcements\ControllersLogic;
+
+use App\Classes\General\Abstracts\AbstractControllerLogic;
+use App\Classes\Modules\Announcements\Services\ListsAnnouncements;
+use App\Classes\Modules\Announcements\Standards\Rules\CanListAnnouncements;
+use App\Http\Resources\AnnouncementResource;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+
+class ListAnnouncementsLogic extends AbstractControllerLogic
+{
+
+    /**
+     * @return array
+     */
+    protected function notification(): array
+    {
+        return [
+            'title' => 'Retrieve Announcements',
+            'message' => 'You have successfully retrieved a list of Announcements'
+        ];
+    }
+
+    /** @var CanListAnnouncements */
+    private $canListAnnouncements;
+
+    /** @var ListsAnnouncements */
+    private $listsAnnouncements;
+
+    /**
+     * ListAnnouncementsLogic constructor.
+     * @param CanListAnnouncements $canListAnnouncements
+     * @param ListsAnnouncements $listsAnnouncements
+     */
+    public function __construct(CanListAnnouncements $canListAnnouncements, ListsAnnouncements $listsAnnouncements)
+    {
+        $this->canListAnnouncements = $canListAnnouncements;
+        $this->listsAnnouncements = $listsAnnouncements;
+    }
+
+
+    /**
+     * @param Request $request
+     * @return JsonResponse
+     * @throws \App\Classes\Exceptions\AccessForbiddenException
+     * @throws \App\Classes\Exceptions\MalformedRequestException
+     * @throws \App\Classes\Exceptions\RequestValidationException
+     */
+    public function logic(Request $request): JsonResponse
+    {
+
+        $this->canListAnnouncements->passes();
+
+        $annoucements = $this->listsAnnouncements->execute($this->listsAnnouncements->deserializeFilters($request->input('filters')));
+
+        return $this->collectionResponse(AnnouncementResource::collection($annoucements));
+    }
+}

app/Classes/Modules/Announcements/Services/ListsAnnouncements.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Classes\Modules\Announcements\Services;
+
+use App\Classes\General\Eloquent\AbstractListRecord;
+use Illuminate\Database\Eloquent\Builder;
+use App\Models\Announcement;
+
+class ListsAnnouncements extends AbstractListRecord
+{
+
+    /** @var Announcement */
+    private $repository;
+
+    /**
+     * ListsAnnouncement constructor.
+     * @param Announcement $repository
+     */
+    public function __construct(Announcement $repository)
+    {
+        $this->repository = $repository;
+    }
+
+
+    /**
+     * @return Builder
+     */
+    function getRepository(): Builder
+    {
+        return $this->repository->newQuery();
+    }
+}

app/Classes/Modules/Announcements/Standards/Rules/CanListAnnouncements.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Classes\Modules\Announcements\Standards\Rules;
+
+use App\Classes\General\Abstracts\AbstractRule;
+use App\Classes\Modules\Announcements\DataTransferObjects\AnnouncementObject;
+
+class CanListAnnouncements extends AbstractRule
+{
+
+    /**
+     * @return bool
+     */
+    protected function authorized(): bool
+    {
+        return true;
+    }
+
+    /**
+     * @param AnnouncementObject $object
+     * @return bool
+     */
+    protected function validators($object): bool
+    {
+        return true;
+    }
+
+    /**
+     * @param AnnouncementObject $object
+     * @return bool
+     */
+    protected function criteria($object): bool
+    {
+        return true;
+    }
+}

app/Http/Resources/AnnouncementResource.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace App\Http\Resources;
+
+use Illuminate\Http\Resources\Json\JsonResource;
+use Carbon\Carbon;
+
+class AnnouncementResource extends JsonResource
+{
+    /**
+     * Transform the resource into an array.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array
+     */
+    public function toArray($request)
+    {
+        return [
+            'id' => $this->id,
+            'title' => $this->title,
+            'description' => $this->description,
+            'segment' => $this->segments,
+            'ending_on' => $this->ending_on,
+            'starting_on' => $this->starting_on,
+            'starting_on_date' => Carbon::parse($this->starting_on)->format('Y-m-d'),
+            'ending_on_date' => Carbon::parse($this->ending_on)->format('Y-m-d'),
+        ];
+    }
+}