feat/phpdoc-for-ecloud

src/Page.php

@@ -2,14 +2,18 @@
 
 namespace UKFast\SDK;
 
+use Closure;
 use GuzzleHttp\Psr7\Request;
 use UKFast\SDK\Client;
 use UKFast\SDK\Exception\InvalidJsonException;
 
+/**
+ * @template T of Entity
+ */
 class Page
 {
     /**
-     * @var array
+     * @var array<int, T>
      */
     protected $items;
 
@@ -24,7 +28,7 @@ class Page
     protected $request;
 
     /**
-     * @var \Closure|null
+     * @var Closure|null
      */
     protected $serializer;
 
@@ -41,7 +45,7 @@ public function __construct($items, $meta, $request)
     }
 
     /**
-     * @return array
+     * @return array<int, T>
      */
     public function getItems()
     {
@@ -51,8 +55,8 @@ public function getItems()
     /**
      * Setter for page items
      *
-     * @param array $items
-     * @return \UKFast\SDK\Page
+     * @param array<int, T> $items
+     * @return array<int, T>
      */
     public function setItems($items)
     {
@@ -64,8 +68,8 @@ public function setItems($items)
      * Sets a mapping function to serialize each
      * item in a new page with
      *
-     * @param \Closure $callback
-     * @return \UKFast\SDK\Page
+     * @param Closure $callback
+     * @return Page<T>
      */
     public function serializeWith($callback)
     {
@@ -78,7 +82,7 @@ public function serializeWith($callback)
      * Applies a callback to each item in the page
      * and returns the resulting array
      *
-     * @param \Closure $callback
+     * @param Closure $callback
      * @return array
      */
     public function map($callback)
@@ -95,8 +99,8 @@ public function map($callback)
      * Sets client to use when making requests
      * to other pages
      *
-     * @param \UKFast\SDK\Client $client
-     * @return \UKFast\SDK\Page
+     * @param Client $client
+     * @return Page<T>
      */
     public function setClient(Client $client)
     {
@@ -176,7 +180,7 @@ public function pageNumber()
      * Gets a page by number
      *
      * @param int $number
-     * @return \UKFast\SDK\Page
+     * @return Page<T>
      * @throws \GuzzleHttp\Exception\GuzzleException
      * @throws \UKFast\SDK\Exception\InvalidJsonException
      */
@@ -192,7 +196,7 @@ public function getPage($number)
     }
 
     /**
-     * @return \UKFast\SDK\Page|false
+     * @return Page<T>|false
      */
     public function getNextPage()
     {
@@ -205,7 +209,7 @@ public function getNextPage()
     }
 
     /**
-     * @return \UKFast\SDK\Page|false
+     * @return Page<T>|false
      */
     public function getPreviousPage()
     {
@@ -218,7 +222,7 @@ public function getPreviousPage()
     }
 
     /**
-     * @return \UKFast\SDK\Page
+     * @return Page<T>
      */
     public function getFirstPage()
     {
@@ -227,7 +231,7 @@ public function getFirstPage()
     }
 
     /**
-     * @return \UKFast\SDK\Page
+     * @return Page<T>
      */
     public function getLastPage()
     {
@@ -241,7 +245,7 @@ public function getLastPage()
      *
      * @param Response $response
      * @param string|\Psr\Http\Message\UriInterface $uri
-     * @return \UKFast\SDK\Page
+     * @return Page<T>
      * @throws \UKFast\SDK\Exception\InvalidJsonException
      */
     private function constructNewPage($response, $uri)

src/Traits/PageItems.php

@@ -2,9 +2,13 @@
 
 namespace UKFast\SDK\Traits;
 
+use UKFast\SDK\Entity;
 use UKFast\SDK\Page;
 use UKFast\SDK\SelfResponse;
 
+/**
+ * @template T of Entity
+ */
 trait PageItems
 {
     /**
@@ -19,6 +23,7 @@ public function getEntityMap()
     /**
      * Return an entity model
      * @param $data
+     * @return T
      */
     abstract public function loadEntity($data);
 
@@ -28,7 +33,7 @@ abstract public function loadEntity($data);
      * @param int $page
      * @param int $perPage
      * @param array $filters
-     * @return Page
+     * @return Page<T>
      */
     public function getPage($page = 1, $perPage = 15, $filters = [])
     {
@@ -49,7 +54,7 @@ public function getPage($page = 1, $perPage = 15, $filters = [])
      * Get an array of all items from all pages
      *
      * @param array $filters
-     * @return array
+     * @return array<int, T>
      */
     public function getAll($filters = [])
     {
@@ -79,7 +84,7 @@ public function getAll($filters = [])
     /**
      * Get a single item from the collection
      * @param $id
-     * @return mixed
+     * @return T
      */
     public function getById($id)
     {
@@ -101,7 +106,7 @@ public function deleteById($id)
 
     /**
      * Create a new item for the collection
-     * @param $entity
+     * @param T $entity
      * @return SelfResponse
      */
     public function createEntity($entity)
@@ -121,7 +126,7 @@ public function createEntity($entity)
 
     /**
      * Update an existing item in the collection
-     * @param $entity
+     * @param T $entity
      * @return SelfResponse
      */
     public function updateEntity($entity)

src/eCloud/AffinityRuleClient.php

@@ -9,6 +9,7 @@
 
 class AffinityRuleClient extends Client implements ClientEntityInterface
 {
+    /** @use PageItems<AffinityRule> */
     use PageItems;
 
     protected $collectionPath = 'v2/affinity-rules';

src/eCloud/AffinityRuleMemberClient.php

@@ -8,6 +8,7 @@
 
 class AffinityRuleMemberClient extends Client implements ClientEntityInterface
 {
+    /** @use PageItems<AffinityRuleMember> */
     use PageItems;
 
     protected $collectionPath = 'v2/affinity-rule-members';

src/eCloud/ApplianceClient.php

@@ -24,7 +24,7 @@ class ApplianceClient extends Client
      * @param int $page
      * @param int $perPage
      * @param array $filters
-     * @return Page
+     * @return Page<Appliance>
      * @throws \GuzzleHttp\Exception\GuzzleException
      */
     public function getPage($page = 1, $perPage = 15, $filters = [])

src/eCloud/AvailabilityZoneClient.php

@@ -12,6 +12,7 @@
 
 class AvailabilityZoneClient extends Client implements ClientEntityInterface
 {
+    /** @use PageItems<AvailabilityZone> */
     use PageItems;
 
     protected $collectionPath = 'v2/availability-zones';

src/eCloud/BillingHistoryClient.php

@@ -8,6 +8,7 @@
 
 class BillingHistoryClient extends Client implements ClientEntityInterface
 {
+    /** @use PageItems<BillingHistory> */
     use PageItems;
 
     protected $collectionPath = 'v2/billing-history';

src/eCloud/BillingMetricClient.php

@@ -8,6 +8,7 @@
 
 class BillingMetricClient extends Client implements ClientEntityInterface
 {
+    /** @use PageItems<BillingMetric> */
     use PageItems;
 
     protected $collectionPath = 'v2/billing-metrics';