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

WorkerQueueBag::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 13
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 13
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 10
nc 1
nop 3
1
<?php
2
3
namespace Cmobi\RabbitmqBundle\Transport\Worker;
4
5
use Cmobi\RabbitmqBundle\Queue\QueueBagInterface;
6
use Symfony\Component\OptionsResolver\OptionsResolver;
7
8
class WorkerQueueBag implements QueueBagInterface
9
{
10
    private $resolver;
11
    private $options;
12
13
    public function __construct(
14
        $queueName,
15
        $basicQos = 1,
16
        array $arguments = null
17
    ) {
18
        $this->resolver = new OptionsResolver();
19
        $this->resolver->setDefaults([
20
            'queue_name' => $queueName,
21
            'basic_qos' => $basicQos,
22
            'arguments' => $arguments
23
        ]);
24
        $this->options = $this->resolver->resolve([]);
25
    }
26
27
    /**
28
     * @param $queue
29
     */
30
    public function setQueue($queue)
31
    {
32
        $this->options['queue_name'] = $queue;
33
    }
34
35
    /**
36
     * @return string|mixed
37
     */
38
    public function getQueue()
39
    {
40
        return $this->options['queue_name'];
41
    }
42
43
    /**
44
     * @param $qos
45
     */
46
    public function setBasicQos($qos)
47
    {
48
        $this->options['basic_qos'] = $qos;
49
    }
50
51
    /**
52
     * @return int
53
     */
54
    public function getBasicQos()
55
    {
56
        return $this->options['basic_qos'];
57
    }
58
59
    /**
60
     * @return bool
61
     */
62
    public function getPassive()
63
    {
64
        return false;
65
    }
66
67
    /**
68
     * @return bool
69
     */
70
    public function getDurable()
71
    {
72
        return true;
73
    }
74
75
    /**
76
     * @return bool
77
     */
78
    public function getExclusive()
79
    {
80
        return false;
81
    }
82
83
    /**
84
     * @return bool
85
     */
86
    public function getAutoDelete()
87
    {
88
        return false;
89
    }
90
91
    /**
92
     * @return bool
93
     */
94
    public function getNoWait()
95
    {
96
        return false;
97
    }
98
99
    /**
100
     * @return null
101
     */
102
    public function getTicket()
103
    {
104
        return null;
105
    }
106
107
    /**
108
     * @return string
109
     */
110
    public function getConsumerTag()
111
    {
112
        return '';
113
    }
114
115
    /**
116
     * @return bool
117
     */
118
    public function getNoAck()
119
    {
120
        return false;
121
    }
122
123
    /**
124
     * @return bool
125
     */
126
    public function getNoLocal()
127
    {
128
        return false;
129
    }
130
131
    /**
132
     * @param array $arguments
133
     */
134
    public function setArguments(array $arguments)
135
    {
136
        $this->options['arguments'] = $arguments;
137
    }
138
139
    /**
140
     * @return string
141
     */
142
    public function getArguments()
143
    {
144
        return $this->options['arguments'];
145
    }
146
147
    /**
148
     * @return array
149
     */
150 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...
151
    {
152
        return [
153
            $this->getQueue(),
154
            $this->getPassive(),
155
            $this->getDurable(),
156
            $this->getExclusive(),
157
            $this->getAutoDelete(),
158
            $this->getNoWait(),
159
            $this->getArguments(),
160
            $this->getTicket(),
161
        ];
162
    }
163
164
    /**
165
     * @return array
166
     */
167 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...
168
    {
169
        return [
170
            $this->getQueue(),
171
            $this->getConsumerTag(),
172
            $this->getNoLocal(),
173
            $this->getNoAck(),
174
            $this->getExclusive(),
175
            $this->getNoWait(),
176
            $this->getTicket(),
177
            $this->getArguments(),
178
        ];
179
    }
180
181
    /**
182
     * @return array|false
183
     */
184
    public function getExchangeDeclare()
185
    {
186
        return false;
187
    }
188
189
    /**
190
     * @return string
191
     */
192
    public function getExchange()
193
    {
194
        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...
195
    }
196
197
    /**
198
     * @return string
199
     */
200
    public function getType()
201
    {
202
        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...
203
    }
204
205
    /**
206
     * @param array $options
207
     * @return QueueBagInterface
208
     */
209
    public function registerOptions(array $options)
210
    {
211
        $this->options = $this->resolver->resolve($options);
212
213
        return $this;
214
    }
215
}
216