PHPushbullet::getDeviceIden() - Code Metrics - joetannenbaum/phpushbullet - Measure and Improve Code Quality continuously with Scrutinizer

PHPushbullet::getDeviceIden() A
last analyzed 2016-06-15 18:22 UTC

↳ Parent: PHPushbullet

Complexity

Conditions	4
Paths	4

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
c	3
b	0
f	1
dl	0
loc	12
ccs	8
cts	8
cp	1
rs	9.2
cc	4
eloc	6
nc	4
nop	1
crap	4

<?php

namespace PHPushbullet;

/**
 * @method array address(string $name, string|array $address)
 * @method array file(string $file_name, string $file_url, string $body = null)
 * @method array link(string $title, string $url, string $body = null)
 * @method array list(string $title, array $items)
 * @method array note(string $title, string $body)
 */

class PHPushbullet
{
    /**
     * An instance of the Guzzle client to make requests
     *
     * @var \GuzzleHttp\Client $api
     */
    protected $api;

    /**
     * The set of devices we are currently pushing to
     *
     * @var array $devices
     */
    protected $devices = [];

    /**
     * The set of users we are currently pushing to,
     * an array of emails
     *
     * @var array $users
     */
    protected $users = [];

    /**
     * The set of channels we are currntly pushing to
     *
     * @var array $channels
     */
    protected $channels = [];

    /**
     * An array of all devices available
     *
     * @var array $all_devices
     */
    protected $all_devices = [];

    public function __construct($access_token = null, Connection $connection =  null, array $config = [])
    {
        $access_token = $access_token ?: getenv('pushbullet.access_token');

        if (!$access_token) {
            throw new \Exception('Your Pushbullet access token is not set.');
        }

        $connection = $connection ?: new Connection($access_token, null, $config);

        $this->api = $connection->client();
    }

    /**
     * Get a list of all of the devices available
     *
     * @return array
     */
    public function devices()
    {
        if (empty($this->all_devices)) {
            $response = $this->fromJson($this->api->get('devices'));

            $this->all_devices = array_map(function ($device) {
                return new Device($device);
            }, $response['devices']);
        }

        return $this->all_devices;
    }

    public function user()
    {
        $this->users = array_merge($this->argsToArray(func_get_args()), $this->users);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->users = array_filter($this->users);
        $this->users = array_unique($this->users);

        return $this;
    }

    /**
     * Set the passed in device(s) for the current push
     *
     * @return \PHPushbullet\PHPushbullet
     */
    public function device()
    {
        $devices = $this->argsToArray(func_get_args());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        foreach ($devices as $destination) {
            $device = $this->getDeviceIden($destination);

            if (!$device) {
                throw new \Exception("{$destination} is not a valid device.");
            }

            $this->devices[] = $device;
        }

        return $this;
    }

    /**
     * Set the passed in channel(s) for the current push
     *
     * @return \PHPushbullet\PHPushbullet
     */
    public function channel()
    {
        $this->channels = array_merge($this->argsToArray(func_get_args()));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $this;
    }

    /**
     * Set all of the devices for the current push
     *
     * @return \PHPushbullet\PHPushbullet
     */
    public function all()
    {
        foreach ($this->devices() as $device) {
            if ($device->pushable == true) {
                $this->devices[] = $device->iden;
            }
        }

        return $this;
    }

    /**
     * Actually send the push
     *
     * @return array
     */
    public function push($request)
    {
        if (empty($this->devices) && empty($this->users) && empty($this->channels)) {
            throw new \Exception('You must specify something to push to.');
        }

        $responses = [];

        $destinations = [
            'devices'  => 'device_iden',
            'users'    => 'email',
            'channels' => 'channel_tag',
        ];

        foreach ($destinations as $destination => $key) {
            foreach ($this->{$destination} as $dest) {
                $responses[] = $this->pushRequest($request, [$key => $dest]);
            }
        }

        $this->devices  = [];
        $this->users    = [];
        $this->channels = [];

        return $responses;
    }

    public function getClient()
    {
        return $this->api;
    }

    /**
     * Create push request and... push it
     *
     * @param array $request
     * @param array $merge
     *
     * @return array
     */
    protected function pushRequest($request, $merge)
    {
        $request  = array_merge($request, $merge);
        $response = $this->api->post('pushes', ['json' => $request]);

        return $this->fromJson($response);
    }

    /**
     * Get the `iden` for the device by either the iden or nickname
     *
     * @param string $device
     *
     * @return mixed (boolean|string)
     */
    protected function getDeviceIden($device)
    {
        foreach ($this->devices() as $available_device) {
            foreach (['iden', 'nickname'] as $field) {
                if ($available_device->$field == $device) {
                    return $available_device->iden;
                }
            }
        }

        return false;
    }

    /**
     * @param type $args
     *
     * @return array
     */
    protected function argsToArray($args)
    {
        if (is_array($args[0])) {
            return $args[0];
        }

        return $args;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    protected function fromJson($response)
    {
        return json_decode((string) $response->getBody(), true);
    }

    /**
     * Magic method, figures out what sort of push the user is trying to do
     */
    public function __call($method, $arguments)
    {
        $request_class = 'PHPushbullet\Request\Push' . ucwords($method);

        if (!class_exists($request_class)) {
            throw new \Exception(sprintf('Unknown method "%s"', $method));
        }

        $class   = new \ReflectionClass($request_class);
        $request = $class->newInstanceArgs($arguments);

        return $this->push($request->request());
    }
}


1		<?php
2
3		namespace PHPushbullet;
4
5		/**
6		* @method array address(string $name, string\|array $address)
7		* @method array file(string $file_name, string $file_url, string $body = null)
8		* @method array link(string $title, string $url, string $body = null)
9		* @method array list(string $title, array $items)
10		* @method array note(string $title, string $body)
11		*/
12
13		class PHPushbullet
14		{
15		/**
16		* An instance of the Guzzle client to make requests
17		*
18		* @var \GuzzleHttp\Client $api
19		*/
20		protected $api;
21
22		/**
23		* The set of devices we are currently pushing to
24		*
25		* @var array $devices
26		*/
27		protected $devices = [];
28
29		/**
30		* The set of users we are currently pushing to,
31		* an array of emails
32		*
33		* @var array $users
34		*/
35		protected $users = [];
36
37		/**
38		* The set of channels we are currntly pushing to
39		*
40		* @var array $channels
41		*/
42		protected $channels = [];
43
44		/**
45		* An array of all devices available
46		*
47		* @var array $all_devices
48		*/
49		protected $all_devices = [];
50
51	27	public function __construct($access_token = null, Connection $connection = null, array $config = [])
52		{
53	27	$access_token = $access_token ?: getenv('pushbullet.access_token');
54
55	27	if (!$access_token) {
56		throw new \Exception('Your Pushbullet access token is not set.');
57		}
58
59	27	$connection = $connection ?: new Connection($access_token, null, $config);
60
61	27	$this->api = $connection->client();
62	27	}
63
64		/**
65		* Get a list of all of the devices available
66		*
67		* @return array
68		*/
69	12	public function devices()
70		{
71	12	if (empty($this->all_devices)) {
72	12	$response = $this->fromJson($this->api->get('devices'));
73
74	12	$this->all_devices = array_map(function ($device) {
75	12	return new Device($device);
76	12	}, $response['devices']);
77	12	}
78
79	12	return $this->all_devices;
80		}
81
82	1	public function user()
83		{
84	1	$this->users = array_merge($this->argsToArray(func_get_args()), $this->users);
		0 ignored issues – show Documentation introduced 2016-03-22 00:19 UTC by Report Bug Copy Issue Report `func_get_args()` is of type `array`, but the function expects a `object<PHPushbullet\type>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
85	1	$this->users = array_filter($this->users);
86	1	$this->users = array_unique($this->users);
87
88	1	return $this;
89		}
90
91		/**
92		* Set the passed in device(s) for the current push
93		*
94		* @return \PHPushbullet\PHPushbullet
95		*/
96	11	public function device()
97		{
98	11	$devices = $this->argsToArray(func_get_args());
		0 ignored issues – show Documentation introduced 2016-03-22 00:19 UTC by Report Bug Copy Issue Report `func_get_args()` is of type `array`, but the function expects a `object<PHPushbullet\type>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
99
100	11	foreach ($devices as $destination) {
101	11	$device = $this->getDeviceIden($destination);
102
103	11	if (!$device) {
104	1	throw new \Exception("{$destination} is not a valid device.");
105		}
106
107	10	$this->devices[] = $device;
108	10	}
109
110	10	return $this;
111		}
112
113		/**
114		* Set the passed in channel(s) for the current push
115		*
116		* @return \PHPushbullet\PHPushbullet
117		*/
118	2	public function channel()
119		{
120	2	$this->channels = array_merge($this->argsToArray(func_get_args()));
		0 ignored issues – show Documentation introduced 2016-03-22 00:19 UTC by Report Bug Copy Issue Report `func_get_args()` is of type `array`, but the function expects a `object<PHPushbullet\type>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
121
122	2	return $this;
123		}
124
125		/**
126		* Set all of the devices for the current push
127		*
128		* @return \PHPushbullet\PHPushbullet
129		*/
130		public function all()
131		{
132		foreach ($this->devices() as $device) {
133		if ($device->pushable == true) {
134		$this->devices[] = $device->iden;
135		}
136		}
137
138		return $this;
139		}
140
141		/**
142		* Actually send the push
143		*
144		* @return array
145		*/
146	14	public function push($request)
147		{
148	14	if (empty($this->devices) && empty($this->users) && empty($this->channels)) {
149	1	throw new \Exception('You must specify something to push to.');
150		}
151
152	13	$responses = [];
153
154		$destinations = [
155	13	'devices' => 'device_iden',
156	13	'users' => 'email',
157	13	'channels' => 'channel_tag',
158	13	];
159
160	13	foreach ($destinations as $destination => $key) {
161	13	foreach ($this->{$destination} as $dest) {
162	13	$responses[] = $this->pushRequest($request, [$key => $dest]);
163	13	}
164	13	}
165
166	13	$this->devices = [];
167	13	$this->users = [];
168	13	$this->channels = [];
169
170	13	return $responses;
171		}
172
173		public function getClient()
174		{
175		return $this->api;
176		}
177
178		/**
179		* Create push request and... push it
180		*
181		* @param array $request
182		* @param array $merge
183		*
184		* @return array
185		*/
186	13	protected function pushRequest($request, $merge)
187		{
188	13	$request = array_merge($request, $merge);
189	13	$response = $this->api->post('pushes', ['json' => $request]);
190
191	13	return $this->fromJson($response);
192		}
193
194		/**
195		* Get the `iden` for the device by either the iden or nickname
196		*
197		* @param string $device
198		*
199		* @return mixed (boolean\|string)
200		*/
201	11	protected function getDeviceIden($device)
202		{
203	11	foreach ($this->devices() as $available_device) {
204	11	foreach (['iden', 'nickname'] as $field) {
205	11	if ($available_device->$field == $device) {
206	10	return $available_device->iden;
207		}
208	11	}
209	11	}
210
211	1	return false;
212		}
213
214		/**
215		* @param type $args
216		*
217		* @return array
218		*/
219	14	protected function argsToArray($args)
220		{
221	14	if (is_array($args[0])) {
222		return $args[0];
223		}
224
225	14	return $args;
		0 ignored issues – show Bug Best Practice introduced 2016-03-22 00:19 UTC by Report Bug Copy Issue Report The return type of `return $args;` (`PHPushbullet\type`) is incompatible with the return type documented by `PHPushbullet\PHPushbullet::argsToArray` of type `array`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
226		}
227
228	15	protected function fromJson($response)
229		{
230	15	return json_decode((string) $response->getBody(), true);
231		}
232
233		/**
234		* Magic method, figures out what sort of push the user is trying to do
235		*/
236	14	public function __call($method, $arguments)
237		{
238	14	$request_class = 'PHPushbullet\Request\Push' . ucwords($method);
239
240	14	if (!class_exists($request_class)) {
241		throw new \Exception(sprintf('Unknown method "%s"', $method));
242		}
243
244	14	$class = new \ReflectionClass($request_class);
245	14	$request = $class->newInstanceArgs($arguments);
246
247	14	return $this->push($request->request());
248		}
249		}
250

joetannenbaum / phpushbullet

PHPushbullet::getDeviceIden() A last analyzed 2016-06-15 18:22 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

PHPushbullet::getDeviceIden() A
last analyzed 2016-06-15 18:22 UTC