GenericPageTest::testGenerateContentRaces()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
3
namespace Sportic\Timing\RaceTecClient\Tests\Parsers;
4
5
use Sportic\Timing\CommonClient\Content\GenericContent;
6
use Sportic\Timing\RaceTecClient\Scrapers\EventPage as EventPageScraper;
7
use Sportic\Timing\RaceTecClient\Parsers\EventPage as EventPageParser;
8
9
/**
10
 * Class EventPageTest
11
 * @package Sportic\Timing\RaceTecClient\Tests\Scrapers
12
 */
13
class GenericPageTest extends AbstractPageTest
14
{
15
16
    public function testGenerateContentRaces()
17
    {
18
        self::assertInstanceOf(GenericContent::class, self::$parametersParsed);
19
    }
20
21
    /**
22
     * @inheritdoc
23
     */
24
    protected static function getNewScraper()
25
    {
26
        return new EventPageScraper('16648', '2091', '1');
27
    }
28
29
    /**
30
     * @inheritdoc
31
     */
32
    protected static function getNewParser()
33
    {
34
        return new EventPageParser();
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \Sportic\Timi...nt\Parsers\EventPage(); (Sportic\Timing\RaceTecClient\Parsers\EventPage) is incompatible with the return type declared by the abstract method Sportic\Timing\RaceTecCl...tPageTest::getNewParser of type Sportic\Timing\RaceTecCl...crapers\AbstractScraper.

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...
35
    }
36
37
    /**
38
     * @inheritdoc
39
     */
40
    protected static function getSerializedFile()
41
    {
42
        return 'event_page.serialized';
43
    }
44
45
    /**
46
     * @inheritdoc
47
     */
48
    protected static function getHtmlFile()
49
    {
50
        return 'event_page.html';
51
    }
52
}
53