Passed
Pull Request — master (#38)
by Christophe
05:14
created

TreeMapChart::setOptions()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
cc 1
eloc 2
nc 1
nop 1
dl 0
loc 5
ccs 0
cts 3
cp 0
crap 2
rs 10
c 0
b 0
f 0
1
<?php
2
3
namespace CMEN\GoogleChartsBundle\GoogleCharts\Charts;
4
5
use CMEN\GoogleChartsBundle\GoogleCharts\Chart;
6
use CMEN\GoogleChartsBundle\GoogleCharts\EventType;
7
use CMEN\GoogleChartsBundle\GoogleCharts\Options\TreeMapChart\TreeMapChartOptions;
8
9
/**
10
 * @author Christophe Meneses
11
 */
12
class TreeMapChart extends Chart
13
{
14
    /**
15
     * @var TreeMapChartOptions
16
     */
17
    protected $options;
18
19 1
    public function __construct()
20
    {
21 1
        parent::__construct();
22
23 1
        $this->options = new TreeMapChartOptions();
24 1
    }
25
26
    public function getType()
27
    {
28
        return 'TreeMap';
29
    }
30
31
    public function getPackage()
32
    {
33
        return 'treemap';
34
    }
35
36 1
    public function getAvailableEventTypes()
37
    {
38
        return [
39 1
            EventType::ON_MOUSE_OUT,
40
            EventType::ON_MOUSE_OVER,
41
            EventType::READY,
42
            EventType::ROLLUP,
43
            EventType::SELECT,
44
        ];
45
    }
46
47
    /**
48
     * @return TreeMapChartOptions
49
     */
50
    public function getOptions()
51
    {
52
        return $this->options;
53
    }
54
55
    /**
56
     * @param TreeMapChartOptions $options
57
     *
58
     * @return TreeMapChart
59
     */
60
    public function setOptions($options)
61
    {
62
        $this->options = $options;
63
64
        return $this;
0 ignored issues
show
Bug Best Practice introduced by
The expression return $this returns the type CMEN\GoogleChartsBundle\...rts\Charts\TreeMapChart which is incompatible with the return type mandated by CMEN\GoogleChartsBundle\...rts\Chart::setOptions() of CMEN\GoogleChartsBundle\...s\ChartOptionsInterface.

In the issue above, the returned value is violating the contract defined by the mentioned interface.

Let's take a look at an example:

interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
Loading history...
65
    }
66
}
67