Client::__construct() - Code Metrics - nimmneun/StarCraftApiClient - Measure and Improve Code Quality continuously with Scrutinizer

Client::__construct() A
last analyzed 2016-01-26 18:58 UTC

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
c	4
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	2

<?php namespace StarCraftApiClient;

use StarCraftApiClient\Requests\DataRequest;
use StarCraftApiClient\Requests\LadderRequest;
use StarCraftApiClient\Requests\ProfileRequest;

/**
 * Sloppy way to perform several requests to the battle.net StarCraft Api
 * in one go. Once you added one or more requests, start pulling from
 * battle.net via Client->run(). Individual results can be accessed via
 * a dot-style path e.g. [basetype.id.type].
 *
 * After requesting all data for one player like:
 * Client->addAllProfileRequests(123321, 'CoolGuy', 'eu') ...
 * ... Client->get('profile.123321.ladders') will give you just the ladders,
 * while Client->get('profile.123321') will return an array containing
 * profil, matches and ladders for this player.
 * Hence Client->get('profile') will give you all the requested
 * profile-type results as an array.
 *
 * The actual request object for individual requests is accessible via
 * Client->getRequest(...). To access e.g. CURL info of a request
 * Client->getRequest('profile.123321.ladders')->info()
 * will give you just that.
 *
 * FYI: You should keep the number of requests to perform within
 * a reasonable level. See https://dev.battle.net/ for details.
 *
 * @author neun
 * @since  2015-10-25
 */
class Client
{
    /**
     * @var string
     */
    private $apiToken;

    /**
     * @var string
     */
    private $language;

    /**
     * @var float
     */
    private $runtime;

    /**
     * @var array
     */
    private $curlOptions = [
        CURLOPT_RETURNTRANSFER => 1,
        CURLOPT_SSL_VERIFYHOST => 0,
        CURLOPT_SSL_VERIFYPEER => 0,
        CURLOPT_CONNECTTIMEOUT => 9,
        CURLOPT_FOLLOWLOCATION => 1
    ];

    /**
     * @var Requests\Request[]
     */
    private $requests;

    /**
     * @var array
     */
    private $results;

    public function __construct($apiToken, $language = 'en_GB')
    {
        $this->apiToken = $apiToken;
        $this->language = $language;
    }

    /**
     * @param int $id
     * @param string $name
     * @param string $region
     */
    public function addAllProfileRequests($id, $name, $region)
    {
        $this->addProfileRequest($id, $name, $region);
        $this->addProfileLaddersRequest($id, $name, $region);
        $this->addProfileMatchesRequest($id, $name, $region);
    }

    /**
     * @param int $id
     * @param string $name
     * @param string $region
     */
    public function addProfileRequest($id, $name, $region)
    {
        $this->requests['profile.'.$id.'.profile'] =
            new ProfileRequest($this, 'profile', $id, $name, $region);
    }

    /**
     * @param int $id
     * @param string $name
     * @param string $region
     */
    public function addProfileLaddersRequest($id, $name, $region)
    {
        $this->requests['profile.'.$id.'.ladders'] =
            new ProfileRequest($this, 'ladders', $id, $name, $region);
    }

    /**
     * @param int $id
     * @param string $name
     * @param string $region
     */
    public function addProfileMatchesRequest($id, $name, $region)
    {
        $this->requests['profile.'.$id.'.matches'] =
            new ProfileRequest($this, 'matches', $id, $name, $region);
    }

    /**
     * @param int $id
     * @param string $region
     */
    public function addLadderRequest($id, $region)
    {
        $this->requests['ladder.'.$id] =
            new LadderRequest($this, $id, $region);
    }

    /**
     * @param string $region
     */
    public function addAchievementsRequest($region)
    {
        $this->requests['data.achievements'] =
            new DataRequest($this, 'achievements', $region);
    }

    /**
     * @param string $region
     */
    public function addRewardsRequest($region)
    {
        $this->requests['data.rewards'] =
            new DataRequest($this, 'rewards', $region);
    }

    /**
     * @return void
     */
    public function run()
    {
        $start = -microtime(1);
        $mh = curl_multi_init();

        $chs = $this->hydrateCurlHandles($mh);
        $this->performCurlRequests($mh);
        $this->fetchCurlRequestData($chs, $mh);

        curl_multi_close($mh);
        $this->runtime = $start+microtime(1);
    }

    /**
     * @param resource $mh
     * @return resource[] $chs
     */
    private function hydrateCurlHandles($mh)
    {
        $chs = [];
        /** @var Requests\Request $request */
        foreach ($this->requests as $id => $request) {
            $chs[$id] = curl_init($request->url());
            curl_setopt_array($chs[$id], $this->curlOptions);
            curl_multi_add_handle($mh, $chs[$id]);
        }

        return $chs;
    }

    /**
     * @param resource $mh
     */
    private function performCurlRequests($mh)
    {
        do {
            usleep(11111);
            curl_multi_exec($mh, $active);
        } while ($active > 0);
    }

    /**
     * @param resource[] $chs
     * @param resource $mh
     */
    private function fetchCurlRequestData($chs, $mh)
    {
        foreach ($chs as $id => $ch) {
            $path = explode('.', $id);
            $response = curl_multi_getcontent($ch);
            $this->requests[$id]->setInfo(curl_getinfo($ch))->setResponse($response);

            $result = json_decode($response);
            if (isset($path[2])) {
                $this->results[$path[0]][$path[1]][$path[2]] = $result;
            } elseif (isset($path[1])) {
                $this->results[$path[0]][$path[1]] = $result;
            } else {
                $this->results[$path[0]] = $result;
            }

            curl_multi_remove_handle($mh, $ch);
        }
    }

    /**
     * Return indiviual results, collections of results
     * or all results entirely.
     *
     * @param string $path
     * @return Object
     */
    public function get($path = null)
    {
        if (null === $path) {
            $result = $this->results;
        } else {
            foreach (explode('.', $path) as $chunk) {
                $result = isset($result) ? $result[$chunk] : $this->results[$chunk];
            }
        }

        return isset($result) ? $result : null;
    }

    /**
     * Return the individual result objects, containing the
     * plain response, connection info etc.
     *
     * @param $path
     * @return Requests\Request[]|
     */
    public function getRequests($path = null)
    {
        $requests = [];
        if (null === $path) {
            $requests = $this->requests;
        } else {
            $requests[] = isset($this->requests[$path]) ? $this->requests[$path] : null;
        }

        return $requests;
    }

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

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

    /**
     * @return float $runtime
     */
    public function runtime()
    {
        return $this->runtime;
    }
}


1			<?php namespace StarCraftApiClient;
2
3			use StarCraftApiClient\Requests\DataRequest;
4			use StarCraftApiClient\Requests\LadderRequest;
5			use StarCraftApiClient\Requests\ProfileRequest;
6
7			/**
8			* Sloppy way to perform several requests to the battle.net StarCraft Api
9			* in one go. Once you added one or more requests, start pulling from
10			* battle.net via Client->run(). Individual results can be accessed via
11			* a dot-style path e.g. [basetype.id.type].
12			*
13			* After requesting all data for one player like:
14			* Client->addAllProfileRequests(123321, 'CoolGuy', 'eu') ...
15			* ... Client->get('profile.123321.ladders') will give you just the ladders,
16			* while Client->get('profile.123321') will return an array containing
17			* profil, matches and ladders for this player.
18			* Hence Client->get('profile') will give you all the requested
19			* profile-type results as an array.
20			*
21			* The actual request object for individual requests is accessible via
22			* Client->getRequest(...). To access e.g. CURL info of a request
23			* Client->getRequest('profile.123321.ladders')->info()
24			* will give you just that.
25			*
26			* FYI: You should keep the number of requests to perform within
27			* a reasonable level. See https://dev.battle.net/ for details.
28			*
29			* @author neun
30			* @since 2015-10-25
31			*/
32			class Client
33			{
34			/**
35			* @var string
36			*/
37			private $apiToken;
38
39			/**
40			* @var string
41			*/
42			private $language;
43
44			/**
45			* @var float
46			*/
47			private $runtime;
48
49			/**
50			* @var array
51			*/
52			private $curlOptions = [
53			CURLOPT_RETURNTRANSFER => 1,
54			CURLOPT_SSL_VERIFYHOST => 0,
55			CURLOPT_SSL_VERIFYPEER => 0,
56			CURLOPT_CONNECTTIMEOUT => 9,
57			CURLOPT_FOLLOWLOCATION => 1
58			];
59
60			/**
61			* @var Requests\Request[]
62			*/
63			private $requests;
64
65			/**
66			* @var array
67			*/
68			private $results;
69
70			public function __construct($apiToken, $language = 'en_GB')
71			{
72			$this->apiToken = $apiToken;
73			$this->language = $language;
74			}
75
76			/**
77			* @param int $id
78			* @param string $name
79			* @param string $region
80			*/
81			public function addAllProfileRequests($id, $name, $region)
82			{
83			$this->addProfileRequest($id, $name, $region);
84			$this->addProfileLaddersRequest($id, $name, $region);
85			$this->addProfileMatchesRequest($id, $name, $region);
86			}
87
88			/**
89			* @param int $id
90			* @param string $name
91			* @param string $region
92			*/
93			public function addProfileRequest($id, $name, $region)
94			{
95			$this->requests['profile.'.$id.'.profile'] =
96			new ProfileRequest($this, 'profile', $id, $name, $region);
97			}
98
99			/**
100			* @param int $id
101			* @param string $name
102			* @param string $region
103			*/
104			public function addProfileLaddersRequest($id, $name, $region)
105			{
106			$this->requests['profile.'.$id.'.ladders'] =
107			new ProfileRequest($this, 'ladders', $id, $name, $region);
108			}
109
110			/**
111			* @param int $id
112			* @param string $name
113			* @param string $region
114			*/
115			public function addProfileMatchesRequest($id, $name, $region)
116			{
117			$this->requests['profile.'.$id.'.matches'] =
118			new ProfileRequest($this, 'matches', $id, $name, $region);
119			}
120
121			/**
122			* @param int $id
123			* @param string $region
124			*/
125			public function addLadderRequest($id, $region)
126			{
127			$this->requests['ladder.'.$id] =
128			new LadderRequest($this, $id, $region);
129			}
130
131			/**
132			* @param string $region
133			*/
134			public function addAchievementsRequest($region)
135			{
136			$this->requests['data.achievements'] =
137			new DataRequest($this, 'achievements', $region);
138			}
139
140			/**
141			* @param string $region
142			*/
143			public function addRewardsRequest($region)
144			{
145			$this->requests['data.rewards'] =
146			new DataRequest($this, 'rewards', $region);
147			}
148
149			/**
150			* @return void
151			*/
152			public function run()
153			{
154			$start = -microtime(1);
155			$mh = curl_multi_init();
156
157			$chs = $this->hydrateCurlHandles($mh);
158			$this->performCurlRequests($mh);
159			$this->fetchCurlRequestData($chs, $mh);
160
161			curl_multi_close($mh);
162			$this->runtime = $start+microtime(1);
163			}
164
165			/**
166			* @param resource $mh
167			* @return resource[] $chs
168			*/
169			private function hydrateCurlHandles($mh)
170			{
171			$chs = [];
172			/** @var Requests\Request $request */
173			foreach ($this->requests as $id => $request) {
174			$chs[$id] = curl_init($request->url());
175			curl_setopt_array($chs[$id], $this->curlOptions);
176			curl_multi_add_handle($mh, $chs[$id]);
177			}
178
179			return $chs;
180			}
181
182			/**
183			* @param resource $mh
184			*/
185			private function performCurlRequests($mh)
186			{
187			do {
188			usleep(11111);
189			curl_multi_exec($mh, $active);
190			} while ($active > 0);
191			}
192
193			/**
194			* @param resource[] $chs
195			* @param resource $mh
196			*/
197			private function fetchCurlRequestData($chs, $mh)
198			{
199			foreach ($chs as $id => $ch) {
200			$path = explode('.', $id);
201			$response = curl_multi_getcontent($ch);
202			$this->requests[$id]->setInfo(curl_getinfo($ch))->setResponse($response);
203
204			$result = json_decode($response);
205			if (isset($path[2])) {
206			$this->results[$path[0]][$path[1]][$path[2]] = $result;
207			} elseif (isset($path[1])) {
208			$this->results[$path[0]][$path[1]] = $result;
209			} else {
210			$this->results[$path[0]] = $result;
211			}
212
213			curl_multi_remove_handle($mh, $ch);
214			}
215			}
216
217			/**
218			* Return indiviual results, collections of results
219			* or all results entirely.
220			*
221			* @param string $path
222			* @return Object
223			*/
224			public function get($path = null)
225			{
226			if (null === $path) {
227			$result = $this->results;
228			} else {
229			foreach (explode('.', $path) as $chunk) {
230			$result = isset($result) ? $result[$chunk] : $this->results[$chunk];
231			}
232			}
233
234			return isset($result) ? $result : null;
235			}
236
237			/**
238			* Return the individual result objects, containing the
239			* plain response, connection info etc.
240			*
241			* @param $path
242			* @return Requests\Request[]\|
243			*/
244			public function getRequests($path = null)
245			{
246			$requests = [];
247			if (null === $path) {
248			$requests = $this->requests;
249			} else {
250			$requests[] = isset($this->requests[$path]) ? $this->requests[$path] : null;
251			}
252
253			return $requests;
254			}
255
256			/**
257			* @return string $apiToken
258			*/
259			public function apiToken()
260			{
261			return $this->apiToken;
262			}
263
264			/**
265			* @return string $language
266			*/
267			public function language()
268			{
269			return $this->language;
270			}
271
272			/**
273			* @return float $runtime
274			*/
275			public function runtime()
276			{
277			return $this->runtime;
278			}
279			}
280

nimmneun / StarCraftApiClient

Client::__construct() A last analyzed 2016-01-26 18:58 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Client::__construct() A
last analyzed 2016-01-26 18:58 UTC