Add an interface for entity collections

Author: deviantintegral

src/Entity/Collection/EntityCollection.php

@@ -6,7 +6,7 @@
 use Symfony\Component\Serializer\Encoder\JsonDecode;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
 
-abstract class EntityCollection implements \Iterator, \Countable
+abstract class EntityCollection implements EntityCollectionInterface, \Countable
 {
     use CollectionRelLinkTrait;
 
@@ -72,7 +72,7 @@ public function key()
     /**
      * {@inheritdoc}
      */
-    public function valid()
+    public function valid(): bool
     {
         return isset($this->rawData->list[$this->iteratorPosition]);
     }

src/Entity/Collection/EntityCollectionInterface.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace Hussainweb\DrupalApi\Entity\Collection;
+
+/**
+ * Interface representing a collection of entities loaded from drupal.org.
+ */
+interface EntityCollectionInterface extends \Iterator
+{
+
+    /**
+     * @return bool|\GuzzleHttp\Psr7\Uri
+     */
+    public function getSelfLink();
+
+    /**
+     * @return bool|\GuzzleHttp\Psr7\Uri
+     */
+    public function getFirstLink();
+
+    /**
+     * @return bool|\GuzzleHttp\Psr7\Uri
+     */
+    public function getPreviousLink();
+
+    /**
+     * @return bool|\GuzzleHttp\Psr7\Uri
+     */
+    public function getNextLink();
+
+    /**
+     * @return bool|\GuzzleHttp\Psr7\Uri
+     */
+    public function getLastLink();
+
+    /**
+     * {@inheritdoc}
+     */
+    public function current();
+
+    /**
+     * {@inheritdoc}
+     */
+    public function next();
+
+    /**
+     * {@inheritdoc}
+     */
+    public function key();
+
+    /**
+     * {@inheritdoc}
+     */
+    public function valid(): bool;
+
+    /**
+     * {@inheritdoc}
+     *
+     * If a collection does not support rewinding, implement this method with an
+     * empty body.
+     */
+    public function rewind();
+}