Merge pull request #52 from Arkemlar/master

Add generics annotations for better IDE support

Author: stevebauman

src/Collections/FolderCollection.php

@@ -2,6 +2,10 @@
 
 namespace DirectoryTree\ImapEngine\Collections;
 
+use DirectoryTree\ImapEngine\FolderInterface;
 use Illuminate\Support\Collection;
 
+/**
+ * @template-extends Collection<array-key, FolderInterface>
+ */
 class FolderCollection extends Collection {}

src/Collections/MessageCollection.php

@@ -5,6 +5,9 @@
 use DirectoryTree\ImapEngine\Message;
 use DirectoryTree\ImapEngine\MessageInterface;
 
+/**
+ * @template-extends PaginatedCollection<array-key, MessageInterface>
+ */
 class MessageCollection extends PaginatedCollection
 {
     /**

src/Collections/PaginatedCollection.php

@@ -5,6 +5,12 @@
 use DirectoryTree\ImapEngine\Pagination\LengthAwarePaginator;
 use Illuminate\Support\Collection;
 
+/**
+ * @template TKey of array-key
+ * @template-covariant TValue
+ *
+ * @template-extends Collection<TKey, TValue>
+ */
 class PaginatedCollection extends Collection
 {
     /**
@@ -14,6 +20,8 @@ class PaginatedCollection extends Collection
 
     /**
      * Paginate the current collection.
+     * 
+     * @return LengthAwarePaginator<TKey, TValue>
      */
     public function paginate(int $perPage = 15, ?int $page = null, string $pageName = 'page', bool $prepaginated = false): LengthAwarePaginator
     {
@@ -26,6 +34,8 @@ public function paginate(int $perPage = 15, ?int $page = null, string $pageName
 
     /**
      * Create a new length-aware paginator instance.
+     * 
+     *  @return LengthAwarePaginator<TKey, TValue>
      */
     protected function paginator(Collection $items, int $total, int $perPage, ?int $currentPage, string $pageName): LengthAwarePaginator
     {

src/Collections/ResponseCollection.php

@@ -3,14 +3,20 @@
 namespace DirectoryTree\ImapEngine\Collections;
 
 use DirectoryTree\ImapEngine\Connection\Responses\ContinuationResponse;
+use DirectoryTree\ImapEngine\Connection\Responses\Response;
 use DirectoryTree\ImapEngine\Connection\Responses\TaggedResponse;
 use DirectoryTree\ImapEngine\Connection\Responses\UntaggedResponse;
 use Illuminate\Support\Collection;
 
+/**
+ * @template-extends Collection<array-key, Response>
+ */
 class ResponseCollection extends Collection
 {
     /**
      * Filter the collection to only tagged responses.
+     * 
+     * @return self<array-key, TaggedResponse>
      */
     public function tagged(): self
     {
@@ -19,6 +25,8 @@ public function tagged(): self
 
     /**
      * Filter the collection to only untagged responses.
+     *
+     * @return self<array-key, UntaggedResponse>
      */
     public function untagged(): self
     {
@@ -27,6 +35,8 @@ public function untagged(): self
 
     /**
      * Filter the collection to only continuation responses.
+     * 
+     *  @return self<array-key, ContinuationResponse>
      */
     public function continuation(): self
     {

src/Pagination/LengthAwarePaginator.php

@@ -7,6 +7,12 @@
 use Illuminate\Support\Collection;
 use JsonSerializable;
 
+/**
+ * @template TKey of array-key
+ * @template-covariant TValue
+ *
+ * @template-implements Arrayable<TKey, TValue>
+ */
 class LengthAwarePaginator implements Arrayable, JsonSerializable
 {
     use ForwardsCalls;
@@ -38,6 +44,8 @@ public function __call(string $method, array $parameters): mixed
 
     /**
      * Get the items being paginated.
+     * 
+     * @return Collection<TKey, TValue>
      */
     public function items(): Collection
     {