Quote::getAuthor() - Code Metrics - Inspection of "Update CHANGELOG" - webeweb/core-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d3835e...a9f295 )

by WEBEWEB

created 2019-04-15 17:14 UTC

Quote::getAuthor() A

↳ Parent: Quote

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

/*
 * This file is part of the core-bundle package.
 *
 * (c) 2019 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Bundle\CoreBundle\Quote;

use DateTime;

/**
 * Quote.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\CoreBundle\Quote
 */
class Quote implements QuoteInterface {

    /**
     * Author.
     *
     * @var string
     */
    private $author;

    /**
     * Content.
     *
     * @var string
     */
    private $content;

    /**
     * Date.
     *
     * @var DateTime
     */
    private $date;

    /**
     * Constructor.
     */
    public function __construct() {
        // NOTHING TO DO.
    }

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

    /**
     * {@inheritdoc}
     */
    public function getContent() {
        return $this->content;
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 getDate() {
        return $this->date;
    }

    /**
     * Set the author.
     *
     * @param string $author The author.
     * @return Quote Returns this quote.
     */
    public function setAuthor($author) {
        $this->author = $author;
        return $this;
    }

    /**
     * Set the content.
     *
     * @param string $content The content.
     * @return Quote Returns this quote.
     */
    public function setContent($content) {
        $this->content = $content;
        return $this;
    }

    /**
     * Set the date.
     *
     * @param DateTime $date The date.
     * @return Quote Returns this quote.
     */
    public function setDate(DateTime $date = null) {
        $this->date = $date;
        return $this;
    }
}


1			<?php
2
3			/*
4			* This file is part of the core-bundle package.
5			*
6			* (c) 2019 WEBEWEB
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace WBW\Bundle\CoreBundle\Quote;
13
14			use DateTime;
15
16			/**
17			* Quote.
18			*
19			* @author webeweb <https://github.com/webeweb/>
20			* @package WBW\Bundle\CoreBundle\Quote
21			*/
22			class Quote implements QuoteInterface {
23
24			/**
25			* Author.
26			*
27			* @var string
28			*/
29			private $author;
30
31			/**
32			* Content.
33			*
34			* @var string
35			*/
36			private $content;
37
38			/**
39			* Date.
40			*
41			* @var DateTime
42			*/
43			private $date;
44
45			/**
46			* Constructor.
47			*/
48			public function __construct() {
49			// NOTHING TO DO.
50			}
51
52			/**
53			* {@inheritdoc}
54			*/
55			public function getAuthor() {
56			return $this->author;
57			}
58
59			/**
60			* {@inheritdoc}
61			*/
62			public function getContent() {
63			return $this->content;
			0 ignored issues – show Bug Best Practice introduced 2019-04-15 17:16 UTC by Report Bug Copy Issue Report The return type of `return $this->content;` (`string`) is incompatible with the return type declared by the interface `WBW\Bundle\CoreBundle\Qu...teInterface::getContent` of type `WBW\Bundle\CoreBundle\Quote\strng`. 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...
64			}
65
66			/**
67			* {@inheritdoc}
68			*/
69			public function getDate() {
70			return $this->date;
71			}
72
73			/**
74			* Set the author.
75			*
76			* @param string $author The author.
77			* @return Quote Returns this quote.
78			*/
79			public function setAuthor($author) {
80			$this->author = $author;
81			return $this;
82			}
83
84			/**
85			* Set the content.
86			*
87			* @param string $content The content.
88			* @return Quote Returns this quote.
89			*/
90			public function setContent($content) {
91			$this->content = $content;
92			return $this;
93			}
94
95			/**
96			* Set the date.
97			*
98			* @param DateTime $date The date.
99			* @return Quote Returns this quote.
100			*/
101			public function setDate(DateTime $date = null) {
102			$this->date = $date;
103			return $this;
104			}
105			}
106

webeweb / core-bundle

Push — master ( d3835e...a9f295 )

Quote::getAuthor() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like