Doyo\UserBundle\Model\User

Complexity

Total Complexity

33

Size/Duplication

Total Lines	312
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

30 Methods

Rating	Name	Duplication	Size	Complexity
A	getPasswordRequestedAt()	0	3	1
A	getRoles()	0	3	1
A	getConfirmationToken()	0	3	1
A	setConfirmationToken()	0	5	1
A	setEmail()	0	5	1
A	getUsername()	0	3	1
A	setPasswordRequestedAt()	0	5	1
A	getPlainPassword()	0	3	1
A	setSalt()	0	5	1
A	setRoles()	0	9	2
A	setPassword()	0	5	1
A	setUsername()	0	5	1
A	eraseCredentials()	0	3	1
A	getUsernameCanonical()	0	3	1
A	setEnabled()	0	5	1
A	getLastLogin()	0	3	1
A	getPassword()	0	3	1
A	__construct()	0	4	1
A	setLastLogin()	0	5	1
A	removeRole()	0	8	2
A	getId()	0	3	1
A	setEmailCanonical()	0	5	1
A	setPlainPassword()	0	5	1
A	isEnabled()	0	3	1
A	getEmailCanonical()	0	3	1
A	addRole()	0	9	2
A	getSalt()	0	3	1
A	setUsernameCanonical()	0	5	1
A	getEmail()	0	3	1
A	hasRole()	0	5	1

<?php

Class found in ".php" file; use ".inc" extension instead

The PHP open tag does not have a corresponding PHP close tag

Filename "User.php" doesn't match the expected filename "user.php"

You must use "/**" style comments for a file comment

/*

You must use "/**" style comments for a file comment

 * This file is part of the DoyoUserBundle project.
 *
 * (c) Anthonius Munthi <me@itstoni.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Doyo\UserBundle\Model;

class User implements UserInterface

Missing doc comment for class User

{

Opening brace should be on the same line as the declaration for class User

    /**

Missing short description in doc comment

     * @var string|int|null

Expected "string|integer|null" but found "string|int|null" for @var tag in member variable comment

     */
    protected $id;

Expected 1 blank line(s) before first member var; 0 found

Protected member variable "id" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var string|null
     */
    protected $username;

Protected member variable "username" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var string|null
     */
    protected $usernameCanonical;

Protected member variable "usernameCanonical" must contain a leading underscore

    /**

Missing short description in doc comment

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

Protected member variable "email" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var string|null
     */
    protected $emailCanonical;

Protected member variable "emailCanonical" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var bool

Expected "boolean" but found "bool" for @var tag in member variable comment

     */
    protected $enabled;

Protected member variable "enabled" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var array|null
     */
    protected $roles;

Protected member variable "roles" must contain a leading underscore

    /**

Missing short description in doc comment

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

Protected member variable "plainPassword" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var string|null
     */
    protected $password;

Protected member variable "password" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var string|null
     */
    protected $salt;

Protected member variable "salt" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var \DateTimeImmutable|null
     */
    protected $lastLogin;

Protected member variable "lastLogin" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var string|null
     */
    protected $confirmationToken;

Protected member variable "confirmationToken" must contain a leading underscore

    /**

Missing short description in doc comment

     * @var \DateTimeImmutable|null
     */
    protected $passwordRequestedAt;

Protected member variable "passwordRequestedAt" must contain a leading underscore

    public function __construct()

Expected 2 blank lines before function; 1 found

Missing doc comment for function __construct()

    {

Opening brace should be on the same line as the declaration

        $this->roles   = ['ROLE_USER'];

Short array syntax is not allowed

        $this->enabled = false;

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**

Missing short description in doc comment

     * @return int|string|null

Expected "integer|string|null" but found "int|string|null" for function return type

     */
    public function getId()
    {

Opening brace should be on the same line as the declaration

        return $this->id;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getId()

    /**

Missing short description in doc comment

     * @param string $role

Missing parameter comment

     *
     * @return static
     */
    public function addRole($role)

Type hint "string" missing for $role

    {

Opening brace should be on the same line as the declaration

        $role = strtoupper($role);

        if (!$this->hasRole($role)) {

Expected 1 space(s) after NOT operator; 0 found

            $this->roles[] = $role;
        }

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end addRole()

    /**

Missing short description in doc comment

     * @param string $role

Missing parameter comment

     */

Missing @return tag in function comment

    public function hasRole($role): bool

Type hint "string" missing for $role

    {

Opening brace should be on the same line as the declaration

        $role = strtoupper($role);

        return \in_array($role, $this->roles, true);

It seems like $this->roles can also be of type null; however, parameter $haystack of in_array() does only seem to accept array, maybe add an additional type check?

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of true please use TRUE.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end hasRole()

    /**

Missing short description in doc comment

     * @param string $role

Missing parameter comment

     *
     * @return static
     */
    public function removeRole($role)

Type hint "string" missing for $role

    {

Opening brace should be on the same line as the declaration

        if (false !== $key = array_search(strtoupper($role), $this->roles, true)) {

It seems like $this->roles can also be of type null; however, parameter $haystack of array_search() does only seem to accept array, maybe add an additional type check?

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

Variable assignment found within a condition. Did you mean to do a comparison ?

Assignments must be the first block of code on a line

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of true please use TRUE.

            unset($this->roles[$key]);
            $this->roles = array_values($this->roles);

It seems like $this->roles can also be of type null; however, parameter $input of array_values() does only seem to accept array, maybe add an additional type check?

        }

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end removeRole()

    /**

Missing short description in doc comment

Parameter $roles should have a doc-comment as per coding-style.

     * @return static
     */
    public function setRoles(?array $roles)
    {

Opening brace should be on the same line as the declaration

        $this->roles = [];

Short array syntax is not allowed

        foreach ($roles as $role) {
            $this->addRole($role);
        }

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setRoles()

    public function getSalt(): ?string

Missing doc comment for function getSalt()

    {

Opening brace should be on the same line as the declaration

        return $this->salt;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getSalt()

    /**

Missing short description in doc comment

Parameter $salt should have a doc-comment as per coding-style.

     * @return static
     */
    public function setSalt(?string $salt)
    {

Opening brace should be on the same line as the declaration

        $this->salt = $salt;

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setSalt()

    /**
     * {@inheritdoc}
     */

Missing @return tag in function comment

    public function eraseCredentials()
    {

Opening brace should be on the same line as the declaration

        $this->plainPassword = null;

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of null please use NULL.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end eraseCredentials()

    public function isEnabled(): bool

Missing doc comment for function isEnabled()

    {

Opening brace should be on the same line as the declaration

        return $this->enabled;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end isEnabled()

    /**

Missing short description in doc comment

Parameter $enabled should have a doc-comment as per coding-style.

     * @return static
     */
    public function setEnabled(bool $enabled)
    {

Opening brace should be on the same line as the declaration

        $this->enabled = $enabled;

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setEnabled()

    public function getUsername(): ?string

Missing doc comment for function getUsername()

    {

Opening brace should be on the same line as the declaration

        return $this->username;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getUsername()

    /**

Missing short description in doc comment

Parameter $username should have a doc-comment as per coding-style.

     * @return static
     */
    public function setUsername(?string $username)
    {

Opening brace should be on the same line as the declaration

        $this->username = $username;

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setUsername()

    public function getUsernameCanonical(): ?string

Missing doc comment for function getUsernameCanonical()

    {

Opening brace should be on the same line as the declaration

        return $this->usernameCanonical;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getUsernameCanonical()

    /**

Missing short description in doc comment

Parameter $usernameCanonical should have a doc-comment as per coding-style.

     * @return static
     */
    public function setUsernameCanonical(?string $usernameCanonical)
    {

Opening brace should be on the same line as the declaration

        $this->usernameCanonical = $usernameCanonical;

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setUsernameCanonical()

    public function getEmail(): ?string

Missing doc comment for function getEmail()

    {

Opening brace should be on the same line as the declaration

        return $this->email;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getEmail()

    /**

Missing short description in doc comment

Parameter $email should have a doc-comment as per coding-style.

     * @return static
     */
    public function setEmail(?string $email)
    {

Opening brace should be on the same line as the declaration

        $this->email = $email;

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setEmail()

    public function getEmailCanonical(): ?string

Missing doc comment for function getEmailCanonical()

    {

Opening brace should be on the same line as the declaration

        return $this->emailCanonical;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getEmailCanonical()

    /**

Missing short description in doc comment

Parameter $emailCanonical should have a doc-comment as per coding-style.

     * @return static
     */
    public function setEmailCanonical(?string $emailCanonical)
    {

Opening brace should be on the same line as the declaration

        $this->emailCanonical = $emailCanonical;

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setEmailCanonical()

    public function getRoles(): ?array

Missing doc comment for function getRoles()

    {

Opening brace should be on the same line as the declaration

        return $this->roles;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getRoles()

    public function getPlainPassword(): ?string

Missing doc comment for function getPlainPassword()

    {

Opening brace should be on the same line as the declaration

        return $this->plainPassword;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getPlainPassword()

    /**

Missing short description in doc comment

Parameter $plainPassword should have a doc-comment as per coding-style.

     * @return static
     */
    public function setPlainPassword(?string $plainPassword)
    {

Opening brace should be on the same line as the declaration

        $this->plainPassword = $plainPassword;

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setPlainPassword()

    public function getPassword(): ?string

Missing doc comment for function getPassword()

    {

Opening brace should be on the same line as the declaration

        return $this->password;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getPassword()

    /**

Missing short description in doc comment

Parameter $password should have a doc-comment as per coding-style.

     * @return static
     */
    public function setPassword(?string $password)
    {

Opening brace should be on the same line as the declaration

        $this->password = $password;

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setPassword()

    public function getLastLogin(): ?\DateTimeImmutable

Missing doc comment for function getLastLogin()

    {

Opening brace should be on the same line as the declaration

        return $this->lastLogin;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getLastLogin()

    /**

Missing short description in doc comment

Parameter $lastLogin should have a doc-comment as per coding-style.

     * @return static
     */
    public function setLastLogin(?\DateTimeImmutable $lastLogin)
    {

Opening brace should be on the same line as the declaration

        $this->lastLogin = $lastLogin;

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setLastLogin()

    public function getConfirmationToken(): ?string

Missing doc comment for function getConfirmationToken()

    {

Opening brace should be on the same line as the declaration

        return $this->confirmationToken;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getConfirmationToken()

    /**

Missing short description in doc comment

Parameter $confirmationToken should have a doc-comment as per coding-style.

     * @return static
     */
    public function setConfirmationToken(?string $confirmationToken)
    {

Opening brace should be on the same line as the declaration

        $this->confirmationToken = $confirmationToken;

        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setConfirmationToken()

    public function getPasswordRequestedAt(): ?\DateTimeImmutable

Missing doc comment for function getPasswordRequestedAt()

    {

Opening brace should be on the same line as the declaration

        return $this->passwordRequestedAt;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getPasswordRequestedAt()

    /**

Missing short description in doc comment

Parameter $passwordRequestedAt should have a doc-comment as per coding-style.

     * @return static
     */
    public function setPasswordRequestedAt(?\DateTimeImmutable $passwordRequestedAt)
    {

Opening brace should be on the same line as the declaration

        $this->passwordRequestedAt = $passwordRequestedAt;

        return $this;
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setPasswordRequestedAt()

}

Expected //end class

As per coding style, files should not end with a newline character.