Completed
Pull Request — master (#5)
by John
02:50
created

CommandGetxmlTest   A

Complexity

Total Complexity 3

Size/Duplication

Total Lines 26
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 2

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 3
c 1
b 0
f 0
lcom 0
cbo 2
dl 0
loc 26
rs 10

3 Methods

Rating   Name   Duplication   Size   Complexity  
A getCommand() 0 4 1
A getRawTelnetResponse() 0 4 1
A getExpectedResponseText() 0 4 1
1
<?php
2
3
/**
4
 * This file is part of graze/dynamark3-client.
5
 *
6
 * Copyright (c) 2016 Nature Delivered Ltd. <https://www.graze.com>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 *
11
 * @license https://github.com/graze/dynamark3-client/blob/master/LICENSE.md
12
 * @link https://github.com/graze/dynamark3-client
13
 */
14
15
namespace Graze\Dynamark3Client\Test\Unit\Command;
16
17
use Graze\Dynamark3Client\Test\AbstractCommandTestCase;
18
use Graze\Dynamark3Client\Command\CommandGetxml;
19
use Graze\Dynamark3Client\Dynamark3Constants;
20
21
class CommandGetxmlTest extends AbstractCommandTestCase
22
{
23
    /**
24
     * @return \Graze\Dynamark3Client\Command\CommandInterface
25
     */
26
    protected function getCommand()
27
    {
28
        return new CommandGetxml();
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \Graze\Dynama...ommand\CommandGetxml(); (Graze\Dynamark3Client\Command\CommandGetxml) is incompatible with the return type declared by the abstract method Graze\Dynamark3Client\Te...andTestCase::getCommand of type Graze\Dynamark3Client\Te...ommand\CommandInterface.

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...
29
    }
30
31
    /**
32
     * @return string
33
     */
34
    protected function getRawTelnetResponse()
35
    {
36
        return 'RESULT GETXML <xml><node>cool xml</node></xml>' . Dynamark3Constants::LINE_ENDING;
37
    }
38
39
    /**
40
     * @return string
41
     */
42
    protected function getExpectedResponseText()
43
    {
44
        return '<xml><node>cool xml</node></xml>';
45
    }
46
}
47