Notifier::prepareNotification() - Code Metrics - Inspection of "Refactorization #2" - phaniso/phpmonitor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 288ab5...55621d )

by Ma

created 2016-03-02 13:30 UTC

Notifier::prepareNotification() A

↳ Parent: Notifier

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	1
eloc	6
nc	1
nop	2

<?php
namespace Monitor\Notification;

use Monitor\Model\Notification;
use Monitor\Model\Trigger;
use Monitor\Service\NotificationLog as NotificationLogService;
use Doctrine\ORM\EntityRepository;

class Notifier extends Observable
{

    /**
     * @var \Monitor\Notification\Parser
     */
    private $notificationParser;
    /**
     * @var \Monitor\Service\NotificationLog
     */
    private $notificationLogService;
    /**
     * Notification repository
     * @var \Doctrine\ORM\EntityRepository
     */
    private $repository;
    /**
     * @var array
     */
    private $notificationData;

    public function __construct(
        Parser $notificationParser,
        NotificationLogService $notificationLogService,
        EntityRepository $repository
    ) {
    
        $this->notificationParser = $notificationParser;
        $this->notificationLogService = $notificationLogService;
        $this->repository = $repository;
    }

    /**
     * Add notification data, we will use them in notification services
     *
     * @param array $data
     */
    public function setNotificationData(array $data)
    {
        $this->notificationData = $data;
    }
    /**
     * Get Notification by id
     *
     * @param int $id
     * @return \Monitor\Model\Notification $notification
     */
    private function getNotificationById($id)
    {
        $notification = $this->repository->find($id);
        return $notification;
    }

    /**
     * Parse notification message
     *
     * @param \Monitor\Model\Notification $notification
     * @param array $data
     */
    private function parseNotification(Notification $notification, $data)
    {
        $this->notificationParser->parse($notification, $data);
    }

    /**
     * Prepare notification
     *
     * @access private
     * @param  Trigger $trigger
     * @param  array   $serverData
     * @return \Monitor\Notification\Notification
     */
    private function prepareNotification(Trigger $trigger, array $serverData)
    {
        $notificationId = $trigger->getNotificationId();
        $notification = $this->getNotificationById($notificationId);
        //merge server data and trigger properties so we can use them in fulfilling notification message
        $data = array_merge($serverData, $trigger->toArray());
        $this->parseNotification($notification, $data);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        return $notification;
    }

    /**
     *
     *
     * @param  Trigger $trigger
     * @param  array   $serverData
     * @return \Monitor\Notification\Notification
     */
    public function triggerHasBeenFired(Trigger $trigger, array $serverData)
    {
        $notification = $this->prepareNotification($trigger, $serverData);
        $this->notifyServices($notification);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        return $notification;
    }

    /**
     * Send notification to notification service
     *
     * @access public
     * @param  Notification $notification
     * @return
     */
    public function notifyServices(Notification $notification)
    {
        foreach ($this->observers as $observer) {
            $observer->sendNotification($notification, $this->notificationData);
        }
    }
}


1			<?php
2			namespace Monitor\Notification;
3
4			use Monitor\Model\Notification;
5			use Monitor\Model\Trigger;
6			use Monitor\Service\NotificationLog as NotificationLogService;
7			use Doctrine\ORM\EntityRepository;
8
9			class Notifier extends Observable
10			{
11
12			/**
13			* @var \Monitor\Notification\Parser
14			*/
15			private $notificationParser;
16			/**
17			* @var \Monitor\Service\NotificationLog
18			*/
19			private $notificationLogService;
20			/**
21			* Notification repository
22			* @var \Doctrine\ORM\EntityRepository
23			*/
24			private $repository;
25			/**
26			* @var array
27			*/
28			private $notificationData;
29
30			public function __construct(
31			Parser $notificationParser,
32			NotificationLogService $notificationLogService,
33			EntityRepository $repository
34			) {
35
36			$this->notificationParser = $notificationParser;
37			$this->notificationLogService = $notificationLogService;
38			$this->repository = $repository;
39			}
40
41			/**
42			* Add notification data, we will use them in notification services
43			*
44			* @param array $data
45			*/
46			public function setNotificationData(array $data)
47			{
48			$this->notificationData = $data;
49			}
50			/**
51			* Get Notification by id
52			*
53			* @param int $id
54			* @return \Monitor\Model\Notification $notification
55			*/
56			private function getNotificationById($id)
57			{
58			$notification = $this->repository->find($id);
59			return $notification;
60			}
61
62			/**
63			* Parse notification message
64			*
65			* @param \Monitor\Model\Notification $notification
66			* @param array $data
67			*/
68			private function parseNotification(Notification $notification, $data)
69			{
70			$this->notificationParser->parse($notification, $data);
71			}
72
73			/**
74			* Prepare notification
75			*
76			* @access private
77			* @param Trigger $trigger
78			* @param array $serverData
79			* @return \Monitor\Notification\Notification
80			*/
81			private function prepareNotification(Trigger $trigger, array $serverData)
82			{
83			$notificationId = $trigger->getNotificationId();
84			$notification = $this->getNotificationById($notificationId);
85			//merge server data and trigger properties so we can use them in fulfilling notification message
86			$data = array_merge($serverData, $trigger->toArray());
87			$this->parseNotification($notification, $data);
			0 ignored issues – show Bug introduced 2016-03-02 13:24 UTC by Report Bug Copy Issue Report It seems like `$notification` defined by `$this->getNotificationById($notificationId)` on line `84` can be `null`; however, `Monitor\Notification\Notifier::parseNotification()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
88			return $notification;
89			}
90
91			/**
92			*
93			*
94			* @param Trigger $trigger
95			* @param array $serverData
96			* @return \Monitor\Notification\Notification
97			*/
98			public function triggerHasBeenFired(Trigger $trigger, array $serverData)
99			{
100			$notification = $this->prepareNotification($trigger, $serverData);
101			$this->notifyServices($notification);
			0 ignored issues – show Bug introduced 2016-03-02 13:24 UTC by Report Bug Copy Issue Report It seems like `$notification` defined by `$this->prepareNotification($trigger, $serverData)` on line `100` can be `null`; however, `Monitor\Notification\Notifier::notifyServices()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
102			return $notification;
103			}
104
105			/**
106			* Send notification to notification service
107			*
108			* @access public
109			* @param Notification $notification
110			* @return
111			*/
112			public function notifyServices(Notification $notification)
113			{
114			foreach ($this->observers as $observer) {
115			$observer->sendNotification($notification, $this->notificationData);
116			}
117			}
118			}
119

phaniso / phpmonitor

Push — master ( 288ab5...55621d )

Notifier::prepareNotification() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like