RuntimeBackend - Code Metrics - sonata-project/SonataNotificationBundle - Measure and Improve Code Quality continuously with Scrutinizer

RuntimeBackend A
last analyzed 2020-08-28 02:03 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

Metric	Value
wmc	10
lcom	1
cbo	6
dl	0
loc	93
rs	10
c	0
b	0
f	0

9 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	publish()	6	1
A	create()	9	1
A	createAndPublish()	4	1
A	getIterator()	4	1
A	initialize()	3	1
A	cleanup()	3	1
A	handle()	16	2
A	getStatus()	4	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\NotificationBundle\Backend;

use Laminas\Diagnostics\Result\Success;
use Sonata\NotificationBundle\Consumer\ConsumerEvent;
use Sonata\NotificationBundle\Exception\HandlingException;
use Sonata\NotificationBundle\Model\Message;
use Sonata\NotificationBundle\Model\MessageInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

class RuntimeBackend implements BackendInterface
{
    /**
     * @var EventDispatcherInterface
     */
    protected $dispatcher;

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

    /**
     * {@inheritdoc}
     */
    public function publish(MessageInterface $message)
    {
        $this->handle($message, $this->dispatcher);

        return $message;
    }

    /**
     * {@inheritdoc}
     */
    public function create($type, array $body)
    {
        $message = new Message();
        $message->setType($type);
        $message->setBody($body);
        $message->setState(MessageInterface::STATE_OPEN);

        return $message;
    }

    /**
     * {@inheritdoc}
     */
    public function createAndPublish($type, array $body)
    {
        return $this->publish($this->create($type, $body));
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator()
    {
        return new \EmptyIterator();
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function initialize(): void
    {
    }

    /**
     * {@inheritdoc}
     */
    public function cleanup(): void
    {
    }

    /**
     * {@inheritdoc}
     */
    public function handle(MessageInterface $message, EventDispatcherInterface $dispatcher): void
    {
        $event = new ConsumerEvent($message);

        try {
            $dispatcher->dispatch($event, $message->getType());

            $message->setCompletedAt(new \DateTime());
            $message->setState(MessageInterface::STATE_DONE);
        } catch (\Exception $e) {
            $message->setCompletedAt(new \DateTime());
            $message->setState(MessageInterface::STATE_ERROR);

            throw new HandlingException('Error while handling a message: '.$e->getMessage(), 0, $e);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getStatus()
    {
        return new Success('Runtime backend health check', 'Ok  (Runtime)');
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\NotificationBundle\Backend;
15
16			use Laminas\Diagnostics\Result\Success;
17			use Sonata\NotificationBundle\Consumer\ConsumerEvent;
18			use Sonata\NotificationBundle\Exception\HandlingException;
19			use Sonata\NotificationBundle\Model\Message;
20			use Sonata\NotificationBundle\Model\MessageInterface;
21			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
22
23			class RuntimeBackend implements BackendInterface
24			{
25			/**
26			* @var EventDispatcherInterface
27			*/
28			protected $dispatcher;
29
30			public function __construct(EventDispatcherInterface $dispatcher)
31			{
32			$this->dispatcher = $dispatcher;
33			}
34
35			/**
36			* {@inheritdoc}
37			*/
38			public function publish(MessageInterface $message)
39			{
40			$this->handle($message, $this->dispatcher);
41
42			return $message;
43			}
44
45			/**
46			* {@inheritdoc}
47			*/
48			public function create($type, array $body)
49			{
50			$message = new Message();
51			$message->setType($type);
52			$message->setBody($body);
53			$message->setState(MessageInterface::STATE_OPEN);
54
55			return $message;
56			}
57
58			/**
59			* {@inheritdoc}
60			*/
61			public function createAndPublish($type, array $body)
62			{
63			return $this->publish($this->create($type, $body));
64			}
65
66			/**
67			* {@inheritdoc}
68			*/
69			public function getIterator()
70			{
71			return new \EmptyIterator();
			0 ignored issues – show Bug Best Practice introduced 2017-08-02 00:09 UTC by Report Bug Copy Issue Report The return type of `return new \EmptyIterator();` (`EmptyIterator`) is incompatible with the return type declared by the interface `Sonata\NotificationBundl...dInterface::getIterator` of type `Sonata\NotificationBundl...essageIteratorInterface`. 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...
72			}
73
74			/**
75			* {@inheritdoc}
76			*/
77			public function initialize(): void
78			{
79			}
80
81			/**
82			* {@inheritdoc}
83			*/
84			public function cleanup(): void
85			{
86			}
87
88			/**
89			* {@inheritdoc}
90			*/
91			public function handle(MessageInterface $message, EventDispatcherInterface $dispatcher): void
92			{
93			$event = new ConsumerEvent($message);
94
95			try {
96			$dispatcher->dispatch($event, $message->getType());
97
98			$message->setCompletedAt(new \DateTime());
99			$message->setState(MessageInterface::STATE_DONE);
100			} catch (\Exception $e) {
101			$message->setCompletedAt(new \DateTime());
102			$message->setState(MessageInterface::STATE_ERROR);
103
104			throw new HandlingException('Error while handling a message: '.$e->getMessage(), 0, $e);
105			}
106			}
107
108			/**
109			* {@inheritdoc}
110			*/
111			public function getStatus()
112			{
113			return new Success('Runtime backend health check', 'Ok (Runtime)');
114			}
115			}
116

sonata-project / SonataNotificationBundle

RuntimeBackend A last analyzed 2020-08-28 02:03 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

Duplication Side-by-Side

Filter issues like

RuntimeBackend A
last analyzed 2020-08-28 02:03 UTC