DenormalizerContextBuilder::create() - Code Metrics - Inspection of "addResetMissingFields" - chubbyphp/chubbyphp-deserialization - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#24)

by Dominik

created 2018-10-06 08:34 UTC

DenormalizerContextBuilder::create() A

↳ Parent: DenormalizerContextBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Chubbyphp\Deserialization\Denormalizer;

use Psr\Http\Message\ServerRequestInterface;

final class DenormalizerContextBuilder implements DenormalizerContextBuilderInterface
{
    /**
     * @var array|null
     */
    private $allowedAdditionalFields;

    /**
     * @var string[]
     */
    private $groups = [];

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

    /**
     * @var bool
     */
    private $resetMissingFields = false;

    private function __construct()
    {
    }

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

    /**
     * @param array|null $allowedAdditionalFields
     *
     * @return DenormalizerContextBuilderInterface
     */
    public function setAllowedAdditionalFields(
        array $allowedAdditionalFields = null
    ): DenormalizerContextBuilderInterface {
        $this->allowedAdditionalFields = $allowedAdditionalFields;

        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 string[] $groups
     *
     * @return DenormalizerContextBuilderInterface
     */
    public function setGroups(array $groups): DenormalizerContextBuilderInterface
    {
        $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 ServerRequestInterface|null $request
     *
     * @return DenormalizerContextBuilderInterface
     */
    public function setRequest(ServerRequestInterface $request = null): DenormalizerContextBuilderInterface
    {
        $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());
}
    }

    /**
     * @param bool $resetMissingFields
     *
     * @return DenormalizerContextBuilderInterface
     */
    public function setResetMissingFields(bool $resetMissingFields): DenormalizerContextBuilderInterface
    {
        $this->resetMissingFields = $resetMissingFields;

        return $this;
    }

    /**
     * @return DenormalizerContextInterface
     */
    public function getContext(): DenormalizerContextInterface
    {
        return new DenormalizerContext(
            $this->allowedAdditionalFields,
            $this->groups,
            $this->request,
            $this->resetMissingFields
        );
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Chubbyphp\Deserialization\Denormalizer;
6
7		use Psr\Http\Message\ServerRequestInterface;
8
9		final class DenormalizerContextBuilder implements DenormalizerContextBuilderInterface
10		{
11		/**
12		* @var array\|null
13		*/
14		private $allowedAdditionalFields;
15
16		/**
17		* @var string[]
18		*/
19		private $groups = [];
20
21		/**
22		* @var ServerRequestInterface\|null
23		*/
24		private $request;
25
26		/**
27		* @var bool
28		*/
29		private $resetMissingFields = false;
30
31	3	private function __construct()
32		{
33	3	}
34
35		/**
36		* @return DenormalizerContextBuilderInterface
37		*/
38	3	public static function create(): DenormalizerContextBuilderInterface
39		{
40	3	return new self();
41		}
42
43		/**
44		* @param array\|null $allowedAdditionalFields
45		*
46		* @return DenormalizerContextBuilderInterface
47		*/
48	1	public function setAllowedAdditionalFields(
49		array $allowedAdditionalFields = null
50		): DenormalizerContextBuilderInterface {
51	1	$this->allowedAdditionalFields = $allowedAdditionalFields;
52
53	1	return $this;
		0 ignored issues – show Bug Best Practice introduced 2017-10-03 14:15 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Chubbyphp\Deserializatio...ormalizerContextBuilder`) is incompatible with the return type declared by the interface `Chubbyphp\Deserializatio...AllowedAdditionalFields` 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...
54		}
55
56		/**
57		* @param string[] $groups
58		*
59		* @return DenormalizerContextBuilderInterface
60		*/
61	1	public function setGroups(array $groups): DenormalizerContextBuilderInterface
62		{
63	1	$this->groups = $groups;
64
65	1	return $this;
		0 ignored issues – show Bug Best Practice introduced 2017-10-03 14:15 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Chubbyphp\Deserializatio...ormalizerContextBuilder`) is incompatible with the return type declared by the interface `Chubbyphp\Deserializatio...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...
66		}
67
68		/**
69		* @param ServerRequestInterface\|null $request
70		*
71		* @return DenormalizerContextBuilderInterface
72		*/
73	2	public function setRequest(ServerRequestInterface $request = null): DenormalizerContextBuilderInterface
74		{
75	2	$this->request = $request;
76
77	2	return $this;
		0 ignored issues – show Bug Best Practice introduced 2017-10-26 07:03 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Chubbyphp\Deserializatio...ormalizerContextBuilder`) is incompatible with the return type declared by the interface `Chubbyphp\Deserializatio...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...
78		}
79
80		/**
81		* @param bool $resetMissingFields
82		*
83		* @return DenormalizerContextBuilderInterface
84		*/
85	1	public function setResetMissingFields(bool $resetMissingFields): DenormalizerContextBuilderInterface
86		{
87	1	$this->resetMissingFields = $resetMissingFields;
88
89	1	return $this;
90		}
91
92		/**
93		* @return DenormalizerContextInterface
94		*/
95	3	public function getContext(): DenormalizerContextInterface
96		{
97	3	return new DenormalizerContext(
98	3	$this->allowedAdditionalFields,
99	3	$this->groups,
100	3	$this->request,
101	3	$this->resetMissingFields
102		);
103		}
104		}
105

chubbyphp / chubbyphp-deserialization

Pull Request — master (#24)

DenormalizerContextBuilder::create() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like