Skip to content

Commit f6454a5

Browse files
committed
Fix @return documentation of ODataRequest::execute()
This documents the return type change that was introduced with version 0.7.0.
1 parent c88701d commit f6454a5

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

src/ODataClient.php

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,12 @@ public function delete($requestUri)
312312
* @param string $requestUri
313313
* @param mixed $body
314314
*
315-
* @return IODataRequest
315+
* @return If $entityReturnType === 'stream': GuzzleHttp\Psr7\Response
316+
* Otherwise: array with two values
317+
* - First value: array of objects
318+
* .. of class $entityReturnType if $entityReturnType !== false
319+
* .. of class ODataResponse if $entityReturnType === false
320+
* - Second value: string containing the "next link" URL
316321
*
317322
* @throws ODataException
318323
*/

src/ODataRequest.php

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,12 @@ public function setTimeout($timeout)
213213
*
214214
* @throws ODataException if response is invalid
215215
*
216-
* @return array array of objects
217-
* of class $returnType if $returnType !== false
218-
* of class ODataResponse if $returnType === false
216+
* @return If $returnType === 'stream': GuzzleHttp\Psr7\Response
217+
* Otherwise: array with two values
218+
* - First value: array of objects
219+
* .. of class $returnType if $returnType !== false
220+
* .. of class ODataResponse if $returnType === false
221+
* - Second value: string containing the "next link" URL
219222
*/
220223
public function execute()
221224
{

0 commit comments

Comments
 (0)