UUID   A
last analyzed

Complexity

Total Complexity 7

Size/Duplication

Total Lines 63
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 4

Test Coverage

Coverage 100%

Importance

Changes 3
Bugs 0 Features 0
Metric Value
wmc 7
c 3
b 0
f 0
lcom 1
cbo 4
dl 0
loc 63
ccs 22
cts 22
cp 1
rs 10

4 Methods

Rating   Name   Duplication   Size   Complexity  
A fromNative() 0 7 1
A generateAsString() 0 7 1
A sameValueAs() 0 8 2
A __construct() 0 16 3
1
<?php
2
3
namespace ValueObjects\Identity;
4
5
use ValueObjects\Exception\InvalidNativeArgumentException;
6
use ValueObjects\StringLiteral\StringLiteral;
7
use ValueObjects\Util\Util;
8
use ValueObjects\ValueObjectInterface;
9
use Ramsey\Uuid\Uuid as BaseUuid;
10
11
class UUID extends StringLiteral
12
{
13
    /** @var BaseUuid */
14
    protected $value;
15
16
    /**
17
     * @param  string                                                 $uuid
0 ignored issues
show
Bug introduced by
There is no parameter named $uuid. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
18
     * @return UUID
19
     * @throws \ValueObjects\Exception\InvalidNativeArgumentException
20
     */
21 1
    public static function fromNative()
22
    {
23 1
        $uuid_str = \func_get_arg(0);
24 1
        $uuid     = new static($uuid_str);
25
26 1
        return $uuid;
27
    }
28
29
    /**
30
     * Generate a new UUID string
31
     *
32
     * @return string
33
     */
34 1
    public static function generateAsString()
35
    {
36 1
        $uuid       = new static();
37 1
        $uuidString = $uuid->toNative();
38
39 1
        return $uuidString;
40
    }
41
42 4
    public function __construct($value = null)
43
    {
44 4
        $uuid_str = BaseUuid::uuid4();
45
46 4
        if (null !== $value) {
47 2
            $pattern = '/'.BaseUuid::VALID_PATTERN.'/';
48
49 2
            if (! \preg_match($pattern, $value)) {
50 1
                throw new InvalidNativeArgumentException($value, array('UUID string'));
51
            }
52
53 1
            $uuid_str = $value;
54 1
        }
55
56 3
        $this->value = \strval($uuid_str);
0 ignored issues
show
Documentation Bug introduced by
It seems like \strval($uuid_str) of type string is incompatible with the declared type object<Ramsey\Uuid\Uuid> of property $value.

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...
57 3
    }
58
59
    /**
60
     * Tells whether two UUID are equal by comparing their values
61
     *
62
     * @param  UUID $uuid
63
     * @return bool
64
     */
65 2
    public function sameValueAs(ValueObjectInterface $uuid)
66
    {
67 2
        if (false === Util::classEquals($this, $uuid)) {
68 1
            return false;
69
        }
70
71 2
        return $this->toNative() === $uuid->toNative();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface ValueObjects\ValueObjectInterface as the method toNative() does only exist in the following implementations of said interface: ValueObjects\Boolean\BoolLiteral, ValueObjects\Boolean\BooleanString, ValueObjects\Climate\Celsius, ValueObjects\Climate\Fahrenheit, ValueObjects\Climate\Kelvin, ValueObjects\Climate\RelativeHumidity, ValueObjects\Climate\Temperature, ValueObjects\DateTime\Hour, ValueObjects\DateTime\Minute, ValueObjects\DateTime\Month, ValueObjects\DateTime\MonthDay, ValueObjects\DateTime\Second, ValueObjects\DateTime\WeekDay, ValueObjects\DateTime\Year, ValueObjects\Enum\Enum, ValueObjects\Geography\Continent, ValueObjects\Geography\CountryCode, ValueObjects\Geography\DistanceFormula, ValueObjects\Geography\DistanceUnit, ValueObjects\Geography\Ellipsoid, ValueObjects\Geography\Latitude, ValueObjects\Geography\Longitude, ValueObjects\Identity\Imei, ValueObjects\Identity\MacAddress, ValueObjects\Identity\UUID, ValueObjects\Money\CurrencyCode, ValueObjects\Number\Complex, ValueObjects\Number\Integer, ValueObjects\Number\Natural, ValueObjects\Number\Real, ValueObjects\Number\RoundingMode, ValueObjects\Person\Age, ValueObjects\Person\Gender, ValueObjects\StringLiteral\StringLiteral, ValueObjects\Web\Domain, ValueObjects\Web\EmailAddress, ValueObjects\Web\FragmentIdentifier, ValueObjects\Web\Hostname, ValueObjects\Web\IPAddress, ValueObjects\Web\IPAddressVersion, ValueObjects\Web\IPv4Address, ValueObjects\Web\IPv6Address, ValueObjects\Web\NullFragmentIdentifier, ValueObjects\Web\NullQueryString, ValueObjects\Web\Path, ValueObjects\Web\PortNumber, ValueObjects\Web\QueryString, ValueObjects\Web\SchemeName.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
72
    }
73
}
74