HasPushSubscriptions::routeNotificationForWebPush() - Code Metrics - Inspection of "customize subscriber model" - laravel-notification-channels/webpush - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#83)

by José Eduardo

created 2019-06-15 11:22 UTC

routeNotificationForWebPush() A

↳ Parent: HasPushSubscriptions

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace NotificationChannels\WebPush;

trait HasPushSubscriptions
{
    /**
     * Get the user's subscriptions.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function pushSubscriptions()
    {
        return $this->hasMany(PushSubscription::class);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Update (or create) user subscription.
     *
     * @param  string $endpoint
     * @param  string|null $key
     * @param  string|null $token
     * @return \NotificationChannels\WebPush\PushSubscription
     */
    public function updatePushSubscription($endpoint, $key = null, $token = null)
    {
        $subscription = PushSubscription::findByEndpoint($endpoint);

        if ($subscription && $this->pushSubscriptionBelongsToUser($subscription)) {
            $subscription->public_key = $key;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $subscription->auth_token = $token;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $subscription->save();

            return $subscription;
        }

        if ($subscription && ! $this->pushSubscriptionBelongsToUser($subscription)) {
            $subscription->delete();
        }

        return $this->pushSubscriptions()->save(new PushSubscription([
            'endpoint' => $endpoint,
            'public_key' => $key,
            'auth_token' => $token,
        ]));
    }

    /**
     * Determine if the given subscription belongs to this user.
     *
     * @param  \NotificationChannels\WebPush\PushSubscription $subscription
     * @return bool
     */
    public function pushSubscriptionBelongsToUser($subscription)
    {
        $subscriber_foreing_key = config('webpush.subscriber_foreing_key', 'user_id');

        return $subscription->{$subscriber_foreing_key} === $this->getKey();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Delete subscription by endpoint.
     *
     * @param  string $endpoint
     * @return void
     */
    public function deletePushSubscription($endpoint)
    {
        $this->pushSubscriptions()
            ->where('endpoint', $endpoint)
            ->delete();
    }

    /**
     * Get all subscriptions.
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function routeNotificationForWebPush()
    {
        return $this->pushSubscriptions;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }
}


1		<?php
2
3		namespace NotificationChannels\WebPush;
4
5		trait HasPushSubscriptions
6		{
7		/**
8		* Get the user's subscriptions.
9		*
10		* @return \Illuminate\Database\Eloquent\Relations\HasMany
11		*/
12	8	public function pushSubscriptions()
13		{
14	8	return $this->hasMany(PushSubscription::class);
		0 ignored issues – show Bug introduced 2016-08-12 10:41 UTC by Report Bug Copy Issue Report It seems like `hasMany()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
15		}
16
17		/**
18		* Update (or create) user subscription.
19		*
20		* @param string $endpoint
21		* @param string\|null $key
22		* @param string\|null $token
23		* @return \NotificationChannels\WebPush\PushSubscription
24		*/
25	7	public function updatePushSubscription($endpoint, $key = null, $token = null)
26		{
27	7	$subscription = PushSubscription::findByEndpoint($endpoint);
28
29	7	if ($subscription && $this->pushSubscriptionBelongsToUser($subscription)) {
30		$subscription->public_key = $key;
		0 ignored issues – show Documentation introduced 2016-08-12 10:41 UTC by Report Bug Copy Issue Report The property `public_key` does not exist on `object<NotificationChann...bPush\PushSubscription>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
31		$subscription->auth_token = $token;
		0 ignored issues – show Documentation introduced 2016-08-12 10:41 UTC by Report Bug Copy Issue Report The property `auth_token` does not exist on `object<NotificationChann...bPush\PushSubscription>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
32		$subscription->save();
33
34		return $subscription;
35		}
36
37	7	if ($subscription && ! $this->pushSubscriptionBelongsToUser($subscription)) {
38	2	$subscription->delete();
39		}
40
41	7	return $this->pushSubscriptions()->save(new PushSubscription([
42	7	'endpoint' => $endpoint,
43	7	'public_key' => $key,
44	7	'auth_token' => $token,
45		]));
46		}
47
48		/**
49		* Determine if the given subscription belongs to this user.
50		*
51		* @param \NotificationChannels\WebPush\PushSubscription $subscription
52		* @return bool
53		*/
54	3	public function pushSubscriptionBelongsToUser($subscription)
55		{
56	3	$subscriber_foreing_key = config('webpush.subscriber_foreing_key', 'user_id');
57
58	3	return $subscription->{$subscriber_foreing_key} === $this->getKey();
		0 ignored issues – show Bug introduced 2019-06-15 11:25 UTC by Report Bug Copy Issue Report It seems like `getKey()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
59		}
60
61		/**
62		* Delete subscription by endpoint.
63		*
64		* @param string $endpoint
65		* @return void
66		*/
67		public function deletePushSubscription($endpoint)
68		{
69		$this->pushSubscriptions()
70		->where('endpoint', $endpoint)
71		->delete();
72		}
73
74		/**
75		* Get all subscriptions.
76		*
77		* @return \Illuminate\Database\Eloquent\Collection
78		*/
79	3	public function routeNotificationForWebPush()
80		{
81	3	return $this->pushSubscriptions;
		0 ignored issues – show Bug introduced 2016-08-12 10:41 UTC by Report Bug Copy Issue Report The property `pushSubscriptions` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
82		}
83		}
84

laravel-notification-channels / webpush

GitHub Access Token became invalid

Pull Request — master (#83)

routeNotificationForWebPush() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like