Completed
Pull Request — master (#5)
by Giancarlos
04:05
created

SummaryV2   A

Complexity

Total Complexity 2

Size/Duplication

Total Lines 26
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 1

Test Coverage

Coverage 100%

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 2
lcom 0
cbo 1
dl 0
loc 26
ccs 5
cts 5
cp 1
rs 10
c 1
b 0
f 0

2 Methods

Rating   Name   Duplication   Size   Complexity  
A getDetails() 0 4 1
A setDetails() 0 5 1
1
<?php
2
/**
3
 * Created by PhpStorm.
4
 * User: Administrador
5
 * Date: 04/10/2017
6
 * Time: 12:08 PM
7
 */
8
9
namespace Greenter\Model\Summary;
10
11
/**
12
 * Class SummaryV2
13
 * @package Greenter\Model\Summary
14
 */
15
class SummaryV2 extends Summary
16
{
17
    /**
18
     * @Assert\Valid()
19
     * @var SummaryDetailV2[]
20
     */
21
    private $details;
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
22
23
    /**
24
     * @return SummaryDetailV2[]
25
     */
26 6
    public function getDetails()
27
    {
28 6
        return $this->details;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->details; (Greenter\Model\Summary\SummaryDetailV2[]) is incompatible with the return type of the parent method Greenter\Model\Summary\Summary::getDetails of type Greenter\Model\Summary\SummaryDetail[].

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
     * @param SummaryDetailV2[] $details
33
     * @return SummaryV2
34
     */
35 12
    public function setDetails($details)
36
    {
37 12
        $this->details = $details;
38 12
        return $this;
39
    }
40
}