MultiComparator::acceptComparatorVisitor() - Code Metrics - Inspection of "added dynamic dispatch vivitor" - cubiche/comparable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 13ee85...192638 )

by Ivannis Suárez

created 2016-07-04 22:02 UTC

MultiComparator::acceptComparatorVisitor() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

/**
 * This file is part of the Cubiche package.
 *
 * Copyright (c) Cubiche
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Cubiche\Core\Comparable;

/**
 * Multi Comparator Class.
 *
 * @author Karel Osorio Ramírez <[email protected]>
 */
class MultiComparator extends AbstractComparator
{
    /**
     * @var ComparatorInterface
     */
    protected $firstComparator;

    /**
     * @var ComparatorInterface
     */
    protected $secondComparator;

    /**
     * @param ComparatorInterface $firstComparator
     * @param ComparatorInterface $secondComparator
     */
    public function __construct(ComparatorInterface $firstComparator, ComparatorInterface $secondComparator)
    {
        $this->firstComparator = $firstComparator;
        $this->secondComparator = $secondComparator;
    }

    /**
     * @return \Cubiche\Core\Comparable\ComparatorInterface
     */
    public function firstComparator()
    {
        return $this->firstComparator;
    }

    /**
     * @return \Cubiche\Core\Comparable\ComparatorInterface
     */
    public function secondComparator()
    {
        return $this->secondComparator;
    }

    /**
     * {@inheritdoc}
     */
    public function compare($a, $b)
    {
        $result = $this->firstComparator()->compare($a, $b);

        return $result !== 0 ? $result : $this->secondComparator()->compare($a, $b);
    }

    /**
     * {@inheritdoc}
     */
    public function reverse()
    {
        return new self($this->firstComparator()->reverse(), $this->secondComparator()->reverse());
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());
}
    }
}


1			<?php
2
3			/**
4			* This file is part of the Cubiche package.
5			*
6			* Copyright (c) Cubiche
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11			namespace Cubiche\Core\Comparable;
12
13			/**
14			* Multi Comparator Class.
15			*
16			* @author Karel Osorio Ramírez <[email protected]>
17			*/
18			class MultiComparator extends AbstractComparator
19			{
20			/**
21			* @var ComparatorInterface
22			*/
23			protected $firstComparator;
24
25			/**
26			* @var ComparatorInterface
27			*/
28			protected $secondComparator;
29
30			/**
31			* @param ComparatorInterface $firstComparator
32			* @param ComparatorInterface $secondComparator
33			*/
34			public function __construct(ComparatorInterface $firstComparator, ComparatorInterface $secondComparator)
35			{
36			$this->firstComparator = $firstComparator;
37			$this->secondComparator = $secondComparator;
38			}
39
40			/**
41			* @return \Cubiche\Core\Comparable\ComparatorInterface
42			*/
43			public function firstComparator()
44			{
45			return $this->firstComparator;
46			}
47
48			/**
49			* @return \Cubiche\Core\Comparable\ComparatorInterface
50			*/
51			public function secondComparator()
52			{
53			return $this->secondComparator;
54			}
55
56			/**
57			* {@inheritdoc}
58			*/
59			public function compare($a, $b)
60			{
61			$result = $this->firstComparator()->compare($a, $b);
62
63			return $result !== 0 ? $result : $this->secondComparator()->compare($a, $b);
64			}
65
66			/**
67			* {@inheritdoc}
68			*/
69			public function reverse()
70			{
71			return new self($this->firstComparator()->reverse(), $this->secondComparator()->reverse());
			0 ignored issues – show Bug Best Practice introduced 2016-04-20 16:17 UTC by Report Bug Copy Issue Report The return type of `return new self($this->f...mparator()->reverse());` (`Cubiche\Core\Comparable\MultiComparator`) is incompatible with the return type of the parent method `Cubiche\Core\Comparable\...ractComparator::reverse` of type `Cubiche\Core\Comparable\ReverseComparator`. 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

cubiche / comparable

Push — master ( 13ee85...192638 )

MultiComparator::acceptComparatorVisitor() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like