MessageConsumed - Code Metrics - Inspection of "feat: allow to send metrics to StatsD or DogStatsD" - Evaneos/Burrow - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#27)

by Frederic

created 2018-12-17 13:00 UTC

MessageConsumed A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

Metric	Value
dl	0
loc	46
c	0
b	0
f	0
wmc	5
lcom	0
cbo	1
rs	10

5 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	elapsedTime()	4	1
A	getName()	4	1
A	stopPropagation()	4	1
A	isPropagationStopped()	4	1

<?php

namespace Burrow\Event;

use League\Event\EmitterAwareTrait;
use League\Event\EventInterface;

class MessageConsumed implements EventInterface
{
    use EmitterAwareTrait;

    const NAME = 'message.consumed';

    /** @var float */
    private $elapsedTime;

    /**
     * DaemonStopped constructor.
     *
     * @param float $elapsedTime
     */
    public function __construct($elapsedTime)
    {
        $this->elapsedTime = $elapsedTime;
    }

    /**
     * @return float
     */
    public function elapsedTime()
    {
        return $this->elapsedTime;
    }


    /**
     * @return string
     */
    public function getName()
    {
        return self::NAME;
    }

    public function stopPropagation()
    {
        return false;
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());
}
    }

    public function isPropagationStopped()
    {
        return false;
    }
}


1			<?php
2
3			namespace Burrow\Event;
4
5			use League\Event\EmitterAwareTrait;
6			use League\Event\EventInterface;
7
8			class MessageConsumed implements EventInterface
9			{
10			use EmitterAwareTrait;
11
12			const NAME = 'message.consumed';
13
14			/** @var float */
15			private $elapsedTime;
16
17			/**
18			* DaemonStopped constructor.
19			*
20			* @param float $elapsedTime
21			*/
22			public function __construct($elapsedTime)
23			{
24			$this->elapsedTime = $elapsedTime;
25			}
26
27			/**
28			* @return float
29			*/
30			public function elapsedTime()
31			{
32			return $this->elapsedTime;
33			}
34
35
36			/**
37			* @return string
38			*/
39			public function getName()
40			{
41			return self::NAME;
42			}
43
44			public function stopPropagation()
45			{
46			return false;
			0 ignored issues – show Bug Best Practice introduced 2018-12-17 13:06 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `League\Event\EventInterface::stopPropagation` of type `League\Event\EventInterface`. 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...
47			}
48
49			public function isPropagationStopped()
50			{
51			return false;
52			}
53			}
54

Evaneos / Burrow

Pull Request — master (#27)

MessageConsumed A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like