AbstractResource::getResponseKey() - Code Metrics - Inspection of "Create Action abstraction" - Edwin-Luijten/shopify-client - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — develop ( 1bc728...a00b17 )

by Edwin

created 2017-10-16 09:25 UTC

AbstractResource::getResponseKey() A

↳ Parent: AbstractResource::getParentId()

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	5
cts	5
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	1
crap	2

<?php

namespace ShopifyClient\Resource;

use ShopifyClient\Action\Action;
use ShopifyClient\Action\ActionCollection;
use ShopifyClient\Action\ActionInterface;
use ShopifyClient\Exception\ClientException;
use ShopifyClient\Request;

abstract class AbstractResource
{
    /**
     * @var Request
     */
    protected $request;

    /**
     * @var ActionCollection
     */
    protected $actions = [];

    /**
     * @var array
     */
    protected $childResources = [];

    /**
     * AbstractResource constructor.
     * @param Request $request
     */
    public function __construct(Request $request)
    {
        $this->request = $request;
        $this->actions = new ActionCollection();
    }

    /**
     * @param string $action
     * @return ActionInterface
     * @throws ClientException
     */
    public function getAction(string $action): ActionInterface
    {
        return $this->actions->get($action);
    }

    /**
     * @return Request
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * @param string $action
     * @return bool
     */
    public function hasAction(string $action): bool
    {
        if (!$this->actions->has($action)) {
            return false;
        }

        return true;
    }

    /**
     * @return array
     */
    public function getChildResources(): array
    {
        return $this->childResources;
    }

    /**
     * @param string $action
     * @param float|null $parentId
     * @param float|null $childId
     * @param float|null $childChildId
     * @param array|null $parameters
     * @return array|bool
     */
    protected function request(
        string $action,
        float $parentId = null,
        float $childId = null,
        float $childChildId = null,
        array $parameters = []
    ) {
        $action = $this->getAction($action);

        $this->request->setResponseKey($action->getResponseKey());

        return $this->request->request(
            $action->getMethod(),
            $this->getEndpoint($action, $parentId, $childId, $childChildId),

            $this->getRequestOptions($action, $parameters)

        );
    }

    /**
     * @param Action $action
     * @param float|null $parentId
     * @param float|null $childId
     * @param float|null $childChildId
     * @return string
     * @throws ClientException
     */
    protected function getEndpoint(
        Action $action,
        float $parentId = null,
        float $childId = null,
        float $childChildId = null
    ): string {
        return sprintf($action->getEndpoint(), $parentId, $childId, $childChildId);
    }

    /**
     * @param Action $action
     * @param array $parameters
     * @return array
     */
    private function getRequestOptions(Action $action, array $parameters): array
    {
        $method      = $action->getMethod();
        $resourceKey = $action->getResourceKey();

        if ($method === 'POST' || $method === 'PUT') {
            return strlen($resourceKey) < 1 ? [] : ['body' => json_encode([$resourceKey => $parameters])];
        }

        return [
            'query' => $parameters
        ];
    }

    /**
     * @param string $method
     * @param array|null $arguments
     * @return array|bool
     */
    public function __call(string $method, array $arguments = [])
    {
        return $this->request(
            $method,
            $this->getParentId($arguments),
            $this->getChildId($arguments),
            $this->getChildChildId($arguments),
            $this->getParameters($arguments)
        );
    }

    /**
     * @param array $arguments
     * @return float|null
     */
    private function getParentId(array $arguments)
    {
        $parentId = null;

        if (!empty($arguments[0])) {
            if (is_numeric($arguments[0])) {
                $parentId = $arguments[0];
            }
        }

        return $parentId;
    }

    /**
     * @param array $arguments
     * @return float|null
     */
    private function getChildId(array $arguments)
    {
        $childId = null;

        if (!empty($arguments[1])) {
            if (is_numeric($arguments[1])) {
                $childId = $arguments[1];
            }
        }

        return $childId;
    }

    /**
     * @param array $arguments
     * @return float|null
     */
    private function getChildChildId(array $arguments)
    {
        $childChildId = null;

        if (!empty($arguments[2])) {
            if (is_numeric($arguments[2])) {
                $childChildId = $arguments[2];
            }
        }

        return $childChildId;
    }

    /**
     * @param array $arguments
     * @return array
     */
    private function getParameters(array $arguments): array
    {
        foreach ($arguments as $value) {
            if (is_array($value)) {
                return $value;
            }
        }

        return [];
    }
}


1		<?php
2
3		namespace ShopifyClient\Resource;
4
5		use ShopifyClient\Action\Action;
6		use ShopifyClient\Action\ActionCollection;
7		use ShopifyClient\Action\ActionInterface;
8		use ShopifyClient\Exception\ClientException;
9		use ShopifyClient\Request;
10
11		abstract class AbstractResource
12		{
13		/**
14		* @var Request
15		*/
16		protected $request;
17
18		/**
19		* @var ActionCollection
20		*/
21		protected $actions = [];
22
23		/**
24		* @var array
25		*/
26		protected $childResources = [];
27
28		/**
29		* AbstractResource constructor.
30		* @param Request $request
31		*/
32	5	public function __construct(Request $request)
33		{
34	5	$this->request = $request;
35	5	$this->actions = new ActionCollection();
36	5	}
37
38		/**
39		* @param string $action
40		* @return ActionInterface
41		* @throws ClientException
42		*/
43	133	public function getAction(string $action): ActionInterface
44		{
45	133	return $this->actions->get($action);
46		}
47
48		/**
49		* @return Request
50		*/
51	1	public function getRequest()
52		{
53	1	return $this->request;
54		}
55
56		/**
57		* @param string $action
58		* @return bool
59		*/
60	17	public function hasAction(string $action): bool
61		{
62	17	if (!$this->actions->has($action)) {
63	1	return false;
64		}
65
66	16	return true;
67		}
68
69		/**
70		* @return array
71		*/
72	5	public function getChildResources(): array
73		{
74	5	return $this->childResources;
75		}
76
77		/**
78		* @param string $action
79		* @param float\|null $parentId
80		* @param float\|null $childId
81		* @param float\|null $childChildId
82		* @param array\|null $parameters
83		* @return array\|bool
84		*/
85	133	protected function request(
86		string $action,
87		float $parentId = null,
88		float $childId = null,
89		float $childChildId = null,
90		array $parameters = []
91		) {
92	133	$action = $this->getAction($action);
93
94	130	$this->request->setResponseKey($action->getResponseKey());
95
96	130	return $this->request->request(
97	130	$action->getMethod(),
98	130	$this->getEndpoint($action, $parentId, $childId, $childChildId),
		0 ignored issues – show Compatibility introduced 2017-10-16 09:28 UTC by Report Bug Copy Issue Report `$action` of type `object<ShopifyClient\Action\ActionInterface>` is not a sub-type of `object<ShopifyClient\Action\Action>`. It seems like you assume a concrete implementation of the interface `ShopifyClient\Action\ActionInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
99	130	$this->getRequestOptions($action, $parameters)
		0 ignored issues – show Compatibility introduced 2017-10-16 09:28 UTC by Report Bug Copy Issue Report `$action` of type `object<ShopifyClient\Action\ActionInterface>` is not a sub-type of `object<ShopifyClient\Action\Action>`. It seems like you assume a concrete implementation of the interface `ShopifyClient\Action\ActionInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
100		);
101		}
102
103		/**
104		* @param Action $action
105		* @param float\|null $parentId
106		* @param float\|null $childId
107		* @param float\|null $childChildId
108		* @return string
109		* @throws ClientException
110		*/
111	130	protected function getEndpoint(
112		Action $action,
113		float $parentId = null,
114		float $childId = null,
115		float $childChildId = null
116		): string {
117	130	return sprintf($action->getEndpoint(), $parentId, $childId, $childChildId);
118		}
119
120		/**
121		* @param Action $action
122		* @param array $parameters
123		* @return array
124		*/
125	130	private function getRequestOptions(Action $action, array $parameters): array
126		{
127	130	$method = $action->getMethod();
128	130	$resourceKey = $action->getResourceKey();
129
130	130	if ($method === 'POST' \|\| $method === 'PUT') {
131	52	return strlen($resourceKey) < 1 ? [] : ['body' => json_encode([$resourceKey => $parameters])];
132		}
133
134		return [
135	82	'query' => $parameters
136		];
137		}
138
139		/**
140		* @param string $method
141		* @param array\|null $arguments
142		* @return array\|bool
143		*/
144	133	public function __call(string $method, array $arguments = [])
145		{
146	133	return $this->request(
147	133	$method,
148	133	$this->getParentId($arguments),
149	133	$this->getChildId($arguments),
150	133	$this->getChildChildId($arguments),
151	133	$this->getParameters($arguments)
152		);
153		}
154
155		/**
156		* @param array $arguments
157		* @return float\|null
158		*/
159	133	private function getParentId(array $arguments)
160		{
161	133	$parentId = null;
162
163	133	if (!empty($arguments[0])) {
164	127	if (is_numeric($arguments[0])) {
165	109	$parentId = $arguments[0];
166		}
167		}
168
169	133	return $parentId;
170		}
171
172		/**
173		* @param array $arguments
174		* @return float\|null
175		*/
176	133	private function getChildId(array $arguments)
177		{
178	133	$childId = null;
179
180	133	if (!empty($arguments[1])) {
181	75	if (is_numeric($arguments[1])) {
182	46	$childId = $arguments[1];
183		}
184		}
185
186	133	return $childId;
187		}
188
189		/**
190		* @param array $arguments
191		* @return float\|null
192		*/
193	133	private function getChildChildId(array $arguments)
194		{
195	133	$childChildId = null;
196
197	133	if (!empty($arguments[2])) {
198	24	if (is_numeric($arguments[2])) {
199	8	$childChildId = $arguments[2];
200		}
201		}
202
203	133	return $childChildId;
204		}
205
206		/**
207		* @param array $arguments
208		* @return array
209		*/
210	133	private function getParameters(array $arguments): array
211		{
212	133	foreach ($arguments as $value) {
213	128	if (is_array($value)) {
214	128	return $value;
215		}
216		}
217
218	83	return [];
219		}
220		}
221

Edwin-Luijten / shopify-client

Push — develop ( 1bc728...a00b17 )

AbstractResource::getResponseKey() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like