NotifiableTrait - Code Metrics - Inspection of "update readme" - tuyakhov/yii2-notifications - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( f1f97e...65b71b )

by Anton

created 2016-10-09 21:04 UTC

NotifiableTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	7
lcom	1
cbo	1
dl	0
loc	48
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	shouldReceiveNotification()	8	2
A	viaChannels()	4	1
A	routeNotificationFor()	12	4

<?php
/**
 * @copyright Anton Tuyakhov <[email protected]>
 */

namespace tuyakhov\notifications;


use yii\helpers\Inflector;

trait NotifiableTrait
{
    /**
     * Determines if notifiable entity should receive the notification by checking in notification settings.
     * @param NotificationInterface $notification
     * @return bool
     */
    public function shouldReceiveNotification(NotificationInterface $notification)
    {
        $notificationAlias = Inflector::camel2id(get_class($notification));
        if (isset($this->notificationSettings[$notificationAlias])) {
            return (bool) $this->notificationSettings[$notificationAlias];
class MyClass { }

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

    /**
     * Send notifications via email by default
     * @return array
     */
    public function viaChannels()
    {
        return ['mail'];
    }

    /**
     * Return the notification routing information for the given channel.
     * ```php
     * public function routeNotificationForMail() {
     *      return $this->email;
     * }
     * ```
     * @param $channel string
     * @return mixed
     */
    public function routeNotificationFor($channel)
    {
        if (method_exists($this, $method = 'routeNotificationFor'.Inflector::id2camel($channel))) {
            return $this->{$method}();
        }
        switch ($channel) {
            case 'mail':
                return $this->email;
class MyClass { }

$x = new MyClass();
$x->foo = true;
            case 'nexmo':
                return $this->phone_number;
class MyClass { }

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

1			<?php
2			/**
3			* @copyright Anton Tuyakhov <[email protected]>
4			*/
5
6			namespace tuyakhov\notifications;
7
8
9			use yii\helpers\Inflector;
10
11			trait NotifiableTrait
12			{
13			/**
14			* Determines if notifiable entity should receive the notification by checking in notification settings.
15			* @param NotificationInterface $notification
16			* @return bool
17			*/
18			public function shouldReceiveNotification(NotificationInterface $notification)
19			{
20			$notificationAlias = Inflector::camel2id(get_class($notification));
21			if (isset($this->notificationSettings[$notificationAlias])) {
22			return (bool) $this->notificationSettings[$notificationAlias];
			0 ignored issues – show Bug introduced 2016-10-09 21:07 UTC by Report Bug Copy Issue Report The property `notificationSettings` 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...
23			}
24			return true;
25			}
26
27			/**
28			* Send notifications via email by default
29			* @return array
30			*/
31			public function viaChannels()
32			{
33			return ['mail'];
34			}
35
36			/**
37			* Return the notification routing information for the given channel.
38			* ```php
39			* public function routeNotificationForMail() {
40			* return $this->email;
41			* }
42			* ```
43			* @param $channel string
44			* @return mixed
45			*/
46			public function routeNotificationFor($channel)
47			{
48			if (method_exists($this, $method = 'routeNotificationFor'.Inflector::id2camel($channel))) {
49			return $this->{$method}();
50			}
51			switch ($channel) {
52			case 'mail':
53			return $this->email;
			0 ignored issues – show Bug introduced 2016-10-09 15:03 UTC by Report Bug Copy Issue Report The property `email` 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...
54			case 'nexmo':
55			return $this->phone_number;
			0 ignored issues – show Bug introduced 2016-10-09 15:03 UTC by Report Bug Copy Issue Report The property `phone_number` 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... Coding Style introduced 2016-10-09 15:03 UTC by Report Bug Copy Issue Report Variable "phone_number" is not in valid camel caps format Loading history...
56			}
57			}
58			}

tuyakhov / yii2-notifications

Push — master ( f1f97e...65b71b )

NotifiableTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Duplication Side-by-Side

Filter issues like