BaseObject::__sleep() - Code Metrics - Inspection of "Merge branch 'master' of github.com:railt/sdl" - railt/sdl - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5ac91e...39483e )

by Kirill

created 2018-05-05 20:22 UTC

BaseObject::__sleep() A

↳ Parent: BaseObject

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	3
cts	3
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	5
nc	1
nop	0
crap	1

<?php
/**
 * This file is part of Railt package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace Railt\SDL\Base\Definitions;

use Railt\SDL\Base\Dependent\Field\BaseFieldsContainer;
use Railt\SDL\Base\Invocations\Directive\BaseDirectivesContainer;
use Railt\SDL\Contracts\Definitions\InterfaceDefinition;
use Railt\SDL\Contracts\Definitions\ObjectDefinition;
use Railt\SDL\Contracts\Type;

/**
 * Class BaseObject
 */
abstract class BaseObject extends BaseTypeDefinition implements ObjectDefinition
{
    use BaseDirectivesContainer;
    use BaseFieldsContainer;

    /**
     * Object type name
     */
    protected const TYPE_NAME = Type::OBJECT;

    /**
     * @var array|InterfaceDefinition[]
     */
    protected $interfaces = [];

    /**
     * @return iterable|InterfaceDefinition[]
     */
    public function getInterfaces(): iterable
    {
        return \array_values($this->interfaces);
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());
}
    }

    /**
     * @param string $name
     * @return bool
     */
    public function hasInterface(string $name): bool
    {
        return \array_key_exists($name, $this->interfaces);
    }

    /**
     * @param string $name
     * @return null|InterfaceDefinition
     */
    public function getInterface(string $name): ?InterfaceDefinition
    {
        return $this->interfaces[$name] ?? null;
    }

    /**
     * @return int
     */
    public function getNumberOfInterfaces(): int
    {
        return \count($this->interfaces);
    }

    /**
     * @return array
     */
    public function __sleep(): array
    {
        return \array_merge(parent::__sleep(), [
            // self class
            'interfaces',

            // trait HasFields
            'fields',

            // trait HasDirectives
            'directives',
        ]);
    }
}


1		<?php
2		/**
3		* This file is part of Railt package.
4		*
5		* For the full copyright and license information, please view the LICENSE
6		* file that was distributed with this source code.
7		*/
8		declare(strict_types=1);
9
10		namespace Railt\SDL\Base\Definitions;
11
12		use Railt\SDL\Base\Dependent\Field\BaseFieldsContainer;
13		use Railt\SDL\Base\Invocations\Directive\BaseDirectivesContainer;
14		use Railt\SDL\Contracts\Definitions\InterfaceDefinition;
15		use Railt\SDL\Contracts\Definitions\ObjectDefinition;
16		use Railt\SDL\Contracts\Type;
17
18		/**
19		* Class BaseObject
20		*/
21		abstract class BaseObject extends BaseTypeDefinition implements ObjectDefinition
22		{
23		use BaseDirectivesContainer;
24		use BaseFieldsContainer;
25
26		/**
27		* Object type name
28		*/
29		protected const TYPE_NAME = Type::OBJECT;
30
31		/**
32		* @var array\|InterfaceDefinition[]
33		*/
34		protected $interfaces = [];
35
36		/**
37		* @return iterable\|InterfaceDefinition[]
38		*/
39	2822	public function getInterfaces(): iterable
40		{
41	2822	return \array_values($this->interfaces);
		0 ignored issues – show Bug Best Practice introduced 2018-05-05 21:00 UTC by Report Bug Copy Issue Report The return type of `return \array_values($this->interfaces);` (`array`) is incompatible with the return type declared by the interface `Railt\SDL\Contracts\Defi...finition::getInterfaces` of type `Railt\SDL\Contracts\Defi...s\InterfaceDefinition[]`. 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...
42		}
43
44		/**
45		* @param string $name
46		* @return bool
47		*/
48	26	public function hasInterface(string $name): bool
49		{
50	26	return \array_key_exists($name, $this->interfaces);
51		}
52
53		/**
54		* @param string $name
55		* @return null\|InterfaceDefinition
56		*/
57	30	public function getInterface(string $name): ?InterfaceDefinition
58		{
59	30	return $this->interfaces[$name] ?? null;
60		}
61
62		/**
63		* @return int
64		*/
65	24	public function getNumberOfInterfaces(): int
66		{
67	24	return \count($this->interfaces);
68		}
69
70		/**
71		* @return array
72		*/
73	739	public function __sleep(): array
74		{
75	739	return \array_merge(parent::__sleep(), [
76		// self class
77	739	'interfaces',
78
79		// trait HasFields
80		'fields',
81
82		// trait HasDirectives
83		'directives',
84		]);
85		}
86		}
87

railt / sdl

Push — master ( 5ac91e...39483e )

BaseObject::__sleep() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like