Notifications::getAll() - Code Metrics - Inspection of "Add "kind" argument to notifications getAll method" - norkunas/onesignal-php-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b0aa12...e86867 )

by Tomas

created 2020-06-17 12:31 UTC

Notifications::getAll() B

↳ Parent: Notifications

Complexity

Conditions	9
Paths	32

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	31
rs	8.0555
c	0
b	0
f	0
cc	9
nc	32
nop	2

<?php

declare(strict_types=1);

namespace OneSignal;

use OneSignal\Resolver\ResolverFactory;

class Notifications extends AbstractApi
{
    private $resolverFactory;

    public function __construct(OneSignal $client, ResolverFactory $resolverFactory)
    {
        parent::__construct($client);

        $this->resolverFactory = $resolverFactory;
    }

    /**
     * Get information about notification with provided ID.
     *
     * Application authentication key and ID must be set.
     *
     * @param string $id Notification ID
     */
    public function getOne(string $id): array

    {
        $request = $this->createRequest('GET', "/notifications/$id?app_id={$this->client->getConfig()->getApplicationId()}");
        $request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");

        return $this->client->sendRequest($request);
    }

    /**
     * Get information about all notifications.
     *
     * Application authentication key and ID must be set.
     *
     * @param int $limit  How many notifications to return (max 50)
     * @param int $offset Results offset (results are sorted by ID)
     * @param int $kind   Kind of notifications returned. Default (not set) is all notification types
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function getAll(int $limit = null, int $offset = null/*, int $kind = null */): array
    {
        if (func_num_args() > 2 && !is_int(func_get_arg(2))) {
            trigger_deprecation('norkunas/onesignal-php-api', '2.1.0', 'Method %s() will have a third `int $kind` argument. Not defining it or passing a non integer value is deprecated.', __METHOD__);
        } elseif (__CLASS__ !== static::class) {
            $r = new \ReflectionMethod($this, __FUNCTION__);

            if (\count($r->getParameters()) > 2) {
                trigger_deprecation('norkunas/onesignal-php-api', '2.1.0', 'Method %s() will have a third `int $kind` argument. Not defining it or passing a non integer value is deprecated.', __METHOD__);
            }
        }

        $query = ['app_id' => $this->client->getConfig()->getApplicationId()];

        if ($limit !== null) {
            $query['limit'] = $limit;
        }

        if ($offset !== null) {
            $query['offset'] = $offset;
        }

        if (func_num_args() > 2 && is_int(func_get_arg(2))) {
            $query['kind'] = func_get_arg(2);
        }

        $request = $this->createRequest('GET', '/notifications?'.http_build_query($query));
        $request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");

        return $this->client->sendRequest($request);
    }

    /**
     * Send new notification with provided data.
     *
     * Application authentication key and ID must be set.
     */
    public function add(array $data): array

    {
        $resolvedData = $this->resolverFactory->createNotificationResolver()->resolve($data);

        $request = $this->createRequest('POST', '/notifications');
        $request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");
        $request = $request->withHeader('Content-Type', 'application/json');
        $request = $request->withBody($this->createStream($resolvedData));

        return $this->client->sendRequest($request);
    }

    /**
     * Open notification.
     *
     * Application authentication key and ID must be set.
     *
     * @param string $id Notification ID
     */
    public function open(string $id): array
    {
        $request = $this->createRequest('PUT', "/notifications/$id");
        $request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");
        $request = $request->withHeader('Content-Type', 'application/json');
        $request = $request->withBody($this->createStream([
            'app_id' => $this->client->getConfig()->getApplicationId(),
            'opened' => true,
        ]));

        return $this->client->sendRequest($request);
    }

    /**
     * Cancel notification.
     *
     * Application authentication key and ID must be set.
     *
     * @param string $id Notification ID
     */
    public function cancel(string $id): array

    {
        $request = $this->createRequest('DELETE', "/notifications/$id?app_id={$this->client->getConfig()->getApplicationId()}");
        $request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");

        return $this->client->sendRequest($request);
    }

    /**
     * View the devices sent a notification.
     *
     * Application authentication key and ID must be set.
     *
     * @param string $id Notification ID
     */
    public function history(string $id, array $data): array
    {
        $resolvedData = $this->resolverFactory->createNotificationHistoryResolver()->resolve($data);

        $request = $this->createRequest('POST', "/notifications/$id/history");
        $request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");
        $request = $request->withHeader('Cache-Control', 'no-cache');
        $request = $request->withHeader('Content-Type', 'application/json');
        $request = $request->withBody($this->createStream($resolvedData));

        return $this->client->sendRequest($request);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace OneSignal;
6
7		use OneSignal\Resolver\ResolverFactory;
8
9		class Notifications extends AbstractApi
10		{
11		private $resolverFactory;
12
13		public function __construct(OneSignal $client, ResolverFactory $resolverFactory)
14		{
15		parent::__construct($client);
16
17		$this->resolverFactory = $resolverFactory;
18		}
19
20		/**
21		* Get information about notification with provided ID.
22		*
23		* Application authentication key and ID must be set.
24		*
25		* @param string $id Notification ID
26		*/
27	View Code Duplication	public function getOne(string $id): array
		0 ignored issues – show Duplication introduced 2020-01-15 07:36 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
28		{
29		$request = $this->createRequest('GET', "/notifications/$id?app_id={$this->client->getConfig()->getApplicationId()}");
30		$request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");
31
32		return $this->client->sendRequest($request);
33		}
34
35		/**
36		* Get information about all notifications.
37		*
38		* Application authentication key and ID must be set.
39		*
40		* @param int $limit How many notifications to return (max 50)
41		* @param int $offset Results offset (results are sorted by ID)
42		* @param int $kind Kind of notifications returned. Default (not set) is all notification types
		0 ignored issues – show Bug introduced 2020-06-17 12:36 UTC by Report Bug Copy Issue Report There is no parameter named `$kind`. 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...
43		*/
44		public function getAll(int $limit = null, int $offset = null/, int $kind = null /): array
45		{
46		if (func_num_args() > 2 && !is_int(func_get_arg(2))) {
47		trigger_deprecation('norkunas/onesignal-php-api', '2.1.0', 'Method %s() will have a third `int $kind` argument. Not defining it or passing a non integer value is deprecated.', __METHOD__);
48		} elseif (__CLASS__ !== static::class) {
49		$r = new \ReflectionMethod($this, __FUNCTION__);
50
51		if (\count($r->getParameters()) > 2) {
52		trigger_deprecation('norkunas/onesignal-php-api', '2.1.0', 'Method %s() will have a third `int $kind` argument. Not defining it or passing a non integer value is deprecated.', __METHOD__);
53		}
54		}
55
56		$query = ['app_id' => $this->client->getConfig()->getApplicationId()];
57
58		if ($limit !== null) {
59		$query['limit'] = $limit;
60		}
61
62		if ($offset !== null) {
63		$query['offset'] = $offset;
64		}
65
66		if (func_num_args() > 2 && is_int(func_get_arg(2))) {
67		$query['kind'] = func_get_arg(2);
68		}
69
70		$request = $this->createRequest('GET', '/notifications?'.http_build_query($query));
71		$request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");
72
73		return $this->client->sendRequest($request);
74		}
75
76		/**
77		* Send new notification with provided data.
78		*
79		* Application authentication key and ID must be set.
80		*/
81	View Code Duplication	public function add(array $data): array
		0 ignored issues – show Duplication introduced 2017-09-04 13:31 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
82		{
83		$resolvedData = $this->resolverFactory->createNotificationResolver()->resolve($data);
84
85		$request = $this->createRequest('POST', '/notifications');
86		$request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");
87		$request = $request->withHeader('Content-Type', 'application/json');
88		$request = $request->withBody($this->createStream($resolvedData));
89
90		return $this->client->sendRequest($request);
91		}
92
93		/**
94		* Open notification.
95		*
96		* Application authentication key and ID must be set.
97		*
98		* @param string $id Notification ID
99		*/
100		public function open(string $id): array
101		{
102		$request = $this->createRequest('PUT', "/notifications/$id");
103		$request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");
104		$request = $request->withHeader('Content-Type', 'application/json');
105		$request = $request->withBody($this->createStream([
106		'app_id' => $this->client->getConfig()->getApplicationId(),
107		'opened' => true,
108		]));
109
110		return $this->client->sendRequest($request);
111		}
112
113		/**
114		* Cancel notification.
115		*
116		* Application authentication key and ID must be set.
117		*
118		* @param string $id Notification ID
119		*/
120	View Code Duplication	public function cancel(string $id): array
		0 ignored issues – show Duplication introduced 2020-01-15 07:36 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
121		{
122		$request = $this->createRequest('DELETE', "/notifications/$id?app_id={$this->client->getConfig()->getApplicationId()}");
123		$request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");
124
125		return $this->client->sendRequest($request);
126		}
127
128		/**
129		* View the devices sent a notification.
130		*
131		* Application authentication key and ID must be set.
132		*
133		* @param string $id Notification ID
134		*/
135		public function history(string $id, array $data): array
136		{
137		$resolvedData = $this->resolverFactory->createNotificationHistoryResolver()->resolve($data);
138
139		$request = $this->createRequest('POST', "/notifications/$id/history");
140		$request = $request->withHeader('Authorization', "Basic {$this->client->getConfig()->getApplicationAuthKey()}");
141		$request = $request->withHeader('Cache-Control', 'no-cache');
142		$request = $request->withHeader('Content-Type', 'application/json');
143		$request = $request->withBody($this->createStream($resolvedData));
144
145		return $this->client->sendRequest($request);
146		}
147		}
148

norkunas / onesignal-php-api

Push — master ( b0aa12...e86867 )

Notifications::getAll() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like