Completed
Push — master ( c432ac...8e117f )
by Mathijs
04:01
created

JobPermissionCreateMapper   A

Complexity

Total Complexity 3

Size/Duplication

Total Lines 31
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 3

Importance

Changes 0
Metric Value
wmc 3
lcom 0
cbo 3
dl 0
loc 31
rs 10
c 0
b 0
f 0

3 Methods

Rating   Name   Duplication   Size   Complexity  
A mapMethod() 0 3 1
A mapUrl() 0 3 1
A mapConfig() 0 11 1
1
<?php
2
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\jobs\JobQueueCreate;
9
use mcorten87\rabbitmq_api\objects\Method;
10
use mcorten87\rabbitmq_api\objects\Url;
11
use mcorten87\rabbitmq_api\services\MqManagementConfig;
12
13
class JobPermissionCreateMapper extends BaseMapper
14
{
15
16
    protected function mapMethod(JobBase $job) : Method {
17
        return new Method(Method::METHOD_PUT);
18
    }
19
20
    /**
21
     * @param JobPermissionCreate $job
22
     * @return Url
23
     */
24
    protected function mapUrl(JobBase $job) : Url {
25
        return new Url('permissions/'.urlencode($job->getVirtualHost()).'/'.urlencode($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 getVirtualHost() 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\j...rmissionVirtualHostList, mcorten87\rabbitmq_api\jobs\JobQueueCreate, mcorten87\rabbitmq_api\jobs\JobQueueDelete, mcorten87\rabbitmq_api\jobs\JobQueueList, mcorten87\rabbitmq_api\jobs\JobQueuesList, 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...
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\JobPermissionUserList, 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
     * @param JobQueueCreate $job
30
     * @return array
31
     */
32
    protected function mapConfig(JobBase $job) : array {
33
        $body = [
34
            'configure'     => '.*',
35
            'write'         => '.*',
36
            'read'          => '.*',
37
        ];
38
39
        return array_merge(parent::mapConfig($job), [
40
            'json'      =>  $body,
41
        ]);
42
    }
43
}
44