BoolLiteral::__toString() - Code Metrics - Inspection of "BoolLiteral and Boolean VO (#76)" - nicolopignatelli/valueobjects - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e344b5...6c2145 )

by Nicolò

created 2017-01-17 20:38 UTC

BoolLiteral::__toString() A

↳ Parent: BoolLiteral

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

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	2
eloc	2
nc	2
nop	0
crap	2

<?php

namespace ValueObjects\Boolean;

use ValueObjects\Exception\InvalidNativeArgumentException;
use ValueObjects\Util\Util;
use ValueObjects\ValueObjectInterface;

class BoolLiteral implements ValueObjectInterface
{
    protected $value;

    /**
     * Returns a BoolLiteral object given a BooleanString as parameter.
     *
     * @param  BooleanString $booleanString
     *
     * @return static
     */
    public static function fromBooleanString(BooleanString $booleanString)
    {
        return static::fromNative($booleanString->toBool());
    }

    /**
     * Returns a BoolLiteral object given a PHP native bool as parameter.
     *
     * @param  bool $value
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return static
     */
    public static function fromNative()
    {
        $value = func_get_arg(0);

        return new static($value);
    }

    /**
     * Returns a BoolLiteral object given a PHP native bool as parameter.
     *
     * @param bool $value
     */
    public function __construct($value)
    {
        if (false === \is_bool($value)) {
            throw new InvalidNativeArgumentException($value, array('bool'));
        }

        $this->value = $value;
    }

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

        return $this->toNative() === $boolLiteral->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 the native value of the BoolLiteral
     *
     * @return bool
     */
    public function toNative()
    {
        return $this->value;
    }

    /**
     * Returns a string representation of the BoolLiteral
     *
     * @return string
     */
    public function __toString()
    {
        return $this->value ? 'true' : 'false';
    }
}


1		<?php
2
3		namespace ValueObjects\Boolean;
4
5		use ValueObjects\Exception\InvalidNativeArgumentException;
6		use ValueObjects\Util\Util;
7		use ValueObjects\ValueObjectInterface;
8
9		class BoolLiteral implements ValueObjectInterface
10		{
11		protected $value;
12
13		/**
14		* Returns a BoolLiteral object given a BooleanString as parameter.
15		*
16		* @param BooleanString $booleanString
17		*
18		* @return static
19		*/
20	9	public static function fromBooleanString(BooleanString $booleanString)
21		{
22	9	return static::fromNative($booleanString->toBool());
23		}
24
25		/**
26		* Returns a BoolLiteral object given a PHP native bool as parameter.
27		*
28		* @param bool $value
		0 ignored issues – show Bug introduced 2017-01-17 09:15 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...
29		*
30		* @return static
31		*/
32	10	public static function fromNative()
33		{
34	10	$value = func_get_arg(0);
35
36	10	return new static($value);
37		}
38
39		/**
40		* Returns a BoolLiteral object given a PHP native bool as parameter.
41		*
42		* @param bool $value
43		*/
44	14	public function __construct($value)
45		{
46	14	if (false === \is_bool($value)) {
47	1	throw new InvalidNativeArgumentException($value, array('bool'));
48		}
49
50	13	$this->value = $value;
51	13	}
52
53		/**
54		* Tells whether two BoolLiteral are equal by comparing their values
55		*
56		* @param ValueObjectInterface $boolLiteral
57		*
58		* @return bool
59		*/
60	11	public function sameValueAs(ValueObjectInterface $boolLiteral)
61		{
62	11	if (false === Util::classEquals($this, $boolLiteral)) {
63	1	return false;
64		}
65
66	11	return $this->toNative() === $boolLiteral->toNative();
		0 ignored issues – show Bug introduced 2017-01-17 09:15 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\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...
67		}
68
69		/**
70		* Returns the native value of the BoolLiteral
71		*
72		* @return bool
73		*/
74	12	public function toNative()
75		{
76	12	return $this->value;
77		}
78
79		/**
80		* Returns a string representation of the BoolLiteral
81		*
82		* @return string
83		*/
84	1	public function __toString()
85		{
86	1	return $this->value ? 'true' : 'false';
87		}
88		}
89

nicolopignatelli / valueobjects

Push — master ( e344b5...6c2145 )

BoolLiteral::__toString() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like