BaseGateway::hasClient() - Code Metrics - Inspection of "Add cache for process method `requestCommands`." - vuongxuongminh/yii2-gateway-clients - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( f6a2f3...43b34e )

by Vuong

created 2018-05-08 09:40 UTC

BaseGateway::hasClient() A

↳ Parent: BaseGateway

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php
/**
 * @link https://github.com/vuongxuongminh/yii2-gatewayclients
 * @copyright Copyright (c) 2018 Vuong Xuong Minh
 * @license [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
 */

namespace vxm\gatewayclients;

use Yii;
use ReflectionClass;

use yii\base\Component;
use yii\base\InvalidArgumentException;
use yii\base\InvalidConfigException;
use yii\helpers\ArrayHelper;
use yii\httpclient\Client as HttpClient;


/**
 * Class BaseClient a base class that implements the [[GatewayInterface]].
 * It is an abstraction layer, implements classes will be add more properties to support create request to gateway server api.
 *
 * @property BaseClient $defaultClient
 * @property BaseClient $client
 *
 * @author Vuong Minh <[email protected]>
 * @since 1.0
 */
abstract class BaseGateway extends Component implements GatewayInterface
{

    /**
     * @event RequestEvent an event that is triggered at the beginning of request to gateway server api.
     */
    const EVENT_BEFORE_REQUEST = 'beforeRequest';

    /**
     * @event RequestEvent an event that is triggered at the end of requested to gateway server api.
     */
    const EVENT_AFTER_REQUEST = 'afterRequest';

    /**
     * @var array config use for setup properties of all request data to send to gateway server api. It called by [[request()]].
     */
    public $requestDataConfig;

    /**
     * @var array config use for setup properties of all response data get from gateway server api. It called by [[request()]].
     */
    public $responseDataConfig;

    /**
     * @var array config of client use for setup properties of the clients list.
     */
    public $clientConfig = [];

    /**
     * The clients list.
     *
     * @var array|BaseClient[]
     */
    private $_clients = [];

    /**
     * @inheritdoc
     */
    public function getVersion(): string
    {
        return '1.0';
    }

    /**
     * @inheritdoc
     * @throws InvalidConfigException
     */
    public function getClients(): array
    {
        $clients = [];
        foreach ($this->_clients as $id => $client) {
            $clients[$id] = $this->getClient($id);
        }

        return $clients;
    }

    /**
     * @inheritdoc
     * @throws InvalidConfigException
     */
    public function setClients(array $clients): bool
    {
        foreach ($clients as $id => $client) {
            $this->setClient($id, $client);
        }

        return true;
    }

    /**
     * @inheritdoc
     * @throws InvalidConfigException|InvalidArgumentException
     */
    public function getClient($id = null): ClientInterface
    {
        if ($id === null) {
            return $this->getDefaultClient();
        } elseif ($this->hasClient($id)) {
            $client = $this->_clients[$id];

            if (is_string($client)) {
                $client = ['class' => $client];
            }

            if (is_array($client)) {
                $client = ArrayHelper::merge($this->clientConfig, $client);
            }

            if (!$client instanceof BaseClient) {
                $client = $this->_clients[$id] = Yii::createObject($client, [$this]);
            }

            return $client;
        } else {
            throw new InvalidArgumentException("An id client: `$id` not exist!");
        }
    }

    /**
     * @var BaseClient|ClientInterface The default client value.
     */
    private $_defaultClient;

    /**
     * @inheritdoc
     * @return BaseClient|ClientInterface
     * @throws InvalidConfigException
     */
    public function getDefaultClient(): ClientInterface
    {
        if ($this->_defaultClient === null) {
            if (!empty($this->_clients)) {
                $ids = array_keys($this->_clients);
                $id = array_pop($ids);

                return $this->_defaultClient = $this->getClient($id);
            } else {
                throw new InvalidConfigException('Can not detect default client from an empty client lists!');
            }
        } else {
            return $this->_defaultClient;
        }
    }

    /**
     * @inheritdoc
     * @throws InvalidConfigException
     */
    public function setClient($id, $client = null): bool
    {
        if ($client === null) {
            $this->setDefaultClient($id);
        } else {
            $this->_clients[$id] = $client;
        }

        return true;
    }

    /**
     * @inheritdoc
     * @throws InvalidConfigException
     */
    public function setDefaultClient($client): bool
    {
        array_push($this->_clients, $client);
        $this->_defaultClient = null;
        $this->getDefaultClient();

        return true;
    }

    /**
     * @inheritdoc
     */
    public function hasClient($id): bool
    {
        return array_key_exists($id, $this->_clients);
    }

    /**
     * @inheritdoc
     * @return ResponseData|DataInterface
     * @throws InvalidConfigException|InvalidArgumentException|\ReflectionException
     */
    public function request($command, array $data, $clientId = null): DataInterface
    {
        if (in_array($command, $this->requestCommands(), true)) {
            $client = $this->getClient($clientId);

            /** @var RequestData $requestData */

            $requestData = Yii::createObject($this->requestDataConfig, [$command, $data, $client]);
            $event = Yii::createObject([
                'class' => RequestEvent::class,
                'command' => $command,
                'client' => $client,
                'requestData' => $requestData
            ]);

            $this->beforeRequest($event);
            $httpClient = $this->getHttpClient();
            $data = $this->requestInternal($requestData, $httpClient);
            $responseData = Yii::createObject($this->responseDataConfig, [$command, $data, $client]);
            $event->responseData = $responseData;
            $this->afterRequest($event);
            Yii::debug(__CLASS__ . " requested sent with command: `$command` - version: " . $this->getVersion());

            return $responseData;
        } else {
            throw new InvalidArgumentException("Unknown request command `$command`");
        }
    }

    /**
     * An array store all request commands supported in gateway [[request()]].
     *
     * @see requestCommands
     * @var array
     */
    private $_requestCommands;

    /**
     * This method automatically detect request commands supported via constants name prefix with `RC_`.
     * `RC` meaning Request Command.
     *
     * @return array An array constants value have name prefix with `RC_`
     * @throws \ReflectionException
     */
    public function requestCommands(): array
    {
        if ($this->_requestCommands === null) {
            $reflection = new ReflectionClass($this);

            $commands = [];
            foreach ($reflection->getConstants() as $name => $value) {
                if (strpos($name, 'RC_') === 0) {
                    $commands[] = $value;
                }
            }

            return $this->_requestCommands = $commands;
        } else {
            return $this->_requestCommands;
        }
    }

    /**
     * This method is called at the beginning of requesting data to gateway server api.
     *
     * The default implementation will trigger an [[EVENT_BEFORE_REQUEST]] event.
     * When overriding this method, make sure you call the parent implementation like the following:
     *
     * ```php
     * public function beforeRequest($insert)
     * {
     *     // ...custom code here...
     *
     *     parent::beforeSave($insert);
     * }
     * ```
     *
     * @param RequestEvent $event an event will be trigger in this method.
     */
    public function beforeRequest(RequestEvent $event)
    {
        $this->trigger(self::EVENT_BEFORE_REQUEST, $event);
    }

    /**
     * @var HttpClient will be use to send request to gateway server api.
     */
    private $_httpClient;

    /**
     * This method is called in [[request()]] invoke client and use it make request send to gateway server api.
     *
     * @param bool $force
     * @return object|HttpClient
     * @throws InvalidConfigException
     */
    protected function getHttpClient(bool $force = false): HttpClient
    {
        if ($this->_httpClient === null || $force) {
            /** @var HttpClient $client */

            $client = $this->_httpClient = Yii::createObject(ArrayHelper::merge([
                'class' => HttpClient::class,
                'baseUrl' => $this->getBaseUrl()
            ], $this->getHttpClientConfig()));

            return $client;
        } else {
            return $this->_httpClient;
        }
    }

    /**
     * Returns the config for the HttpClient.
     * An implement class may override this method for add default headers, transport, options...
     *
     * @return array
     */
    protected function getHttpClientConfig(): array
    {
        return [];
    }

    /**
     * An internal method get and send customize data depend on gateway server api. This method called by [[request()]] .
     *
     * @param RequestData $requestData use to get data, command, client for prepare request to send.
     * @param HttpClient $httpClient use for make request to gateway server api.
     * @return array response requested data.
     */
    abstract protected function requestInternal(RequestData $requestData, HttpClient $httpClient): array;


    /**
     * This method is called at the end of requesting data to gateway server api.
     * The default implementation will trigger an [[EVENT_AFTER_REQUEST]] event.
     * When overriding this method, make sure you call the parent implementation at the end so that
     * the event is triggered.
     *
     * @param RequestEvent $event an event will be trigger in this method.
     */
    public function afterRequest(RequestEvent $event)
    {
        $this->trigger(self::EVENT_AFTER_REQUEST, $event);
    }

}


1		<?php
2		/**
3		* @link https://github.com/vuongxuongminh/yii2-gatewayclients
4		* @copyright Copyright (c) 2018 Vuong Xuong Minh
5		* @license [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
6		*/
7
8		namespace vxm\gatewayclients;
9
10		use Yii;
11		use ReflectionClass;
12
13		use yii\base\Component;
14		use yii\base\InvalidArgumentException;
15		use yii\base\InvalidConfigException;
16		use yii\helpers\ArrayHelper;
17		use yii\httpclient\Client as HttpClient;
18
19
20		/**
21		* Class BaseClient a base class that implements the [[GatewayInterface]].
22		* It is an abstraction layer, implements classes will be add more properties to support create request to gateway server api.
23		*
24		* @property BaseClient $defaultClient
25		* @property BaseClient $client
26		*
27		* @author Vuong Minh <[email protected]>
28		* @since 1.0
29		*/
30		abstract class BaseGateway extends Component implements GatewayInterface
31		{
32
33		/**
34		* @event RequestEvent an event that is triggered at the beginning of request to gateway server api.
35		*/
36		const EVENT_BEFORE_REQUEST = 'beforeRequest';
37
38		/**
39		* @event RequestEvent an event that is triggered at the end of requested to gateway server api.
40		*/
41		const EVENT_AFTER_REQUEST = 'afterRequest';
42
43		/**
44		* @var array config use for setup properties of all request data to send to gateway server api. It called by [[request()]].
45		*/
46		public $requestDataConfig;
47
48		/**
49		* @var array config use for setup properties of all response data get from gateway server api. It called by [[request()]].
50		*/
51		public $responseDataConfig;
52
53		/**
54		* @var array config of client use for setup properties of the clients list.
55		*/
56		public $clientConfig = [];
57
58		/**
59		* The clients list.
60		*
61		* @var array\|BaseClient[]
62		*/
63		private $_clients = [];
64
65		/**
66		* @inheritdoc
67		*/
68	5	public function getVersion(): string
69		{
70	5	return '1.0';
71		}
72
73		/**
74		* @inheritdoc
75		* @throws InvalidConfigException
76		*/
77		public function getClients(): array
78		{
79		$clients = [];
80		foreach ($this->_clients as $id => $client) {
81		$clients[$id] = $this->getClient($id);
82		}
83
84		return $clients;
85		}
86
87		/**
88		* @inheritdoc
89		* @throws InvalidConfigException
90		*/
91	2	public function setClients(array $clients): bool
92		{
93	2	foreach ($clients as $id => $client) {
94	2	$this->setClient($id, $client);
95		}
96
97	2	return true;
98		}
99
100		/**
101		* @inheritdoc
102		* @throws InvalidConfigException\|InvalidArgumentException
103		*/
104	14	public function getClient($id = null): ClientInterface
105		{
106	14	if ($id === null) {
107	12	return $this->getDefaultClient();
108	11	} elseif ($this->hasClient($id)) {
109	11	$client = $this->_clients[$id];
110
111	11	if (is_string($client)) {
112		$client = ['class' => $client];
113		}
114
115	11	if (is_array($client)) {
116	10	$client = ArrayHelper::merge($this->clientConfig, $client);
117		}
118
119	11	if (!$client instanceof BaseClient) {
120	10	$client = $this->_clients[$id] = Yii::createObject($client, [$this]);
121		}
122
123	11	return $client;
124		} else {
125		throw new InvalidArgumentException("An id client: `$id` not exist!");
126		}
127		}
128
129		/**
130		* @var BaseClient\|ClientInterface The default client value.
131		*/
132		private $_defaultClient;
133
134		/**
135		* @inheritdoc
136		* @return BaseClient\|ClientInterface
137		* @throws InvalidConfigException
138		*/
139	12	public function getDefaultClient(): ClientInterface
140		{
141	12	if ($this->_defaultClient === null) {
142	12	if (!empty($this->_clients)) {
143	9	$ids = array_keys($this->_clients);
144	9	$id = array_pop($ids);
145
146	9	return $this->_defaultClient = $this->getClient($id);
147		} else {
148	3	throw new InvalidConfigException('Can not detect default client from an empty client lists!');
149		}
150		} else {
151	9	return $this->_defaultClient;
152		}
153		}
154
155		/**
156		* @inheritdoc
157		* @throws InvalidConfigException
158		*/
159	11	public function setClient($id, $client = null): bool
160		{
161	11	if ($client === null) {
162	9	$this->setDefaultClient($id);
163		} else {
164	6	$this->_clients[$id] = $client;
165		}
166
167	11	return true;
168		}
169
170		/**
171		* @inheritdoc
172		* @throws InvalidConfigException
173		*/
174	9	public function setDefaultClient($client): bool
175		{
176	9	array_push($this->_clients, $client);
177	9	$this->_defaultClient = null;
178	9	$this->getDefaultClient();
179
180	9	return true;
181		}
182
183		/**
184		* @inheritdoc
185		*/
186	11	public function hasClient($id): bool
187		{
188	11	return array_key_exists($id, $this->_clients);
189		}
190
191		/**
192		* @inheritdoc
193		* @return ResponseData\|DataInterface
194		* @throws InvalidConfigException\|InvalidArgumentException\|\ReflectionException
195		*/
196	13	public function request($command, array $data, $clientId = null): DataInterface
197		{
198	13	if (in_array($command, $this->requestCommands(), true)) {
199	9	$client = $this->getClient($clientId);
200
201		/** @var RequestData $requestData */
202
203	6	$requestData = Yii::createObject($this->requestDataConfig, [$command, $data, $client]);
204	6	$event = Yii::createObject([
205	6	'class' => RequestEvent::class,
206	6	'command' => $command,
207	6	'client' => $client,
208	6	'requestData' => $requestData
209		]);
210
211	6	$this->beforeRequest($event);
212	6	$httpClient = $this->getHttpClient();
213	6	$data = $this->requestInternal($requestData, $httpClient);
214	5	$responseData = Yii::createObject($this->responseDataConfig, [$command, $data, $client]);
215	5	$event->responseData = $responseData;
216	5	$this->afterRequest($event);
217	5	Yii::debug(__CLASS__ . " requested sent with command: `$command` - version: " . $this->getVersion());
218
219	5	return $responseData;
220		} else {
221	4	throw new InvalidArgumentException("Unknown request command `$command`");
222		}
223		}
224
225		/**
226		* An array store all request commands supported in gateway [[request()]].
227		*
228		* @see requestCommands
229		* @var array
230		*/
231		private $_requestCommands;
232
233		/**
234		* This method automatically detect request commands supported via constants name prefix with `RC_`.
235		* `RC` meaning Request Command.
236		*
237		* @return array An array constants value have name prefix with `RC_`
238		* @throws \ReflectionException
239		*/
240	13	public function requestCommands(): array
241		{
242	13	if ($this->_requestCommands === null) {
243	13	$reflection = new ReflectionClass($this);
244
245	13	$commands = [];
246	13	foreach ($reflection->getConstants() as $name => $value) {
247	13	if (strpos($name, 'RC_') === 0) {
248	13	$commands[] = $value;
249		}
250		}
251
252	13	return $this->_requestCommands = $commands;
253		} else {
254	5	return $this->_requestCommands;
255		}
256		}
257
258		/**
259		* This method is called at the beginning of requesting data to gateway server api.
260		*
261		* The default implementation will trigger an [[EVENT_BEFORE_REQUEST]] event.
262		* When overriding this method, make sure you call the parent implementation like the following:
263		*
264		* ```php
265		* public function beforeRequest($insert)
266		* {
267		* // ...custom code here...
268		*
269		* parent::beforeSave($insert);
270		* }
271		* ```
272		*
273		* @param RequestEvent $event an event will be trigger in this method.
274		*/
275	6	public function beforeRequest(RequestEvent $event)
276		{
277	6	$this->trigger(self::EVENT_BEFORE_REQUEST, $event);
278	6	}
279
280		/**
281		* @var HttpClient will be use to send request to gateway server api.
282		*/
283		private $_httpClient;
284
285		/**
286		* This method is called in [[request()]] invoke client and use it make request send to gateway server api.
287		*
288		* @param bool $force
289		* @return object\|HttpClient
290		* @throws InvalidConfigException
291		*/
292	6	protected function getHttpClient(bool $force = false): HttpClient
293		{
294	6	if ($this->_httpClient === null \|\| $force) {
295		/** @var HttpClient $client */
296
297	6	$client = $this->_httpClient = Yii::createObject(ArrayHelper::merge([
298	6	'class' => HttpClient::class,
299	6	'baseUrl' => $this->getBaseUrl()
300	6	], $this->getHttpClientConfig()));
301
302	6	return $client;
303		} else {
304	5	return $this->_httpClient;
305		}
306		}
307
308		/**
309		* Returns the config for the HttpClient.
310		* An implement class may override this method for add default headers, transport, options...
311		*
312		* @return array
313		*/
314	6	protected function getHttpClientConfig(): array
315		{
316	6	return [];
317		}
318
319		/**
320		* An internal method get and send customize data depend on gateway server api. This method called by [[request()]] .
321		*
322		* @param RequestData $requestData use to get data, command, client for prepare request to send.
323		* @param HttpClient $httpClient use for make request to gateway server api.
324		* @return array response requested data.
325		*/
326		abstract protected function requestInternal(RequestData $requestData, HttpClient $httpClient): array;
327
328
329		/**
330		* This method is called at the end of requesting data to gateway server api.
331		* The default implementation will trigger an [[EVENT_AFTER_REQUEST]] event.
332		* When overriding this method, make sure you call the parent implementation at the end so that
333		* the event is triggered.
334		*
335		* @param RequestEvent $event an event will be trigger in this method.
336		*/
337	5	public function afterRequest(RequestEvent $event)
338		{
339	5	$this->trigger(self::EVENT_AFTER_REQUEST, $event);
340	5	}
341
342		}
343

vuongxuongminh / yii2-gateway-clients

Push — master ( f6a2f3...43b34e )

BaseGateway::hasClient() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like