RpcClient::setResponse() - Code Metrics - Inspection of "Migration to msf bundle" - contamobi/CmobiRabbitmqBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1)

by Daniel

created 2016-12-28 18:40 UTC

RpcClient::setResponse() A

↳ Parent: RpcClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php

namespace Cmobi\RabbitmqBundle\Transport\Rpc;

use Cmobi\RabbitmqBundle\Connection\CmobiAMQPChannel;
use Cmobi\RabbitmqBundle\Connection\ConnectionManager;
use Cmobi\RabbitmqBundle\Queue\CmobiAMQPMessage;
use Cmobi\RabbitmqBundle\Queue\QueueProducerInterface;
use PhpAmqpLib\Message\AMQPMessage;

class RpcClient implements QueueProducerInterface
{
    private $connectionManager;
    private $channel;
    private $fromName;
    private $queueName;
    private $response;
    private $correlationId;
    private $callbackQueue;

    public function __construct($queueName, ConnectionManager $manager, $fromName = '')
    {
        $this->queueName = $queueName;
        $this->fromName = $fromName;
        $this->connectionManager = $manager;
    }

    /**
     * @param AMQPMessage $rep
     */
    public function onResponse(AMQPMessage $rep)
    {
        if ($rep->get('correlation_id') === $this->correlationId) {
            $this->response = $rep->getBody();
        }
    }

    /**
     * @return \PhpAmqpLib\Channel\AMQPChannel
     *
     * @throws \Cmobi\RabbitmqBundle\Connection\Exception\NotFoundAMQPConnectionFactoryException
     */
    public function refreshChannel()

    {
        $connection = $this->connectionManager->getConnection();

        if (!$connection->isConnected()) {
            $connection->reconnect();
        }
        $this->channel = $connection->channel();

        return $this->channel;
    }

    /**
     * @param $data
     * @param int $expire
     * @param int $priority
     */
    public function publish($data, $expire = self::DEFAULT_TTL, $priority = self::PRIORITY_LOW)
    {
        $this->refreshChannel();
        $this->correlationId = $this->generateCorrelationId();
        $queueBag = new RpcQueueBag(
            sprintf('callback_to_%s_from_%s_%s', $this->getQueueName(), $this->getFromName(), microtime())
        );
        $queueBag->setArguments([
            'x-expires' => ['I', $expire],
        ]);
        list($callbackQueue) = $this->getChannel()->queueDeclare($queueBag->getQueueDeclare());
        $this->callbackQueue = $callbackQueue;
        $consumeQueueBag = new RpcQueueBag($callbackQueue);

        $this->getChannel()->basicConsume(
            $consumeQueueBag->getQueueConsume(),
            [$this, 'onResponse']
        );
        $msg = new CmobiAMQPMessage(
            (string) $data,
            [
                'correlation_id' => $this->correlationId,
                'reply_to' => $this->callbackQueue,
                'priority' => $priority,
            ]
        );
        $this->getChannel()->basic_publish($msg, '', $this->getQueueName());

        while (!$this->response) {
            $this->getChannel()->wait(null, 0, ($expire / 1000));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        $this->getChannel()->close();
        $this->connectionManager->getConnection()->close();
    }

    /**
     * @return string
     */
    public function getQueueName()
    {
        return $this->queueName;
    }

    /**
     * @return CmobiAMQPChannel
     */
    public function getChannel()
    {
        return $this->channel;
    }

    /**
     * @return string
     */
    public function getFromName()
    {
        return $this->fromName;
    }

    /**
     * @todo unecessary method set, its only exists to run tests whitout stay jailed in infinite while waiting response.
     *
     * @param $content
     */
    public function setResponse($content)
    {
        $this->response = $content;
    }

    /**
     * @return string
     */
    public function getResponse()
    {
        return $this->response;
    }

    /** @return string */
    public function generateCorrelationId()
    {
        return uniqid($this->getQueueName()).microtime();
    }

    /**
     * @return string
     */
    public function getCurrentCorrelationId()
    {
        return $this->correlationId;
    }

    /**
     * @return string
     */
    public function getExchange()
    {
        return false;
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());
}
    }

    /**
     * @return string
     */
    public function getExchangeType()
    {
        return false;
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());
}
    }
}


1		<?php
2
3		namespace Cmobi\RabbitmqBundle\Transport\Rpc;
4
5		use Cmobi\RabbitmqBundle\Connection\CmobiAMQPChannel;
6		use Cmobi\RabbitmqBundle\Connection\ConnectionManager;
7		use Cmobi\RabbitmqBundle\Queue\CmobiAMQPMessage;
8		use Cmobi\RabbitmqBundle\Queue\QueueProducerInterface;
9		use PhpAmqpLib\Message\AMQPMessage;
10
11		class RpcClient implements QueueProducerInterface
12		{
13		private $connectionManager;
14		private $channel;
15		private $fromName;
16		private $queueName;
17		private $response;
18		private $correlationId;
19		private $callbackQueue;
20
21		public function __construct($queueName, ConnectionManager $manager, $fromName = '')
22		{
23		$this->queueName = $queueName;
24		$this->fromName = $fromName;
25		$this->connectionManager = $manager;
26		}
27
28		/**
29		* @param AMQPMessage $rep
30		*/
31		public function onResponse(AMQPMessage $rep)
32		{
33		if ($rep->get('correlation_id') === $this->correlationId) {
34		$this->response = $rep->getBody();
35		}
36		}
37
38		/**
39		* @return \PhpAmqpLib\Channel\AMQPChannel
40		*
41		* @throws \Cmobi\RabbitmqBundle\Connection\Exception\NotFoundAMQPConnectionFactoryException
42		*/
43	View Code Duplication	public function refreshChannel()
		0 ignored issues – show Duplication introduced 2016-12-28 18:51 UTC by Report Bug Copy Issue Report 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...
44		{
45		$connection = $this->connectionManager->getConnection();
46
47		if (!$connection->isConnected()) {
48		$connection->reconnect();
49		}
50		$this->channel = $connection->channel();
51
52		return $this->channel;
53		}
54
55		/**
56		* @param $data
57		* @param int $expire
58		* @param int $priority
59		*/
60		public function publish($data, $expire = self::DEFAULT_TTL, $priority = self::PRIORITY_LOW)
61		{
62		$this->refreshChannel();
63		$this->correlationId = $this->generateCorrelationId();
64		$queueBag = new RpcQueueBag(
65		sprintf('callback_to_%s_from_%s_%s', $this->getQueueName(), $this->getFromName(), microtime())
66		);
67		$queueBag->setArguments([
68		'x-expires' => ['I', $expire],
69		]);
70		list($callbackQueue) = $this->getChannel()->queueDeclare($queueBag->getQueueDeclare());
71		$this->callbackQueue = $callbackQueue;
72		$consumeQueueBag = new RpcQueueBag($callbackQueue);
73
74		$this->getChannel()->basicConsume(
75		$consumeQueueBag->getQueueConsume(),
76		[$this, 'onResponse']
77		);
78		$msg = new CmobiAMQPMessage(
79		(string) $data,
80		[
81		'correlation_id' => $this->correlationId,
82		'reply_to' => $this->callbackQueue,
83		'priority' => $priority,
84		]
85		);
86		$this->getChannel()->basic_publish($msg, '', $this->getQueueName());
87
88		while (!$this->response) {
89		$this->getChannel()->wait(null, 0, ($expire / 1000));
		0 ignored issues – show Documentation introduced 2016-04-29 12:41 UTC by Report Bug Copy Issue Report `0` is of type `integer`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
90		}
91		$this->getChannel()->close();
92		$this->connectionManager->getConnection()->close();
93		}
94
95		/**
96		* @return string
97		*/
98		public function getQueueName()
99		{
100		return $this->queueName;
101		}
102
103		/**
104		* @return CmobiAMQPChannel
105		*/
106		public function getChannel()
107		{
108		return $this->channel;
109		}
110
111		/**
112		* @return string
113		*/
114		public function getFromName()
115		{
116		return $this->fromName;
117		}
118
119		/**
120		* @todo unecessary method set, its only exists to run tests whitout stay jailed in infinite while waiting response.
121		*
122		* @param $content
123		*/
124		public function setResponse($content)
125		{
126		$this->response = $content;
127		}
128
129		/**
130		* @return string
131		*/
132		public function getResponse()
133		{
134		return $this->response;
135		}
136
137		/** @return string */
138		public function generateCorrelationId()
139		{
140		return uniqid($this->getQueueName()).microtime();
141		}
142
143		/**
144		* @return string
145		*/
146		public function getCurrentCorrelationId()
147		{
148		return $this->correlationId;
149		}
150
151		/**
152		* @return string
153		*/
154		public function getExchange()
155		{
156		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-12-28 18:51 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Cmobi\RabbitmqBundle\Que...rInterface::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...
157		}
158
159		/**
160		* @return string
161		*/
162		public function getExchangeType()
163		{
164		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-12-28 18:51 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Cmobi\RabbitmqBundle\Que...erface::getExchangeType` 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...
165		}
166		}
167

contamobi / CmobiRabbitmqBundle

Pull Request — master (#1)

RpcClient::setResponse() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like