NormalizerContextBuilder - Code Metrics - Inspection of "add-authorization-checker" - chubbyphp/chubbyphp-serialization - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#12)

by Dominik

created 2019-04-23 09:47 UTC

NormalizerContextBuilder A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

80%

Importance

Changes

Metric	Value
dl	0
loc	73
c	0
b	0
f	0
wmc	6
lcom	1
cbo	1
ccs	12
cts	15
cp	0.8
rs	10

6 Methods

Rating	Name	Size	Complexity
A	__construct()	3	1
A	create()	4	1
A	setGroups()	6	1
A	setRequest()	6	1
A	setRole()	6	1
A	getContext()	4	1

<?php

declare(strict_types=1);

namespace Chubbyphp\Serialization\Normalizer;

use Psr\Http\Message\ServerRequestInterface;

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

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

    /**
     * @var object|string|null
     */
    private $role;

    private function __construct()
    {
    }

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

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

    /**
     * @param object|string|null $role
     *
     * @return NormalizerContextBuilderInterface
     */
    public function setRole($role): NormalizerContextBuilderInterface
    {
        $this->role = $role;

        return $this;
    }

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


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		* @var string[]
13		*/
14		private $groups = [];
15
16		/**
17		* @var ServerRequestInterface\|null
18		*/
19		private $request;
20
21		/**
22		* @var object\|string\|null
23		*/
24		private $role;
25
26	3	private function __construct()
27		{
28	3	}
29
30		/**
31		* @return NormalizerContextBuilderInterface
32		*/
33	3	public static function create(): NormalizerContextBuilderInterface
34		{
35	3	return new self();
36		}
37
38		/**
39		* @param string[] $groups
40		*
41		* @return NormalizerContextBuilderInterface
42		*/
43	1	public function setGroups(array $groups): NormalizerContextBuilderInterface
44		{
45	1	$this->groups = $groups;
46
47	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...
48		}
49
50		/**
51		* @param ServerRequestInterface\|null $request
52		*
53		* @return NormalizerContextBuilderInterface
54		*/
55	2	public function setRequest(ServerRequestInterface $request = null): NormalizerContextBuilderInterface
56		{
57	2	$this->request = $request;
58
59	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...
60		}
61
62		/**
63		* @param object\|string\|null $role
64		*
65		* @return NormalizerContextBuilderInterface
66		*/
67		public function setRole($role): NormalizerContextBuilderInterface
68		{
69		$this->role = $role;
70
71		return $this;
72		}
73
74		/**
75		* @return NormalizerContextInterface
76		*/
77	3	public function getContext(): NormalizerContextInterface
78		{
79	3	return new NormalizerContext($this->groups, $this->request, $this->role);
80		}
81		}
82

chubbyphp / chubbyphp-serialization

Pull Request — master (#12)

NormalizerContextBuilder A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Duplication Side-by-Side

Filter issues like