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

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
      * Called when data is available to be processed.
      * The resource classes can use this method to process the data.
      *
-     * @param mixed $data
+     * @param \stdClass $data
      */
     protected function onData($data)
     {

spec/Bibs/BibSpec.php

Doc Comments +4 added lines

@@ -21,6 +21,10 @@
         $this->beConstructedWith($client, '999104760474702204');
     }
 
+    /**
+     * @param AlmaClient $client
+     * @param UriInterface $url
+     */
     protected function expectRequest($client, $url)
     {
         $client->buildUrl('/bibs/999104760474702204', [])

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

src/Client.php

Doc Comments +1 added lines, -5 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
      *
@@ -187,7 +187,6 @@ 
      * Extend an URL (UriInterface or string) with query string parameters
      * and return an UriInterface object.
      *
-     * @param string $url|UriInterface
      * @param array  $query
      *
      * @return UriInterface
@@ -268,7 +267,6 @@ 
     /**
      * Make a GET request.
      *
-     * @param string $url|UriInterface
      * @param array  $query
      * @param string $contentType
      *
@@ -289,7 +287,6 @@ 
     /**
      * Make a GET request, accepting JSON.
      *
-     * @param string $url|UriInterface
      * @param array  $query
      *
      * @return \stdClass JSON response as an object.
@@ -304,7 +301,6 @@ 
     /**
      * Make a GET request, accepting XML.
      *
-     * @param string $url|UriInterface
      * @param array  $query
      *
      * @return QuiteSimpleXMLElement