ApnChannel::sendNotifications() - 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-23 21:29 UTC

ApnChannel::sendNotifications() A

↳ Parent: ApnChannel

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	4
cts	4
cp	1
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	3
crap	2

<?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($notifiable, $notification, $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 mixed $notifiable
     * @param \Illuminate\Notifications\Notification $notification
     * @param array $responses
     * @return void
     */
    protected function dispatchEvents($notifiable, $notification, 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	2	public function __construct(Client $client, Dispatcher $events)
48		{
49	2	$this->client = $client;
50	2	$this->events = $events;
51	2	}
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	2	public function send($notifiable, Notification $notification)
61		{
62	2	$tokens = (array) $notifiable->routeNotificationFor('apn', $notification);
63
64	2	if (empty($tokens)) {
65		return;
66		}
67
68	2	$responses = $this->sendNotifications(
69	2	$message->client ?? $this->client,
70	2	$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	2	$this->dispatchEvents($notifiable, $notification, $responses);
75
76	2	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	2	protected function sendNotifications(Client $client, ApnMessage $message, array $tokens)
88		{
89	2	foreach ($tokens as $token) {
90	2	$client->addNotification((new ApnAdapter)->adapt($message, $token));
91		}
92
93	2	return $client->push();
94		}
95
96		/**
97		* Dispatch failed events for notifications that weren't delivered.
98		*
99		* @param mixed $notifiable
100		* @param \Illuminate\Notifications\Notification $notification
101		* @param array $responses
102		* @return void
103		*/
104	2	protected function dispatchEvents($notifiable, $notification, array $responses)
105		{
106	2	foreach ($responses as $response) {
107	1	if ($response->getStatusCode() === Response::APNS_SUCCESS) {
108	1	continue;
109		}
110
111	1	$event = new NotificationFailed($notifiable, $notification, $this, [
		0 ignored issues – show 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...
112	1	'id' => $response->getApnsId(),
113	1	'token' => $response->getDeviceToken(),
114	1	'error' => $response->getErrorReason(),
115		]);
116
117	1	$this->events->dispatch($event);
118		}
119	2	}
120		}
121

laravel-notification-channels / apn

GitHub Access Token became invalid

Pull Request — master (#79)

ApnChannel::sendNotifications() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like