NotifableBasic::unreadNotification() - Code Metrics - fenos/Notifynder - Measure and Improve Code Quality continuously with Scrutinizer

NotifableBasic::unreadNotification() A
last analyzed 2017-08-10 09:23 UTC

↳ Parent: NotifableBasic

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace Fenos\Notifynder\Traits;

use Fenos\Notifynder\Helpers\TypeChecker;

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

    /**
     * Get the notifications Relationship.
     *
     * @param array|bool $eagerLoad
     * @return \Illuminate\Database\Eloquent\Relations\HasMany|\Illuminate\Database\Eloquent\Relations\MorphMany
     */
    public function getNotificationRelation($eagerLoad = null)
    {
        $with = [];
        if (is_null($eagerLoad)) {
            $eagerLoad = notifynder_config('eager_load', false);
        }

        if ($eagerLoad === true) {
            $with = ['category', 'from', 'to']; // all relations
        } elseif (is_array($eagerLoad)) {
            $with = $eagerLoad;
        }

        return $this->getLazyNotificationRelation()->with($with);
    }

    /**
     * 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->getLazyNotificationRelation()->findOrFail($notification);
        }

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

        return false;
    }

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

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

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

fenos / Notifynder

NotifableBasic::unreadNotification() A last analyzed 2017-08-10 09:23 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

NotifableBasic::unreadNotification() A
last analyzed 2017-08-10 09:23 UTC