AbstractApi - Code Metrics - Inspection of "Add BasicAuthClient and AbstractApi" - adam-paterson/ibm-watson-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 2c75a2...3f95e8 )

by Adam

created 2018-09-20 15:30 UTC

AbstractApi A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
wmc	10
lcom	1
cbo	2
dl	0
loc	177
rs	10
c	0
b	0
f	0

10 Methods

Rating	Name	Size	Complexity
A	__construct()	7	1
A	get()	6	1
A	head()	6	1
A	trace()	6	1
A	post()	4	1
A	postRaw()	6	1
A	put()	6	1
A	patch()	6	1
A	delete()	6	1
A	options()	6	1

<?php

namespace IBM\Watson\Common\Api;

use Http\Client\HttpClient;
use IBM\Watson\Common\RequestBuilderInterface;

/**
 * AbstractApi is used to create and send HTTP requests.
 */
abstract class AbstractApi implements ApiInterface
{
    /**
     * @var \Http\Client\HttpClient
     */
    private $httpClient;

    /**
     * @var RequestBuilderInterface
     */
    private $requestBuilder;

    /**
     * @param \Http\Client\HttpClient                    $httpClient     HTTP client to send requests.
     * @param \IBM\Watson\Common\RequestBuilderInterface $requestBuilder Request builder to create requests.
     */
    public function __construct(
        HttpClient $httpClient,
        RequestBuilderInterface $requestBuilder
    ) {
        $this->httpClient = $httpClient;
        $this->requestBuilder = $requestBuilder;
    }

    /**
     * Create and send GET request.
     *
     * @param string|UriInterface $uri     API URI.
     * @param array               $params  Query parameters.
     * @param array               $headers Query headers.
     *
     * @return \Psr\Http\Message\ResponseInterface
     *
     * @throws \Http\Client\Exception
     */
    protected function get($uri, array $params = [], array $headers = [])
    {
        return $this->httpClient->sendRequest(
            $this->requestBuilder->create(static::HTTP_METHOD_GET, $uri, $params, $headers)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );
    }

    /**
     * Create and send HEAD request.
     *
     * @param string|UriInterface $uri     API URI.
     * @param array               $headers Query headers.
     *
     * @return \Psr\Http\Message\ResponseInterface
     * @throws \Http\Client\Exception
     */
    protected function head($uri, array $headers = [])
    {
        return $this->httpClient->sendRequest(
            $this->requestBuilder->create(static::HTTP_METHOD_HEAD, $uri, $headers, null)
        );
    }

    /**
     * Create and send TRACE request.
     *
     * @param string|UriInterface $uri     API URI.
     * @param array               $headers Query headers.
     *
     * @return \Psr\Http\Message\ResponseInterface
     * @throws \Http\Client\Exception
     */
    protected function trace($uri, array $headers = [])
    {
        return $this->httpClient->sendRequest(
            $this->requestBuilder->create(static::HTTP_METHOD_TRACE, $uri, $headers, null)
        );
    }

    /**
     * Create and send POST request.
     *
     * @param string|UriInterface $uri     API URI.
     * @param array               $params  Query parameters.
     * @param array               $headers Query headers.
     *
     * @return \Psr\Http\Message\ResponseInterface
     *
     * @throws \Http\Client\Exception
     */
    protected function post($uri, array $params = [], array $headers = [])
    {
        return $this->postRaw($uri, \http_build_query($params), $headers);
    }

    /**
     * Create and send POST request.
     *
     * @param string|UriInterface                  $uri     API URI.
     * @param resource|string|StreamInterface|null $body    Request body.
     * @param array                                $headers Query headers.
     *
     * @return \Psr\Http\Message\ResponseInterface
     *
     * @throws \Http\Client\Exception
     */
    protected function postRaw($uri, $body, array $headers = [])
    {
        return $this->httpClient->sendRequest(
            $this->requestBuilder->create(static::HTTP_METHOD_POST, $uri, $headers, $body)
        );
    }

    /**
     * Create and send PUT request.
     *
     * @param string|UriInterface $uri     API URI.
     * @param array               $params  Query parameters.
     * @param array               $headers Query headers.
     *
     * @return \Psr\Http\Message\ResponseInterface
     *
     * @throws \Http\Client\Exception
     */
    protected function put($uri, array $params = [], array $headers = [])
    {
        return $this->httpClient->sendRequest(
            $this->requestBuilder->create(static::HTTP_METHOD_PUT, $uri, $params, $headers)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );
    }

    /**
     * Create and send PATCH request.
     *
     * @param string|UriInterface                  $uri     API URI.
     * @param resource|string|StreamInterface|null $body    Request body.
     * @param array                                $headers Query headers.
     *
     * @return \Psr\Http\Message\ResponseInterface
     * @throws \Http\Client\Exception
     */
    protected function patch($uri, $body, array $headers = [])
    {
        return $this->httpClient->sendRequest(
            $this->requestBuilder->create(static::HTTP_METHOD_PATCH, $uri, $headers, $body)
        );
    }

    /**
     * Create and send DELETE request.
     *
     * @param string|UriInterface $uri     API URI.
     * @param array               $params  Query parameters.
     * @param array               $headers Query headers.
     *
     * @return \Psr\Http\Message\ResponseInterface
     * @throws \Http\Client\Exception
     */
    protected function delete($uri, array $params = [], array $headers = [])
    {
        return $this->httpClient->sendRequest(
            $this->requestBuilder->create(static::HTTP_METHOD_DELETE, $uri, $params, $headers)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );
    }

    /**
     * Create and send OPTIONS request.
     *
     * @param string|UriInterface $uri     API URI.
     * @param array               $params  Query parameters.
     * @param array               $headers Query headers.
     *
     * @return \Psr\Http\Message\ResponseInterface
     * @throws \Http\Client\Exception
     */
    protected function options($uri, array $params = [], array $headers = [])
    {
        return $this->httpClient->sendRequest(
            $this->requestBuilder->create(static::HTTP_METHOD_OPTIONS, $uri, $params, $headers)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );
    }
}


1			<?php
2
3			namespace IBM\Watson\Common\Api;
4
5			use Http\Client\HttpClient;
6			use IBM\Watson\Common\RequestBuilderInterface;
7
8			/**
9			* AbstractApi is used to create and send HTTP requests.
10			*/
11			abstract class AbstractApi implements ApiInterface
12			{
13			/**
14			* @var \Http\Client\HttpClient
15			*/
16			private $httpClient;
17
18			/**
19			* @var RequestBuilderInterface
20			*/
21			private $requestBuilder;
22
23			/**
24			* @param \Http\Client\HttpClient $httpClient HTTP client to send requests.
25			* @param \IBM\Watson\Common\RequestBuilderInterface $requestBuilder Request builder to create requests.
26			*/
27			public function __construct(
28			HttpClient $httpClient,
29			RequestBuilderInterface $requestBuilder
30			) {
31			$this->httpClient = $httpClient;
32			$this->requestBuilder = $requestBuilder;
33			}
34
35			/**
36			* Create and send GET request.
37			*
38			* @param string\|UriInterface $uri API URI.
39			* @param array $params Query parameters.
40			* @param array $headers Query headers.
41			*
42			* @return \Psr\Http\Message\ResponseInterface
43			*
44			* @throws \Http\Client\Exception
45			*/
46			protected function get($uri, array $params = [], array $headers = [])
47			{
48			return $this->httpClient->sendRequest(
49			$this->requestBuilder->create(static::HTTP_METHOD_GET, $uri, $params, $headers)
			0 ignored issues – show Documentation introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report `$headers` is of type `array`, but the function expects a `resource\|string\|object<I...n\StreamInterface>\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
50			);
51			}
52
53			/**
54			* Create and send HEAD request.
55			*
56			* @param string\|UriInterface $uri API URI.
57			* @param array $headers Query headers.
58			*
59			* @return \Psr\Http\Message\ResponseInterface
60			* @throws \Http\Client\Exception
61			*/
62			protected function head($uri, array $headers = [])
63			{
64			return $this->httpClient->sendRequest(
65			$this->requestBuilder->create(static::HTTP_METHOD_HEAD, $uri, $headers, null)
66			);
67			}
68
69			/**
70			* Create and send TRACE request.
71			*
72			* @param string\|UriInterface $uri API URI.
73			* @param array $headers Query headers.
74			*
75			* @return \Psr\Http\Message\ResponseInterface
76			* @throws \Http\Client\Exception
77			*/
78			protected function trace($uri, array $headers = [])
79			{
80			return $this->httpClient->sendRequest(
81			$this->requestBuilder->create(static::HTTP_METHOD_TRACE, $uri, $headers, null)
82			);
83			}
84
85			/**
86			* Create and send POST request.
87			*
88			* @param string\|UriInterface $uri API URI.
89			* @param array $params Query parameters.
90			* @param array $headers Query headers.
91			*
92			* @return \Psr\Http\Message\ResponseInterface
93			*
94			* @throws \Http\Client\Exception
95			*/
96			protected function post($uri, array $params = [], array $headers = [])
97			{
98			return $this->postRaw($uri, \http_build_query($params), $headers);
99			}
100
101			/**
102			* Create and send POST request.
103			*
104			* @param string\|UriInterface $uri API URI.
105			* @param resource\|string\|StreamInterface\|null $body Request body.
106			* @param array $headers Query headers.
107			*
108			* @return \Psr\Http\Message\ResponseInterface
109			*
110			* @throws \Http\Client\Exception
111			*/
112			protected function postRaw($uri, $body, array $headers = [])
113			{
114			return $this->httpClient->sendRequest(
115			$this->requestBuilder->create(static::HTTP_METHOD_POST, $uri, $headers, $body)
116			);
117			}
118
119			/**
120			* Create and send PUT request.
121			*
122			* @param string\|UriInterface $uri API URI.
123			* @param array $params Query parameters.
124			* @param array $headers Query headers.
125			*
126			* @return \Psr\Http\Message\ResponseInterface
127			*
128			* @throws \Http\Client\Exception
129			*/
130			protected function put($uri, array $params = [], array $headers = [])
131			{
132			return $this->httpClient->sendRequest(
133			$this->requestBuilder->create(static::HTTP_METHOD_PUT, $uri, $params, $headers)
			0 ignored issues – show Documentation introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report `$headers` is of type `array`, but the function expects a `resource\|string\|object<I...n\StreamInterface>\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
134			);
135			}
136
137			/**
138			* Create and send PATCH request.
139			*
140			* @param string\|UriInterface $uri API URI.
141			* @param resource\|string\|StreamInterface\|null $body Request body.
142			* @param array $headers Query headers.
143			*
144			* @return \Psr\Http\Message\ResponseInterface
145			* @throws \Http\Client\Exception
146			*/
147			protected function patch($uri, $body, array $headers = [])
148			{
149			return $this->httpClient->sendRequest(
150			$this->requestBuilder->create(static::HTTP_METHOD_PATCH, $uri, $headers, $body)
151			);
152			}
153
154			/**
155			* Create and send DELETE request.
156			*
157			* @param string\|UriInterface $uri API URI.
158			* @param array $params Query parameters.
159			* @param array $headers Query headers.
160			*
161			* @return \Psr\Http\Message\ResponseInterface
162			* @throws \Http\Client\Exception
163			*/
164			protected function delete($uri, array $params = [], array $headers = [])
165			{
166			return $this->httpClient->sendRequest(
167			$this->requestBuilder->create(static::HTTP_METHOD_DELETE, $uri, $params, $headers)
			0 ignored issues – show Documentation introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report `$headers` is of type `array`, but the function expects a `resource\|string\|object<I...n\StreamInterface>\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
168			);
169			}
170
171			/**
172			* Create and send OPTIONS request.
173			*
174			* @param string\|UriInterface $uri API URI.
175			* @param array $params Query parameters.
176			* @param array $headers Query headers.
177			*
178			* @return \Psr\Http\Message\ResponseInterface
179			* @throws \Http\Client\Exception
180			*/
181			protected function options($uri, array $params = [], array $headers = [])
182			{
183			return $this->httpClient->sendRequest(
184			$this->requestBuilder->create(static::HTTP_METHOD_OPTIONS, $uri, $params, $headers)
			0 ignored issues – show Documentation introduced 2018-09-20 15:39 UTC by Report Bug Copy Issue Report `$headers` is of type `array`, but the function expects a `resource\|string\|object<I...n\StreamInterface>\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
185			);
186			}
187			}
188

adam-paterson / ibm-watson-sdk

Push — develop ( 2c75a2...3f95e8 )

AbstractApi A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

10 Methods

Duplication Side-by-Side

Filter issues like