BaseUserDataTransferObject::getRoles() - Code Metrics - Inspection of "Add roles" - sumocoders/FrameworkMultiUserBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#78)

unknown

created 2018-11-13 13:03 UTC

BaseUserDataTransferObject::getRoles() A

↳ Parent: BaseUserDataTransferObject

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace SumoCoders\FrameworkMultiUserBundle\DataTransferObject;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use SumoCoders\FrameworkMultiUserBundle\DataTransferObject\Interfaces\UserDataTransferObject;
use SumoCoders\FrameworkMultiUserBundle\User\Interfaces\User;
use SumoCoders\FrameworkMultiUserBundle\Entity\BaseUser;

class BaseUserDataTransferObject implements UserDataTransferObject
{
    /** @var int|null */
    public $id;

    /** @var string|null */
    public $userName;

    /** @var string|null */
    public $displayName;

    /** @var string|null */
    public $email;

    /** @var string|null */
    public $plainPassword;

    /** @var User */
    protected $user;

    /** @var Collection|null */
    public $roles;

    public static function fromUser(User $user): UserDataTransferObject
    {
        $baseUserTransferObject = new static();
        $baseUserTransferObject->user = $user;
        $baseUserTransferObject->id = $user->getId();
        $baseUserTransferObject->userName = $user->getUsername();
        $baseUserTransferObject->displayName = $user->getDisplayName();
        $baseUserTransferObject->email = $user->getEmail();
        $baseUserTransferObject->roles = $user->getRoles();

        if ($user->hasPlainPassword()) {
            $baseUserTransferObject->plainPassword = $user->getPlainPassword();
        }

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

    public function getEntity(): User
    {
        if ($this->user) {
            $this->user->change($this);

            return $this->user;
        }

        return new BaseUser(
            $this->userName,
            $this->plainPassword,
            $this->displayName,
            $this->email,
            $this->roles instanceof Collection ? $this->roles : new ArrayCollection()
        );
    }

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getUserName(): ?string
    {
        return $this->userName;
    }

    public function getDisplayName(): ?string
    {
        return $this->displayName;
    }

    public function getEmail(): ?string
    {
        return $this->email;
    }

    public function getPlainPassword(): ?string
    {
        return $this->plainPassword;
    }

    public function getRoles(): ?Collection
    {
        return $this->roles;
    }
}


1			<?php
2
3			namespace SumoCoders\FrameworkMultiUserBundle\DataTransferObject;
4
5			use Doctrine\Common\Collections\ArrayCollection;
6			use Doctrine\Common\Collections\Collection;
7			use SumoCoders\FrameworkMultiUserBundle\DataTransferObject\Interfaces\UserDataTransferObject;
8			use SumoCoders\FrameworkMultiUserBundle\User\Interfaces\User;
9			use SumoCoders\FrameworkMultiUserBundle\Entity\BaseUser;
10
11			class BaseUserDataTransferObject implements UserDataTransferObject
12			{
13			/** @var int\|null */
14			public $id;
15
16			/** @var string\|null */
17			public $userName;
18
19			/** @var string\|null */
20			public $displayName;
21
22			/** @var string\|null */
23			public $email;
24
25			/** @var string\|null */
26			public $plainPassword;
27
28			/** @var User */
29			protected $user;
30
31			/** @var Collection\|null */
32			public $roles;
33
34			public static function fromUser(User $user): UserDataTransferObject
35			{
36			$baseUserTransferObject = new static();
37			$baseUserTransferObject->user = $user;
38			$baseUserTransferObject->id = $user->getId();
39			$baseUserTransferObject->userName = $user->getUsername();
40			$baseUserTransferObject->displayName = $user->getDisplayName();
41			$baseUserTransferObject->email = $user->getEmail();
42			$baseUserTransferObject->roles = $user->getRoles();
			0 ignored issues – show Documentation Bug introduced 2018-11-13 13:05 UTC by Report Bug Copy Issue Report It seems like `$user->getRoles()` of type `array<integer,object<Sym...Core\Role\Role>\|string>` is incompatible with the declared type `object<Doctrine\Common\C...ctions\Collection>\|null` of property `$roles`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
43			if ($user->hasPlainPassword()) {
44			$baseUserTransferObject->plainPassword = $user->getPlainPassword();
45			}
46
47			return $baseUserTransferObject;
			0 ignored issues – show Bug Best Practice introduced 2017-11-16 07:56 UTC by Report Bug Copy Issue Report The return type of `return $baseUserTransferObject;` (`SumoCoders\FrameworkMult...eUserDataTransferObject`) is incompatible with the return type declared by the interface `SumoCoders\FrameworkMult...ransferObject::fromUser` 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			public function getEntity(): User
51			{
52			if ($this->user) {
53			$this->user->change($this);
54
55			return $this->user;
56			}
57
58			return new BaseUser(
59			$this->userName,
60			$this->plainPassword,
61			$this->displayName,
62			$this->email,
63			$this->roles instanceof Collection ? $this->roles : new ArrayCollection()
64			);
65			}
66
67			public function getId(): ?int
68			{
69			return $this->id;
70			}
71
72			public function getUserName(): ?string
73			{
74			return $this->userName;
75			}
76
77			public function getDisplayName(): ?string
78			{
79			return $this->displayName;
80			}
81
82			public function getEmail(): ?string
83			{
84			return $this->email;
85			}
86
87			public function getPlainPassword(): ?string
88			{
89			return $this->plainPassword;
90			}
91
92			public function getRoles(): ?Collection
93			{
94			return $this->roles;
95			}
96			}
97

sumocoders / FrameworkMultiUserBundle

Pull Request — master (#78)

BaseUserDataTransferObject::getRoles() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like