DefaultChannel::format() - Code Metrics - Inspection of "Add event subscriber to drive event driven dispatc..." - irishdan/NotificationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 25ba26...942c9a )

by dan

created 2017-08-30 06:52 UTC

DefaultChannel::format() A

↳ Parent: DefaultChannel

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace IrishDan\NotificationBundle\Channel;

use IrishDan\NotificationBundle\Event\MessageCreatedEvent;
use IrishDan\NotificationBundle\Exception\MessageDispatchException;
use IrishDan\NotificationBundle\Exception\MessageFormatException;
use IrishDan\NotificationBundle\Message\MessageInterface;
use IrishDan\NotificationBundle\Notification\NotificationInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;


/**
 * Class DefaultChannel
 *
 * @package NotificationBundle\Channel
 */
class DefaultChannel extends BaseChannel implements ChannelInterface
{
    protected $eventDispatcher;
    protected $dispatchToEvent = true;

    public function setDispatchToEvent($dispatchToEvent)
    {
        $this->dispatchToEvent = $dispatchToEvent;
    }

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

    public function formatAndDispatch(NotificationInterface $notification)
    {
        $message = $this->format($notification);

        if (!empty($this->eventDispatcher) && $this->dispatchToEvent) {
            $messageEvent = new MessageCreatedEvent($message);
            $this->eventDispatcher->dispatch(MessageCreatedEvent::NAME, $messageEvent);

            return $message;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        } else {
            return $this->dispatch($message);
        }
    }

    public function format(NotificationInterface $notification)
    {
        try {
            // Do the formatting.
            $message = $this->formatter->format($notification);

            return $message;
        } catch (\Exception $e) {
            throw new MessageFormatException(
                $e->getMessage() . ' ' . $e->getCode() . ' ' . $e->getFile() . ' ' . $e->getLine()
            );
        }
    }

    public function dispatch(MessageInterface $message)
    {
        // Dispatch the message
        try {
            return $this->dispatcher->dispatch($message);
        } catch (\Exception $e) {
            throw new MessageDispatchException(
                $e->getMessage() . ' ' . $e->getCode() . ' ' . $e->getFile() . ' ' . $e->getLine()
            );
        }
    }
}


1			<?php
2
3			namespace IrishDan\NotificationBundle\Channel;
4
5			use IrishDan\NotificationBundle\Event\MessageCreatedEvent;
6			use IrishDan\NotificationBundle\Exception\MessageDispatchException;
7			use IrishDan\NotificationBundle\Exception\MessageFormatException;
8			use IrishDan\NotificationBundle\Message\MessageInterface;
9			use IrishDan\NotificationBundle\Notification\NotificationInterface;
10			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
11
12
13			/**
14			* Class DefaultChannel
15			*
16			* @package NotificationBundle\Channel
17			*/
18			class DefaultChannel extends BaseChannel implements ChannelInterface
19			{
20			protected $eventDispatcher;
21			protected $dispatchToEvent = true;
22
23			public function setDispatchToEvent($dispatchToEvent)
24			{
25			$this->dispatchToEvent = $dispatchToEvent;
26			}
27
28			public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
29			{
30			$this->eventDispatcher = $eventDispatcher;
31			}
32
33			public function formatAndDispatch(NotificationInterface $notification)
34			{
35			$message = $this->format($notification);
36
37			if (!empty($this->eventDispatcher) && $this->dispatchToEvent) {
38			$messageEvent = new MessageCreatedEvent($message);
39			$this->eventDispatcher->dispatch(MessageCreatedEvent::NAME, $messageEvent);
40
41			return $message;
			0 ignored issues – show Bug Best Practice introduced 2017-08-30 06:54 UTC by Report Bug Copy Issue Report The return type of `return $message;` (`IrishDan\NotificationBun...essage\MessageInterface`) is incompatible with the return type declared by the interface `IrishDan\NotificationBun...face::formatAndDispatch` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
42			} else {
43			return $this->dispatch($message);
44			}
45			}
46
47			public function format(NotificationInterface $notification)
48			{
49			try {
50			// Do the formatting.
51			$message = $this->formatter->format($notification);
52
53			return $message;
54			} catch (\Exception $e) {
55			throw new MessageFormatException(
56			$e->getMessage() . ' ' . $e->getCode() . ' ' . $e->getFile() . ' ' . $e->getLine()
57			);
58			}
59			}
60
61			public function dispatch(MessageInterface $message)
62			{
63			// Dispatch the message
64			try {
65			return $this->dispatcher->dispatch($message);
66			} catch (\Exception $e) {
67			throw new MessageDispatchException(
68			$e->getMessage() . ' ' . $e->getCode() . ' ' . $e->getFile() . ' ' . $e->getLine()
69			);
70			}
71			}
72			}
73

irishdan / NotificationBundle

Push — master ( 25ba26...942c9a )

DefaultChannel::format() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like