AuthCode::getUserIdentifier() - Code Metrics - Inspection of "refactoring" - delboy1978uk/oauth2-api - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e9c9be...dec7df )

by Derek Stephen

created 2018-11-21 16:59 UTC

AuthCode::getUserIdentifier() A

↳ Parent: AuthCode

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace OAuth;

use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use League\OAuth2\Server\Entities\AuthCodeEntityInterface;
use League\OAuth2\Server\Entities\ClientEntityInterface;
use League\OAuth2\Server\Entities\ScopeEntityInterface;

/**
 * @ORM\Entity(repositoryClass="OAuth\Repository\AuthCodeRepository")
 * @ORM\Table(name="AuthCode")
 */
class AuthCode implements AuthCodeEntityInterface
{

    /**
     * @var null|string
     * @ORM\Column(type="string", length=255, nullable=true)
     */
    protected $redirectUri;

    /**
     * @var ArrayCollection $scopes
     */
    protected $scopes;

    /**
     * @var DateTime
     * @ORM\Column(type="datetime",nullable=true)
     */
    protected $expiryDateTime;

    /**
     * @var OAuthUser
     * @ORM\OneToOne(targetEntity="OAuth\OAuthUser")
     * @ORM\JoinColumn(name="user", referencedColumnName="id")
     */
    protected $userIdentifier;

    /**
     * @var ClientEntityInterface
     * @ORM\ManyToOne(targetEntity="OAuth\Client")
     * @ORM\JoinColumn(name="client", referencedColumnName="id")
     */
    protected $client;

    /**
     * @var string
     * @ORM\Column(type="text", nullable=false)
     */
    protected $identifier;

    /**
     * @var int
     * @ORM\Id
     * @ORM\Column(type="integer", nullable=false)
     * @ORM\GeneratedValue
     */
    protected $id;

    /**
     * @var bool
     * @ORM\Column(type="boolean")
     */
    protected $revoked = false;

    public function __construct()
    {
        $this->scopes = new ArrayCollection();
    }

    /**
     * @return string
     */
    public function getIdentifier()
    {
        return $this->identifier;
    }

    /**
     * @param string $identifier
     */
    public function setIdentifier($identifier)
    {
        $this->identifier = $identifier;
    }

    /**
     * @param ScopeEntityInterface $scope
     * @return $this
     */
    public function addScope(ScopeEntityInterface $scope)
    {
        $this->scopes->add($scope);
        return $this;
    }

    /**
     * Return an array of scopes associated with the token.
     *
     * @return ScopeEntityInterface[]
     */
    public function getScopes()
    {
        return $this->scopes->toArray();
    }

    /**
     * Get the token's expiry date time.
     *
     * @return DateTime
     */
    public function getExpiryDateTime()
    {
        return $this->expiryDateTime;
    }

    /**
     * Set the date time when the token expires.
     *
     * @param DateTime $dateTime
     */
    public function setExpiryDateTime(DateTime $dateTime)
    {
        $this->expiryDateTime = $dateTime;
    }

    /**
     * Set the identifier of the user associated with the token.
     *
     * @param OAuthUser $identifier The identifier of the user
     */
    public function setUserIdentifier($identifier)
    {
        $this->userIdentifier = $identifier;
    }

    /**
     * Get the token user's identifier.
     *
     * @return OAuthUser
     */
    public function getUserIdentifier()
    {
        return $this->userIdentifier;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * Get the client that the token was issued to.
     *
     * @return ClientEntityInterface
     */
    public function getClient()
    {
        return $this->client;
    }

    /**
     * Set the client that the token was issued to.
     *
     * @param ClientEntityInterface $client
     */
    public function setClient(ClientEntityInterface $client)
    {
        $this->client = $client;
    }

    /**
     * @return string
     */
    public function getRedirectUri()
    {
        return $this->redirectUri;
    }

    /**
     * @param string $uri
     */
    public function setRedirectUri($uri)
    {
        $this->redirectUri = $uri;
    }

    /**
     * @return bool
     */
    public function isRevoked(): bool
    {
        return $this->revoked;
    }

    /**
     * @param bool $revoked
     */
    public function setRevoked(bool $revoked): void
    {
        $this->revoked = $revoked;
    }
}

1		<?php
2
3		namespace OAuth;
4
5		use DateTime;
6		use Doctrine\Common\Collections\ArrayCollection;
7		use Doctrine\ORM\Mapping as ORM;
8		use League\OAuth2\Server\Entities\AuthCodeEntityInterface;
9		use League\OAuth2\Server\Entities\ClientEntityInterface;
10		use League\OAuth2\Server\Entities\ScopeEntityInterface;
11
12		/**
13		* @ORM\Entity(repositoryClass="OAuth\Repository\AuthCodeRepository")
14		* @ORM\Table(name="AuthCode")
15		*/
16		class AuthCode implements AuthCodeEntityInterface
17		{
18
19		/**
20		* @var null\|string
21		* @ORM\Column(type="string", length=255, nullable=true)
22		*/
23		protected $redirectUri;
24
25		/**
26		* @var ArrayCollection $scopes
27		*/
28		protected $scopes;
29
30		/**
31		* @var DateTime
32		* @ORM\Column(type="datetime",nullable=true)
33		*/
34		protected $expiryDateTime;
35
36		/**
37		* @var OAuthUser
38		* @ORM\OneToOne(targetEntity="OAuth\OAuthUser")
39		* @ORM\JoinColumn(name="user", referencedColumnName="id")
40		*/
41		protected $userIdentifier;
42
43		/**
44		* @var ClientEntityInterface
45		* @ORM\ManyToOne(targetEntity="OAuth\Client")
46		* @ORM\JoinColumn(name="client", referencedColumnName="id")
47		*/
48		protected $client;
49
50		/**
51		* @var string
52		* @ORM\Column(type="text", nullable=false)
53		*/
54		protected $identifier;
55
56		/**
57		* @var int
58		* @ORM\Id
59		* @ORM\Column(type="integer", nullable=false)
60		* @ORM\GeneratedValue
61		*/
62		protected $id;
63
64		/**
65		* @var bool
66		* @ORM\Column(type="boolean")
67		*/
68		protected $revoked = false;
69
70	6	public function __construct()
71		{
72	6	$this->scopes = new ArrayCollection();
73	6	}
74
75		/**
76		* @return string
77		*/
78	1	public function getIdentifier()
79		{
80	1	return $this->identifier;
81		}
82
83		/**
84		* @param string $identifier
85		*/
86	1	public function setIdentifier($identifier)
87		{
88	1	$this->identifier = $identifier;
89	1	}
90
91		/**
92		* @param ScopeEntityInterface $scope
93		* @return $this
94		*/
95	1	public function addScope(ScopeEntityInterface $scope)
96		{
97	1	$this->scopes->add($scope);
98	1	return $this;
99		}
100
101		/**
102		* Return an array of scopes associated with the token.
103		*
104		* @return ScopeEntityInterface[]
105		*/
106	1	public function getScopes()
107		{
108	1	return $this->scopes->toArray();
109		}
110
111		/**
112		* Get the token's expiry date time.
113		*
114		* @return DateTime
115		*/
116	1	public function getExpiryDateTime()
117		{
118	1	return $this->expiryDateTime;
119		}
120
121		/**
122		* Set the date time when the token expires.
123		*
124		* @param DateTime $dateTime
125		*/
126	1	public function setExpiryDateTime(DateTime $dateTime)
127		{
128	1	$this->expiryDateTime = $dateTime;
129	1	}
130
131		/**
132		* Set the identifier of the user associated with the token.
133		*
134		* @param OAuthUser $identifier The identifier of the user
135		*/
136	1	public function setUserIdentifier($identifier)
137		{
138	1	$this->userIdentifier = $identifier;
139	1	}
140
141		/**
142		* Get the token user's identifier.
143		*
144		* @return OAuthUser
145		*/
146	1	public function getUserIdentifier()
147		{
148	1	return $this->userIdentifier;
		0 ignored issues – show Bug Best Practice introduced 2018-11-12 19:12 UTC by Report Bug Copy Issue Report The expression `return $this->userIdentifier` returns the type `OAuth\OAuthUser` which is incompatible with the return type mandated by `League\OAuth2\Server\Ent...ce::getUserIdentifier()` of `integer\|null\|string`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
149		}
150
151		/**
152		* Get the client that the token was issued to.
153		*
154		* @return ClientEntityInterface
155		*/
156	1	public function getClient()
157		{
158	1	return $this->client;
159		}
160
161		/**
162		* Set the client that the token was issued to.
163		*
164		* @param ClientEntityInterface $client
165		*/
166	1	public function setClient(ClientEntityInterface $client)
167		{
168	1	$this->client = $client;
169	1	}
170
171		/**
172		* @return string
173		*/
174	1	public function getRedirectUri()
175		{
176	1	return $this->redirectUri;
177		}
178
179		/**
180		* @param string $uri
181		*/
182	1	public function setRedirectUri($uri)
183		{
184	1	$this->redirectUri = $uri;
185	1	}
186
187		/**
188		* @return bool
189		*/
190		public function isRevoked(): bool
191		{
192		return $this->revoked;
193		}
194
195		/**
196		* @param bool $revoked
197		*/
198		public function setRevoked(bool $revoked): void
199		{
200		$this->revoked = $revoked;
201		}
202		}

delboy1978uk / oauth2-api

Push — master ( e9c9be...dec7df )

AuthCode::getUserIdentifier() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like