ApiClient::getRunesApi() - Code Metrics - Babacooll/lol-api - Measure and Improve Code Quality continuously with Scrutinizer

ApiClient::getRunesApi() A
last analyzed 2019-06-18 19:54 UTC

↳ Parent: ApiClient

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

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

<?php

namespace LoLApi;

use GuzzleHttp\Client;
use LoLApi\Api\ChampionApi;
use LoLApi\Api\ChampionMasteryApi;
use LoLApi\Api\SpectatorApi;
use LoLApi\Api\LeagueApi;
use LoLApi\Api\MasteryApi;
use LoLApi\Api\MatchApi;
use LoLApi\Api\RuneApi;
use LoLApi\Api\StaticDataApi;
use LoLApi\Api\StatusApi;
use LoLApi\Api\SummonerApi;
use LoLApi\Exception\InvalidRegionException;
use LoLApi\Result\ApiResult;
use Symfony\Component\Cache\Adapter\AdapterInterface;
use Symfony\Component\Cache\Adapter\ArrayAdapter;
use Symfony\Component\Cache\Adapter\NullAdapter;

/**
 * Class ApiClient
 *
 * @package LoLApi
 */
class ApiClient
{
    const REGION_BR   = 'br';
    const REGION_EUNE = 'eune';
    const REGION_EUW  = 'euw';
    const REGION_JP   = 'jp';
    const REGION_KR   = 'kr';
    const REGION_LAN  = 'lan';
    const REGION_LAS  = 'las';
    const REGION_NA   = 'na';
    const REGION_OCE  = 'oce';
    const REGION_TR   = 'tr';
    const REGION_RU   = 'ru';

    const REGION_BR_ID   = 'br1';
    const REGION_EUNE_ID = 'eun1';
    const REGION_EUW_ID  = 'euw1';
    const REGION_JP_ID   = 'jp1';
    const REGION_KR_ID   = 'kr';
    const REGION_LAN_ID  = 'la1';
    const REGION_LAS_ID  = 'la2';
    const REGION_NA_ID   = 'na1';
    const REGION_OCE_ID  = 'oc1';
    const REGION_TR_ID   = 'tr1';
    const REGION_RU_ID   = 'ru';

    /**
     * @var array
     */
    public static $availableRegions = [
        self::REGION_BR,
        self::REGION_EUNE,
        self::REGION_EUW,
        self::REGION_JP,
        self::REGION_KR,
        self::REGION_LAN,
        self::REGION_LAS,
        self::REGION_NA,
        self::REGION_OCE,
        self::REGION_RU,
        self::REGION_TR,
    ];

    public static $regionsWithIds = [
        self::REGION_BR   => self::REGION_BR_ID,
        self::REGION_EUNE => self::REGION_EUNE_ID,
        self::REGION_EUW  => self::REGION_EUW_ID,
        self::REGION_JP   => self::REGION_JP_ID,
        self::REGION_KR   => self::REGION_KR_ID,
        self::REGION_LAN  => self::REGION_LAN_ID,
        self::REGION_LAS  => self::REGION_LAS_ID,
        self::REGION_NA   => self::REGION_NA_ID,
        self::REGION_OCE  => self::REGION_OCE_ID,
        self::REGION_RU   => self::REGION_RU_ID,
        self::REGION_TR   => self::REGION_TR_ID,
    ];

    /**
     * @var string
     */
    protected $region;

    /**
     * @var string
     */
    protected $apiKey;

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

    /**
     * @var AdapterInterface
     */
    protected $cacheProvider;

    /**
     * @param string          $region
     * @param string          $apiKey
     * @param AdapterInterface $cache
     * @param Client          $client
     *
     * @throws InvalidRegionException
     */
    public function __construct($region, $apiKey, AdapterInterface $cache = null, Client $client = null)
    {
        if (!in_array($region, self::$availableRegions)) {
            throw new InvalidRegionException(sprintf('Invalid region %s', $region));
        }

        $this->region     = $region;
        $this->httpClient = $client ? $client : new Client();
        $this->apiKey     = $apiKey;
        $this->cache      = $cache ? $cache : new NullAdapter();
class MyClass { }

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

    /**
     * @param AdapterInterface $cache
     */
    public function setCacheProvider(AdapterInterface $cache)
    {
        $this->cache = $cache;
    }

    /**
     * @return AdapterInterface
     */
    public function getCacheProvider()
    {
        return $this->cache;
    }

    /**
     * @return Client
     */
    public function getHttpClient()
    {
        return $this->httpClient;
    }

    /**
     * @return string
     */
    public function getRegion()
    {
        return $this->region;
    }

    /**
     * @return string
     */
    public function getApiKey()
    {
        return $this->apiKey;
    }

    /**
     * @return MatchApi
     */
    public function getMatchApi()
    {
        return new MatchApi($this);
    }

    /**
     * @return SummonerApi
     */
    public function getSummonerApi()
    {
        return new SummonerApi($this);
    }

    /**
     * @return ChampionApi
     */
    public function getChampionApi()
    {
        return new ChampionApi($this);
    }

    /**
     * @return SpectatorApi
     */
    public function getFeaturedGamesApi()
    {
        return new SpectatorApi($this);
    }

    /**
     * @return MasteryApi
     */
    public function getMasteriesApi()
    {
        return new MasteryApi($this);
    }

    /**
     * @return RuneApi
     */
    public function getRunesApi()
    {
        return new RuneApi($this);
    }

    /**
     * @return SpectatorApi
     */
    public function getSpectatorApi()
    {
        return new SpectatorApi($this);
    }

    /**
     * @return LeagueApi
     */
    public function getLeagueApi()
    {
        return new LeagueApi($this);
    }

    /**
     * @return StaticDataApi
     */
    public function getStaticDataApi()
    {
        return new StaticDataApi($this);
    }

    /**
     * @return StatusApi
     */
    public function getStatusApi()
    {
        return new StatusApi($this);
    }

    /**
     * @return ChampionMasteryApi
     */
    public function getChampionMasteryApi()
    {
        return new ChampionMasteryApi($this);
    }

    /**
     * @return string
     */
    public function getBaseUrl()
    {
        return 'https://'.self::$regionsWithIds[$this->region].'.api.riotgames.com';
    }

    /**
     * @param ApiResult $apiResult
     * @param int       $ttl
     */
    public function cacheApiResult(ApiResult $apiResult, $ttl = 60)
    {
        $cacheKey = md5($apiResult->getUrl());

        $item = $this->cache->getItem($cacheKey);

        if (!$item->isHit()) {
           $item->set(json_encode($apiResult->getResult()));
           $item->expiresAfter($ttl);
           $this->cache->save($item);
        }
    }
}


1		<?php
2
3		namespace LoLApi;
4
5		use GuzzleHttp\Client;
6		use LoLApi\Api\ChampionApi;
7		use LoLApi\Api\ChampionMasteryApi;
8		use LoLApi\Api\SpectatorApi;
9		use LoLApi\Api\LeagueApi;
10		use LoLApi\Api\MasteryApi;
11		use LoLApi\Api\MatchApi;
12		use LoLApi\Api\RuneApi;
13		use LoLApi\Api\StaticDataApi;
14		use LoLApi\Api\StatusApi;
15		use LoLApi\Api\SummonerApi;
16		use LoLApi\Exception\InvalidRegionException;
17		use LoLApi\Result\ApiResult;
18		use Symfony\Component\Cache\Adapter\AdapterInterface;
19		use Symfony\Component\Cache\Adapter\ArrayAdapter;
20		use Symfony\Component\Cache\Adapter\NullAdapter;
21
22		/**
23		* Class ApiClient
24		*
25		* @package LoLApi
26		*/
27		class ApiClient
28		{
29		const REGION_BR = 'br';
30		const REGION_EUNE = 'eune';
31		const REGION_EUW = 'euw';
32		const REGION_JP = 'jp';
33		const REGION_KR = 'kr';
34		const REGION_LAN = 'lan';
35		const REGION_LAS = 'las';
36		const REGION_NA = 'na';
37		const REGION_OCE = 'oce';
38		const REGION_TR = 'tr';
39		const REGION_RU = 'ru';
40
41		const REGION_BR_ID = 'br1';
42		const REGION_EUNE_ID = 'eun1';
43		const REGION_EUW_ID = 'euw1';
44		const REGION_JP_ID = 'jp1';
45		const REGION_KR_ID = 'kr';
46		const REGION_LAN_ID = 'la1';
47		const REGION_LAS_ID = 'la2';
48		const REGION_NA_ID = 'na1';
49		const REGION_OCE_ID = 'oc1';
50		const REGION_TR_ID = 'tr1';
51		const REGION_RU_ID = 'ru';
52
53		/**
54		* @var array
55		*/
56		public static $availableRegions = [
57		self::REGION_BR,
58		self::REGION_EUNE,
59		self::REGION_EUW,
60		self::REGION_JP,
61		self::REGION_KR,
62		self::REGION_LAN,
63		self::REGION_LAS,
64		self::REGION_NA,
65		self::REGION_OCE,
66		self::REGION_RU,
67		self::REGION_TR,
68		];
69
70		public static $regionsWithIds = [
71		self::REGION_BR => self::REGION_BR_ID,
72		self::REGION_EUNE => self::REGION_EUNE_ID,
73		self::REGION_EUW => self::REGION_EUW_ID,
74		self::REGION_JP => self::REGION_JP_ID,
75		self::REGION_KR => self::REGION_KR_ID,
76		self::REGION_LAN => self::REGION_LAN_ID,
77		self::REGION_LAS => self::REGION_LAS_ID,
78		self::REGION_NA => self::REGION_NA_ID,
79		self::REGION_OCE => self::REGION_OCE_ID,
80		self::REGION_RU => self::REGION_RU_ID,
81		self::REGION_TR => self::REGION_TR_ID,
82		];
83
84		/**
85		* @var string
86	3	*/
87		protected $region;
88	3
89	1	/**
90		* @var string
91		*/
92	2	protected $apiKey;
93	2
94	2	/**
95	2	* @var Client
96	2	*/
97		protected $httpClient;
98
99		/**
100		* @var AdapterInterface
101	1	*/
102		protected $cacheProvider;
103	1
104	1	/**
105		* @param string $region
106		* @param string $apiKey
107		* @param AdapterInterface $cache
108		* @param Client $client
109	1	*
110		* @throws InvalidRegionException
111	1	*/
112		public function __construct($region, $apiKey, AdapterInterface $cache = null, Client $client = null)
113		{
114		if (!in_array($region, self::$availableRegions)) {
115		throw new InvalidRegionException(sprintf('Invalid region %s', $region));
116		}
117	1
118		$this->region = $region;
119	1	$this->httpClient = $client ? $client : new Client();
120		$this->apiKey = $apiKey;
121		$this->cache = $cache ? $cache : new NullAdapter();
		0 ignored issues – show Bug introduced 2017-05-23 11:58 UTC by Report Bug Copy Issue Report The property `cache` 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...
122		}
123
124		/**
125	1	* @param AdapterInterface $cache
126		*/
127	1	public function setCacheProvider(AdapterInterface $cache)
128		{
129		$this->cache = $cache;
130		}
131
132		/**
133	1	* @return AdapterInterface
134		*/
135	1	public function getCacheProvider()
136		{
137		return $this->cache;
138		}
139
140		/**
141	1	* @return Client
142		*/
143	1	public function getHttpClient()
144		{
145		return $this->httpClient;
146		}
147
148		/**
149	1	* @return string
150		*/
151	1	public function getRegion()
152		{
153		return $this->region;
154		}
155
156		/**
157	1	* @return string
158		*/
159	1	public function getApiKey()
160		{
161		return $this->apiKey;
162		}
163
164		/**
165	1	* @return MatchApi
166		*/
167	1	public function getMatchApi()
168		{
169		return new MatchApi($this);
170		}
171
172		/**
173	1	* @return SummonerApi
174		*/
175	1	public function getSummonerApi()
176		{
177		return new SummonerApi($this);
178		}
179
180		/**
181	1	* @return ChampionApi
182		*/
183	1	public function getChampionApi()
184		{
185		return new ChampionApi($this);
186		}
187
188		/**
189	1	* @return SpectatorApi
190		*/
191	1	public function getFeaturedGamesApi()
192		{
193		return new SpectatorApi($this);
194		}
195
196		/**
197	1	* @return MasteryApi
198		*/
199	1	public function getMasteriesApi()
200		{
201		return new MasteryApi($this);
202		}
203
204		/**
205	1	* @return RuneApi
206		*/
207	1	public function getRunesApi()
208		{
209		return new RuneApi($this);
210		}
211
212		/**
213	1	* @return SpectatorApi
214		*/
215	1	public function getSpectatorApi()
216		{
217		return new SpectatorApi($this);
218		}
219
220		/**
221	1	* @return LeagueApi
222		*/
223	1	public function getLeagueApi()
224		{
225		return new LeagueApi($this);
226		}
227
228		/**
229	1	* @return StaticDataApi
230		*/
231	1	public function getStaticDataApi()
232		{
233		return new StaticDataApi($this);
234		}
235
236		/**
237	1	* @return StatusApi
238		*/
239	1	public function getStatusApi()
240		{
241		return new StatusApi($this);
242		}
243
244		/**
245	1	* @return ChampionMasteryApi
246		*/
247	1	public function getChampionMasteryApi()
248		{
249		return new ChampionMasteryApi($this);
250		}
251
252		/**
253	1	* @return string
254		*/
255	1	public function getBaseUrl()
256		{
257		return 'https://'.self::$regionsWithIds[$this->region].'.api.riotgames.com';
258		}
259
260		/**
261	1	* @param ApiResult $apiResult
262		* @param int $ttl
263	1	*/
264		public function cacheApiResult(ApiResult $apiResult, $ttl = 60)
265		{
266		$cacheKey = md5($apiResult->getUrl());
267
268		$item = $this->cache->getItem($cacheKey);
269
270	1	if (!$item->isHit()) {
271		$item->set(json_encode($apiResult->getResult()));
272	1	$item->expiresAfter($ttl);
273	1	$this->cache->save($item);
274		}
275		}
276		}
277

Babacooll / lol-api

ApiClient::getRunesApi() A last analyzed 2019-06-18 19:54 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ApiClient::getRunesApi() A
last analyzed 2019-06-18 19:54 UTC