Abstract Model

CHANGELOG.md

@@ -32,6 +32,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - [Refactor: Use Query-Parameters for Where-Clause](https://github.com/5pm-HDH/churchtools-api/pull/106)
 - [Fix Unit-Test for Person Update-Request](https://github.com/5pm-HDH/churchtools-api/pull/109)
 - [Fix Integration-Test: Cache Api-key](https://github.com/5pm-HDH/churchtools-api/pull/113)
+- [Abstract Model](https://github.com/5pm-HDH/churchtools-api/pull/118)
 
 ### Fixed
 

docs/out/Models.md

@@ -77,6 +77,27 @@ The attributes of a model can be used accessed with getters and setter.
 
 ```
 
+The model id can be retrieved with the `getId` getter. There is also a null-safe getter (`getIdOrFail`) and a integer casted getter (`getIdAsInteger`):
+
+```php
+        use CTApi\Models\Person;
+
+        // can be null:
+        var_dump( $this->person->getId());
+        // Output: "21"
+
+
+        // throws CTModelException if id is null:
+        var_dump( $this->person->getIdOrFail());
+        // Output: "21"
+
+
+        // return int or throws CTModelException:
+        var_dump( $this->person->getIdAsInteger());
+        // Output: 21
+
+
+```
 
 **`request`-method (one-to-one - singular)**
 

docs/out/Requests.md

@@ -135,24 +135,8 @@ $twoPersons = PersonRequest::where('ids', [219, 318])->get();
 
 ## Details
 
-* [AuthRequest](#authrequest)
-* [PersonRequest](#personrequest)
-* [EventRequest](#eventrequest)
-* [EventRequestAgenda](#eventrequestagenda)
-
-### AuthRequest
-
-* ✅ authWithEmailAndPassword
-* ❌ all; find / findOrFail; where; orderBy; limit
-
 ### PersonRequest
 
-* ✅ whoami
-* ✅ all
-* ✅ find / findOrFail
-* ✅ where
-* ✅ orderBy
-
 **Where filter criteria:**
 
 | Criteria | Value | Description |
@@ -166,41 +150,15 @@ $twoPersons = PersonRequest::where('ids', [219, 318])->get();
 
 ### EventRequest
 
-* ✅ all
-* ✅ find / findOrFail
-* ✅ where
-* ✅ orderBy
-
 **Where filter criteria:**
 
 | Criteria | Value | Description |
 | --- | --- | --- |
 | from | date-string (YYYY-MM-DD) | select events beginning with date |
 | to | date-string (YYYY-MM-DD) | select events ending with date |
 
-### EventRequestAgenda
-
-* ✅ get
-
-```php
-use \CTApi\Requests\EventAgendaRequest;
-use \CTApi\Models\Event;
-
-$eventId = 21;
-$event = Event::createModelFromData(['id' => $eventId]);
-
-$agenda = EventAgendaRequest::fromEvent($eventId)->get();
-$agenda = $event->requestAgenda();
-
-```
-
 ### SongRequest
 
-* ✅ all
-* ✅ find / findOrFail
-* ✅ where
-* ✅ orderBy
-
 **Where filter criteria:**
 
 | Criteria | Value | Description |

docs/src/ressources/Models.md

@@ -27,6 +27,9 @@ The attributes of a model can be used accessed with getters and setter.
 
 {{ \Tests\Unit\Docs\ModelTest.testGetterAndSetter }}
 
+The model id can be retrieved with the `getId` getter. There is also a null-safe getter (`getIdOrFail`) and a integer casted getter (`getIdAsInteger`):
+
+{{ \Tests\Unit\Docs\ModelTest.testGetId }}
 
 **`request`-method (one-to-one - singular)**
 

docs/src/ressources/Requests.md

@@ -93,24 +93,8 @@ $twoPersons = PersonRequest::where('ids', [219, 318])->get();
 
 ## Details
 
-* [AuthRequest](#authrequest)
-* [PersonRequest](#personrequest)
-* [EventRequest](#eventrequest)
-* [EventRequestAgenda](#eventrequestagenda)
-
-### AuthRequest
-
-* ✅ authWithEmailAndPassword
-* ❌ all; find / findOrFail; where; orderBy; limit
-
 ### PersonRequest
 
-* ✅ whoami
-* ✅ all
-* ✅ find / findOrFail
-* ✅ where
-* ✅ orderBy
-
 **Where filter criteria:**
 
 | Criteria | Value | Description |
@@ -124,40 +108,15 @@ $twoPersons = PersonRequest::where('ids', [219, 318])->get();
 
 ### EventRequest
 
-* ✅ all
-* ✅ find / findOrFail
-* ✅ where
-* ✅ orderBy
-
 **Where filter criteria:**
 
 | Criteria | Value | Description |
 | --- | --- | --- |
 | from | date-string (YYYY-MM-DD) | select events beginning with date |
 | to | date-string (YYYY-MM-DD) | select events ending with date |
 
-### EventRequestAgenda
-
-* ✅ get
-
-```php
-use \CTApi\Requests\EventAgendaRequest;
-use \CTApi\Models\Event;
-
-$eventId = 21;
-$event = Event::createModelFromData(['id' => $eventId]);
-
-$agenda = EventAgendaRequest::fromEvent($eventId)->get();
-$agenda = $event->requestAgenda();
-```
-
 ### SongRequest
 
-* ✅ all
-* ✅ find / findOrFail
-* ✅ where
-* ✅ orderBy
-
 **Where filter criteria:**
 
 | Criteria | Value | Description |

src/Models/Absence.php

@@ -8,11 +8,10 @@
 use CTApi\Models\Traits\ExtractData;
 use CTApi\Models\Traits\FillWithData;
 
-class Absence implements UpdatableModel
+class Absence extends AbstractModel implements UpdatableModel
 {
     use FillWithData, ExtractData;
 
-    protected ?string $id = null;
     protected ?string $comment = null;
     protected ?string $absenceReasonId = null;
     protected ?AbsenceReason $absenceReason = null;
@@ -48,14 +47,6 @@ static function getModifiableAttributes(): array
         ];
     }
 
-    /**
-     * @return string|null
-     */
-    public function getId(): ?string
-    {
-        return $this->id;
-    }
-
     /**
      * @param string|null $id
      * @return Absence

src/Models/AbsenceReason.php

@@ -6,23 +6,14 @@
 
 use CTApi\Models\Traits\FillWithData;
 
-class AbsenceReason
+class AbsenceReason extends AbstractModel
 {
     use FillWithData;
 
-    protected ?string $id = null;
     protected ?string $name = null;
     protected ?string $nameTranslated = null;
     protected ?string $sortKey = null;
 
-    /**
-     * @return string|null
-     */
-    public function getId(): ?string
-    {
-        return $this->id;
-    }
-
     /**
      * @param string|null $id
      * @return AbsenceReason

src/Models/AbstractModel.php

@@ -0,0 +1,60 @@
+<?php
+
+
+namespace CTApi\Models;
+
+
+use CTApi\Exceptions\CTModelException;
+
+/**
+ * Class AbstractModel
+ * @package CTApi\Models
+ */
+abstract class AbstractModel
+{
+    protected ?string $id = null;
+
+    /**
+     * @return string|null
+     */
+    public function getId(): ?string
+    {
+        return $this->id;
+    }
+
+    /**
+     * Fluent setter have to be implemented by child-class. Returns instance of model.
+     * @param string|null $id
+     * @return mixed
+     */
+    abstract public function setId(?string $id);
+
+    /**
+     * Throws exception if id is null.
+     * @return string
+     */
+    public function getIdOrFail(): string
+    {
+        if (is_null($this->id)) {
+            throw new CTModelException("Id of " . get_class($this) . " is null.");
+        }
+        return $this->id;
+    }
+
+    /**
+     * Throws exception if id cannot be casted to int.
+     * @return int
+     */
+    public function getIdAsInteger(): int
+    {
+        $id = $this->getIdOrFail();
+
+        $castedInteger = intval($id);
+        $backCastedInteger = strval($castedInteger);
+        if ($backCastedInteger == $id) {
+            return $castedInteger;
+        } else {
+            throw new CTModelException("Could not cast id (" . $id . ") to integer in " . get_class($this) . ".");
+        }
+    }
+}

src/Models/Appointment.php

@@ -6,11 +6,10 @@
 
 use CTApi\Models\Traits\FillWithData;
 
-class Appointment
+class Appointment extends AbstractModel
 {
     use FillWithData;
 
-    protected ?string $id = null;
     protected ?string $caption = null;
     protected ?string $note = null;
     protected ?string $version = null;
@@ -47,14 +46,6 @@ protected function fillArrayType(string $key, array $data): void
         }
     }
 
-    /**
-     * @return string|null
-     */
-    public function getId(): ?string
-    {
-        return $this->id;
-    }
-
     /**
      * @param string|null $id
      * @return Appointment

src/Models/Calendar.php

@@ -8,11 +8,10 @@
 use CTApi\Models\Traits\MetaAttribute;
 use CTApi\Requests\AppointmentRequestBuilder;
 
-class Calendar
+class Calendar extends AbstractModel
 {
     use FillWithData, MetaAttribute;
 
-    protected ?string $id = null;
     protected ?string $name = null;
     protected ?string $nameTranslated = null;
     protected ?string $sortKey = null;
@@ -43,14 +42,6 @@ public function requestAppointments(): ?AppointmentRequestBuilder
         }
     }
 
-    /**
-     * @return string|null
-     */
-    public function getId(): ?string
-    {
-        return $this->id;
-    }
-
     /**
      * @param string|null $id
      * @return Calendar

src/Models/Event.php

@@ -9,11 +9,10 @@
 use CTApi\Requests\FileRequest;
 use CTApi\Requests\FileRequestBuilder;
 
-class Event
+class Event extends AbstractModel
 {
     use FillWithData;
 
-    protected ?string $id = null;
     protected ?string $guid = null;
     protected ?string $name = null;
     protected ?string $description = null;
@@ -45,13 +44,13 @@ protected function fillArrayType(string $key, array $data): void
 
     public function requestAgenda(): EventAgenda
     {
-        return (new EventAgendaRequestBuilder((int)$this->getId()))->get();
+        return (new EventAgendaRequestBuilder($this->getIdAsInteger()))->get();
     }
 
     public function requestFiles(): ?FileRequestBuilder
     {
         if (!is_null($this->getId())) {
-            return FileRequest::forEvent((int)$this->getId());
+            return FileRequest::forEvent($this->getIdAsInteger());
         }
         return null;
     }
@@ -67,14 +66,6 @@ public function requestEventServiceWithServiceId(int $serviceId): ?EventService
         return null;
     }
 
-    /**
-     * @return string|null
-     */
-    public function getId(): ?string
-    {
-        return $this->id;
-    }
-
     /**
      * @param string|null $id
      * @return Event