AnnotationChart - Code Metrics - Inspection of "Allow all available events" - cmen/CMENGoogleChartsBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#26)

by Christophe

created 2019-03-02 09:51 UTC

AnnotationChart A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

55.56%

Importance

Changes

Metric	Value
wmc	6
lcom	0
cbo	2
dl	0
loc	65
ccs	10
cts	18
cp	0.5556
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
A	__construct()	6	1
A	getType()	4	1
A	getPackage()	4	1
A	getAvailableEventTypes()	8	1
A	getOptions()	4	1
A	setOptions()	6	1

<?php

namespace CMEN\GoogleChartsBundle\GoogleCharts\Charts;

use CMEN\GoogleChartsBundle\GoogleCharts\Chart;
use CMEN\GoogleChartsBundle\GoogleCharts\EventType;
use CMEN\GoogleChartsBundle\GoogleCharts\Options\AnnotationChart\AnnotationChartOptions;

/**
 * @author Christophe Meneses
 */
class AnnotationChart extends Chart
{
    /**
     * @var AnnotationChartOptions
     */
    protected $options;

    /**
     * AnnotationChart constructor.
     */
    public function __construct()
    {
        parent::__construct();

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

    /**
     * {@inheritdoc}
     */
    public function getType()
    {
        return 'AnnotationChart';
    }

    /**
     * {@inheritdoc}
     */
    public function getPackage()
    {
        return 'annotationchart';
    }

    /**
     * {@inheritdoc}
     */
    public function getAvailableEventTypes()
    {
        return [
            EventType::RANGE_CHANGE,
            EventType::READY,
            EventType::SELECT,
        ];
    }

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

    /**
     * @param $options AnnotationChartOptions
     *
     * @return AnnotationChart
     */
    public function setOptions($options)
    {
        $this->options = $options;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}

        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\AnnotationChart\AnnotationChartOptions;
8
9		/**
10		* @author Christophe Meneses
11		*/
12		class AnnotationChart extends Chart
13		{
14		/**
15		* @var AnnotationChartOptions
16		*/
17		protected $options;
18
19		/**
20		* AnnotationChart constructor.
21		*/
22	1	public function __construct()
23		{
24	1	parent::__construct();
25
26	1	$this->options = new AnnotationChartOptions();
27	1	}
28
29		/**
30		* {@inheritdoc}
31		*/
32	1	public function getType()
33		{
34	1	return 'AnnotationChart';
35		}
36
37		/**
38		* {@inheritdoc}
39		*/
40	1	public function getPackage()
41		{
42	1	return 'annotationchart';
43		}
44
45		/**
46		* {@inheritdoc}
47		*/
48		public function getAvailableEventTypes()
49		{
50		return [
51		EventType::RANGE_CHANGE,
52		EventType::READY,
53		EventType::SELECT,
54		];
55		}
56
57		/**
58		* @return AnnotationChartOptions
59		*/
60	1	public function getOptions()
61		{
62	1	return $this->options;
63		}
64
65		/**
66		* @param $options AnnotationChartOptions
67		*
68		* @return AnnotationChart
69		*/
70		public function setOptions($options)
71		{
72		$this->options = $options;
		0 ignored issues – show Documentation Bug introduced 2017-12-16 17:28 UTC by Report Bug Copy Issue Report `$options` is of type `object<CMEN\GoogleCharts...\ChartOptionsInterface>`, but the property `$options` was declared to be of type `object<CMEN\GoogleCharts...AnnotationChartOptions>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
73
74		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\...\Charts\AnnotationChart`) 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...
75		}
76		}
77

cmen / CMENGoogleChartsBundle

Pull Request — master (#26)

AnnotationChart A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Duplication Side-by-Side

Filter issues like