JobPermissionCreateMapper::mapMethod()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 0
loc 3
rs 10
ccs 2
cts 2
cp 1
cc 1
eloc 2
nc 1
nop 0
crap 1
1
<?php
2
declare(strict_types=1);
3
namespace mcorten87\rabbitmq_api\mappers;
4
5
6
use mcorten87\rabbitmq_api\jobs\JobBase;
7
use mcorten87\rabbitmq_api\jobs\JobPermissionCreate;
8
use mcorten87\rabbitmq_api\objects\Method;
9
use mcorten87\rabbitmq_api\objects\Url;
10
11
class JobPermissionCreateMapper extends BaseMapper
12
{
13
14 1
    protected function mapMethod() : Method {
15 1
        return new Method(Method::PUT);
16
    }
17
18
    /**
19
     * @param JobPermissionCreate $job
20
     * @return Url
21
     */
22 1
    protected function mapUrl(JobBase $job) : Url {
23 1
        return new Url('permissions/'
24 1
            .urlencode((string)$job->getVirtualHost())
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class mcorten87\rabbitmq_api\jobs\JobBase as the method getVirtualHost() does only exist in the following sub-classes of mcorten87\rabbitmq_api\jobs\JobBase: mcorten87\rabbitmq_api\j...BetweenQueueAndExchange, mcorten87\rabbitmq_api\jobs\JobBindingListExchange, mcorten87\rabbitmq_api\jobs\JobBindingListQueue, mcorten87\rabbitmq_api\j...bBindingListVirtualHost, mcorten87\rabbitmq_api\j...BindingToExchangeCreate, mcorten87\rabbitmq_api\j...BindingToExchangeDelete, mcorten87\rabbitmq_api\j...JobBindingToQueueCreate, mcorten87\rabbitmq_api\j...JobBindingToQueueDelete, mcorten87\rabbitmq_api\j...nnectionListVirtualHost, mcorten87\rabbitmq_api\j...finitionListVirtualHost, mcorten87\rabbitmq_api\jobs\JobExchangeCreate, mcorten87\rabbitmq_api\jobs\JobExchangeDelete, mcorten87\rabbitmq_api\jobs\JobExchangeList, mcorten87\rabbitmq_api\j...ExchangeListVirtualHost, mcorten87\rabbitmq_api\jobs\JobExchangePublish, mcorten87\rabbitmq_api\jobs\JobPermissionCreate, mcorten87\rabbitmq_api\jobs\JobPermissionDelete, mcorten87\rabbitmq_api\j...rmissionListVirtualHost, mcorten87\rabbitmq_api\jobs\JobQueueCreate, mcorten87\rabbitmq_api\jobs\JobQueueDelete, mcorten87\rabbitmq_api\jobs\JobQueueList, mcorten87\rabbitmq_api\j...JobQueueListVirtualHost, mcorten87\rabbitmq_api\jobs\JobVirtualHostCreate, mcorten87\rabbitmq_api\jobs\JobVirtualHostDelete, mcorten87\rabbitmq_api\jobs\JobVirtualHostList. 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...
25 1
            .'/'.urlencode((string)$job->getUser())
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class mcorten87\rabbitmq_api\jobs\JobBase as the method getUser() does only exist in the following sub-classes of mcorten87\rabbitmq_api\jobs\JobBase: mcorten87\rabbitmq_api\jobs\JobPermissionCreate, mcorten87\rabbitmq_api\jobs\JobPermissionDelete, mcorten87\rabbitmq_api\jobs\JobPermissionListUser, mcorten87\rabbitmq_api\jobs\JobUserCreate, mcorten87\rabbitmq_api\jobs\JobUserDelete, mcorten87\rabbitmq_api\jobs\JobUserList. 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...
26
        );
27
    }
28
29
    /**
30
     * @param JobPermissionCreate $job
31
     * @return array
32
     */
33 1
    protected function mapConfig(JobBase $job) : array {
34
        $body = [
35 1
            'configure'     => '.*',
36
            'write'         => '.*',
37
            'read'          => '.*',
38
        ];
39
40 1
        return array_merge(parent::mapConfig($job), [
41 1
            'json'      =>  $body,
42
        ]);
43
    }
44
}
45