Notifable - Code Metrics - Inspection of "add php doc blocks to all classes" - fenos/Notifynder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — version-4 ( 855c86...c55f2f )

unknown

created 2016-08-25 10:02 UTC

Notifable A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	135
Duplicated Lines	17.78 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	13
Bugs	6	Features	7

Metric	Value
c	13
b	6
f	7
dl	24
loc	135
rs	10
wmc	16
lcom	1
cbo	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	notifications()	0	9	2
A	notifynder()	0	4	1
A	sendNotificationFrom()	0	4	1
A	sendNotificationTo()	0	4	1
A	readNotification()	12	12	3
A	readAllNotifications()	0	4	1
A	unreadNotification()	12	12	3
A	unreadAllNotifications()	0	4	1
A	countUnreadNotifications()	0	4	1
A	getNotifications()	0	9	2

How to fix Duplicated Code

<?php

namespace Fenos\Notifynder\Traits;

use Fenos\Notifynder\Helpers\TypeChecker;

/**
 * Class Notifable
 * @package Fenos\Notifynder\Traits
 */
trait Notifable
{
    /**
     * Get the notifications Relationship.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany|\Illuminate\Database\Eloquent\Relations\MorphMany
     */
    public function notifications()
    {
        $model = notifynder_config()->getNotificationModel();
        if (notifynder_config()->isPolymorphic()) {
            return $this->morphMany($model, 'to');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $this->hasMany($model, 'to_id');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Get a new NotifynderManager instance with the given category.
     *
     * @param string|int|\Fenos\Notifynder\Models\NotificationCategory $category
     * @return \Fenos\Notifynder\Managers\NotifynderManager
     */
    public function notifynder($category)
    {
        return app('notifynder')->category($category);
    }

    /**
     * Get a new NotifynderManager instance with the given category and $this as the sender.
     *
     * @param string|int|\Fenos\Notifynder\Models\NotificationCategory $category
     * @return \Fenos\Notifynder\Managers\NotifynderManager
     */
    public function sendNotificationFrom($category)
    {
        return $this->notifynder($category)->from($this);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Get a new NotifynderManager instance with the given category and $this as the receiver.
     *
     * @param string|int|\Fenos\Notifynder\Models\NotificationCategory $category
     * @return \Fenos\Notifynder\Managers\NotifynderManager
     */
    public function sendNotificationTo($category)
    {
        return $this->notifynder($category)->to($this);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Read a single Notification.
     *
     * @param int $notification
     * @return bool
     */
    public function readNotification($notification)

    {
        if (! TypeChecker::isNotification($notification, false)) {
            $notification = $this->notifications()->firstOrFail($notification);
        }

        if ($this->notifications()->where($notification->getKeyName(), $notification->getKey())->exists()) {
            return $notification->read();
        }

        return false;
    }

    /**
     * Read all Notifications.
     *
     * @return mixed
     */
    public function readAllNotifications()
    {
        return $this->notifications()->update(['read' => 1]);
    }

    /**
     * Unread a single Notification.
     *
     * @param int $notification
     * @return bool
     */
    public function unreadNotification($notification)

    {
        if (! TypeChecker::isNotification($notification, false)) {
            $notification = $this->notifications()->firstOrFail($notification);
        }

        if ($this->notifications()->where($notification->getKeyName(), $notification->getKey())->exists()) {
            return $notification->unread();
        }

        return false;
    }

    /**
     * Unread all Notifications.
     *
     * @return mixed
     */
    public function unreadAllNotifications()
    {
        return $this->notifications()->update(['read' => 0]);
    }

    /**
     * Count unread notifications.
     *
     * @return int
     */
    public function countUnreadNotifications()
    {
        return $this->notifications()->byRead(0)->count();
    }

    /**
     * Get all Notifications ordered by creation and optional limit.
     * 
     * @param null|int $limit
     * @param string $order
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function getNotifications($limit = null, $order = 'desc')
    {
        $query = $this->notifications()->orderBy('created_at', $order);
        if (! is_null($limit)) {
            $query->limit($limit);
        }

        return $query->get();
    }
}


1		<?php
2
3		namespace Fenos\Notifynder\Traits;
4
5		use Fenos\Notifynder\Helpers\TypeChecker;
6
7		/**
8		* Class Notifable
9		* @package Fenos\Notifynder\Traits
10		*/
11		trait Notifable
12		{
13		/**
14		* Get the notifications Relationship.
15		*
16		* @return \Illuminate\Database\Eloquent\Relations\HasMany\|\Illuminate\Database\Eloquent\Relations\MorphMany
17		*/
18		public function notifications()
19		{
20		$model = notifynder_config()->getNotificationModel();
21		if (notifynder_config()->isPolymorphic()) {
22		return $this->morphMany($model, 'to');
		0 ignored issues – show Bug introduced 2016-06-17 14:28 UTC by Report Bug Copy Issue Report It seems like `morphMany()` 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...
23		}
24
25		return $this->hasMany($model, 'to_id');
		0 ignored issues – show Bug introduced 2016-06-17 14:28 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...
26		}
27
28		/**
29		* Get a new NotifynderManager instance with the given category.
30		*
31		* @param string\|int\|\Fenos\Notifynder\Models\NotificationCategory $category
32		* @return \Fenos\Notifynder\Managers\NotifynderManager
33		*/
34		public function notifynder($category)
35		{
36		return app('notifynder')->category($category);
37		}
38
39		/**
40		* Get a new NotifynderManager instance with the given category and $this as the sender.
41		*
42		* @param string\|int\|\Fenos\Notifynder\Models\NotificationCategory $category
43		* @return \Fenos\Notifynder\Managers\NotifynderManager
44		*/
45		public function sendNotificationFrom($category)
46		{
47		return $this->notifynder($category)->from($this);
		0 ignored issues – show Documentation Bug introduced 2016-08-25 10:12 UTC by Report Bug Copy Issue Report The method `from` does not exist on `object<Fenos\Notifynder\...gers\NotifynderManager>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
48		}
49
50		/**
51		* Get a new NotifynderManager instance with the given category and $this as the receiver.
52		*
53		* @param string\|int\|\Fenos\Notifynder\Models\NotificationCategory $category
54		* @return \Fenos\Notifynder\Managers\NotifynderManager
55		*/
56		public function sendNotificationTo($category)
57		{
58		return $this->notifynder($category)->to($this);
		0 ignored issues – show Documentation Bug introduced 2016-08-25 10:12 UTC by Report Bug Copy Issue Report The method `to` does not exist on `object<Fenos\Notifynder\...gers\NotifynderManager>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
59		}
60
61		/**
62		* Read a single Notification.
63		*
64		* @param int $notification
65		* @return bool
66		*/
67	View Code Duplication	public function readNotification($notification)
		0 ignored issues – show Duplication introduced 2016-07-28 09:23 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...
68		{
69		if (! TypeChecker::isNotification($notification, false)) {
70		$notification = $this->notifications()->firstOrFail($notification);
71		}
72
73		if ($this->notifications()->where($notification->getKeyName(), $notification->getKey())->exists()) {
74		return $notification->read();
75		}
76
77		return false;
78		}
79
80		/**
81		* Read all Notifications.
82		*
83		* @return mixed
84		*/
85		public function readAllNotifications()
86		{
87		return $this->notifications()->update(['read' => 1]);
88		}
89
90		/**
91		* Unread a single Notification.
92		*
93		* @param int $notification
94		* @return bool
95		*/
96	View Code Duplication	public function unreadNotification($notification)
		0 ignored issues – show Duplication introduced 2016-07-28 09:23 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...
97		{
98		if (! TypeChecker::isNotification($notification, false)) {
99		$notification = $this->notifications()->firstOrFail($notification);
100		}
101
102		if ($this->notifications()->where($notification->getKeyName(), $notification->getKey())->exists()) {
103		return $notification->unread();
104		}
105
106		return false;
107		}
108
109		/**
110		* Unread all Notifications.
111		*
112		* @return mixed
113		*/
114		public function unreadAllNotifications()
115		{
116		return $this->notifications()->update(['read' => 0]);
117		}
118
119		/**
120		* Count unread notifications.
121		*
122		* @return int
123		*/
124		public function countUnreadNotifications()
125		{
126		return $this->notifications()->byRead(0)->count();
127		}
128
129		/**
130		* Get all Notifications ordered by creation and optional limit.
131		*
132		* @param null\|int $limit
133		* @param string $order
134		* @return \Illuminate\Database\Eloquent\Collection
135		*/
136		public function getNotifications($limit = null, $order = 'desc')
137		{
138		$query = $this->notifications()->orderBy('created_at', $order);
139		if (! is_null($limit)) {
140		$query->limit($limit);
141		}
142
143		return $query->get();
144		}
145		}
146

fenos / Notifynder

Push — version-4 ( 855c86...c55f2f )

Notifable A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

10 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like