Fix interfaces and add missing IODataResponse

src/IODataClient.php

@@ -54,10 +54,52 @@ public function query();
      * @param $requestUri
      * @param array $bindings
      *
-     * @return IODataRequest
+     * @return IODataResponse
      */
     public function get($requestUri, $bindings = []);
 
+    /**
+     * Run a POST request against the service.
+     *
+     * @param string $requestUri
+     * @param mixed  $postData
+     *
+     * @return IODataResponse
+     */
+    public function post($requestUri, $postData);
+
+    /**
+     * Run a PATCH request against the service.
+     *
+     * @param string $requestUri
+     * @param mixed  $body
+     *
+     * @return IODataResponse
+     */
+    public function patch($requestUri, $body);
+
+    /**
+     * Run a DELETE request against the service.
+     *
+     * @param string $requestUri
+     *
+     * @return IODataResponse
+     */
+    public function delete($requestUri);
+
+    /**
+     * Return an ODataRequest
+     *
+     * @param string $method
+     * @param string $requestUri
+     * @param mixed  $body
+     *
+     * @return IODataResponse
+     *
+     * @throws ODataException
+     */
+    public function request($method, $requestUri, $body = null);
+
     /**
      * Get the query grammar used by the connection.
      *

src/IODataResponse.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace SaintSystems\OData;
+
+interface IODataResponse
+{
+    /**
+     * Get the decoded body of the HTTP response
+     *
+     * @var array The decoded body
+     */
+    public function getBody();
+
+    /**
+     * Get the undecoded body of the HTTP response
+     *
+     * @var string The undecoded body
+     */
+    public function getRawBody();
+
+    /**
+     * Get the status of the HTTP response
+     *
+     * @var string The HTTP status
+     */
+    public function getStatus();
+
+    /**
+     * Get the headers of the response
+     *
+     * @var array The response headers
+     */
+    public function getHeaders();
+
+    /**
+     * Converts the response JSON object to a OData SDK object
+     *
+     * @param mixed $returnType The type to convert the object(s) to
+     *
+     * @return mixed object or array of objects of type $returnType
+     */
+    public function getResponseAsObject($returnType);
+
+    /**
+     * Gets the skip token of a response object from OData
+     *
+     * @return string skip token, if provided
+     */
+    public function getSkipToken();
+
+    /**
+     * Gets the Id of response object (if set) from OData
+     *
+     * @return mixed id if this was an insert, if provided
+     */
+    public function getId();
+}

src/ODataClient.php

@@ -204,7 +204,7 @@ public function query()
      * @param string $requestUri
      * @param array  $bindings
      *
-     * @return IODataRequest
+     * @return IODataResponse
      */
     public function get($requestUri, $bindings = [])
     {
@@ -217,7 +217,7 @@ public function get($requestUri, $bindings = [])
      * @param string $requestUri
      * @param mixed  $postData
      *
-     * @return IODataRequest
+     * @return IODataResponse
      */
     public function post($requestUri, $postData)
     {
@@ -230,7 +230,7 @@ public function post($requestUri, $postData)
      * @param string $requestUri
      * @param mixed  $body
      *
-     * @return IODataRequest
+     * @return IODataResponse
      */
     public function patch($requestUri, $body)
     {
@@ -242,7 +242,7 @@ public function patch($requestUri, $body)
      *
      * @param string $requestUri
      *
-     * @return IODataRequest
+     * @return IODataResponse
      */
     public function delete($requestUri)
     {
@@ -256,7 +256,7 @@ public function delete($requestUri)
      * @param string $requestUri
      * @param mixed  $body
      *
-     * @return IODataRequest
+     * @return IODataResponse
      *
      * @throws ODataException
      */

src/Query/Builder.php

@@ -8,7 +8,6 @@
 use SaintSystems\OData\Constants;
 use SaintSystems\OData\Exception\ODataQueryException;
 use SaintSystems\OData\IODataClient;
-use SaintSystems\OData\IODataRequest;
 use SaintSystems\OData\QueryOptions;
 
 class Builder
@@ -1018,7 +1017,7 @@ public function patch($body, $properties = [], $options = null)
     /**
      * Run the query as a "GET" request against the client.
      *
-     * @return IODataRequest
+     * @return IODataReponse
      */
     protected function runGet()
     {
@@ -1030,7 +1029,7 @@ protected function runGet()
     /**
      * Run the query as a "GET" request against the client.
      *
-     * @return IODataRequest
+     * @return IODataResponse
      */
     protected function runPatch($body)
     {
@@ -1042,7 +1041,7 @@ protected function runPatch($body)
     /**
      * Run the query as a "GET" request against the client.
      *
-     * @return IODataRequest
+     * @return IODataResponse
      */
     protected function runPost($body)
     {
@@ -1054,7 +1053,7 @@ protected function runPost($body)
     /**
      * Run the query as a "GET" request against the client.
      *
-     * @return IODataRequest
+     * @return IODataResponse
      */
     protected function runDelete()
     {
@@ -1084,7 +1083,7 @@ public function count()
      *
      * @param array $values
      *
-     * @return bool
+     * @return IODataResponse
      */
     public function insert(array $values)
     {

src/Query/IProcessor.php

@@ -2,17 +2,17 @@
 
 namespace SaintSystems\OData\Query;
 
-use SaintSystems\OData\IODataRequest;
+use SaintSystems\OData\IODataResponse;
 
 interface IProcessor
 {
     /**
      * Process the results of a "select" query.
      *
      * @param Builder       $query
-     * @param IODataRequest $results
+     * @param IODataResponse $results
      *
-     * @return IODataRequest
+     * @return IODataResponse
      */
     public function processSelect(Builder $query, $results);
 }