DataTransferObjectError::unknownProperties() - Code Metrics - Inspection of "Add properties to exceptions" - spatie/data-transfer-object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#96)

unknown

created 2020-03-04 22:32 UTC

DataTransferObjectError::unknownProperties() A

↳ Parent: DataTransferObjectError

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

declare(strict_types=1);

namespace Spatie\DataTransferObject;

use TypeError;

class DataTransferObjectError extends TypeError
{
    use HasErrorProperties;

    public function __construct($message, $properties = [])
    {
        parent::__construct($message);
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.
    }
}
        $this->setProperties($properties);
    }

    public static function unknownProperties(array $properties, string $className): DataTransferObjectError
    {
        $propertyNames = implode('`, `', $properties);

        return new self("Public properties `{$propertyNames}` not found on {$className}", [
            'error'      => __FUNCTION__,
            'class'      => $className,
            'properties' => $properties,
        ]);
    }

    public static function invalidType(
        string $class,
        string $field,
        array $expectedTypes,
        $value
    ): DataTransferObjectError {
        $currentType = gettype($value);

        if ($value === null) {
            $value = 'null';
        }

        if (is_object($value)) {
            $value = get_class($value);
        }

        if (is_array($value)) {
            $value = 'array';
        }

        $expectedTypesList = implode(', ', $expectedTypes);

        return new self("Invalid type: expected `{$class}::{$field}` to be of type `{$expectedTypesList}`, instead got value `{$value}`, which is {$currentType}.", [
            'error'         => __FUNCTION__,
            'class'         => $class,
            'property'      => $field,
            'value'         => $value,
            'type'          => $currentType,
            'expectedTypes' => $expectedTypes,
        ]);
    }

    public static function uninitialized(string $class, string $field): DataTransferObjectError
    {
        return new self("Non-nullable property `{$class}::{$field}` has not been initialized.", [
            'error'    => __FUNCTION__,
            'class'    => $class,
            'property' => $field,
        ]);
    }

    public static function immutable(string $property): DataTransferObjectError
    {
        return new self("Cannot change the value of property {$property} on an immutable data transfer object", [
            'error'    => __FUNCTION__,
            'property' => $property,
        ]);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Spatie\DataTransferObject;
6
7			use TypeError;
8
9			class DataTransferObjectError extends TypeError
10			{
11			use HasErrorProperties;
12
13			public function __construct($message, $properties = [])
14			{
15			parent::__construct($message);
			0 ignored issues – show Bug introduced 2020-03-04 22:33 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`: `Spatie\DataTransferObject\DataTransferObjectError`. 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...
16			$this->setProperties($properties);
17			}
18
19			public static function unknownProperties(array $properties, string $className): DataTransferObjectError
20			{
21			$propertyNames = implode('`, `', $properties);
22
23			return new self("Public properties `{$propertyNames}` not found on {$className}", [
24			'error' => __FUNCTION__,
25			'class' => $className,
26			'properties' => $properties,
27			]);
28			}
29
30			public static function invalidType(
31			string $class,
32			string $field,
33			array $expectedTypes,
34			$value
35			): DataTransferObjectError {
36			$currentType = gettype($value);
37
38			if ($value === null) {
39			$value = 'null';
40			}
41
42			if (is_object($value)) {
43			$value = get_class($value);
44			}
45
46			if (is_array($value)) {
47			$value = 'array';
48			}
49
50			$expectedTypesList = implode(', ', $expectedTypes);
51
52			return new self("Invalid type: expected `{$class}::{$field}` to be of type `{$expectedTypesList}`, instead got value `{$value}`, which is {$currentType}.", [
53			'error' => __FUNCTION__,
54			'class' => $class,
55			'property' => $field,
56			'value' => $value,
57			'type' => $currentType,
58			'expectedTypes' => $expectedTypes,
59			]);
60			}
61
62			public static function uninitialized(string $class, string $field): DataTransferObjectError
63			{
64			return new self("Non-nullable property `{$class}::{$field}` has not been initialized.", [
65			'error' => __FUNCTION__,
66			'class' => $class,
67			'property' => $field,
68			]);
69			}
70
71			public static function immutable(string $property): DataTransferObjectError
72			{
73			return new self("Cannot change the value of property {$property} on an immutable data transfer object", [
74			'error' => __FUNCTION__,
75			'property' => $property,
76			]);
77			}
78			}
79

spatie / data-transfer-object

GitHub Access Token became invalid

Pull Request — master (#96)

DataTransferObjectError::unknownProperties() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like