Completed
Push — master ( 8158f1...90d7fd )
by Konstantinos
11:17 queued 06:55
created

MatchTeamTransformer::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 4
ccs 3
cts 3
cp 1
rs 10
cc 1
eloc 2
nc 1
nop 0
crap 1
1
<?php
2
3
namespace BZIon\Form\Transformer;
4
5
use Symfony\Component\Form\DataTransformerInterface;
6
use Symfony\Component\Form\Exception\TransformationFailedException;
7
8
class MatchTeamTransformer extends SingleModelTransformer
9
{
10
    /**
11
     * Create new team
12
     */
13 1
    public function __construct()
14
    {
15 1
        parent::__construct('Team');
16 1
    }
17
18
    /**
19
     * Transforms an object (model) to an integer (int).
20
     *
21
     * @param  Model|null $model
22
     * @return int
23
     */
24 1
    public function transform($model)
25
    {
26 1
        return parent::transform($model);
27
    }
28
29
    /**
30
     * Transforms an ID to an object
31
     *
32
     * @param  int                           $id
33
     * @throws TransformationFailedException if the team is not found.
34
     * @return Model
35
     */
36 1
    public function reverseTransform($id)
37
    {
38 1
        if (\ColorTeam::isValidTeamColor($id)) {
39 1
            return new \ColorTeam($id);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \ColorTeam($id); (ColorTeam) is incompatible with the return type of the parent method BZIon\Form\Transformer\S...ormer::reverseTransform of type Model.

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...
40
        }
41
42 1
        return parent::reverseTransform($id);
43
    }
44
}
45