InvalidParameterExceptionHandler   A
last analyzed

Complexity

Total Complexity 4

Size/Duplication

Total Lines 31
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 1

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
wmc 4
lcom 0
cbo 1
dl 0
loc 31
ccs 14
cts 14
cp 1
rs 10
c 0
b 0
f 0

2 Methods

Rating   Name   Duplication   Size   Complexity  
A manages() 0 4 1
A handle() 0 17 3
1
<?php
2
3
/*
4
 * This file is part of JSON-API.
5
 *
6
 * (c) Toby Zerner <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Tobscure\JsonApi\Exception\Handler;
13
14
use Exception;
15
use Tobscure\JsonApi\Exception\InvalidParameterException;
16
17
class InvalidParameterExceptionHandler implements ExceptionHandlerInterface
18
{
19
    /**
20
     * {@inheritdoc}
21
     */
22 6
    public function manages(Exception $e)
23
    {
24 6
        return $e instanceof InvalidParameterException;
25
    }
26
27
    /**
28
     * {@inheritdoc}
29
     */
30 3
    public function handle(Exception $e)
31
    {
32 3
        $status = 400;
33 3
        $error = [];
34
35 3
        $code = $e->getCode();
36 3
        if ($code) {
37 3
            $error['code'] = $code;
38 3
        }
39
40 3
        $invalidParameter = $e->getInvalidParameter();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Exception as the method getInvalidParameter() does only exist in the following sub-classes of Exception: Tobscure\JsonApi\Excepti...validParameterException. 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

  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 parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
41 3
        if ($invalidParameter) {
42 3
            $error['source'] = ['parameter' => $invalidParameter];
43 3
        }
44
45 3
        return new ResponseBag($status, [$error]);
46
    }
47
}
48