Fenos\Notifynder\Traits\NotifableBasic

Complexity

Total Complexity

20

Size/Duplication

Total Lines	168
Duplicated Lines	10.71 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

13 Methods

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

<?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);

The method from does not exist on object<Fenos\Notifynder\Managers\NotifynderManager>? Since you implemented __call, maybe consider adding a @method annotation.

    }

    /**
     * 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);

The method to does not exist on object<Fenos\Notifynder\Managers\NotifynderManager>? Since you implemented __call, maybe consider adding a @method annotation.

    }

    /**
     * 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')

This method seems to be duplicated in your project.

    {
        $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')

This method seems to be duplicated in your project.

    {
        $query = $this->getNotificationRelation()->byRead(0)->orderBy('created_at', $order);
        if (! is_null($limit)) {
            $query->limit($limit);
        }

        return $query->get();
    }
}