Notification::setTo() - Code Metrics - Inspection of "Feature notification center" - bakaphp/canvas-core - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#123)

by Maximo

created 2019-07-08 06:47 UTC

Notification::setTo() A

↳ Parent: Notification

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	1
eloc	1
c	1
b	0
f	1
nc	1
nop	1
dl	0
loc	3
ccs	0
cts	3
cp	0
crap	2
rs	10

<?php

declare(strict_types=1);

namespace Canvas\Notifications;

use Canvas\Contracts\Notifications\NotificationInterfase;
use Canvas\Models\AbstractModel;
use Canvas\Models\NotificationType;
use Baka\Mail\Message;
use Canvas\Models\Users;
use Canvas\Models\Notifications;
use Phalcon\Traits\EventManagerAwareTrait;
use Phalcon\Di;

class Notification implements NotificationInterfase
{
    use EventManagerAwareTrait;

    /**
     *
     * @var Users
     */
    protected $toUser = null;

    /**
     *
     * @var Users
     */
    protected $fromUser = null;

    /**
     * Send this notification to the queue?
     *
     * @var boolean
     */
    protected $useQueue = false;

    /**
     *
     * @var NotificationType
     */
    protected $type = null;

    /**
     *
     * @var AbstractModel
     */
    protected $entity = null;

    /**
     *
     * @var Baka\Mail\Manager

     */
    protected $mail;

    /**
     * Constructor.
     *
     * @param AbstractModel $entity
     */
    public function __construct(AbstractModel $entity)
    {
        $this->entity = $entity;
    }

    /**
     * Set the notification type.
     *
     * @param NotificationType $type
     * @return void
     */
    public function setType(NotificationType $type): void
    {
        $this->type = $type;
    }

    /**
     * Return the message from the current notification type.
     *
     * @return string
     */
    public function message(): string
    {
        return $this->type->template ?: '';
    }

    /**
     * Define a Baka Mail to send a email.
     *
     * @todo add Interfase to bakaMail
     * @return Message
     */
    protected function toMail(): ?Message
    {
    }

    /**
     * To send push notification.
     *
     * @return void
     */
    protected function toPushNotification()
    {
    }

    /**
     * Send to websocket / realtime.
     *
     * @return void
     */
    protected function toReatime()
    {
        //set the channel
        //key_user_id
    }

    /**
     * Set the usre we are sending the notification to.
     *
     * @param Users $user
     * @return void
     */
    public function setTo(Users $user): void
    {
        $this->toUser = $user;
    }

    /**
     * Set the user from who the notification if comming from.
     *
     * @param User $user
filter:
    dependency_paths: ["lib/*"]
     * @return void
     */
    public function setFrom(Users $user): void
    {
        $this->fromUser = $user;
    }

    /**
     * Process the notification
     *  - handle the db
     *  - trigger the notification
     *  - knows if we have to send it to queu.
     *
     * @return boolean
     */
    public function process(): bool
    {
        //if the user didnt provide the type get it based on the class name
        if (is_null($this->type)) {
            $this->setType(NotificationType::getByKey(static::class));
        }

        if (Di::getDefault()->has('mail')) {
            $this->mail = Di::getDefault()->getMail();
        }

        if ($this->useQueue) {
            return true; //send it to the queue
        }

        $this->trigger();

        return true;
    }

    /**
     * Send the noficiatino to the places the user defined.
     *
     * @return boolean
     */
    public function trigger(): bool
    {
        $content = $this->message();
        $app = Di::getDefault()->getApp();

        //save to DB
        $notification = new Notifications();
        $notification->from_users_id = $this->fromUser->getId();
        $notification->users_id = $this->toUser->getId();
        $notification->companies_id = $this->fromUser->currentCompanyId();
        $notification->apps_id = $app->getId();
        $notification->system_modules_id = $this->type->system_modules_id;
        $notification->notification_type_id = $this->type->getId();
        $notification->entity_id = $this->entity->getId();
        $notification->content = $content;
        $notification->read = 0;
        $notification->saveOrFail();

        if ($this->toMail() instanceof Message) {
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            $this->fire('notification:sendMail', $this->toMail());
        }

        /**
         * @todo send to push ontification
         */

        if ($this->type->with_realtime) {
            $this->fire('notification:sendRealtime', $this);
        }

        return true;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Canvas\Notifications;
6
7			use Canvas\Contracts\Notifications\NotificationInterfase;
8			use Canvas\Models\AbstractModel;
9			use Canvas\Models\NotificationType;
10			use Baka\Mail\Message;
11			use Canvas\Models\Users;
12			use Canvas\Models\Notifications;
13			use Phalcon\Traits\EventManagerAwareTrait;
14			use Phalcon\Di;
15
16			class Notification implements NotificationInterfase
17			{
18			use EventManagerAwareTrait;
19
20			/**
21			*
22			* @var Users
23			*/
24			protected $toUser = null;
25
26			/**
27			*
28			* @var Users
29			*/
30			protected $fromUser = null;
31
32			/**
33			* Send this notification to the queue?
34			*
35			* @var boolean
36			*/
37			protected $useQueue = false;
38
39			/**
40			*
41			* @var NotificationType
42			*/
43			protected $type = null;
44
45			/**
46			*
47			* @var AbstractModel
48			*/
49			protected $entity = null;
50
51			/**
52			*
53			* @var Baka\Mail\Manager
			0 ignored issues – show Bug introduced 2019-07-08 06:53 UTC by Report Bug Copy Issue Report The type `Canvas\Notifications\Baka\Mail\Manager` was not found. Did you mean `Baka\Mail\Manager`? If so, make sure to prefix the type with `\`. Loading history...
54			*/
55			protected $mail;
56
57			/**
58			* Constructor.
59			*
60			* @param AbstractModel $entity
61			*/
62			public function __construct(AbstractModel $entity)
63			{
64			$this->entity = $entity;
65			}
66
67			/**
68			* Set the notification type.
69			*
70			* @param NotificationType $type
71			* @return void
72			*/
73			public function setType(NotificationType $type): void
74			{
75			$this->type = $type;
76			}
77
78			/**
79			* Return the message from the current notification type.
80			*
81			* @return string
82			*/
83			public function message(): string
84			{
85			return $this->type->template ?: '';
86			}
87
88			/**
89			* Define a Baka Mail to send a email.
90			*
91			* @todo add Interfase to bakaMail
92			* @return Message
93			*/
94			protected function toMail(): ?Message
95			{
96			}
97
98			/**
99			* To send push notification.
100			*
101			* @return void
102			*/
103			protected function toPushNotification()
104			{
105			}
106
107			/**
108			* Send to websocket / realtime.
109			*
110			* @return void
111			*/
112			protected function toReatime()
113			{
114			//set the channel
115			//key_user_id
116			}
117
118			/**
119			* Set the usre we are sending the notification to.
120			*
121			* @param Users $user
122			* @return void
123			*/
124			public function setTo(Users $user): void
125			{
126			$this->toUser = $user;
127			}
128
129			/**
130			* Set the user from who the notification if comming from.
131			*
132			* @param User $user
			0 ignored issues – show Bug introduced 2019-07-08 06:53 UTC by Report Bug Copy Issue Report The type `Canvas\Notifications\User` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
133			* @return void
134			*/
135			public function setFrom(Users $user): void
136			{
137			$this->fromUser = $user;
138			}
139
140			/**
141			* Process the notification
142			* - handle the db
143			* - trigger the notification
144			* - knows if we have to send it to queu.
145			*
146			* @return boolean
147			*/
148			public function process(): bool
149			{
150			//if the user didnt provide the type get it based on the class name
151			if (is_null($this->type)) {
152			$this->setType(NotificationType::getByKey(static::class));
153			}
154
155			if (Di::getDefault()->has('mail')) {
156			$this->mail = Di::getDefault()->getMail();
157			}
158
159			if ($this->useQueue) {
160			return true; //send it to the queue
161			}
162
163			$this->trigger();
164
165			return true;
166			}
167
168			/**
169			* Send the noficiatino to the places the user defined.
170			*
171			* @return boolean
172			*/
173			public function trigger(): bool
174			{
175			$content = $this->message();
176			$app = Di::getDefault()->getApp();
177
178			//save to DB
179			$notification = new Notifications();
180			$notification->from_users_id = $this->fromUser->getId();
181			$notification->users_id = $this->toUser->getId();
182			$notification->companies_id = $this->fromUser->currentCompanyId();
183			$notification->apps_id = $app->getId();
184			$notification->system_modules_id = $this->type->system_modules_id;
185			$notification->notification_type_id = $this->type->getId();
186			$notification->entity_id = $this->entity->getId();
187			$notification->content = $content;
188			$notification->read = 0;
189			$notification->saveOrFail();
190
191			if ($this->toMail() instanceof Message) {
			0 ignored issues – show Bug introduced 2019-07-08 06:53 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->toMail()` targeting `Canvas\Notifications\Notification::toMail()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
192			$this->fire('notification:sendMail', $this->toMail());
193			}
194
195			/**
196			* @todo send to push ontification
197			*/
198
199			if ($this->type->with_realtime) {
200			$this->fire('notification:sendRealtime', $this);
201			}
202
203			return true;
204			}
205			}
206

bakaphp / canvas-core

Pull Request — master (#123)

Notification::setTo() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like