Category::getId() - Code Metrics - Inspection of "Added article preview controller (#326)" - ahilles107/web-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3ef484...ea5778 )

by Paweł

created 2017-05-09 08:55 UTC

Category::getId() A

↳ Parent: Category

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

/*
 * This file is part of the Superdesk Web Publisher Bridge Component.
 *
 * Copyright 2017 Sourcefabric z.ú. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2017 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 */

namespace SWP\Component\Bridge\Model\Event;

use SWP\Component\Bridge\Model\Event;

class Category implements CategoryInterface
{
    /**
     * @var int
     */
    protected $id;

    /**
     * @var string
     */
    protected $name;

    /**
     * @var string
     */
    protected $qcode;

    /**
     * @var string
     */
    protected $subject;

    /**
     * @var Event
     */
    protected $event;

    /**
     * {@inheritdoc}
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * {@inheritdoc}
     */
    public function setName($name)
    {
        $this->name = $name;
    }

    /**
     * {@inheritdoc}
     */
    public function getQcode()
    {
        return $this->qcode;
    }

    /**
     * {@inheritdoc}
     */
    public function setQcode($qcode)
    {
        $this->qcode = $qcode;
    }

    /**
     * {@inheritdoc}
     */
    public function getSubject()
    {
        return $this->subject;
    }

    /**
     * {@inheritdoc}
     */
    public function setSubject($subject)
    {
        $this->subject = $subject;
    }

    /**
     * {@inheritdoc}
     */
    public function getEvent()
    {
        return $this->event;
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function setEvent($event)
    {
        $this->event = $event;

    }
}


1			<?php
2
3			/*
4			* This file is part of the Superdesk Web Publisher Bridge Component.
5			*
6			* Copyright 2017 Sourcefabric z.ú. and contributors.
7			*
8			* For the full copyright and license information, please see the
9			* AUTHORS and LICENSE files distributed with this source code.
10			*
11			* @copyright 2017 Sourcefabric z.ú
12			* @license http://www.superdesk.org/license
13			*/
14
15			namespace SWP\Component\Bridge\Model\Event;
16
17			use SWP\Component\Bridge\Model\Event;
18
19			class Category implements CategoryInterface
20			{
21			/**
22			* @var int
23			*/
24			protected $id;
25
26			/**
27			* @var string
28			*/
29			protected $name;
30
31			/**
32			* @var string
33			*/
34			protected $qcode;
35
36			/**
37			* @var string
38			*/
39			protected $subject;
40
41			/**
42			* @var Event
43			*/
44			protected $event;
45
46			/**
47			* {@inheritdoc}
48			*/
49			public function getId()
50			{
51			return $this->id;
52			}
53
54			/**
55			* {@inheritdoc}
56			*/
57			public function getName()
58			{
59			return $this->name;
60			}
61
62			/**
63			* {@inheritdoc}
64			*/
65			public function setName($name)
66			{
67			$this->name = $name;
68			}
69
70			/**
71			* {@inheritdoc}
72			*/
73			public function getQcode()
74			{
75			return $this->qcode;
76			}
77
78			/**
79			* {@inheritdoc}
80			*/
81			public function setQcode($qcode)
82			{
83			$this->qcode = $qcode;
84			}
85
86			/**
87			* {@inheritdoc}
88			*/
89			public function getSubject()
90			{
91			return $this->subject;
92			}
93
94			/**
95			* {@inheritdoc}
96			*/
97			public function setSubject($subject)
98			{
99			$this->subject = $subject;
100			}
101
102			/**
103			* {@inheritdoc}
104			*/
105			public function getEvent()
106			{
107			return $this->event;
			0 ignored issues – show Bug Best Practice introduced 2017-05-09 09:04 UTC by Report Bug Copy Issue Report The return type of `return $this->event;` (`SWP\Component\Bridge\Model\Event`) is incompatible with the return type declared by the interface `SWP\Component\Bridge\Mod...goryInterface::getEvent` of type `SWP\Component\Bridge\Model\Event\Event`. 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...
108			}
109
110			/**
111			* {@inheritdoc}
112			*/
113			public function setEvent($event)
114			{
115			$this->event = $event;
			0 ignored issues – show Documentation Bug introduced 2017-05-09 09:04 UTC by Report Bug Copy Issue Report It seems like `$event` of type `object<SWP\Component\Bridge\Model\Event\Event>` is incompatible with the declared type `object<SWP\Component\Bridge\Model\Event>` of property `$event`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
116			}
117			}
118

ahilles107 / web-publisher

Push — master ( 3ef484...ea5778 )

Category::getId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like