BaseFormatter::format() - Code Metrics - Inspection of "Add tests for nexmo channel" - irishdan/NotificationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 40fe4a...13aa34 )

by dan

created 2017-08-23 10:25 UTC

BaseFormatter::format() A

↳ Parent: BaseFormatter

Complexity

Conditions	3
Paths	2

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	8
nc	2
nop	1

<?php

namespace IrishDan\NotificationBundle\Formatter;

use IrishDan\NotificationBundle\Message\Message;
use IrishDan\NotificationBundle\Notification\NotificationInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

abstract class BaseFormatter
{
    protected $twig;
    protected $eventDispatcher;

    public function setTemplating(\Twig_Environment $twig)
    {
        $this->twig = $twig;
    }

    public function setDispatcher(EventDispatcherInterface $eventDispatcher)
    {
        $this->eventDispatcher = $eventDispatcher;
    }

    protected function renderTwigTemplate($data, $user, $template)
    {
        return $this->twig->render(
            $template,
            [
                'data' => $data,
                'user' => $user,
            ]
        );
    }

    public function format(NotificationInterface $notification)
    {
        if (!empty($this->twig) && $notification->getTemplate()) {
            $data         = $notification->getDataArray();
            $data['body'] = $this->renderTwigTemplate(
                $data,
                $notification->getNotifiable(),
                $notification->getTemplate()
            );

            $notification->setDataArray($data);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
    }

    static protected function createMessage($dispatchData, $messageData, $channel = 'default')

    {
        $message = new Message();

        $message->setChannel($channel);
        $message->setDispatchData($dispatchData);
        $message->setMessageData($messageData);

        return $message;
    }

    static protected function createMessagaData(array $notificationData)

    {
        // Build the message data array.
        $messageData          = [];
        $messageData['body']  = empty($notificationData['body']) ? '' : $notificationData['body'];
        $messageData['title'] = empty($notificationData['title']) ? '' : $notificationData['title'];

        return $messageData;
    }
}

1			<?php
2
3			namespace IrishDan\NotificationBundle\Formatter;
4
5			use IrishDan\NotificationBundle\Message\Message;
6			use IrishDan\NotificationBundle\Notification\NotificationInterface;
7			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
8
9			abstract class BaseFormatter
10			{
11			protected $twig;
12			protected $eventDispatcher;
13
14			public function setTemplating(\Twig_Environment $twig)
15			{
16			$this->twig = $twig;
17			}
18
19			public function setDispatcher(EventDispatcherInterface $eventDispatcher)
20			{
21			$this->eventDispatcher = $eventDispatcher;
22			}
23
24			protected function renderTwigTemplate($data, $user, $template)
25			{
26			return $this->twig->render(
27			$template,
28			[
29			'data' => $data,
30			'user' => $user,
31			]
32			);
33			}
34
35			public function format(NotificationInterface $notification)
36			{
37			if (!empty($this->twig) && $notification->getTemplate()) {
38			$data = $notification->getDataArray();
39			$data['body'] = $this->renderTwigTemplate(
40			$data,
41			$notification->getNotifiable(),
42			$notification->getTemplate()
43			);
44
45			$notification->setDataArray($data);
			0 ignored issues – show Bug introduced 2017-08-22 14:30 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `IrishDan\NotificationBun...n\NotificationInterface` as the method `setDataArray()` does only exist in the following implementations of said interface: `IrishDan\NotificationBun...cation\TestNotification`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
46			}
47			}
48
49			static protected function createMessage($dispatchData, $messageData, $channel = 'default')
			0 ignored issues – show Coding Style introduced 2017-08-23 10:27 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
50			{
51			$message = new Message();
52
53			$message->setChannel($channel);
54			$message->setDispatchData($dispatchData);
55			$message->setMessageData($messageData);
56
57			return $message;
58			}
59
60			static protected function createMessagaData(array $notificationData)
			0 ignored issues – show Coding Style introduced 2017-08-23 10:27 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history...
61			{
62			// Build the message data array.
63			$messageData = [];
64			$messageData['body'] = empty($notificationData['body']) ? '' : $notificationData['body'];
65			$messageData['title'] = empty($notificationData['title']) ? '' : $notificationData['title'];
66
67			return $messageData;
68			}
69			}

irishdan / NotificationBundle

Push — master ( 40fe4a...13aa34 )

BaseFormatter::format() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like