ColumnChart::__construct() - Code Metrics - Inspection of "Improve QA" - cmen/CMENGoogleChartsBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#38)

by Christophe

created 2019-12-06 15:09 UTC

ColumnChart::__construct() A

↳ Parent: ColumnChart

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	4
cts	4
cp	1
rs	10
c	0
b	0
f	0
nc	1
cc	1
nop	0
crap	1

<?php

namespace CMEN\GoogleChartsBundle\GoogleCharts\Charts;

use CMEN\GoogleChartsBundle\GoogleCharts\Chart;
use CMEN\GoogleChartsBundle\GoogleCharts\EventType;
use CMEN\GoogleChartsBundle\GoogleCharts\Options\ColumnChart\ColumnChartOptions;

/**
 * @author Christophe Meneses
 */
class ColumnChart extends Chart
{
    /**
     * @var ColumnChartOptions
     */
    protected $options;

    public function __construct()
    {
        parent::__construct();

        $this->options = new ColumnChartOptions();
    }

    public function getType()
    {
        return 'ColumnChart';
    }

    public function getPackage()
    {
        return 'corechart';
    }

    public function getAvailableEventTypes()
    {
        return [
            EventType::ANIMATION_FINISH,
            EventType::CLICK,
            EventType::ERROR,
            EventType::ON_MOUSE_OUT,
            EventType::ON_MOUSE_OVER,
            EventType::READY,
            EventType::SELECT,
        ];
    }

    /**
     * @return ColumnChartOptions
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * @param ColumnChartOptions $options
     *
     * @return ColumnChart
     */
    public function setOptions($options)
    {
        $this->options = $options;

        return $this;
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());
}
    }
}


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\ColumnChart\ColumnChartOptions;
8
9		/**
10		* @author Christophe Meneses
11		*/
12		class ColumnChart extends Chart
13		{
14		/**
15		* @var ColumnChartOptions
16		*/
17		protected $options;
18
19	7	public function __construct()
20		{
21	7	parent::__construct();
22
23	7	$this->options = new ColumnChartOptions();
24	7	}
25
26	1	public function getType()
27		{
28	1	return 'ColumnChart';
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 ColumnChartOptions
51		*/
52	2	public function getOptions()
53		{
54	2	return $this->options;
55		}
56
57		/**
58		* @param ColumnChartOptions $options
59		*
60		* @return ColumnChart
61		*/
62		public function setOptions($options)
63		{
64		$this->options = $options;
65
66		return $this;
		0 ignored issues – show Bug Best Practice introduced 2017-12-16 17:28 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`CMEN\GoogleChartsBundle\...arts\Charts\ColumnChart`) is incompatible with the return type declared by the abstract method `CMEN\GoogleChartsBundle\...harts\Chart::setOptions` of type `CMEN\GoogleChartsBundle\...s\ChartOptionsInterface`. 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...
67		}
68		}
69

cmen / CMENGoogleChartsBundle

Pull Request — master (#38)

ColumnChart::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like