Notification::disableQueue() - Code Metrics - Inspection of "42298d05e1c4c13150211e7039f14ae2c9834ddb" - bakaphp/canvas-core - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Branch — add-core-tests (42298d)

by Rafael

created 2019-07-25 14:37 UTC

Notification::disableQueue() 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

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
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;
use Canvas\Queue\Queue;
use Phalcon\Mvc\Model;

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(Model $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 toRealtime()
    {
        //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;
    }

    /**
     * Disable this notification queue in runtime
     *
     * @return void
     */
    public function disableQueue(): void
    {
        $this->useQueue = false;
    }

    /**
     * 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) {
            $this->sendToQueue();
            return true; //send it to the queue
        }

        $this->trigger();

        return true;
    }

    /**
     * Send to our internal Notification queue
     *
     * @return boolean
     */
    protected function sendToQueue(): bool
    {
        $notificationData = [
            'from' => $this->fromUser,
            'to' => $this->toUser,
            'entity' => $this->entity,
            'type' => $this->type,
            'notification' => get_class($this)
        ];

        return Queue::send(Queue::NOTIFICATIONS, serialize($notificationData));
    }

    /**
     * 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			use Canvas\Queue\Queue;
16			use Phalcon\Mvc\Model;
17
18			class Notification implements NotificationInterfase
19			{
20			use EventManagerAwareTrait;
21
22			/**
23			*
24			* @var Users
25			*/
26			protected $toUser = null;
27
28			/**
29			*
30			* @var Users
31			*/
32			protected $fromUser = null;
33
34			/**
35			* Send this notification to the queue?
36			*
37			* @var boolean
38			*/
39			protected $useQueue = false;
40
41			/**
42			*
43			* @var NotificationType
44			*/
45			protected $type = null;
46
47			/**
48			*
49			* @var AbstractModel
50			*/
51			protected $entity = null;
52
53			/**
54			*
55			* @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...
56			*/
57			protected $mail;
58
59			/**
60			* Constructor.
61			*
62			* @param AbstractModel $entity
63			*/
64			public function __construct(Model $entity)
65			{
66			$this->entity = $entity;
67			}
68
69			/**
70			* Set the notification type.
71			*
72			* @param NotificationType $type
73			* @return void
74			*/
75			public function setType(NotificationType $type): void
76			{
77			$this->type = $type;
78			}
79
80			/**
81			* Return the message from the current notification type.
82			*
83			* @return string
84			*/
85			public function message(): string
86			{
87			return $this->type->template ?: '';
88			}
89
90			/**
91			* Define a Baka Mail to send a email.
92			*
93			* @todo add Interfase to bakaMail
94			* @return Message
95			*/
96			protected function toMail(): ?Message
97			{
98			}
99
100			/**
101			* To send push notification.
102			*
103			* @return void
104			*/
105			protected function toPushNotification()
106			{
107			}
108
109			/**
110			* Send to websocket / realtime.
111			*
112			* @return void
113			*/
114			protected function toRealtime()
115			{
116			//set the channel
117			//key_user_id
118			}
119
120			/**
121			* Set the usre we are sending the notification to.
122			*
123			* @param Users $user
124			* @return void
125			*/
126			public function setTo(Users $user): void
127			{
128			$this->toUser = $user;
129			}
130
131			/**
132			* Set the user from who the notification if comming from.
133			*
134			* @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...
135			* @return void
136			*/
137			public function setFrom(Users $user): void
138			{
139			$this->fromUser = $user;
140			}
141
142			/**
143			* Disable this notification queue in runtime
144			*
145			* @return void
146			*/
147			public function disableQueue(): void
148			{
149			$this->useQueue = false;
150			}
151
152			/**
153			* Process the notification
154			* - handle the db
155			* - trigger the notification
156			* - knows if we have to send it to queu.
157			*
158			* @return boolean
159			*/
160			public function process(): bool
161			{
162			//if the user didnt provide the type get it based on the class name
163			if (is_null($this->type)) {
164			$this->setType(NotificationType::getByKey(static::class));
165			}
166
167			if (Di::getDefault()->has('mail')) {
168			$this->mail = Di::getDefault()->getMail();
169			}
170
171			if ($this->useQueue) {
172			$this->sendToQueue();
173			return true; //send it to the queue
174			}
175
176			$this->trigger();
177
178			return true;
179			}
180
181			/**
182			* Send to our internal Notification queue
183			*
184			* @return boolean
185			*/
186			protected function sendToQueue(): bool
187			{
188			$notificationData = [
189			'from' => $this->fromUser,
190			'to' => $this->toUser,
191			'entity' => $this->entity,
192			'type' => $this->type,
193			'notification' => get_class($this)
194			];
195
196			return Queue::send(Queue::NOTIFICATIONS, serialize($notificationData));
197			}
198
199			/**
200			* Send the noficiatino to the places the user defined.
201			*
202			* @return boolean
203			*/
204			public function trigger(): bool
205			{
206			$content = $this->message();
207			$app = Di::getDefault()->getApp();
208
209			//save to DB
210			$notification = new Notifications();
211			$notification->from_users_id = $this->fromUser->getId();
212			$notification->users_id = $this->toUser->getId();
213			$notification->companies_id = $this->fromUser->currentCompanyId();
214			$notification->apps_id = $app->getId();
215			$notification->system_modules_id = $this->type->system_modules_id;
216			$notification->notification_type_id = $this->type->getId();
217			$notification->entity_id = $this->entity->getId();
218			$notification->content = $content;
219			$notification->read = 0;
220			$notification->saveOrFail();
221
222			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...
223			$this->fire('notification:sendMail', $this->toMail());
224			}
225
226			/**
227			* @todo send to push ontification
228			*/
229
230			if ($this->type->with_realtime) {
231			$this->fire('notification:sendRealtime', $this);
232			}
233
234			return true;
235			}
236			}
237

bakaphp / canvas-core

Branch — add-core-tests (42298d)

Notification::disableQueue() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like