Enum::sameValueAs() - Code Metrics - nicolopignatelli/valueobjects - Measure and Improve Code Quality continuously with Scrutinizer

Enum::sameValueAs() A
last analyzed 2017-04-18 19:08 UTC

↳ Parent: Enum

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

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

<?php

namespace ValueObjects\Enum;

use MabeEnum\Enum as BaseEnum;
use ValueObjects\Util\Util;
use ValueObjects\ValueObjectInterface;

abstract class Enum extends BaseEnum implements ValueObjectInterface
{
    /**
     * Returns a new Enum object from passed value matching argument
     *
     * @param  string $value
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return static
     */
    public static function fromNative()
    {
        return static::get(func_get_arg(0));
    }

    /**
     * Returns the PHP native value of the enum
     *
     * @return mixed
     */
    public function toNative()
    {
        return parent::getValue();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Tells whether two Enum objects are sameValueAs by comparing their values
     *
     * @param  Enum $enum
     * @return bool
     */
    public function sameValueAs(ValueObjectInterface $enum)
    {
        if (false === Util::classEquals($this, $enum)) {
            return false;
        }

        return $this->toNative() === $enum->toNative();
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.
    }
}
    }

    /**
     * Returns a native string representation of the Enum value
     *
     * @return string
     */
    public function __toString()
    {
        return \strval($this->toNative());
    }
}


1		<?php
2
3		namespace ValueObjects\Enum;
4
5		use MabeEnum\Enum as BaseEnum;
6		use ValueObjects\Util\Util;
7		use ValueObjects\ValueObjectInterface;
8
9		abstract class Enum extends BaseEnum implements ValueObjectInterface
10		{
11		/**
12		* Returns a new Enum object from passed value matching argument
13		*
14		* @param string $value
		0 ignored issues – show Bug introduced 2015-11-21 01:12 UTC by Report Bug Copy Issue Report There is no parameter named `$value`. 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...
15		* @return static
16		*/
17	4	public static function fromNative()
18		{
19	4	return static::get(func_get_arg(0));
20		}
21
22		/**
23		* Returns the PHP native value of the enum
24		*
25		* @return mixed
26		*/
27	67	public function toNative()
28		{
29	67	return parent::getValue();
		0 ignored issues – show Comprehensibility Bug introduced 2015-11-21 01:12 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`getValue()` instead of `toNative()`). Are you sure this is correct? If so, you might want to change this to `$this->getValue()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
30		}
31
32		/**
33		* Tells whether two Enum objects are sameValueAs by comparing their values
34		*
35		* @param Enum $enum
36		* @return bool
37		*/
38	23	public function sameValueAs(ValueObjectInterface $enum)
39		{
40	23	if (false === Util::classEquals($this, $enum)) {
41	1	return false;
42		}
43
44	23	return $this->toNative() === $enum->toNative();
		0 ignored issues – show Bug introduced 2017-04-18 19:05 UTC by Report Bug Copy Issue Report 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 Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
45		}
46
47		/**
48		* Returns a native string representation of the Enum value
49		*
50		* @return string
51		*/
52	30	public function __toString()
53		{
54	30	return \strval($this->toNative());
55		}
56		}
57

nicolopignatelli / valueobjects

Enum::sameValueAs() A last analyzed 2017-04-18 19:08 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Enum::sameValueAs() A
last analyzed 2017-04-18 19:08 UTC