Created::getVisibility() - Code Metrics - Inspection of "Feature/III-1608 Make label behaviour of organizer..." - cultuurnet/udb3-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#239)

by Luc

created 2016-11-17 09:39 UTC

Created::getVisibility() A

↳ Parent: Created

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

namespace CultuurNet\UDB3\Label\Events;

use CultuurNet\UDB3\Label\ValueObjects\Privacy;
use CultuurNet\UDB3\Label\ValueObjects\Visibility;
use ValueObjects\Identity\UUID;
use ValueObjects\String\String as StringLiteral;

class Created extends AbstractEvent
{
    const VISIBILITY = 'visibility';
    const PRIVACY = 'privacy';

    /**
     * @var Visibility
     */
    private $visibility;

    /**
     * @var Privacy
     */
    private $privacy;

    /**
     * Created constructor.
     * @param UUID $uuid
     * @param StringLiteral $name
     * @param Visibility $visibility
     * @param Privacy $privacy
     */
    public function __construct(

        UUID $uuid,
        StringLiteral $name,
        Visibility $visibility,
        Privacy $privacy
    ) {
        parent::__construct($uuid, $name);

        $this->visibility = $visibility;
        $this->privacy = $privacy;
    }

    /**
     * @return Visibility
     */
    public function getVisibility()
    {
        return $this->visibility;
    }

    /**
     * @return Privacy
     */
    public function getPrivacy()
    {
        return $this->privacy;
    }

    /**
     * @inheritdoc
     */
    public static function deserialize(array $data)

    {
        return new static(
            new UUID($data[self::UUID]),
            new StringLiteral($data[self::NAME]),
            Visibility::fromNative($data[self::VISIBILITY]),
            Privacy::fromNative($data[self::PRIVACY])
        );
    }

    /**
     * @inheritdoc
     */
    public function serialize()
    {
        return parent::serialize() + [
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            self::VISIBILITY => $this->getVisibility()->toNative(),
            self::PRIVACY => $this->getPrivacy()->toNative()
        ];
    }
}


1		<?php
2
3		namespace CultuurNet\UDB3\Label\Events;
4
5		use CultuurNet\UDB3\Label\ValueObjects\Privacy;
6		use CultuurNet\UDB3\Label\ValueObjects\Visibility;
7		use ValueObjects\Identity\UUID;
8		use ValueObjects\String\String as StringLiteral;
9
10		class Created extends AbstractEvent
11		{
12		const VISIBILITY = 'visibility';
13		const PRIVACY = 'privacy';
14
15		/**
16		* @var Visibility
17		*/
18		private $visibility;
19
20		/**
21		* @var Privacy
22		*/
23		private $privacy;
24
25		/**
26		* Created constructor.
27		* @param UUID $uuid
28		* @param StringLiteral $name
29		* @param Visibility $visibility
30		* @param Privacy $privacy
31		*/
32	View Code Duplication	public function __construct(
		0 ignored issues – show Duplication introduced 2016-05-27 12:10 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
33		UUID $uuid,
34		StringLiteral $name,
35		Visibility $visibility,
36		Privacy $privacy
37		) {
38		parent::__construct($uuid, $name);
39
40		$this->visibility = $visibility;
41		$this->privacy = $privacy;
42		}
43
44		/**
45		* @return Visibility
46		*/
47		public function getVisibility()
48		{
49		return $this->visibility;
50		}
51
52		/**
53		* @return Privacy
54		*/
55		public function getPrivacy()
56		{
57		return $this->privacy;
58		}
59
60		/**
61		* @inheritdoc
62		*/
63	View Code Duplication	public static function deserialize(array $data)
		0 ignored issues – show Duplication introduced 2016-05-27 13:02 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
64		{
65		return new static(
66		new UUID($data[self::UUID]),
67		new StringLiteral($data[self::NAME]),
68		Visibility::fromNative($data[self::VISIBILITY]),
69		Privacy::fromNative($data[self::PRIVACY])
70		);
71		}
72
73		/**
74		* @inheritdoc
75		*/
76		public function serialize()
77		{
78		return parent::serialize() + [
		0 ignored issues – show Best Practice introduced 2016-11-17 09:29 UTC by Report Bug Copy Issue Report The expression `return parent::serialize...Privacy()->toNative());` seems to be an `array`, but some of its elements' types (`boolean`) are incompatible with the return type of the parent method `CultuurNet\UDB3\Label\Ev...bstractEvent::serialize` of type `array<string,string>`. 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 new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return '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...
79		self::VISIBILITY => $this->getVisibility()->toNative(),
80		self::PRIVACY => $this->getPrivacy()->toNative()
81		];
82		}
83		}
84

cultuurnet / udb3-php

Pull Request — master (#239)

Created::getVisibility() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like