UserInfo::__set_state() - Code Metrics - Inspection of "Adding PHP magic methods" - thephpleague/uri - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#46)

by ignace nyamagana

created 2016-04-12 11:09 UTC

UserInfo::__set_state() A

↳ Parent: UserInfo

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * League.Uri (http://uri.thephpleague.com)
 *
 * @package   League.uri
 * @author    Ignace Nyamagana Butera <[email protected]>
 * @copyright 2013-2015 Ignace Nyamagana Butera
 * @license   https://github.com/thephpleague/uri/blob/master/LICENSE (MIT License)
 * @version   4.1.1
 * @link      https://github.com/thephpleague/uri/
 */
namespace League\Uri\Components;

use League\Uri\Interfaces\Pass as PassInterface;
use League\Uri\Interfaces\UriPart;
use League\Uri\Interfaces\User as UserInterface;
use League\Uri\Interfaces\UserInfo as UserInfoInterface;
use League\Uri\Types\ImmutablePropertyTrait;

/**
 * Value object representing the UserInfo part of an URI.
 *
 * @package League.uri
 * @author  Ignace Nyamagana Butera <[email protected]>
 * @since   4.0.0
 *
 */
class UserInfo implements UserInfoInterface
{
    use ImmutablePropertyTrait;

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

    /**
     * Pass Component
     *
     * @var Pass
     */
    protected $pass;

    /**
     * Create a new instance of UserInfo
     *
     * @param UserInterface|string $user
     * @param PassInterface|string $pass
     */
    public function __construct($user = null, $pass = null)
    {
        $this->user = !$user instanceof UserInterface ? new User($user) : $user;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        $this->pass = !$pass instanceof PassInterface ? new Pass($pass) : $pass;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        $this->assertValidObject();
    }

    /**
     * Retrieve the user component of the URI User Info part
     *
     * @return string
     */
    public function getUser()
    {
        return $this->user->__toString();
    }

    /**
     * Retrieve the pass component of the URI User Info part
     *
     * @return string
     */
    public function getPass()
    {
        return $this->pass->__toString();
    }

    /**
     * @inheritdoc
     */
    public function __debugInfo()
    {
        return ['userInfo' => $this->__toString()];
    }

    /**
     * @inheritdoc
     */
    public static function __set_state(array $properties)
    {
        return new static($properties['user'], $properties['pass']);
    }

    /**
     * Returns the instance string representation; If the
     * instance is not defined an empty string is returned
     *
     * @return string
     */
    public function __toString()
    {
        $userInfo = $this->user->__toString();
        if ('' === $userInfo) {
            return $userInfo;
        }

        $pass = $this->pass->__toString();
        if ('' !== $pass) {
            $userInfo .= UserInfoInterface::SEPARATOR.$pass;
        }

        return $userInfo;
    }

    /**
     * Returns the instance string representation
     * with its optional URI delimiters
     *
     * @return string
     */
    public function getUriComponent()
    {
        $component = $this->__toString();
        if ('' !== $component) {
            $component .= UserInfoInterface::DELIMITER;
        }

        return $component;
    }

    /**
     * Returns whether two UriPart objects represent the same value
     * The comparison is based on the getUriComponent method
     *
     * @param UriPart $component
     *
     * @return bool
     */
    public function sameValueAs(UriPart $component)
    {
        return $this->getUriComponent() === $component->getUriComponent();
    }

    /**
     * Return an instance with the specified user.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified user.
     *
     * An empty user is equivalent to removing the user information.
     *
     * @param string $user The user to use with the new instance.
     *
     * @throws \InvalidArgumentException for invalid user.
     *
     * @return static
     */
    public function withUser($user)
    {
        return $this->withProperty('user', $user);
    }

    /**
     * Return an instance with the specified password.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified password.
     *
     * An empty password is equivalent to removing the password.
     *
     * @param string $pass The password to use with the new instance.
     *
     * @throws \InvalidArgumentException for invalid password.
     *
     * @return static
     */
    public function withPass($pass)
    {
        return $this->withProperty('pass', $pass);
    }

    /**
     * @inheritdoc
     */
    protected function assertValidObject()
    {
    }
}


1		<?php
2		/**
3		* League.Uri (http://uri.thephpleague.com)
4		*
5		* @package League.uri
6		* @author Ignace Nyamagana Butera <[email protected]>
7		* @copyright 2013-2015 Ignace Nyamagana Butera
8		* @license https://github.com/thephpleague/uri/blob/master/LICENSE (MIT License)
9		* @version 4.1.1
10		* @link https://github.com/thephpleague/uri/
11		*/
12		namespace League\Uri\Components;
13
14		use League\Uri\Interfaces\Pass as PassInterface;
15		use League\Uri\Interfaces\UriPart;
16		use League\Uri\Interfaces\User as UserInterface;
17		use League\Uri\Interfaces\UserInfo as UserInfoInterface;
18		use League\Uri\Types\ImmutablePropertyTrait;
19
20		/**
21		* Value object representing the UserInfo part of an URI.
22		*
23		* @package League.uri
24		* @author Ignace Nyamagana Butera <[email protected]>
25		* @since 4.0.0
26		*
27		*/
28		class UserInfo implements UserInfoInterface
29		{
30		use ImmutablePropertyTrait;
31
32		/**
33		* User Component
34		*
35		* @var User
36		*/
37		protected $user;
38
39		/**
40		* Pass Component
41		*
42		* @var Pass
43		*/
44		protected $pass;
45
46		/**
47		* Create a new instance of UserInfo
48		*
49		* @param UserInterface\|string $user
50		* @param PassInterface\|string $pass
51		*/
52	640	public function __construct($user = null, $pass = null)
53		{
54	640	$this->user = !$user instanceof UserInterface ? new User($user) : $user;
		0 ignored issues – show Documentation Bug introduced 2016-02-02 09:40 UTC by Report Bug Copy Issue Report `!$user instanceof \Leagu...nts\User($user) : $user` is of type `object<League\Uri\Interfaces\User>`, but the property `$user` was declared to be of type `object<League\Uri\Components\User>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
55	640	$this->pass = !$pass instanceof PassInterface ? new Pass($pass) : $pass;
		0 ignored issues – show Documentation Bug introduced 2016-02-02 09:40 UTC by Report Bug Copy Issue Report `!$pass instanceof \Leagu...nts\Pass($pass) : $pass` is of type `object<League\Uri\Interfaces\Pass>`, but the property `$pass` was declared to be of type `object<League\Uri\Components\Pass>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
56	640	$this->assertValidObject();
57	640	}
58
59		/**
60		* Retrieve the user component of the URI User Info part
61		*
62		* @return string
63		*/
64	132	public function getUser()
65		{
66	132	return $this->user->__toString();
67		}
68
69		/**
70		* Retrieve the pass component of the URI User Info part
71		*
72		* @return string
73		*/
74	126	public function getPass()
75		{
76	126	return $this->pass->__toString();
77		}
78
79		/**
80		* @inheritdoc
81		*/
82	2	public function __debugInfo()
83		{
84	2	return ['userInfo' => $this->__toString()];
85		}
86
87		/**
88		* @inheritdoc
89		*/
90	12	public static function __set_state(array $properties)
91		{
92	12	return new static($properties['user'], $properties['pass']);
93		}
94
95		/**
96		* Returns the instance string representation; If the
97		* instance is not defined an empty string is returned
98		*
99		* @return string
100		*/
101	604	public function __toString()
102		{
103	604	$userInfo = $this->user->__toString();
104	604	if ('' === $userInfo) {
105	510	return $userInfo;
106		}
107
108	145	$pass = $this->pass->__toString();
109	145	if ('' !== $pass) {
110	142	$userInfo .= UserInfoInterface::SEPARATOR.$pass;
111	94	}
112
113	145	return $userInfo;
114		}
115
116		/**
117		* Returns the instance string representation
118		* with its optional URI delimiters
119		*
120		* @return string
121		*/
122	584	public function getUriComponent()
123		{
124	584	$component = $this->__toString();
125	584	if ('' !== $component) {
126	137	$component .= UserInfoInterface::DELIMITER;
127	91	}
128
129	584	return $component;
130		}
131
132		/**
133		* Returns whether two UriPart objects represent the same value
134		* The comparison is based on the getUriComponent method
135		*
136		* @param UriPart $component
137		*
138		* @return bool
139		*/
140	12	public function sameValueAs(UriPart $component)
141		{
142	12	return $this->getUriComponent() === $component->getUriComponent();
143		}
144
145		/**
146		* Return an instance with the specified user.
147		*
148		* This method MUST retain the state of the current instance, and return
149		* an instance that contains the specified user.
150		*
151		* An empty user is equivalent to removing the user information.
152		*
153		* @param string $user The user to use with the new instance.
154		*
155		* @throws \InvalidArgumentException for invalid user.
156		*
157		* @return static
158		*/
159	114	public function withUser($user)
160		{
161	114	return $this->withProperty('user', $user);
162		}
163
164		/**
165		* Return an instance with the specified password.
166		*
167		* This method MUST retain the state of the current instance, and return
168		* an instance that contains the specified password.
169		*
170		* An empty password is equivalent to removing the password.
171		*
172		* @param string $pass The password to use with the new instance.
173		*
174		* @throws \InvalidArgumentException for invalid password.
175		*
176		* @return static
177		*/
178	114	public function withPass($pass)
179		{
180	114	return $this->withProperty('pass', $pass);
181		}
182
183		/**
184		* @inheritdoc
185		*/
186	640	protected function assertValidObject()
187		{
188	640	}
189		}
190

thephpleague / uri

Pull Request — master (#46)

UserInfo::__set_state() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like