AbstractRequest::setParameters() - Code Metrics - Inspection of "Merge pull request #4 from williamespindola/tests" - williamespindola/abstract-http-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ca7e72...8276bb )

by William

created 2017-12-01 02:25 UTC

AbstractRequest::setParameters() B

↳ Parent: AbstractRequest

Complexity

Conditions	5
Paths	7

Size

Total Lines	20
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	10
nc	7
nop	1

<?php
/**
 * This file is part of :project_name
 *
 * PHP version 7
 *
 * @category  PHP
 * @package   WilliamEspindola\AbstractHTTPClient
 * @author    William Espindola <[email protected]>
 * @copyright Free
 * @license   MIT
 * @link      https://github.com/williamespindola/abstract-http-client-guzzle
 */
declare(strict_types=1);

namespace WilliamEspindola\AbstractHTTPClient;

use Exception;
use InvalidArgumentException;

/**
 * Abstracts request resources
 *
 * @category  PHP
 * @package   WilliamEspindola\AbstractHTTPClient
 * @author    William Espindola <[email protected]>
 * @copyright Free
 * @license   MIT
 * @version   Release: 1.0.0
 * @link      https://github.com/williamespindola/abstract-http-client-guzzle
 */
abstract class AbstractRequest
{
    /**
     * @var array
     */
    protected $config;

    /**
     * @var Client $httpClient Cliente implementation
     */
    protected $httpClient;

    /**
     * @var string $baseUrl Base API URL
     */
    protected $baseUrl;

    /**
     * @var string $uri String that identifies resource
     */
    private $uri;

    /**
     * Initializes new AbstractNuxeoIntegration
     *
     * @param HTTPClient $httpClient HTTP Client implementation
     * @param string     $baseUrl    Base API URL
     */
    public function __construct(HTTPClient $httpClient, string $baseUrl)
    {
        $this->baseUrl = $baseUrl;

        $this->httpClient = $httpClient;

    }

    /**
     * Get URI concatenating base url api with resource end point
     *
     * @return string URI end point
     *
     * @throws Exception If AbstractRequest::baseUrl or AbstractRequest::uri was empty
     */
    protected function getURI(): string
    {
        if (empty($this->baseUrl) || empty($this->uri)) {
            throw new Exception('Url or end point can not be null');
        }

        return $this->baseUrl . $this->uri;
    }

    /**
     * Set url parameters
     *
     * @param array $parameters array with parameters that must be setted
     *
     * <code>
     *  $this->setParameters([
     *      ':paramkey' => 'my param value'
     *  ]);
     * </code>
     *
     * @throws InvalidArgumentException If parameters param was empty
     * @throws Exception                If parametes not match with request endPoint
     *
     * @return void
     */
    protected function setParameters(array $parameters): void
    {
        if (empty($parameters)) {
            throw new InvalidArgumentException('Parameters can not be null');
        }

        $this->uri = null;

        foreach ($parameters as $key => $param) {
            if (preg_match("/{$key}/i", $this->endPoint)) {
                $this->uri = str_replace($key, $param, $this->endPoint);
class MyClass { }

$x = new MyClass();
$x->foo = true;
            }
        }

        if (empty($this->uri)) {
            throw new Exception(
                'Parameters definition not matches with request end point'
            );
        }
    }
}


1			<?php
2			/**
3			* This file is part of :project_name
4			*
5			* PHP version 7
6			*
7			* @category PHP
8			* @package WilliamEspindola\AbstractHTTPClient
9			* @author William Espindola <[email protected]>
10			* @copyright Free
11			* @license MIT
12			* @link https://github.com/williamespindola/abstract-http-client-guzzle
13			*/
14			declare(strict_types=1);
15
16			namespace WilliamEspindola\AbstractHTTPClient;
17
18			use Exception;
19			use InvalidArgumentException;
20
21			/**
22			* Abstracts request resources
23			*
24			* @category PHP
25			* @package WilliamEspindola\AbstractHTTPClient
26			* @author William Espindola <[email protected]>
27			* @copyright Free
28			* @license MIT
29			* @version Release: 1.0.0
30			* @link https://github.com/williamespindola/abstract-http-client-guzzle
31			*/
32			abstract class AbstractRequest
33			{
34			/**
35			* @var array
36			*/
37			protected $config;
38
39			/**
40			* @var Client $httpClient Cliente implementation
41			*/
42			protected $httpClient;
43
44			/**
45			* @var string $baseUrl Base API URL
46			*/
47			protected $baseUrl;
48
49			/**
50			* @var string $uri String that identifies resource
51			*/
52			private $uri;
53
54			/**
55			* Initializes new AbstractNuxeoIntegration
56			*
57			* @param HTTPClient $httpClient HTTP Client implementation
58			* @param string $baseUrl Base API URL
59			*/
60			public function __construct(HTTPClient $httpClient, string $baseUrl)
61			{
62			$this->baseUrl = $baseUrl;
63
64			$this->httpClient = $httpClient;
			1 ignored issue – show Documentation Bug introduced 2017-12-01 02:33 UTC by Report Bug Copy Issue Report It seems like `$httpClient` of type `object<WilliamEspindola\...tHTTPClient\HTTPClient>` is incompatible with the declared type `object<WilliamEspindola\...tractHTTPClient\Client>` of property `$httpClient`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
65			}
66
67			/**
68			* Get URI concatenating base url api with resource end point
69			*
70			* @return string URI end point
71			*
72			* @throws Exception If AbstractRequest::baseUrl or AbstractRequest::uri was empty
73			*/
74			protected function getURI(): string
75			{
76			if (empty($this->baseUrl) \|\| empty($this->uri)) {
77			throw new Exception('Url or end point can not be null');
78			}
79
80			return $this->baseUrl . $this->uri;
81			}
82
83			/**
84			* Set url parameters
85			*
86			* @param array $parameters array with parameters that must be setted
87			*
88			* <code>
89			* $this->setParameters([
90			* ':paramkey' => 'my param value'
91			* ]);
92			* </code>
93			*
94			* @throws InvalidArgumentException If parameters param was empty
95			* @throws Exception If parametes not match with request endPoint
96			*
97			* @return void
98			*/
99			protected function setParameters(array $parameters): void
100			{
101			if (empty($parameters)) {
102			throw new InvalidArgumentException('Parameters can not be null');
103			}
104
105			$this->uri = null;
106
107			foreach ($parameters as $key => $param) {
108			if (preg_match("/{$key}/i", $this->endPoint)) {
109			$this->uri = str_replace($key, $param, $this->endPoint);
			1 ignored issue – show Bug introduced 2017-12-01 02:33 UTC by Report Bug Copy Issue Report The property `endPoint` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
110			}
111			}
112
113			if (empty($this->uri)) {
114			throw new Exception(
115			'Parameters definition not matches with request end point'
116			);
117			}
118			}
119			}
120

williamespindola / abstract-http-client

Push — master ( ca7e72...8276bb )

AbstractRequest::setParameters() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like