API::sort_by_name() - Code Metrics - Inspection of "Update header comments, add start of manga editing..." - timw4mail/HummingBirdAnimeClient - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 645554...205c7a )

by Timothy

created 2016-01-04 21:58 UTC

API::sort_by_name() A

↳ Parent: API

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	11
rs	9.4286
cc	2
eloc	5
nc	2
nop	2

<?php
/**
 * Hummingbird Anime Client
 *
 * An API client for Hummingbird to manage anime and manga watch lists
 *
 * @package     HummingbirdAnimeClient
 * @author      Timothy J. Warren
 * @copyright   Copyright (c) 2015 - 2016
 * @link        https://github.com/timw4mail/HummingBirdAnimeClient
 * @license     MIT
 */
namespace Aviat\AnimeClient\Model;

use GuzzleHttp\Client;
use GuzzleHttp\Cookie\CookieJar;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\ResponseInterface;
use GuzzleHttp\Exception\ClientException;

use Aviat\Ion\Di\ContainerInterface;
use Aviat\AnimeClient\Model as BaseModel;

/**
 * Base model for api interaction
 *
 * @method ResponseInterface get(string $uri, array $options);
 * @method ResponseInterface delete(string $uri, array $options);
 * @method ResponseInterface head(string $uri, array $options);
 * @method ResponseInterface options(string $uri, array $options);
 * @method ResponseInterface patch(string $uri, array $options);
 * @method ResponseInterface post(string $uri, array $options);
 * @method ResponseInterface put(string $uri, array $options);
 */
class API extends BaseModel {

	/**
	 * Base url for making api requests
	 * @var string
	 */
	protected $base_url = '';

	/**
	 * The Guzzle http client object
	 * @var object
	 */
	protected $client;

	/**
	 * Cookie jar object for api requests
	 * @var object
	 */
	protected $cookieJar;

	/**
	 * Constructor
	 *
	 * @param ContainerInterface $container
	 */
	public function __construct(ContainerInterface $container)
	{
		parent::__construct($container);
		$this->init();
	}

	/**
	 * Set up the class properties
	 *
	 * @return void
	 */
	protected function init()
	{
		$this->cookieJar = new CookieJar();
		$this->client = new Client([
			'base_uri' => $this->base_url,
			'cookies' => TRUE,
			'http_errors' => FALSE,
			'defaults' => [
				'cookies' => $this->cookieJar,
				'headers' => [
					'User-Agent' => "Tim's Anime Client/2.0",
					'Accept-Encoding' => 'application/json'
				],
				'timeout' => 25,
				'connect_timeout' => 25
			]
		]);
	}

	/**
	 * Magic methods to call guzzle api client
	 *
	 * @param  string $method
	 * @param  array $args
	 * @return ResponseInterface|null
	 */
	public function __call($method, $args)
	{
		$valid_methods = [
			'get',
			'delete',
			'head',
			'options',
			'patch',
			'post',
			'put'
		];

		if ( ! in_array($method, $valid_methods))
		{
			return NULL;
		}

		array_unshift($args, strtoupper($method));
		return call_user_func_array([$this->client, 'request'], $args);
	}

	/**
	 * Get the data for the specified library entry
	 *
	 * @param  string $id
	 * @param  string $status
	 * @return array
	 */
	public function get_library_item($id, $status)
	{
		$data = $this->_get_list_from_api($status);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
		$index_array = array_column($data, 'id');

		$key = array_search($id, $index_array);

		return $key !== FALSE
			? $data[$key]
			: [];
	}

	/**
	 * Sort the manga entries by their title
	 *
	 * @codeCoverageIgnore
	 * @param array $array
	 * @param string $key
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @return void
	 */
	protected function sort_by_name(&$array, $sort_key)
	{
		$sort = array();

		foreach ($array as $key => $item)
		{
			$sort[$key] = $item[$sort_key]['title'];
		}

		array_multisort($sort, SORT_ASC, $array);
	}

	/**
	 * Attempt login via the api
	 *
	 * @codeCoverageIgnore
	 * @param string $username
	 * @param string $password
	 * @return string|false
	 */
	public function authenticate($username, $password)
	{
		$response = $this->post('https://hummingbird.me/api/v1/users/authenticate', [
			'form_params' => [
				'username' => $username,
				'password' => $password
			]
		]);

		if ($response->getStatusCode() === 201)
		{
			return json_decode($response->getBody(), TRUE);
		}

		return FALSE;
	}
}
// End of BaseApiModel.php

1			<?php
2			/**
3			* Hummingbird Anime Client
4			*
5			* An API client for Hummingbird to manage anime and manga watch lists
6			*
7			* @package HummingbirdAnimeClient
8			* @author Timothy J. Warren
9			* @copyright Copyright (c) 2015 - 2016
10			* @link https://github.com/timw4mail/HummingBirdAnimeClient
11			* @license MIT
12			*/
13			namespace Aviat\AnimeClient\Model;
14
15			use GuzzleHttp\Client;
16			use GuzzleHttp\Cookie\CookieJar;
17			use GuzzleHttp\Psr7\Request;
18			use GuzzleHttp\Psr7\ResponseInterface;
19			use GuzzleHttp\Exception\ClientException;
20
21			use Aviat\Ion\Di\ContainerInterface;
22			use Aviat\AnimeClient\Model as BaseModel;
23
24			/**
25			* Base model for api interaction
26			*
27			* @method ResponseInterface get(string $uri, array $options);
28			* @method ResponseInterface delete(string $uri, array $options);
29			* @method ResponseInterface head(string $uri, array $options);
30			* @method ResponseInterface options(string $uri, array $options);
31			* @method ResponseInterface patch(string $uri, array $options);
32			* @method ResponseInterface post(string $uri, array $options);
33			* @method ResponseInterface put(string $uri, array $options);
34			*/
35			class API extends BaseModel {
36
37			/**
38			* Base url for making api requests
39			* @var string
40			*/
41			protected $base_url = '';
42
43			/**
44			* The Guzzle http client object
45			* @var object
46			*/
47			protected $client;
48
49			/**
50			* Cookie jar object for api requests
51			* @var object
52			*/
53			protected $cookieJar;
54
55			/**
56			* Constructor
57			*
58			* @param ContainerInterface $container
59			*/
60			public function __construct(ContainerInterface $container)
61			{
62			parent::__construct($container);
63			$this->init();
64			}
65
66			/**
67			* Set up the class properties
68			*
69			* @return void
70			*/
71			protected function init()
72			{
73			$this->cookieJar = new CookieJar();
74			$this->client = new Client([
75			'base_uri' => $this->base_url,
76			'cookies' => TRUE,
77			'http_errors' => FALSE,
78			'defaults' => [
79			'cookies' => $this->cookieJar,
80			'headers' => [
81			'User-Agent' => "Tim's Anime Client/2.0",
82			'Accept-Encoding' => 'application/json'
83			],
84			'timeout' => 25,
85			'connect_timeout' => 25
86			]
87			]);
88			}
89
90			/**
91			* Magic methods to call guzzle api client
92			*
93			* @param string $method
94			* @param array $args
95			* @return ResponseInterface\|null
96			*/
97			public function __call($method, $args)
98			{
99			$valid_methods = [
100			'get',
101			'delete',
102			'head',
103			'options',
104			'patch',
105			'post',
106			'put'
107			];
108
109			if ( ! in_array($method, $valid_methods))
110			{
111			return NULL;
112			}
113
114			array_unshift($args, strtoupper($method));
115			return call_user_func_array([$this->client, 'request'], $args);
116			}
117
118			/**
119			* Get the data for the specified library entry
120			*
121			* @param string $id
122			* @param string $status
123			* @return array
124			*/
125			public function get_library_item($id, $status)
126			{
127			$data = $this->_get_list_from_api($status);
			0 ignored issues – show Documentation Bug introduced 2016-01-04 22:04 UTC by Report Bug Copy Issue Report The method `_get_list_from_api` does not exist on `object<Aviat\AnimeClient\Model\API>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
128			$index_array = array_column($data, 'id');
129
130			$key = array_search($id, $index_array);
131
132			return $key !== FALSE
133			? $data[$key]
134			: [];
135			}
136
137			/**
138			* Sort the manga entries by their title
139			*
140			* @codeCoverageIgnore
141			* @param array $array
142			* @param string $key
			0 ignored issues – show Bug introduced 2016-01-04 22:04 UTC by Report Bug Copy Issue Report There is no parameter named `$key`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
143			* @return void
144			*/
145			protected function sort_by_name(&$array, $sort_key)
146			{
147			$sort = array();
148
149			foreach ($array as $key => $item)
150			{
151			$sort[$key] = $item[$sort_key]['title'];
152			}
153
154			array_multisort($sort, SORT_ASC, $array);
155			}
156
157			/**
158			* Attempt login via the api
159			*
160			* @codeCoverageIgnore
161			* @param string $username
162			* @param string $password
163			* @return string\|false
164			*/
165			public function authenticate($username, $password)
166			{
167			$response = $this->post('https://hummingbird.me/api/v1/users/authenticate', [
168			'form_params' => [
169			'username' => $username,
170			'password' => $password
171			]
172			]);
173
174			if ($response->getStatusCode() === 201)
175			{
176			return json_decode($response->getBody(), TRUE);
177			}
178
179			return FALSE;
180			}
181			}
182			// End of BaseApiModel.php

timw4mail / HummingBirdAnimeClient

Push — master ( 645554...205c7a )

API::sort_by_name() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like