AbstractPropertyNotThingableError::__construct() - Code Metrics - Inspection of "abstracting thingable exceptions" - SignpostMarv/daft-object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a67098...e6e3d2 )

by SignpostMarv

created 2017-08-29 20:08 UTC

AbstractPropertyNotThingableError::__construct() A

↳ Parent: AbstractPropertyNotThingableError

Complexity

Conditions	1
Paths	1

Size

Total Lines	18
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	14
nc	1
nop	5

<?php
/**
* Exceptions.
*
* @author SignpostMarv
*/
declare(strict_types=1);

namespace SignpostMarv\DaftObject;

use Throwable;
use TypeError;

/**
* Error thrown when a property is not thingable.
*/
abstract class AbstractPropertyNotThingableError extends TypeError
{
    /**
    * Wraps to TypeError::__construct().
    *
    * @param string $thing the type of thing that the $property cannot do, i.e. writeable, nullable
    * @param string $className name of the class on which the property is not thingable
    * @param string $property name of the property which is not thingable
    * @param int $code @see TypeError::__construct()
    * @param Throwable|null $previous @see TypeError::__construct()
    */
    public function __construct(
        string $thing,
        string $className,
        string $property,
        int $code = 0,
        Throwable $previous = null
    ) {
        parent::__construct(
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            sprintf(
                'Property not %s: %s::$%s',
                $thing,
                $className,
                $property
            ),
            $code,
            $previous
        );
    }
}


GitHub Access Token became invalid

Push — master ( a67098...e6e3d2 )

AbstractPropertyNotThingableError::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

1			<?php
2			/**
3			* Exceptions.
4			*
5			* @author SignpostMarv
6			*/
7			declare(strict_types=1);
8
9			namespace SignpostMarv\DaftObject;
10
11			use Throwable;
12			use TypeError;
13
14			/**
15			* Error thrown when a property is not thingable.
16			*/
17			abstract class AbstractPropertyNotThingableError extends TypeError
18			{
19			/**
20			* Wraps to TypeError::__construct().
21			*
22			* @param string $thing the type of thing that the $property cannot do, i.e. writeable, nullable
23			* @param string $className name of the class on which the property is not thingable
24			* @param string $property name of the property which is not thingable
25			* @param int $code @see TypeError::__construct()
26			* @param Throwable\|null $previous @see TypeError::__construct()
27			*/
28			public function __construct(
29			string $thing,
30			string $className,
31			string $property,
32			int $code = 0,
33			Throwable $previous = null
34			) {
35			parent::__construct(
			0 ignored issues – show Bug introduced 2017-08-29 20:09 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `TypeError` as the method `__construct()` does only exist in the following sub-classes of `TypeError`: `SignpostMarv\DaftObject\...opertyNotThingableError`, `SignpostMarv\DaftObject\...rtyNotNullableException`, `SignpostMarv\DaftObject\...tyNotWriteableException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
36			sprintf(
37			'Property not %s: %s::$%s',
38			$thing,
39			$className,
40			$property
41			),
42			$code,
43			$previous
44			);
45			}
46			}
47

SignpostMarv / daft-object

GitHub Access Token became invalid

Push — master ( a67098...e6e3d2 )

AbstractPropertyNotThingableError::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like