Updated doc blocks and removed getItemsPerPage because the list feed does not return that element

Author: asimlqt

src/Google/Spreadsheet/DefaultServiceRequest.php

@@ -303,11 +303,8 @@ protected function initRequest($url, $requestHeaders = array())
      * 
      * @return string the xml response
      *
-     * @throws \Google\Spreadsheet\Exception If the was a problem with the request.
-     *                                       Will throw an exception if the response
-     *                                       code is 300 or greater
-     *                                       
      * @throws UnauthorizedException
+     * @throws BadRequestException
      *
      * @codeCoverageIgnore
      */

src/Google/Spreadsheet/ListFeed.php

@@ -99,7 +99,7 @@ public function insert($row)
     /**
      * Get the entries of this feed
      * 
-     * @return \Google\Spreadsheet\ListEntry[]
+     * @return ListEntry[]
      */
     public function getEntries()
     {
@@ -120,18 +120,22 @@ public function getEntries()
         return $rows;
     }
 
+    /**
+     * Get open search total results
+     * 
+     * @return int
+     */
     public function getTotalResults()
     {
         $xml = $this->xml->children('openSearch', true);
         return intval($xml->totalResults);
     }
 
-    public function getItemsPerPage()
-    {
-        $xml = $this->xml->children('openSearch', true);
-        return intval($xml->itemsPerPage);
-    }
-
+    /**
+     * Get open search start index
+     * 
+     * @return int
+     */
     public function getStartIndex()
     {
         $xml = $this->xml->children('openSearch', true);

src/Google/Spreadsheet/ServiceRequestFactory.php

@@ -27,10 +27,13 @@
  */
 class ServiceRequestFactory
 {
+    /**
+     * @var ServiceRequestInterface
+     */
     private static $instance;
 
     /**
-     * [setInstance description]
+     * Set an instance of ServiceRequestInterface
      * 
      * @param ServiceRequestInterface $instance
      */
@@ -44,7 +47,7 @@ public static function setInstance(ServiceRequestInterface $instance = null)
      * 
      * @return ServiceRequestInterface
      * 
-     * @throws \Google\Spreadsheet\Exception
+     * @throws Exception
      */
     public static function getInstance()
     {

src/Google/Spreadsheet/Spreadsheet.php

@@ -124,7 +124,7 @@ public function getWorksheetByTitle($title)
      * @param int    $rowCount default is 100
      * @param int    $colCount default is 10
      *
-     * @return \Google\Spreadsheet\Worksheet
+     * @return Worksheet
      */
     public function addWorksheet($title, $rowCount=100, $colCount=10)
     {

src/Google/Spreadsheet/Worksheet.php

@@ -127,7 +127,7 @@ public function getColCount()
      *
      * @param array $query add additional query params to the url to sort/filter the results
      * 
-     * @return \Google\Spreadsheet\ListFeed
+     * @return ListFeed
      */
     public function getListFeed(array $query = [])
     {
@@ -143,7 +143,7 @@ public function getListFeed(array $query = [])
     /**
      * Get the cell feed of this worksheet
      * 
-     * @return \Google\Spreadsheet\CellFeed
+     * @return CellFeed
      */
     public function getCellFeed(array $query = [])
     {
@@ -241,6 +241,7 @@ public function getCellFeedUrl()
      * Get the export csv url
      *
      * @return string
+     * 
      * @throws Exception
      */
     public function getExportCsvUrl()

tests/Google/Spreadsheet/ListFeedTest.php

@@ -6,28 +6,36 @@
 
 class ListFeedTest extends TestBase
 {
+    private $listFeed;
+
+    public function setUp()
+    {
+        $this->listFeed = new ListFeed($this->getSimpleXMLElement("list-feed"));
+    }
+
+    public function tearDown()
+    {
+        $this->listFeed = null;
+    }
+
     public function testGetXml()
     {
-        $feed = new ListFeed($this->getSimpleXMLElement("list-feed"));
-        $this->assertTrue($feed->getXml() instanceof \SimpleXMLElement);
+        $this->assertTrue($this->listFeed->getXml() instanceof \SimpleXMLElement);
     }
 
     public function testGetId()
     {
-        $feed = new ListFeed($this->getSimpleXMLElement("list-feed"));
         $this->assertEquals(
             "https://spreadsheets.google.com/feeds/list/G3345eEsfsk60/od6/private/full",
-            $feed->getId()
+            $this->listFeed->getId()
         );
     }
 
     public function testGetPostUrl()
     {
-        $listFeed = new ListFeed($this->getSimpleXMLElement("list-feed"));
-
         $this->assertEquals(
             "https://spreadsheets.google.com/feeds/list/G3345eEsfsk60/od6/private/full",
-            $listFeed->getPostUrl()
+            $this->listFeed->getPostUrl()
         );
     }
 
@@ -47,15 +55,22 @@ public function testInsert()
 
         ServiceRequestFactory::setInstance($mockServiceRequest);
 
-        $listFeed = new ListFeed($this->getSimpleXMLElement("list-feed"));
-        $listFeed->insert(["name" => "asim", "occupation" => "software engineer"]);
+        $this->listFeed->insert(["name" => "asim", "occupation" => "software engineer"]);
     }
 
     public function testGetEntries()
     {
-        $listFeed = new ListFeed($this->getSimpleXMLElement("list-feed"));
+        $this->assertEquals(4, count($this->listFeed->getEntries()));
+    }
+
+    public function testGetTotalResults()
+    {
+        $this->assertEquals(4, $this->listFeed->getTotalResults());
+    }
 
-        $this->assertEquals(4, count($listFeed->getEntries()));
+    public function testGetStartIndex()
+    {
+        $this->assertEquals(1, $this->listFeed->getStartIndex());
     }
 
 }