scriptotek / php-alma-client

src/Analytics/Report.php

Doc Comments +2 added lines, -2 removed lines

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

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()
     {

src/Bibs/Bibs.php

Doc Comments +1 added lines, -1 removed lines

@@ -77,7 +77,7 @@
      * @param string $cql       The CQL query
      * @param int    $batchSize Number of records to return in each batch.
      *
-     * @return \Generator|Bib[]
+     * @return \Generator
      */
     public function search($cql, $batchSize = 10)
     {

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/Model/LazyResource.php

Doc Comments +2 added lines, -2 removed lines

@@ -85,7 +85,7 @@ 
 
     /**
      * Get and return the model data.
-     * @return object
+     * @return \stdClass
      */
     protected function fetchData()
     {
@@ -96,7 +96,7 @@ 
      * Called when data is available on the object.
      * The resource classes can use this method to process the data.
      *
-     * @param mixed $data
+     * @param \stdClass $data
      */
     protected function onData($data)
     {

src/Model/SimplePaginatedList.php

Doc Comments +3 added lines

@@ -42,6 +42,9 @@
         return null;
     }
 
+    /**
+     * @param \stdClass $data
+     */
     protected function onData($data)
     {
         parent::onData($data);