scriptotek / php-alma-client

src/Bibs/Bib.php

Doc Comments +1 added lines

@@ -86,6 +86,7 @@
 
     /**
      * Get the MMS ID of the linked record in network zone.
+     * @return string
      */
     public function getNzMmsId()
     {

spec/Bibs/BibSpec.php

Doc Comments +3 added lines

@@ -21,6 +21,9 @@
         $this->beConstructedWith($client, '999104760474702204');
     }
 
+    /**
+     * @param AlmaClient $client
+     */
     protected function expectRequest($client)
     {
         $client->getXML('/bibs/999104760474702204')

src/Client.php

Doc Comments +1 added lines, -1 removed lines

@@ -167,7 +167,7 @@
     /**
      * Set the Alma region code ('na' for North America, 'eu' for Europe, 'ap' for Asia Pacific).
      *
-     * @param $regionCode
+     * @param string $regionCode
      *
      * @throws \ErrorException
      *

src/Analytics/Report.php

Doc Comments +2 added lines, -2 removed lines

@@ -84,9 +84,9 @@
     /**
      * Convert a retrieved resource to an object.
      *
-     * @param $data
+     * @param QuiteSimpleXMLElement $data
      *
-     * @return mixed
+     * @return Row
      */
     protected function convertToResource($data)
     {

src/Model/SimplePaginatedList.php

Doc Comments +3 added lines

@@ -39,6 +39,9 @@
         } while (!$this->isInitialized($this->resources));
     }
 
+    /**
+     * @param \stdClass $data
+     */
     protected function onData($data)
     {
         parent::onData($data);

spec/Bibs/HoldingSpec.php

Doc Comments +3 added lines

@@ -19,6 +19,9 @@
         $this->beConstructedWith($client, $bib, $holdings_id);
     }
 
+    /**
+     * @param AlmaClient $client
+     */
     protected function expectRequest($client)
     {
         $client->getXML('/bibs/abc/holdings/123')

src/Model/LazyResource.php

Doc Comments +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
     /**
      * Get and return the model data.
      *
-     * @return object
+     * @return \stdClass
      */
     protected function fetchData()
     {

spec/Bibs/ElectronicCollectionsSpec.php

Doc Comments +3 added lines

@@ -23,6 +23,9 @@
         $this->shouldHaveType(ElectronicCollections::class);
     }
 
+    /**
+     * @param AlmaClient $client
+     */
     protected function expectRequest($client)
     {
         $client->getJSON('/bibs/abc/e-collections')

spec/Bibs/PortfolioSpec.php

Doc Comments +3 added lines

@@ -25,6 +25,9 @@
         $this->shouldHaveType(Portfolio::class);
     }
 
+    /**
+     * @param AlmaClient $client
+     */
     protected function expectRequest($client)
     {
         $client->getJSON('/bibs/abc/portfolios/123')