Completed
Push — master ( 248a24...bb02de )
by Daniel
02:42
created

RpcQueueBag::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 17
Code Lines 14

Duplication

Lines 17
Ratio 100 %

Importance

Changes 0
Metric Value
dl 17
loc 17
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 14
nc 1
nop 5
1
<?php
2
3
namespace Cmobi\RabbitmqBundle\Transport\Rpc;
4
5
use Cmobi\RabbitmqBundle\Queue\QueueBagInterface;
6
use Symfony\Component\OptionsResolver\OptionsResolver;
7
8
class RpcQueueBag implements QueueBagInterface
9
{
10
    private $resolver;
11
    private $options;
12
13 View Code Duplication
    public function __construct(
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
14
        $queueName,
15
        $basicQos = 1,
16
        $durable = false,
17
        $autoDelete = true,
18
        array $arguments = null
19
    ) {
20
        $this->resolver = new OptionsResolver();
21
        $this->resolver->setDefaults([
22
            'queue_name' => $queueName,
23
            'basic_qos' => $basicQos,
24
            'durable' => $durable,
25
            'auto_delete' => $autoDelete,
26
            'arguments' => $arguments
27
        ]);
28
        $this->options = $this->resolver->resolve([]);
29
    }
30
31
    /**
32
     * @param $queue
33
     */
34
    public function setQueue($queue)
35
    {
36
        $this->options['queue_name'] = $queue;
37
    }
38
39
    /**
40
     * @return string|mixed
41
     */
42
    public function getQueue()
43
    {
44
        return $this->options['queue_name'];
45
    }
46
47
    /**
48
     * @param $qos
49
     */
50
    public function setBasicQos($qos)
51
    {
52
        $this->options['basic_qos'] = $qos;
53
    }
54
55
    /**
56
     * @return int
57
     */
58
    public function getBasicQos()
59
    {
60
        return $this->options['basic_qos'];
61
    }
62
63
    /**
64
     * @param $autoDelete
65
     */
66
    public function setAutoDelete($autoDelete)
67
    {
68
        $this->options['auto_delete'] = $autoDelete;
69
    }
70
71
    /**
72
     * @return bool
73
     */
74
    public function getAutoDelete()
75
    {
76
        return $this->options['auto_delete'];
77
    }
78
79
    /**
80
     * @param array $arguments
81
     */
82
    public function setArguments(array $arguments)
83
    {
84
        $this->options['arguments'] = $arguments;
85
    }
86
87
    /**
88
     * @return string
89
     */
90
    public function getArguments()
91
    {
92
        return $this->options['arguments'];
93
    }
94
95
    /**
96
     * @return bool
97
     */
98
    public function getPassive()
99
    {
100
        return false;
101
    }
102
103
    /**
104
     * @return bool
105
     */
106
    public function getDurable()
107
    {
108
        return false;
109
    }
110
111
    /**
112
     * @return bool
113
     */
114
    public function getExclusive()
115
    {
116
        return false;
117
    }
118
119
    /**
120
     * @return bool
121
     */
122
    public function getNoWait()
123
    {
124
        return false;
125
    }
126
127
    /**
128
     * @return null
129
     */
130
    public function getTicket()
131
    {
132
        return null;
133
    }
134
135
    /**
136
     * @return string
137
     */
138
    public function getConsumerTag()
139
    {
140
        return '';
141
    }
142
143
    /**
144
     * @return bool
145
     */
146
    public function getNoAck()
147
    {
148
        return false;
149
    }
150
151
    /**
152
     * @return bool
153
     */
154
    public function getNoLocal()
155
    {
156
        return false;
157
    }
158
159
    /**
160
     * @return array|false
161
     */
162
    public function getExchangeDeclare()
163
    {
164
        return false;
165
    }
166
167
    /**
168
     * @return string
169
     */
170
    public function getExchange()
171
    {
172
        return false;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return false; (false) is incompatible with the return type declared by the interface Cmobi\RabbitmqBundle\Que...gInterface::getExchange of type string.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
173
    }
174
175
    /**
176
     * @return string
177
     */
178
    public function getType()
179
    {
180
        return false;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return false; (false) is incompatible with the return type declared by the interface Cmobi\RabbitmqBundle\Que...ueBagInterface::getType of type string.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
181
    }
182
183
    /**
184
     * @return array
185
     */
186 View Code Duplication
    public function getQueueDeclare()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
187
    {
188
        return [
189
            $this->getQueue(),
190
            $this->getPassive(),
191
            $this->getDurable(),
192
            $this->getExclusive(),
193
            $this->getAutoDelete(),
194
            $this->getNoWait(),
195
            $this->getArguments(),
196
            $this->getTicket(),
197
        ];
198
    }
199
200
    /**
201
     * @return array
202
     */
203 View Code Duplication
    public function getQueueConsume()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
204
    {
205
        return [
206
            $this->getQueue(),
207
            $this->getConsumerTag(),
208
            $this->getNoLocal(),
209
            $this->getNoAck(),
210
            $this->getExclusive(),
211
            $this->getNoWait(),
212
            $this->getTicket(),
213
            $this->getArguments(),
214
        ];
215
    }
216
217
    /**
218
     * @param array $options
219
     * @return QueueBagInterface
220
     */
221
    public function registerOptions(array $options)
222
    {
223
        $this->options = $this->resolver->resolve($options);
224
225
        return $this;
226
    }
227
}
228