NormalizerContextBuilder::setAttributes() - Code Metrics - Inspection of "Feat/jmp 592/enhance policies" - chubbyphp/chubbyphp-serialization - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#15)

unknown

created 2019-05-21 07:27 UTC

NormalizerContextBuilder::setAttributes() A

↳ Parent: NormalizerContextBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

declare(strict_types=1);

namespace Chubbyphp\Serialization\Normalizer;

use Psr\Http\Message\ServerRequestInterface;

final class NormalizerContextBuilder implements NormalizerContextBuilderInterface
{
    /**
     * @deprecated
     *
     * @var string[]
     */
    private $groups = [];

    /**
     * @var array
     */
    private $attributes = [];

    /**
     * @var ServerRequestInterface|null
     */
    private $request;

    private function __construct()
    {
    }

    /**
     * @return NormalizerContextBuilderInterface
     */
    public static function create(): NormalizerContextBuilderInterface
    {
        return new self();
    }

    /**
     * @deprecated
     *
     * @param string[] $groups
     *
     * @return NormalizerContextBuilderInterface
     */
    public function setGroups(array $groups): NormalizerContextBuilderInterface
    {
        $this->groups = $groups;


        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());
}
    }

    /**
     * @param array $attributes
     *
     * @return NormalizerContextBuilderInterface
     */
    public function setAttributes(array $attributes): NormalizerContextBuilderInterface
    {
        $this->attributes = $attributes;

        return $this;
    }

    /**
     * @param ServerRequestInterface|null $request
     *
     * @return NormalizerContextBuilderInterface
     */
    public function setRequest(ServerRequestInterface $request = null): NormalizerContextBuilderInterface
    {
        $this->request = $request;

        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());
}
    }

    /**
     * @return NormalizerContextInterface
     */
    public function getContext(): NormalizerContextInterface
    {
        return new NormalizerContext($this->groups, $this->request, $this->attributes);

    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Chubbyphp\Serialization\Normalizer;
6
7		use Psr\Http\Message\ServerRequestInterface;
8
9		final class NormalizerContextBuilder implements NormalizerContextBuilderInterface
10		{
11		/**
12		* @deprecated
13		*
14		* @var string[]
15		*/
16		private $groups = [];
17
18		/**
19		* @var array
20		*/
21		private $attributes = [];
22
23		/**
24		* @var ServerRequestInterface\|null
25		*/
26		private $request;
27
28	3	private function __construct()
29		{
30	3	}
31
32		/**
33		* @return NormalizerContextBuilderInterface
34		*/
35	3	public static function create(): NormalizerContextBuilderInterface
36		{
37	3	return new self();
38		}
39
40		/**
41		* @deprecated
42		*
43		* @param string[] $groups
44		*
45		* @return NormalizerContextBuilderInterface
46		*/
47	1	public function setGroups(array $groups): NormalizerContextBuilderInterface
48		{
49	1	$this->groups = $groups;
		0 ignored issues – show Deprecated Code introduced 2019-05-06 09:57 UTC by Report Bug Copy Issue Report The property `Chubbyphp\Serialization\...ContextBuilder::$groups` has been deprecated. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
50
51	1	return $this;
		0 ignored issues – show Bug Best Practice introduced 2017-10-18 06:47 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Chubbyphp\Serialization\...ormalizerContextBuilder`) is incompatible with the return type declared by the interface `Chubbyphp\Serialization\...derInterface::setGroups` of type `self`. 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...
52		}
53
54		/**
55		* @param array $attributes
56		*
57		* @return NormalizerContextBuilderInterface
58		*/
59	1	public function setAttributes(array $attributes): NormalizerContextBuilderInterface
60		{
61	1	$this->attributes = $attributes;
62
63	1	return $this;
64		}
65
66		/**
67		* @param ServerRequestInterface\|null $request
68		*
69		* @return NormalizerContextBuilderInterface
70		*/
71	2	public function setRequest(ServerRequestInterface $request = null): NormalizerContextBuilderInterface
72		{
73	2	$this->request = $request;
74
75	2	return $this;
		0 ignored issues – show Bug Best Practice introduced 2017-10-23 13:11 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Chubbyphp\Serialization\...ormalizerContextBuilder`) is incompatible with the return type declared by the interface `Chubbyphp\Serialization\...erInterface::setRequest` of type `self`. 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...
76		}
77
78		/**
79		* @return NormalizerContextInterface
80		*/
81	3	public function getContext(): NormalizerContextInterface
82		{
83	3	return new NormalizerContext($this->groups, $this->request, $this->attributes);
		0 ignored issues – show Deprecated Code introduced 2019-05-06 09:57 UTC by Report Bug Copy Issue Report The property `Chubbyphp\Serialization\...ContextBuilder::$groups` has been deprecated. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
84		}
85		}
86

chubbyphp / chubbyphp-serialization

Pull Request — master (#15)

NormalizerContextBuilder::setAttributes() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like