Fix @return documentation of ODataRequest::execute()

This documents the return type change that was introduced with version 0.7.0.
saintsystems · Sep 29, 2023 · f6454a5 · f6454a5
1 parent c88701d
commit f6454a5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/src/ODataClient.php b/src/ODataClient.php
@@ -312,7 +312,12 @@ public function delete($requestUri)
      * @param string $requestUri
      * @param mixed  $body
      *
-     * @return IODataRequest
+     * @return If $entityReturnType === 'stream': GuzzleHttp\Psr7\Response
+     *         Otherwise: array with two values
+     *         - First value: array of objects
+     *           .. of class $entityReturnType if $entityReturnType !== false
+     *           .. of class ODataResponse if $entityReturnType === false
+     *         - Second value: string containing the "next link" URL
      *
      * @throws ODataException
      */

diff --git a/src/ODataRequest.php b/src/ODataRequest.php
@@ -213,9 +213,12 @@ public function setTimeout($timeout)
      *
      * @throws ODataException if response is invalid
      *
-     * @return array array of objects
-     *         of class $returnType if $returnType !== false
-     *         of class ODataResponse if $returnType === false
+     * @return If $returnType === 'stream': GuzzleHttp\Psr7\Response
+     *         Otherwise: array with two values
+     *         - First value: array of objects
+     *           .. of class $returnType if $returnType !== false
+     *           .. of class ODataResponse if $returnType === false
+     *         - Second value: string containing the "next link" URL
      */
     public function execute()
     {