ApnChannel::dispatchEvents() - Code Metrics - Inspection of "Dispatch NotificationFailed events" - laravel-notification-channels/apn - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#79)

by Dwight

created 2020-02-21 03:50 UTC

ApnChannel::dispatchEvents() A

↳ Parent: ApnChannel

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	6.087

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	3
cts	10
cp	0.3
rs	9.7333
c	0
b	0
f	0
cc	3
nc	3
nop	1
crap	6.087

<?php

namespace NotificationChannels\Apn;

use Illuminate\Contracts\Events\Dispatcher;
use Illuminate\Notifications\Events\NotificationFailed;
use Illuminate\Notifications\Notification;
use Pushok\Client;
use Pushok\Response;

class ApnChannel
{
    /**
     * The sandbox environment identifier.
     *
     * @var int
     */
    const SANDBOX = 0;

    /**
     * The production environment identifier.
     *
     * @var int
     */
    const PRODUCTION = 1;

    /**
     * The APNS client.
     *
     * @var \Pushok\Client
     */
    protected $client;

    /**
     * The event dispatcher.
     *
     * @var \Illuminate\Contracts\Events\Dispatcher
     */
    protected $events;

    /**
     * Create a new channel instance.
     *
     * @param  \Pushok\Client  $client
     * @param  \Illuminate\Contracts\Events\Dispatcher  $events
     */
    public function __construct(Client $client, Dispatcher $events)
    {
        $this->client = $client;
        $this->events = $events;
    }

    /**
     * Send the notification to Apple Push Notification Service.
     *
     * @param mixed $notifiable
     * @param \Illuminate\Notifications\Notification $notification
     * @return array|void
     */
    public function send($notifiable, Notification $notification)
    {
        $tokens = (array) $notifiable->routeNotificationFor('apn', $notification);

        if (empty($tokens)) {
            return;
        }

        $responses = $this->sendNotifications(
            $message->client ?? $this->client,
            $notification->toApn($notifiable),

            $tokens
        );

        $this->dispatchEvents($responses);

        return $responses;
    }

    /**
     * Send the message to the given tokens through the given client.
     *
     * @param  \Pushok\Client  $client
     * @param  \NotificationChannels\Apn\ApnMessage  $message
     * @param  array  $tokens
     * @return array
     */
    protected function sendNotifications(Client $client, ApnMessage $message, array $tokens)
    {
        foreach ($tokens as $token) {
            $client->addNotification((new ApnAdapter)->adapt($message, $token));
        }

        return $client->push();
    }

    /**
     * Dispatch failed events for notifications that weren't delivered.
     *
     * @param  array  $responses
     * @return void
     */
    protected function dispatchEvents(array $responses)
    {
        foreach ($responses as $response) {
            if ($response->getStatusCode() === Response::APNS_SUCCESS) {
                continue;
            }

            $event = new NotificationFailed($notifiable, $notification, $this, [
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                'id' => $response->getApnsId(),
                'token' => $response->getDeviceToken(),
                'error' => $response->getErrorReason(),
            ]);

            $this->events->dispatch($event);
        }
    }
}


1		<?php
2
3		namespace NotificationChannels\Apn;
4
5		use Illuminate\Contracts\Events\Dispatcher;
6		use Illuminate\Notifications\Events\NotificationFailed;
7		use Illuminate\Notifications\Notification;
8		use Pushok\Client;
9		use Pushok\Response;
10
11		class ApnChannel
12		{
13		/**
14		* The sandbox environment identifier.
15		*
16		* @var int
17		*/
18		const SANDBOX = 0;
19
20		/**
21		* The production environment identifier.
22		*
23		* @var int
24		*/
25		const PRODUCTION = 1;
26
27		/**
28		* The APNS client.
29		*
30		* @var \Pushok\Client
31		*/
32		protected $client;
33
34		/**
35		* The event dispatcher.
36		*
37		* @var \Illuminate\Contracts\Events\Dispatcher
38		*/
39		protected $events;
40
41		/**
42		* Create a new channel instance.
43		*
44		* @param \Pushok\Client $client
45		* @param \Illuminate\Contracts\Events\Dispatcher $events
46		*/
47	1	public function __construct(Client $client, Dispatcher $events)
48		{
49	1	$this->client = $client;
50	1	$this->events = $events;
51	1	}
52
53		/**
54		* Send the notification to Apple Push Notification Service.
55		*
56		* @param mixed $notifiable
57		* @param \Illuminate\Notifications\Notification $notification
58		* @return array\|void
59		*/
60	1	public function send($notifiable, Notification $notification)
61		{
62	1	$tokens = (array) $notifiable->routeNotificationFor('apn', $notification);
63
64	1	if (empty($tokens)) {
65		return;
66		}
67
68	1	$responses = $this->sendNotifications(
69	1	$message->client ?? $this->client,
70	1	$notification->toApn($notifiable),
		0 ignored issues – show Bug introduced 2020-02-21 03:53 UTC by Report Bug Copy Issue Report The method `toApn()` does not seem to exist on `object<Illuminate\Notifications\Notification>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
71		$tokens
72		);
73
74	1	$this->dispatchEvents($responses);
75
76	1	return $responses;
77		}
78
79		/**
80		* Send the message to the given tokens through the given client.
81		*
82		* @param \Pushok\Client $client
83		* @param \NotificationChannels\Apn\ApnMessage $message
84		* @param array $tokens
85		* @return array
86		*/
87	1	protected function sendNotifications(Client $client, ApnMessage $message, array $tokens)
88		{
89	1	foreach ($tokens as $token) {
90	1	$client->addNotification((new ApnAdapter)->adapt($message, $token));
91		}
92
93	1	return $client->push();
94		}
95
96		/**
97		* Dispatch failed events for notifications that weren't delivered.
98		*
99		* @param array $responses
100		* @return void
101		*/
102	1	protected function dispatchEvents(array $responses)
103		{
104	1	foreach ($responses as $response) {
105		if ($response->getStatusCode() === Response::APNS_SUCCESS) {
106		continue;
107		}
108
109		$event = new NotificationFailed($notifiable, $notification, $this, [
		0 ignored issues – show Bug introduced 2020-02-21 03:53 UTC by Report Bug Copy Issue Report The variable `$notifiable` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2020-02-21 03:53 UTC by Report Bug Copy Issue Report The variable `$notification` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Documentation introduced 2016-09-24 12:53 UTC by Report Bug Copy Issue Report `$this` is of type `this<NotificationChannels\Apn\ApnChannel>`, but the function expects a `string`. 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...
110		'id' => $response->getApnsId(),
111		'token' => $response->getDeviceToken(),
112		'error' => $response->getErrorReason(),
113		]);
114
115		$this->events->dispatch($event);
116		}
117	1	}
118		}
119

laravel-notification-channels / apn

GitHub Access Token became invalid

Pull Request — master (#79)

ApnChannel::dispatchEvents() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like