Completed
Push — master ( 192638...f858f1 )
by Ivannis Suárez
05:02
created

newDefaultOtherwiseComparator()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 6
rs 9.4285
cc 1
eloc 3
nc 1
nop 0
1
<?php
2
/**
3
 * This file is part of the Cubiche package.
4
 *
5
 * Copyright (c) Cubiche
6
 *
7
 * For the full copyright and license information, please view the LICENSE
8
 * file that was distributed with this source code.
9
 */
10
namespace Cubiche\Core\Comparable\Tests\Units;
11
12
use Cubiche\Core\Comparable\Order;
13
14
/**
15
 * Selector Comparator Tests Class.
16
 *
17
 * @author Ivannis Suárez Jerez <[email protected]>
18
 * @author Karel Osorio Ramírez <[email protected]>
19
 */
20
class SelectorComparatorTests extends ComparatorTestCase
21
{
22
    /**
23
     * {@inheritdoc}
24
     */
25
    protected function defaultConstructorArguments()
26
    {
27
        return array(
28
            function ($value) {
29
                return $value['foo'];
30
            },
31
            Order::ASC(),
32
        );
33
    }
34
35
    /**
36
     * {@inheritdoc}
37
     */
38
    protected function compareDataProvider()
39
    {
40
        return array(
41
            array(array('foo' => 1, 'bar' => 2), array('foo' => 2, 'bar' => 1), -1),
42
            array(array('foo' => 1, 'bar' => 0), array('foo' => 1, 'bar' => 2), 0),
43
            array(array('foo' => 1, 'bar' => 2), array('foo' => 0, 'bar' => 1), 1),
44
        );
45
    }
46
47
    /**
48
     * {@inheritdoc}
49
     */
50
    protected function newDefaultOtherwiseComparator()
51
    {
52
        return function ($value) {
0 ignored issues
show
Bug Best Practice introduced by
The return type of return function ($value)...eturn $value['bar']; }; (Closure) is incompatible with the return type of the parent method Cubiche\Core\Comparable\...aultOtherwiseComparator of type Cubiche\Core\Comparable\Comparator.

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...
53
            return $value['bar'];
54
        };
55
    }
56
}
57