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

LineChart::getType()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
ccs 2
cts 2
cp 1
crap 1
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\LineChart\LineChartOptions;
8
9
/**
10
 * @author Christophe Meneses
11
 */
12
class LineChart extends Chart
13
{
14
    /**
15
     * @var LineChartOptions
16
     */
17
    protected $options;
18
19 1
    public function __construct()
20
    {
21 1
        parent::__construct();
22
23 1
        $this->options = new LineChartOptions();
24 1
    }
25
26 1
    public function getType()
27
    {
28 1
        return 'LineChart';
29
    }
30
31 1
    public function getPackage()
32
    {
33 1
        return 'corechart';
34
    }
35
36
    public function getAvailableEventTypes()
37
    {
38
        return [
39
            EventType::ANIMATION_FINISH,
40
            EventType::CLICK,
41
            EventType::ERROR,
42
            EventType::ON_MOUSE_OUT,
43
            EventType::ON_MOUSE_OVER,
44
            EventType::READY,
45
            EventType::SELECT,
46
        ];
47
    }
48
49
    /**
50
     * @return LineChartOptions
51
     */
52 1
    public function getOptions()
53
    {
54 1
        return $this->options;
55
    }
56
57
    /**
58
     * @param LineChartOptions $options
59
     *
60
     * @return LineChart
61
     */
62
    public function setOptions($options)
63
    {
64
        $this->options = $options;
65
66
        return $this;
0 ignored issues
show
Bug Best Practice introduced by
The expression return $this returns the type CMEN\GoogleChartsBundle\...Charts\Charts\LineChart 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...
67
    }
68
}
69