Rename cursor to endCursor

pgrimaud · Apr 9, 2018 · 6e47c1e · 6e47c1e
1 parent 3412aab
commit 6e47c1e
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -277,7 +277,7 @@ $endCursor = $feed->getEndCursor();
 $api = new Api();
 $api->setUserId(184263228);
 $api->retrieveMediaData(true);
-$api->setCursor($endCursor);
+$api->setEndCursor($endCursor);
 
 $feed = $api->getFeed();
 

diff --git a/src/Instagram/Api.php b/src/Instagram/Api.php
@@ -28,9 +28,9 @@ class Api
     private $userId = null;
 
     /**
-     * @var integer
+     * @var string
      */
-    private $cursor = false;
+    private $endCursor = false;
 
     /**
      * @var bool
@@ -69,11 +69,11 @@ public function setUserName($userName)
     }
 
     /**
-     * @param string $cursor
+     * @param string $endCursor
      */
-    public function setCursor($cursor)
+    public function setEndCursor($endCursor)
     {
-        $this->cursor = $cursor;
+        $this->endCursor = $endCursor;
     }
 
     /**
@@ -99,7 +99,7 @@ public function getFeed()
             throw new InstagramException('You must specify a userName to retrieve userData');
         }
 
-        if (($this->retrieveMediaData || $this->cursor) && !$this->userId) {
+        if (($this->retrieveMediaData || $this->endCursor) && !$this->userId) {
             throw new InstagramException('You must specify a userId to retrieve mediaData');
         }
 
@@ -112,7 +112,7 @@ public function getFeed()
         }
 
         if ($this->retrieveMediaData) {
-            $mediaDataFetched = $feed->fetchMediaData($this->userId, $this->cursor);
+            $mediaDataFetched = $feed->fetchMediaData($this->userId, $this->endCursor);
             $hydrator->setMediaData($mediaDataFetched);
         }
 

diff --git a/src/Instagram/Transport/JsonFeed.php b/src/Instagram/Transport/JsonFeed.php
@@ -67,18 +67,18 @@ private function getQueryHash()
 
     /**
      * @param $userId
-     * @param null $cursor
+     * @param null $endCursor
      * @return mixed
      * @throws InstagramException
      * @throws \GuzzleHttp\Exception\GuzzleException
      */
-    public function fetchMediaData($userId, $cursor = null)
+    public function fetchMediaData($userId, $endCursor = null)
     {
         $endpoint = self::INSTAGRAM_ENDPOINT . 'graphql/query/?query_hash=' . $this->getQueryHash() . '&variables={"id":"' . $userId . '","first":"12"';
 
 
-        if ($cursor) {
-            $endpoint .= ',"after":"' . $cursor . '"';
+        if ($endCursor) {
+            $endpoint .= ',"after":"' . $endCursor . '"';
         }
 
         $endpoint .= '}';

diff --git a/tests/ApiTest.php b/tests/ApiTest.php
@@ -85,7 +85,7 @@ public function testEmptyUserIdAndCursor()
         $this->expectException(InstagramException::class);
 
         $api = new Api($this->validUserClient, $this->validMediaClient);
-        $api->setCursor(123);
+        $api->setEndCursor(123);
         $api->setUserName('pgrimaud');
         $api->retrieveUserData(true);
         $api->retrieveMediaData(true);
@@ -165,7 +165,7 @@ public function testValidFeedWithCursorReturn()
         $api = new Api($this->validUserClient, $this->validMediaClient);
         $api->setUserName('pgrimaud');
         $api->setUserId(12345);
-        $api->setCursor(1);
+        $api->setEndCursor('xxxxx');
 
         $api->retrieveMediaData(true);
         $feed = $api->getFeed();
@@ -223,6 +223,8 @@ public function testFeedContent()
         $this->assertSame(30, $feed->getMediaCount());
 
         $this->assertCount(12, $feed->getMedias());
+
+        $this->assertSame('AQDt7mwufgiNOm233ZFUKmdUv5AqQ3SDYAM9UgY1wC1bjteFPQxRuhm0A6pTEZNRZaYlJIb0bmEQAEtLvwHd6COidVHtBo4Ehx8n7K5n5dJ3dw', $feed->getEndCursor());
     }
 
     /**