IpClient::setDataMapper() - Code Metrics - Inspection of "修改缓存位置" - DuC-cnZj/ip - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 37d7ff...4e50f6 )

by du

created 2019-01-12 09:22 UTC

IpClient::setDataMapper() A

↳ Parent: IpClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

namespace DucCnzj\Ip;

use DucCnzj\Ip\Imp\IpImp;
use DucCnzj\Ip\Imp\DataMapImp;
use DucCnzj\Ip\Imp\CacheStoreImp;
use DucCnzj\Ip\Imp\RequestHandlerImp;
use DucCnzj\Ip\Exceptions\InvalidIpAddress;
use DucCnzj\Ip\Exceptions\ServerErrorException;
use DucCnzj\Ip\Exceptions\IpProviderClassNotExistException;

/**
 * @method string getCity()
 * @method string getCountry()
 * @method string getAddress()
 * @method string getRegion()
 *
 * Class IpClient
 *
 * @package DucCnzj\Ip
 */
class IpClient
{
    /**
     * @var string
     */
    protected $ip;

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

    /**
     * @var array|null ['baidu', 'taobao']
     */
    protected $providers = [];

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

    /**
     * @var DataMapImp
     */
    protected $dataMapper;

    /**
     * @var RequestHandlerImp|null
     */
    protected $requestHandler;

    /**
     * @param int $times
     *
     * @return $this
     *
     * @author duc <[email protected]>
     */
    public function try(int $times)
    {
        $this->requestHandler = $this->getRequestHandler()->setTryTimes($times);

        return $this;
    }

    /**
     * @param string $ip
     *
     * @throws InvalidIpAddress
     *
     * @author duc <[email protected]>
     */
    public function checkIp(string $ip)
    {
        $b = preg_match("/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/", $ip);

        if (! $b) {
            throw new InvalidIpAddress;
        }
    }

    /**
     * @return array
     *
     * @author duc <[email protected]>
     */
    public function resolveProviders()
    {
        $providerInstance = [];

        foreach ($this->getProviders() as $provider) {
            if (! isset($this->instances[$provider])) {
                $this->instances[$provider] = $this->createProvider($provider);
            }

            $providerInstance[$provider] = $this->instances[$provider];
        }

        return $providerInstance;
    }

    /**
     * @param string $provider
     *
     * @return IpImp
     * @throws IpProviderClassNotExistException
     *
     * @author duc <[email protected]>
     */
    public function createProvider(string $provider)
    {
        $config = $this->getProviderConfig($provider);

        $shortName = ucfirst(strtolower($provider)) . 'Ip';

        $class = __NAMESPACE__ . "\Strategies\\{$shortName}";

        if (! class_exists($class)) {
            throw new IpProviderClassNotExistException("{$class} 不存在");
        }

        return new $class($config);
    }

    /**
     * @param string $msg
     *
     * @return array
     *
     * @author duc <[email protected]>
     */
    public function responseWithError(string $msg)
    {
        return [
            'success' => 0,
            'message' => $msg,
        ];
    }

    /**
     * @return DataMapper|DataMapImp|NullDataMapper
     *
     * @author duc <[email protected]>
     */
    public function getDataMapper()
    {
        $response = $this->getOriginalInfo();

        if (! $response['success']) {
            return (new NullDataMapper())->setInfo(['ip' => $this->getIp()]);
        }

        if (! $this->dataMapper) {
            $this->dataMapper = new DataMapper();

            return $this->dataMapper->setInfo($response);
        }

        return $this->dataMapper->setInfo($response);
    }

    /**
     * @return RequestHandlerImp|RequestHandler|null
     *
     * @author duc <[email protected]>
     */
    public function getRequestHandler()
    {
        if (! $this->requestHandler) {
            return $this->requestHandler = new RequestHandler();
        }

        return $this->requestHandler;
    }

    /**
     * @return array|mixed
     *
     * @author duc <[email protected]>
     */
    public function getOriginalInfo()
    {
        try {
            $result = $this->getRequestHandler()
                ->send($this->resolveProviders(), $this->getIp());
        } catch (ServerErrorException $e) {
            return $this->responseWithError($e->getMessage());
        }

        return $result;
    }

    /**
     * @return array
     *
     * @author duc <[email protected]>
     */
    public function getErrors(): array
    {
        return $this->getRequestHandler()->getErrors();
    }

    /**
     * @return array
     *
     * @author duc <[email protected]>
     */
    public function getProviders()
    {
        if (is_null($this->providers)) {
            return [];
        }

        if (count($this->providers) === 0) {
            return $this->providers = $this->getDefaultProviders();
        }

        return $this->providers;
    }

    /**
     * @return string
     * @throws \Exception
     *
     * @author duc <[email protected]>
     */
    public function getIp()
    {
        if (! $this->ip) {
            throw new \Exception('请先设置 ip');
        }

        return $this->ip;
    }

    /**
     * @return array
     *
     * @author duc <[email protected]>
     */
    public function getDefaultProviders()
    {
        return [
            'baidu',
            'ali',
            'tencent',
            'taobao',
        ];
    }

    /**
     * @param string $provider
     *
     * @return array|string
     */
    public function getProviderConfig(string $provider)
    {
        if (! isset($this->providerConfig[$provider])) {
            return [];
        }

        return $this->providerConfig[$provider];
    }

    /**
     * @return CacheStore|CacheStoreImp
     *
     * @author duc <[email protected]>
     */
    public function getCacheStore()
    {
        return $this->getRequestHandler()->getCacheStore();
    }

    /**
     * @param string $ip
     *
     * @return $this
     *
     * @author duc <[email protected]>
     */
    public function setIp(string $ip)
    {
        $this->checkIp($ip);

        $this->ip = $ip;

        return $this;
    }

    /**
     * @param string[] ...$provider
     *
     * @return $this
     *
     * @author duc <[email protected]>
     */
    public function useProvider(string ...$provider)
    {
        $providers = array_merge($this->providers ?? [], array_filter($provider));
        $this->providers = array_unique($providers);

        return $this;
    }

    /**
     * @param string $provider
     * @param array|string $config
     *
     * @return $this
     *
     * @author duc <[email protected]>
     */
    public function setProviderConfig(string $provider, $config)
    {
        $this->providerConfig[$provider] = $config;

        return $this;
    }

    /**
     * @param DataMapImp $dataMapper
     *
     * @return $this
     *
     * @author duc <[email protected]>
     */
    public function setDataMapper(DataMapImp $dataMapper)
    {
        $this->dataMapper = $dataMapper;

        return $this;
    }

    /**
     * @param RequestHandlerImp $requestHandler
     *
     * @return $this
     *
     * @author duc <[email protected]>
     */
    public function setRequestHandler(RequestHandlerImp $requestHandler)
    {
        $this->requestHandler = $requestHandler;

        return $this;
    }

    /**
     * @param CacheStoreImp $cacheStore
     *
     * @return $this
     *
     * @author duc <[email protected]>
     */
    public function setCacheStore(CacheStoreImp $cacheStore)
    {
        $this->requestHandler = $this->getRequestHandler()->setCacheStore($cacheStore);

        return $this;
    }

    /**
     * @param string $provider
     * @param IpImp  $instance
     *
     * @return $this
     *
     * @author duc <[email protected]>
     */
    public function bound(string $provider, IpImp $instance)
    {
        $this->instances[$provider] = $instance;

        return $this;
    }

    /**
     * @param string[] ...$provider
     *
     * @return IpClient
     *
     * @author duc <[email protected]>
     */
    public function use(string ...$provider)
    {
        return $this->useProvider(...$provider);
    }

    /**
     * @return $this
     *
     * @author duc <[email protected]>
     */
    public function clearUse()
    {
        $this->providers = null;

        return $this;
    }

    /**
     * @param string $name
     *
     * @return mixed|null
     *
     * @author duc <[email protected]>
     */
    public function getInstanceByName(string $name)
    {
        return isset($this->instances[$name]) ? $this->instances[$name] : null;
    }

    /**
     * @param string $name
     * @param $arguments
     *
     * @return array
     *
     * @author duc <[email protected]>
     */
    public function __call(string $name, $arguments)
    {
        return $this->getDataMapper()->{$name}(...$arguments);
    }

    /**
     * @param string $name
     *
     * @return mixed|string
     *
     * @author duc <[email protected]>
     */
    public function __get(string $name)
    {
        return $this->getDataMapper()->{$name};
    }
}


1		<?php
2
3		namespace DucCnzj\Ip;
4
5		use DucCnzj\Ip\Imp\IpImp;
6		use DucCnzj\Ip\Imp\DataMapImp;
7		use DucCnzj\Ip\Imp\CacheStoreImp;
8		use DucCnzj\Ip\Imp\RequestHandlerImp;
9		use DucCnzj\Ip\Exceptions\InvalidIpAddress;
10		use DucCnzj\Ip\Exceptions\ServerErrorException;
11		use DucCnzj\Ip\Exceptions\IpProviderClassNotExistException;
12
13		/**
14		* @method string getCity()
15		* @method string getCountry()
16		* @method string getAddress()
17		* @method string getRegion()
18		*
19		* Class IpClient
20		*
21		* @package DucCnzj\Ip
22		*/
23		class IpClient
24		{
25		/**
26		* @var string
27		*/
28		protected $ip;
29
30		/**
31		* @var array
32		*/
33		protected $providerConfig = [];
34
35		/**
36		* @var array\|null ['baidu', 'taobao']
37		*/
38		protected $providers = [];
39
40		/**
41		* @var array
42		*/
43		protected $instances = [];
44
45		/**
46		* @var DataMapImp
47		*/
48		protected $dataMapper;
49
50		/**
51		* @var RequestHandlerImp\|null
52		*/
53		protected $requestHandler;
54
55		/**
56		* @param int $times
57		*
58		* @return $this
59		*
60		* @author duc <[email protected]>
61		*/
62	5	public function try(int $times)
63		{
64	5	$this->requestHandler = $this->getRequestHandler()->setTryTimes($times);
65
66	5	return $this;
67		}
68
69		/**
70		* @param string $ip
71		*
72		* @throws InvalidIpAddress
73		*
74		* @author duc <[email protected]>
75		*/
76	14	public function checkIp(string $ip)
77		{
78	14	$b = preg_match("/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/", $ip);
79
80	14	if (! $b) {
81	1	throw new InvalidIpAddress;
82		}
83	13	}
84
85		/**
86		* @return array
87		*
88		* @author duc <[email protected]>
89		*/
90	11	public function resolveProviders()
91		{
92	11	$providerInstance = [];
93
94	11	foreach ($this->getProviders() as $provider) {
95	11	if (! isset($this->instances[$provider])) {
96	4	$this->instances[$provider] = $this->createProvider($provider);
97		}
98
99	10	$providerInstance[$provider] = $this->instances[$provider];
100		}
101
102	10	return $providerInstance;
103		}
104
105		/**
106		* @param string $provider
107		*
108		* @return IpImp
109		* @throws IpProviderClassNotExistException
110		*
111		* @author duc <[email protected]>
112		*/
113	4	public function createProvider(string $provider)
114		{
115	4	$config = $this->getProviderConfig($provider);
116
117	4	$shortName = ucfirst(strtolower($provider)) . 'Ip';
118
119	4	$class = __NAMESPACE__ . "\Strategies\\{$shortName}";
120
121	4	if (! class_exists($class)) {
122	1	throw new IpProviderClassNotExistException("{$class} 不存在");
123		}
124
125	3	return new $class($config);
126		}
127
128		/**
129		* @param string $msg
130		*
131		* @return array
132		*
133		* @author duc <[email protected]>
134		*/
135	5	public function responseWithError(string $msg)
136		{
137		return [
138	5	'success' => 0,
139	5	'message' => $msg,
140		];
141		}
142
143		/**
144		* @return DataMapper\|DataMapImp\|NullDataMapper
145		*
146		* @author duc <[email protected]>
147		*/
148	6	public function getDataMapper()
149		{
150	6	$response = $this->getOriginalInfo();
151
152	6	if (! $response['success']) {
153	4	return (new NullDataMapper())->setInfo(['ip' => $this->getIp()]);
154		}
155
156	2	if (! $this->dataMapper) {
157	2	$this->dataMapper = new DataMapper();
158
159	2	return $this->dataMapper->setInfo($response);
160		}
161
162	1	return $this->dataMapper->setInfo($response);
163		}
164
165		/**
166		* @return RequestHandlerImp\|RequestHandler\|null
167		*
168		* @author duc <[email protected]>
169		*/
170	10	public function getRequestHandler()
171		{
172	10	if (! $this->requestHandler) {
173	8	return $this->requestHandler = new RequestHandler();
174		}
175
176	6	return $this->requestHandler;
177		}
178
179		/**
180		* @return array\|mixed
181		*
182		* @author duc <[email protected]>
183		*/
184	8	public function getOriginalInfo()
185		{
186		try {
187	8	$result = $this->getRequestHandler()
188	8	->send($this->resolveProviders(), $this->getIp());
189	5	} catch (ServerErrorException $e) {
190	5	return $this->responseWithError($e->getMessage());
191		}
192
193	4	return $result;
194		}
195
196		/**
197		* @return array
198		*
199		* @author duc <[email protected]>
200		*/
201	2	public function getErrors(): array
202		{
203	2	return $this->getRequestHandler()->getErrors();
204		}
205
206		/**
207		* @return array
208		*
209		* @author duc <[email protected]>
210		*/
211	14	public function getProviders()
212		{
213	14	if (is_null($this->providers)) {
214	1	return [];
215		}
216
217	14	if (count($this->providers) === 0) {
218	5	return $this->providers = $this->getDefaultProviders();
219		}
220
221	10	return $this->providers;
222		}
223
224		/**
225		* @return string
226		* @throws \Exception
227		*
228		* @author duc <[email protected]>
229		*/
230	14	public function getIp()
231		{
232	14	if (! $this->ip) {
233	1	throw new \Exception('请先设置 ip');
234		}
235
236	13	return $this->ip;
237		}
238
239		/**
240		* @return array
241		*
242		* @author duc <[email protected]>
243		*/
244	5	public function getDefaultProviders()
245		{
246		return [
247	5	'baidu',
248		'ali',
249		'tencent',
250		'taobao',
251		];
252		}
253
254		/**
255		* @param string $provider
256		*
257		* @return array\|string
258		*/
259	5	public function getProviderConfig(string $provider)
260		{
261	5	if (! isset($this->providerConfig[$provider])) {
262	5	return [];
263		}
264
265	1	return $this->providerConfig[$provider];
266		}
267
268		/**
269		* @return CacheStore\|CacheStoreImp
270		*
271		* @author duc <[email protected]>
272		*/
273	8	public function getCacheStore()
274		{
275	8	return $this->getRequestHandler()->getCacheStore();
276		}
277
278		/**
279		* @param string $ip
280		*
281		* @return $this
282		*
283		* @author duc <[email protected]>
284		*/
285	13	public function setIp(string $ip)
286		{
287	13	$this->checkIp($ip);
288
289	13	$this->ip = $ip;
290
291	13	return $this;
292		}
293
294		/**
295		* @param string[] ...$provider
296		*
297		* @return $this
298		*
299		* @author duc <[email protected]>
300		*/
301	10	public function useProvider(string ...$provider)
302		{
303	10	$providers = array_merge($this->providers ?? [], array_filter($provider));
304	10	$this->providers = array_unique($providers);
305
306	10	return $this;
307		}
308
309		/**
310		* @param string $provider
311		* @param array\|string $config
312		*
313		* @return $this
314		*
315		* @author duc <[email protected]>
316		*/
317	2	public function setProviderConfig(string $provider, $config)
318		{
319	2	$this->providerConfig[$provider] = $config;
320
321	2	return $this;
322		}
323
324		/**
325		* @param DataMapImp $dataMapper
326		*
327		* @return $this
328		*
329		* @author duc <[email protected]>
330		*/
331	1	public function setDataMapper(DataMapImp $dataMapper)
332		{
333	1	$this->dataMapper = $dataMapper;
334
335	1	return $this;
336		}
337
338		/**
339		* @param RequestHandlerImp $requestHandler
340		*
341		* @return $this
342		*
343		* @author duc <[email protected]>
344		*/
345	2	public function setRequestHandler(RequestHandlerImp $requestHandler)
346		{
347	2	$this->requestHandler = $requestHandler;
348
349	2	return $this;
350		}
351
352		/**
353		* @param CacheStoreImp $cacheStore
354		*
355		* @return $this
356		*
357		* @author duc <[email protected]>
358		*/
359	2	public function setCacheStore(CacheStoreImp $cacheStore)
360		{
361	2	$this->requestHandler = $this->getRequestHandler()->setCacheStore($cacheStore);
362
363	2	return $this;
364		}
365
366		/**
367		* @param string $provider
368		* @param IpImp $instance
369		*
370		* @return $this
371		*
372		* @author duc <[email protected]>
373		*/
374	9	public function bound(string $provider, IpImp $instance)
375		{
376	9	$this->instances[$provider] = $instance;
377
378	9	return $this;
379		}
380
381		/**
382		* @param string[] ...$provider
383		*
384		* @return IpClient
385		*
386		* @author duc <[email protected]>
387		*/
388	4	public function use(string ...$provider)
389		{
390	4	return $this->useProvider(...$provider);
391		}
392
393		/**
394		* @return $this
395		*
396		* @author duc <[email protected]>
397		*/
398	2	public function clearUse()
399		{
400	2	$this->providers = null;
401
402	2	return $this;
403		}
404
405		/**
406		* @param string $name
407		*
408		* @return mixed\|null
409		*
410		* @author duc <[email protected]>
411		*/
412	1	public function getInstanceByName(string $name)
413		{
414	1	return isset($this->instances[$name]) ? $this->instances[$name] : null;
415		}
416
417		/**
418		* @param string $name
419		* @param $arguments
420		*
421		* @return array
422		*
423		* @author duc <[email protected]>
424		*/
425		public function __call(string $name, $arguments)
426		{
427		return $this->getDataMapper()->{$name}(...$arguments);
428		}
429
430		/**
431		* @param string $name
432		*
433		* @return mixed\|string
434		*
435		* @author duc <[email protected]>
436		*/
437		public function __get(string $name)
438		{
439		return $this->getDataMapper()->{$name};
440		}
441		}
442

DuC-cnZj / ip

Push — master ( 37d7ff...4e50f6 )

IpClient::setDataMapper() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like