AbstractRequest::buildQueryParams() - Code Metrics - Inspection of "added use of tests config" - hiqdev/yii2-hiart - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f81184...3aae6e )

by Andrii

created 2017-01-25 17:35 UTC

AbstractRequest::buildQueryParams() A

↳ Parent: AbstractRequest

Complexity

Conditions	3
Paths	4

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3.0987

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	7
cts	9
cp	0.7778
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	6
nc	4
nop	0
crap	3.0987

<?php
/**
 * Tools to use API as ActiveRecord for Yii2
 *
 * @link      https://github.com/hiqdev/yii2-hiart
 * @package   yii2-hiart
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\hiart;

abstract class AbstractRequest implements RequestInterface
{
    /**
     * @var string response implementation to be specified in concrete implementation
     */
    protected $responseClass;

    /**
     * @var string request handler implementation to be specified in concrete implementation
     */
    protected $handlerClass;

    /**
     * @var QueryBuilderInterface
     */
    protected $builder;

    /**
     * @var Query
     */
    protected $query;

    /**
     * @var string Connection name
     */
    protected $dbname;

    /**
     * @var array request method
     */
    protected $method;
    protected $uri;
    protected $headers = [];
    protected $body;
    protected $version;

    protected $isBuilt;
    protected $parts = [];
    protected $fullUri;

    abstract public function send($options = []);

    public function __construct(QueryBuilderInterface $builder, Query $query)
    {
        $this->builder = $builder;
        $this->query = $query;
    }

    public function getDbname()
    {
        return $this->dbname;
    }

    public function getMethod()
    {
        return $this->method;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function getUri()
    {
        return $this->uri;
    }

    public function getFullUri()
    {
        if ($this->fullUri === null) {
            $this->fullUri = $this->createFullUri();
        }

        return $this->fullUri;
    }

    public function createFullUri()
    {
        return ($this->isFullUri($this->uri) ? '' : $this->getDb()->getBaseUri()) . $this->uri;
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function isFullUri($uri)
    {
        return preg_match('/^https?:\\/\\//i', $uri);
    }

    public function getHeaders()
    {
        return $this->headers;
    }

    public function getBody()
    {
        return $this->body;
    }

    public function getVersion()
    {
        return $this->version;
    }

    /**
     * @return Query
     */
    public function getQuery()
    {
        return $this->query;
    }

    protected function build()
    {
        if ($this->isBuilt === null) {
            if (!empty($this->query)) {
                $this->updateFromQuery();
            }
            $this->isBuilt = true;
        }
    }

    protected function updateFromQuery()
    {
        $this->builder->prepare($this->query);

        $this->buildDbname();
        $this->buildAuth();
        $this->buildMethod();
        $this->buildUri();
        $this->buildQueryParams();
        $this->buildHeaders();
        $this->buildBody();
        $this->buildFormParams();
        $this->buildProtocolVersion();
    }

    protected function buildDbname()
    {
        $this->dbname = $this->getDb()->name;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
    }

    protected function buildAuth()
    {
        $this->builder->buildAuth($this->query);
    }

    protected function buildMethod()
    {
        $this->method = $this->builder->buildMethod($this->query) ?: 'GET';
    }

    protected function buildUri()
    {
        $this->uri = $this->builder->buildUri($this->query);
    }

    protected function buildQueryParams()
    {
        $params = $this->builder->buildQueryParams($this->query);
        if (is_array($params)) {
            $params = http_build_query($params, '', '&');
        }
        if (!empty($params)) {
            $this->uri .= '?' . $params;
        }
    }

    protected function buildHeaders()
    {
        $this->headers = $this->builder->buildHeaders($this->query);
        if (empty($this->headers['User-Agent'])) {
            $this->headers['User-Agent'] = $this->prepareUserAgent();
        }
    }

    protected function buildBody()
    {
        $this->body = $this->builder->buildBody($this->query);
    }

    protected function buildFormParams()
    {
        $this->setFormParams($this->builder->buildFormParams($this->query));
    }

    protected function setFormParams($params)
    {
        if (!empty($params)) {
            $this->body = is_array($params) ? http_build_query($params, '', '&') : $params;
            $this->headers['Content-Type'] = 'application/x-www-form-urlencoded';
        }
    }

    protected function buildProtocolVersion()
    {
        $this->version = $this->builder->buildProtocolVersion($this->query) ?: '1.1';
    }

    public function serialize()
    {
        return serialize($this->getParts());
    }

    public function unserialize($string)
    {
        foreach (unserialize($string) as $key => $value) {
            $this->{$key} = $value;
        }
    }

    public function getParts()
    {
        if (empty($this->parts)) {
            $this->build();
            foreach (['dbname', 'method', 'uri', 'headers', 'body', 'version'] as $key) {
                $this->parts[$key] = $this->{$key};
            }
        }

        return $this->parts;
    }

    public function isRaw()
    {
        return !empty($this->query->options['raw']);
    }

    protected function getHandler()
    {
        $handler = $this->getDb()->getHandler();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        if ($handler === null) {
            $handler = $this->createHandler();
        }

        return $handler;
    }

    protected function createHandler()
    {
        $config = $this->prepareHandlerConfig($this->getDb()->config);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        return new $this->handlerClass($config);
    }

    protected function prepareHandlerConfig($config)
    {
        return $config;
    }

    protected function prepareUserAgent()
    {
        return $this->getDb()->getUserAgent();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * @return AbstractConnection|ConnectionInterface
     */
    public function getDb()
    {
        return isset($this->builder) ? $this->builder->db : AbstractConnection::getDb($this->dbname);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
    }
}


Push — master ( f81184...3aae6e )

AbstractRequest::buildQueryParams() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1		<?php
2		/**
3		* Tools to use API as ActiveRecord for Yii2
4		*
5		* @link https://github.com/hiqdev/yii2-hiart
6		* @package yii2-hiart
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hiqdev\hiart;
12
13		abstract class AbstractRequest implements RequestInterface
14		{
15		/**
16		* @var string response implementation to be specified in concrete implementation
17		*/
18		protected $responseClass;
19
20		/**
21		* @var string request handler implementation to be specified in concrete implementation
22		*/
23		protected $handlerClass;
24
25		/**
26		* @var QueryBuilderInterface
27		*/
28		protected $builder;
29
30		/**
31		* @var Query
32		*/
33		protected $query;
34
35		/**
36		* @var string Connection name
37		*/
38		protected $dbname;
39
40		/**
41		* @var array request method
42		*/
43		protected $method;
44		protected $uri;
45		protected $headers = [];
46		protected $body;
47		protected $version;
48
49		protected $isBuilt;
50		protected $parts = [];
51		protected $fullUri;
52
53		abstract public function send($options = []);
54
55	3	public function __construct(QueryBuilderInterface $builder, Query $query)
56		{
57	3	$this->builder = $builder;
58	3	$this->query = $query;
59	3	}
60
61		public function getDbname()
62		{
63		return $this->dbname;
64		}
65
66		public function getMethod()
67		{
68		return $this->method;
		0 ignored issues – show Bug Best Practice introduced 2017-01-25 17:14 UTC by Report Bug Copy Issue Report The return type of `return $this->method;` (`array`) is incompatible with the return type declared by the interface `hiqdev\hiart\RequestInterface::getMethod` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
69		}
70
71		public function getUri()
72		{
73		return $this->uri;
74		}
75
76	2	public function getFullUri()
77		{
78	2	if ($this->fullUri === null) {
79	2	$this->fullUri = $this->createFullUri();
80	2	}
81
82	2	return $this->fullUri;
83		}
84
85	2	public function createFullUri()
86		{
87	2	return ($this->isFullUri($this->uri) ? '' : $this->getDb()->getBaseUri()) . $this->uri;
		0 ignored issues – show Bug introduced 2017-01-25 17:14 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `hiqdev\hiart\ConnectionInterface` as the method `getBaseUri()` does only exist in the following implementations of said interface: `hiqdev\hiart\AbstractConnection`, `hiqdev\hiart\rest\Connection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
88		}
89
90	2	public function isFullUri($uri)
91		{
92	2	return preg_match('/^https?:\\/\\//i', $uri);
93		}
94
95		public function getHeaders()
96		{
97		return $this->headers;
98		}
99
100		public function getBody()
101		{
102		return $this->body;
103		}
104
105		public function getVersion()
106		{
107		return $this->version;
108		}
109
110		/**
111		* @return Query
112		*/
113	2	public function getQuery()
114		{
115	2	return $this->query;
116		}
117
118	2	protected function build()
119		{
120	2	if ($this->isBuilt === null) {
121	2	if (!empty($this->query)) {
122	2	$this->updateFromQuery();
123	2	}
124	2	$this->isBuilt = true;
125	2	}
126	2	}
127
128	2	protected function updateFromQuery()
129		{
130	2	$this->builder->prepare($this->query);
131
132	2	$this->buildDbname();
133	2	$this->buildAuth();
134	2	$this->buildMethod();
135	2	$this->buildUri();
136	2	$this->buildQueryParams();
137	2	$this->buildHeaders();
138	2	$this->buildBody();
139	2	$this->buildFormParams();
140	2	$this->buildProtocolVersion();
141	2	}
142
143	2	protected function buildDbname()
144		{
145	2	$this->dbname = $this->getDb()->name;
		0 ignored issues – show Bug introduced 2017-01-25 17:14 UTC by Report Bug Copy Issue Report Accessing `name` on the interface `hiqdev\hiart\ConnectionInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
146	2	}
147
148	2	protected function buildAuth()
149		{
150	2	$this->builder->buildAuth($this->query);
151	2	}
152
153	2	protected function buildMethod()
154		{
155	2	$this->method = $this->builder->buildMethod($this->query) ?: 'GET';
156	2	}
157
158	2	protected function buildUri()
159		{
160	2	$this->uri = $this->builder->buildUri($this->query);
161	2	}
162
163	2	protected function buildQueryParams()
164		{
165	2	$params = $this->builder->buildQueryParams($this->query);
166	2	if (is_array($params)) {
167	2	$params = http_build_query($params, '', '&');
168	2	}
169	2	if (!empty($params)) {
170		$this->uri .= '?' . $params;
171		}
172	2	}
173
174	2	protected function buildHeaders()
175		{
176	2	$this->headers = $this->builder->buildHeaders($this->query);
177	2	if (empty($this->headers['User-Agent'])) {
178	2	$this->headers['User-Agent'] = $this->prepareUserAgent();
179	2	}
180	2	}
181
182	2	protected function buildBody()
183		{
184	2	$this->body = $this->builder->buildBody($this->query);
185	2	}
186
187	2	protected function buildFormParams()
188		{
189	2	$this->setFormParams($this->builder->buildFormParams($this->query));
190	2	}
191
192	2	protected function setFormParams($params)
193		{
194	2	if (!empty($params)) {
195		$this->body = is_array($params) ? http_build_query($params, '', '&') : $params;
196		$this->headers['Content-Type'] = 'application/x-www-form-urlencoded';
197		}
198	2	}
199
200	2	protected function buildProtocolVersion()
201		{
202	2	$this->version = $this->builder->buildProtocolVersion($this->query) ?: '1.1';
203	2	}
204
205	2	public function serialize()
206		{
207	2	return serialize($this->getParts());
208		}
209
210		public function unserialize($string)
211		{
212		foreach (unserialize($string) as $key => $value) {
213		$this->{$key} = $value;
214		}
215		}
216
217	2	public function getParts()
218		{
219	2	if (empty($this->parts)) {
220	2	$this->build();
221	2	foreach (['dbname', 'method', 'uri', 'headers', 'body', 'version'] as $key) {
222	2	$this->parts[$key] = $this->{$key};
223	2	}
224	2	}
225
226	2	return $this->parts;
227		}
228
229	2	public function isRaw()
230		{
231	2	return !empty($this->query->options['raw']);
232		}
233
234		protected function getHandler()
235		{
236		$handler = $this->getDb()->getHandler();
		0 ignored issues – show Bug introduced 2017-01-25 17:14 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `hiqdev\hiart\ConnectionInterface` as the method `getHandler()` does only exist in the following implementations of said interface: `hiqdev\hiart\AbstractConnection`, `hiqdev\hiart\rest\Connection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
237		if ($handler === null) {
238		$handler = $this->createHandler();
239		}
240
241		return $handler;
242		}
243
244		protected function createHandler()
245		{
246		$config = $this->prepareHandlerConfig($this->getDb()->config);
		0 ignored issues – show Bug introduced 2017-01-25 17:14 UTC by Report Bug Copy Issue Report Accessing `config` on the interface `hiqdev\hiart\ConnectionInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
247
248		return new $this->handlerClass($config);
249		}
250
251		protected function prepareHandlerConfig($config)
252		{
253		return $config;
254		}
255
256	2	protected function prepareUserAgent()
257		{
258	2	return $this->getDb()->getUserAgent();
		0 ignored issues – show Bug introduced 2017-01-25 17:14 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `hiqdev\hiart\ConnectionInterface` as the method `getUserAgent()` does only exist in the following implementations of said interface: `hiqdev\hiart\AbstractConnection`, `hiqdev\hiart\rest\Connection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
259		}
260
261		/**
262		* @return AbstractConnection\|ConnectionInterface
263		*/
264	2	public function getDb()
265		{
266	2	return isset($this->builder) ? $this->builder->db : AbstractConnection::getDb($this->dbname);
		0 ignored issues – show Bug introduced 2017-01-24 17:39 UTC by Report Bug Copy Issue Report Accessing `db` on the interface `hiqdev\hiart\QueryBuilderInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
267		}
268		}
269

hiqdev / yii2-hiart

Push — master ( f81184...3aae6e )

AbstractRequest::buildQueryParams() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like