NotifableBasic - Code Metrics - Inspection of "Get all unread notifications" - fenos/Notifynder - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Pull Request — master (#272)

by Zeeshan

created 2017-03-30 12:16 UTC

NotifableBasic A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	147
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	0
loc	147
rs	10
c	0
b	0
f	0
wmc	16
lcom	1
cbo	1

12 Methods

Rating	Name	Size	Complexity
	getNotificationRelation()	1	?
A	notifynder()	4	1
A	sendNotificationFrom()	4	1
A	sendNotificationTo()	4	1
A	readNotification()	4	1
A	unreadNotification()	4	1
A	updateSingleReadStatus()	12	4
A	readAllNotifications()	4	1
A	unreadAllNotifications()	4	1
A	countUnreadNotifications()	4	1
A	getNotifications()	9	2
A	getNotificationsNotRead()	10	2

<?php

namespace Fenos\Notifynder\Traits;

use Fenos\Notifynder\Helpers\TypeChecker;

/**
 * Class NotifableBasic.
 */
trait NotifableBasic
{
    /**
     * Get the notifications Relationship.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany|\Illuminate\Database\Eloquent\Relations\MorphMany
     */
    abstract public function getNotificationRelation();

    /**
     * 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)
    {
        return $this->updateSingleReadStatus($notification, 1);
    }

    /**
     * Unread a single Notification.
     *
     * @param int $notification
     * @return bool
     */
    public function unreadNotification($notification)
    {
        return $this->updateSingleReadStatus($notification, 0);
    }

    /**
     * @param int $notification
     * @param int $value
     * @return bool
     */
    protected function updateSingleReadStatus($notification, $value)
    {
        if (! TypeChecker::isNotification($notification, false)) {
            $notification = $this->getNotificationRelation()->findOrFail($notification);
        }

        if ($this->getNotificationRelation()->where($notification->getKeyName(), $notification->getKey())->exists()) {
            return $value ? $notification->read() : $notification->unread();
        }

        return false;
    }

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

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

    /**
     * Count unread notifications.
     *
     * @return int
     */
    public function countUnreadNotifications()
    {
        return $this->getNotificationRelation()->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->getNotificationRelation()->orderBy('created_at', $order);
        if (! is_null($limit)) {
            $query->limit($limit);
        }

        return $query->get();
    }

    /**
     * Get all unread Notifications.
     * 
     * @param null|int $limit
     * @param string $order
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function getNotificationsNotRead($limit = null, $order = 'desc')
    {
        $query = $this->getNotificationRelation()->orderBy('created_at', $order);
        $query = $query->where('notifications.read', 0);
        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 NotifableBasic.
9			*/
10			trait NotifableBasic
11			{
12			/**
13			* Get the notifications Relationship.
14			*
15			* @return \Illuminate\Database\Eloquent\Relations\HasMany\|\Illuminate\Database\Eloquent\Relations\MorphMany
16			*/
17			abstract public function getNotificationRelation();
18
19			/**
20			* Get a new NotifynderManager instance with the given category.
21			*
22			* @param string\|int\|\Fenos\Notifynder\Models\NotificationCategory $category
23			* @return \Fenos\Notifynder\Managers\NotifynderManager
24			*/
25			public function notifynder($category)
26			{
27			return app('notifynder')->category($category);
28			}
29
30			/**
31			* Get a new NotifynderManager instance with the given category and $this as the sender.
32			*
33			* @param string\|int\|\Fenos\Notifynder\Models\NotificationCategory $category
34			* @return \Fenos\Notifynder\Managers\NotifynderManager
35			*/
36			public function sendNotificationFrom($category)
37			{
38			return $this->notifynder($category)->from($this);
			0 ignored issues – show Documentation Bug introduced 2016-09-16 12:36 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...
39			}
40
41			/**
42			* Get a new NotifynderManager instance with the given category and $this as the receiver.
43			*
44			* @param string\|int\|\Fenos\Notifynder\Models\NotificationCategory $category
45			* @return \Fenos\Notifynder\Managers\NotifynderManager
46			*/
47			public function sendNotificationTo($category)
48			{
49			return $this->notifynder($category)->to($this);
			0 ignored issues – show Documentation Bug introduced 2016-09-16 12:36 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...
50			}
51
52			/**
53			* Read a single Notification.
54			*
55			* @param int $notification
56			* @return bool
57			*/
58			public function readNotification($notification)
59			{
60			return $this->updateSingleReadStatus($notification, 1);
61			}
62
63			/**
64			* Unread a single Notification.
65			*
66			* @param int $notification
67			* @return bool
68			*/
69			public function unreadNotification($notification)
70			{
71			return $this->updateSingleReadStatus($notification, 0);
72			}
73
74			/**
75			* @param int $notification
76			* @param int $value
77			* @return bool
78			*/
79			protected function updateSingleReadStatus($notification, $value)
80			{
81			if (! TypeChecker::isNotification($notification, false)) {
82			$notification = $this->getNotificationRelation()->findOrFail($notification);
83			}
84
85			if ($this->getNotificationRelation()->where($notification->getKeyName(), $notification->getKey())->exists()) {
86			return $value ? $notification->read() : $notification->unread();
87			}
88
89			return false;
90			}
91
92			/**
93			* Read all Notifications.
94			*
95			* @return mixed
96			*/
97			public function readAllNotifications()
98			{
99			return $this->getNotificationRelation()->update(['read' => 1]);
100			}
101
102			/**
103			* Unread all Notifications.
104			*
105			* @return mixed
106			*/
107			public function unreadAllNotifications()
108			{
109			return $this->getNotificationRelation()->update(['read' => 0]);
110			}
111
112			/**
113			* Count unread notifications.
114			*
115			* @return int
116			*/
117			public function countUnreadNotifications()
118			{
119			return $this->getNotificationRelation()->byRead(0)->count();
120			}
121
122			/**
123			* Get all Notifications ordered by creation and optional limit.
124			*
125			* @param null\|int $limit
126			* @param string $order
127			* @return \Illuminate\Database\Eloquent\Collection
128			*/
129			public function getNotifications($limit = null, $order = 'desc')
130			{
131			$query = $this->getNotificationRelation()->orderBy('created_at', $order);
132			if (! is_null($limit)) {
133			$query->limit($limit);
134			}
135
136			return $query->get();
137			}
138
139			/**
140			* Get all unread Notifications.
141			*
142			* @param null\|int $limit
143			* @param string $order
144			* @return \Illuminate\Database\Eloquent\Collection
145			*/
146			public function getNotificationsNotRead($limit = null, $order = 'desc')
147			{
148			$query = $this->getNotificationRelation()->orderBy('created_at', $order);
149			$query = $query->where('notifications.read', 0);
150			if (! is_null($limit)) {
151			$query->limit($limit);
152			}
153
154			return $query->get();
155			}
156			}
157

fenos / Notifynder

Pull Request — master (#272)

NotifableBasic A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

Duplication Side-by-Side

Filter issues like