Completed
Push — master ( 958457...6c3b78 )
by John
09:26 queued 06:16
created

RendererBuilderBarcode   A

Complexity

Total Complexity 2

Size/Duplication

Total Lines 20
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 2

Importance

Changes 0
Metric Value
wmc 2
lcom 0
cbo 2
dl 0
loc 20
rs 10
c 0
b 0
f 0

2 Methods

Rating   Name   Duplication   Size   Complexity  
A instantiateParser() 0 4 1
A instantiateRenderer() 0 4 1
1
<?php
2
3
namespace Graze\CiffRenderer\Field\Renderer\Builder;
4
5
use Graze\CiffRenderer\Field\Builder\FixedTextBuilder;
6
use Graze\CiffRenderer\Field\Parser\BarcodeParser;
7
use Graze\CiffRenderer\Field\Renderer\BarcodeRenderer;
8
use Graze\CiffRenderer\Field\Parser\ParserInterface;
9
10
class RendererBuilderBarcode extends RendererBuilderFixedText
11
{
12
    /**
13
     * @return BarcodeRenderer
0 ignored issues
show
Documentation introduced by
Should the return type not be BarcodeParser?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
14
     */
15
    protected function instantiateParser()
16
    {
17
        return new BarcodeParser();
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \Graze\CiffRe...Parser\BarcodeParser(); (Graze\CiffRenderer\Field\Parser\BarcodeParser) is incompatible with the return type declared by the abstract method Graze\CiffRenderer\Field...lder::instantiateParser of type Graze\CiffRenderer\Field\Parser\ParserInterface.

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...
18
    }
19
20
    /**
21
     * @param ParserInterface $parser
22
     *
23
     * @return \Graze\CiffRenderer\Field\Renderer\RendererInterface
24
     */
25
    protected function instantiateRenderer(ParserInterface $parser)
26
    {
27
        return new BarcodeRenderer();
28
    }
29
}
30