refactor(array-annotation): add annotation for array return type

docs/out/GroupAPI.md

@@ -349,13 +349,13 @@
         // Output: "Hello World"
 
 
-        var_dump( $meeting?->getStatistics()->getPresent());
+        var_dump( $meeting->getStatistics()->getPresent());
         // Output: 2
 
-        var_dump( $meeting?->getStatistics()->getAbsent());
+        var_dump( $meeting->getStatistics()->getAbsent());
         // Output: 1
 
-        var_dump( $meeting?->getStatistics()->getUnsure());
+        var_dump( $meeting->getStatistics()->getUnsure());
         // Output: 0
 
 

src/Models/AbstractRequestBuilder.php

@@ -6,6 +6,7 @@
 use CTApi\Exceptions\CTModelException;
 use CTApi\Exceptions\CTRequestException;
 use CTApi\Interfaces\UpdatableModel;
+use CTApi\Models\Events\Event\Event;
 use CTApi\Traits\Request\OrderByCondition;
 use CTApi\Traits\Request\Pagination;
 use CTApi\Traits\Request\WhereCondition;

src/Models/Calendars/Appointment/AppointmentRequestBuilder.php

@@ -17,6 +17,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @return Appointment[]
+     */
     public function get(): array
     {
         $options = [

src/Models/Calendars/Calendar/CalendarRequest.php

@@ -4,6 +4,9 @@
 
 class CalendarRequest
 {
+    /**
+     * @return Calendar[]
+     */
     public static function all(): array
     {
         return (new CalendarRequestBuilder())->all();

src/Models/Calendars/Resource/ResourceBookingsRequestBuilder.php

@@ -17,6 +17,9 @@ public function __construct(array $resourceIds)
         $this->resourceIds = $resourceIds;
     }
 
+    /**
+     * @return ResourceBooking[]
+     */
     public function get(): array
     {
         $options = [];

src/Models/Calendars/Resource/ResourceRequest.php

@@ -4,6 +4,9 @@
 
 class ResourceRequest
 {
+    /**
+     * @return Resource[]
+     */
     public static function all(): array
     {
         return (new ResourceRequestBuilder())->all();

src/Models/Calendars/Resource/ResourceRequestBuilder.php

@@ -7,6 +7,9 @@
 
 class ResourceRequestBuilder
 {
+    /**
+     * @return Resource[]
+     */
     public function all(): array
     {
         $client = CTClient::getClient();

src/Models/Common/DBField/DBFieldForKeysRequestBuilder.php

@@ -15,6 +15,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @return DBFieldValueContainer[]
+     */
     public function get(): array
     {
         $this->allDBFields = DBFieldRequest::all();

src/Models/Common/DBField/DBFieldRequest.php

@@ -8,6 +8,9 @@
 
 class DBFieldRequest
 {
+    /**
+     * @return DBField[]
+     */
     public static function all(): array
     {
         $client = CTClient::getClient();

src/Models/Common/File/FileRequestBuilder.php

@@ -27,6 +27,9 @@ protected function getApiEndpoint(): string
         return "/api/files/" . $this->domainType . "/" . $this->domainIdentifier;
     }
 
+    /**
+     * @return File[]
+     */
     public function get(): array
     {
         $ctClient = CTClient::getClient();

src/Models/Common/Search/SearchRequestBuilder.php

@@ -23,6 +23,9 @@ public function whereDomainType(string $domainType)
         return $this;
     }
 
+    /**
+     * @return SearchResult[]
+     */
     public function get(): array
     {
         $options = [

src/Models/Common/Tag/TagRequest.php

@@ -4,11 +4,17 @@
 
 class TagRequest
 {
+    /**
+     * @return Tag[]
+     */
     public static function allPersonTags(): array
     {
         return (new TagRequestBuilder("persons"))->all();
     }
 
+    /**
+     * @return Tag[]
+     */
     public static function allSongTags(): array
     {
         return (new TagRequestBuilder("songs"))->all();

src/Models/Common/Tag/TagRequestBuilder.php

@@ -8,14 +8,20 @@
 
 class TagRequestBuilder
 {
-    private $tags = [];
+    /**
+     * @var Tag[]
+     */
+    private array $tags = [];
 
     public function __construct(
         private string $type
     ) {
         $this->tags = $this->retrieveData();
     }
 
+    /**
+     * @return Tag[]
+     */
     private function retrieveData(): array
     {
         $client = CTClient::getClient();
@@ -50,6 +56,9 @@ public function findOrFail(int $id): Tag
         return $tag;
     }
 
+    /**
+     * @return Tag[]
+     */
     public function all(): array
     {
         return $this->tags;

src/Models/Events/Absence/AbsencePersonRequestBuilder.php

@@ -23,6 +23,9 @@ protected function getModelClass(): string
         return Absence::class;
     }
 
+    /**
+     * @return Absence[]
+     */
     public function get(): array
     {
         $options = [];

src/Models/Events/Event/EventAgenda.php

@@ -23,6 +23,9 @@ class EventAgenda extends AbstractModel
     protected ?string $eventStartPosition = null;
     protected ?string $calendarId = null;
     protected ?string $total = null;
+    /**
+     * @var EventAgendaItem[]
+     */
     protected array $items = [];
 
 
@@ -40,6 +43,9 @@ protected function fillArrayType(string $key, array $data): void
         }
     }
 
+    /**
+     * @return Song[]
+     */
     public function getSongs(): array
     {
         CTLog::getLog()->info('EventAgenda: Collect all songs from agenda.');
@@ -200,7 +206,7 @@ public function setTotal(?string $total): EventAgenda
     }
 
     /**
-     * @return array
+     * @return EventAgendaItem[]
      */
     public function getItems(): array
     {

src/Models/Events/Event/EventRequest.php

@@ -4,6 +4,9 @@
 
 class EventRequest
 {
+    /**
+     * @return Event[]
+     */
     public static function all(): array
     {
         return (new EventRequestBuilder())->all();

src/Models/Events/Service/ServiceFromServiceGroupBuilder.php

@@ -11,6 +11,9 @@ public function __construct(int $serviceGroupId)
         $this->serviceGroupId = $serviceGroupId;
     }
 
+    /**
+     * @return Service[]
+     */
     public function get(): array
     {
         $allServices = ServiceRequest::all();

src/Models/Events/Service/ServiceGroupRequest.php

@@ -4,6 +4,9 @@
 
 class ServiceGroupRequest
 {
+    /**
+     * @return ServiceGroup[]
+     */
     public static function all(): array
     {
         return (new ServiceGroupRequestBuilder())->all();

src/Models/Events/Service/ServiceRequest.php

@@ -4,6 +4,9 @@
 
 class ServiceRequest
 {
+    /**
+     * @return Service[]
+     */
     public static function all(): array
     {
         return (new ServiceRequestBuilder())->all();

src/Models/Events/Song/Song.php

@@ -18,6 +18,9 @@ class Song extends AbstractModel implements UpdatableModel
     protected ?string $arrangementId = null;
     protected ?string $name = null;
     protected ?string $arrangement = null;
+    /**
+     * @var SongArrangement[]
+     */
     protected array $arrangements = [];
     protected ?SongCategory $category = null;
     protected ?string $category_id = null;
@@ -175,7 +178,7 @@ public function setArrangement(?string $arrangement): Song
     }
 
     /**
-     * @return array
+     * @return SongArrangement[]
      */
     public function getArrangements(): array
     {

src/Models/Events/Song/SongArrangement.php

@@ -25,7 +25,13 @@ class SongArrangement extends AbstractModel implements UpdatableModel
     protected ?string $beat = null;
     protected ?string $duration = null;
     protected ?string $note = null;
+    /**
+     * @var File[]
+     */
     protected array $links = [];
+    /**
+     * @var File[]
+     */
     protected array $files = [];
 
     public static function getModifiableAttributes(): array
@@ -243,7 +249,7 @@ public function setNote(?string $note): SongArrangement
     }
 
     /**
-     * @return array
+     * @return File[]
      */
     public function getLinks(): array
     {
@@ -261,7 +267,7 @@ public function setLinks(array $links): SongArrangement
     }
 
     /**
-     * @return array
+     * @return File[]
      */
     public function getFiles(): array
     {

src/Models/Events/Song/SongArrangementRequestBuilder.php

@@ -4,13 +4,22 @@
 
 class SongArrangementRequestBuilder
 {
+    /**
+     * @var SongArrangement[]
+     */
     private array $songArrangements = [];
 
+    /**
+     * @param SongArrangement[] $songArrangements
+     */
     public function __construct(array $songArrangements)
     {
         $this->songArrangements = $songArrangements;
     }
 
+    /**
+     * @return SongArrangement[]
+     */
     public function get(): array
     {
         return $this->songArrangements;

src/Models/Events/Song/SongCommentRequest.php

@@ -7,6 +7,10 @@
  */
 class SongCommentRequest
 {
+    /**
+     * @param int $arrangementId
+     * @return SongComment[]
+     */
     public static function getForSongArrangement(int $arrangementId): array
     {
         $builder = new SongCommentRequestBuilder($arrangementId);

src/Models/Events/Song/SongRequest.php

@@ -4,6 +4,9 @@
 
 class SongRequest
 {
+    /**
+     * @return Song[]
+     */
     public static function all(): array
     {
         return (new SongRequestBuilder())->all();

src/Models/Events/Song/SongTagRequestBuilder.php

@@ -2,6 +2,7 @@
 
 namespace CTApi\Models\Events\Song;
 
+use CTApi\Models\Common\Tag\Tag;
 use CTApi\Models\Common\Tag\TagRequestBuilder;
 use CTApi\Traits\Request\AjaxApi;
 use CTApi\Utils\CTResponseUtil;
@@ -15,6 +16,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @return Tag[]
+     */
     public function get(): array
     {
         $songData = $this->getTagData();

src/Models/Events/SongStatistic/SongStatisticRequest.php

@@ -4,6 +4,9 @@
 
 class SongStatisticRequest
 {
+    /**
+     * @return SongStatistic[]
+     */
     public static function all(): array
     {
         return (new SongStatisticRequestBuilder())->all();

src/Models/Events/SongStatistic/SongStatisticRequestBuilder.php

@@ -51,6 +51,9 @@ public function find(string $arrangementId): ?SongStatistic
         return null;
     }
 
+    /**
+     * @return SongStatistic[]
+     */
     public function all(): array
     {
         $data = $this->getStatisticData();

src/Models/Groups/Group/Group.php

@@ -24,6 +24,9 @@ class Group extends AbstractModel
     protected ?GroupInformation $information = null;
     protected ?GroupSettings $settings = null;
     protected array $followUp = [];
+    /**
+     * @var GroupRole[]
+     */
     protected array $roles = [];
 
 
@@ -259,7 +262,7 @@ public function setFollowUp(array $followUp): Group
     }
 
     /**
-     * @return array
+     * @return GroupRole[]
      */
     public function getRoles(): array
     {