PublishToExchangeListener::getChannel() - Code Metrics - Inspection of "Merge branch 'v2'" - hiqdev/hiapi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4bcd21...430cdc )

by Dmitry

created 2018-05-14 09:57 UTC

PublishToExchangeListener::getChannel() A

↳ Parent: PublishToExchangeListener

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	2
eloc	5
nc	2
nop	0

<?php

namespace hiapi\event;

use League\Event\AbstractListener;
use League\Event\EventInterface;
use PhpAmqpLib\Connection\AMQPStreamConnection;
use PhpAmqpLib\Channel\AMQPChannel;
use PhpAmqpLib\Message\AMQPMessage;
use Psr\Log\LoggerInterface;
use yii\base\InvalidConfigException;
use yii\helpers\Inflector;

/**
 * Class PublishToExchangeListener published events to AMQP exchange.
 *
 * @author Dmytro Naumenko <[email protected]>
 */
class PublishToExchangeListener extends AbstractListener
{
    /**
     * @var AMQPStreamConnection
     */
    protected $amqp;

    /**
     * @var LoggerInterface
     */
    private $logger;

    /**
     * @var AMQPChannel
     */
    protected $channel;

    /**
     * @var string the exchange name for the published messages
     */
    public $exchange;

    /**
     * @var string the exchange type. Defaults to 'direct'
     */
    public $exchangeType = 'direct';

    public function __construct(AMQPStreamConnection $amqp, LoggerInterface $logger)
    {
        $this->amqp = $amqp;
        $this->logger = $logger;
    }

    /**
     * Handle an event.
     * @param EventInterface $event
     * @return void
     */
    public function handle(EventInterface $event): void
    {
        if ($this->exchange === null) {
            throw new \RuntimeException('Property PublishToQueueListener::queue must be set');
        }

        try {
            $message = $this->createMessage($event);
            $this->getChannel()->basic_publish($message, $this->exchange, $this->buildRoutingKey($event));
        } catch (InvalidConfigException $exception) {
            $this->logger->critical($exception->getMessage());
        }
    }

    protected function getChannel(): AMQPChannel
    {
        if ($this->channel === null) {
            $this->channel = $channel = $this->amqp->channel();
            $channel->exchange_declare($this->exchange, $this->exchangeType, false, true, true, false, false);
        }

        return $this->channel;
    }

    private function createMessage($event): AMQPMessage
    {
        if (!$event instanceof \JsonSerializable) {
            throw new InvalidConfigException('Event "' . get_class($event) . '" can not be sent to exchange');
        }

        return new AMQPMessage(json_encode($event->jsonSerialize(), JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES), [
            'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT,
            'content_type' => 'application/json',
        ]);
    }

    /**
     * Builds routing key for $event. Default logic:
     *
     * For events named with `Was` keyword (e.g. `ObjectWasChanged`) routing key will be `object.was.changed`.
     * For other events [[InvalidConfigException]] will be thrown.
     *
     * You can override this method to implement own routing key generation logic.
     *
     * @param EventInterface $event
     * @return string
     * @throws InvalidConfigException when `Was` keyword
     */
    public function buildRoutingKey(EventInterface $event)
    {
        $className = (new \ReflectionClass($event))->getShortName();
        if (strpos($className, 'Was') === false) {
            throw new InvalidConfigException("Event class name \"$className\" does not contain \"Was\" keyword and can not be processed with default logic.");
        }

        [$object, $eventName] = explode('Was', $className);
function someFunction() {
    $x = 5;
    echo $x;
}

        $object = Inflector::camel2id($object);
function someFunction() {
    $x = 5;
    echo $x;
}
        $eventName = Inflector::camel2id($eventName);
function someFunction() {
    $x = 5;
    echo $x;
}

        return mb_strtolower("$object.was.$eventName");
    }
}


1			<?php
2
3			namespace hiapi\event;
4
5			use League\Event\AbstractListener;
6			use League\Event\EventInterface;
7			use PhpAmqpLib\Connection\AMQPStreamConnection;
8			use PhpAmqpLib\Channel\AMQPChannel;
9			use PhpAmqpLib\Message\AMQPMessage;
10			use Psr\Log\LoggerInterface;
11			use yii\base\InvalidConfigException;
12			use yii\helpers\Inflector;
13
14			/**
15			* Class PublishToExchangeListener published events to AMQP exchange.
16			*
17			* @author Dmytro Naumenko <[email protected]>
18			*/
19			class PublishToExchangeListener extends AbstractListener
20			{
21			/**
22			* @var AMQPStreamConnection
23			*/
24			protected $amqp;
25
26			/**
27			* @var LoggerInterface
28			*/
29			private $logger;
30
31			/**
32			* @var AMQPChannel
33			*/
34			protected $channel;
35
36			/**
37			* @var string the exchange name for the published messages
38			*/
39			public $exchange;
40
41			/**
42			* @var string the exchange type. Defaults to 'direct'
43			*/
44			public $exchangeType = 'direct';
45
46			public function __construct(AMQPStreamConnection $amqp, LoggerInterface $logger)
47			{
48			$this->amqp = $amqp;
49			$this->logger = $logger;
50			}
51
52			/**
53			* Handle an event.
54			* @param EventInterface $event
55			* @return void
56			*/
57			public function handle(EventInterface $event): void
58			{
59			if ($this->exchange === null) {
60			throw new \RuntimeException('Property PublishToQueueListener::queue must be set');
61			}
62
63			try {
64			$message = $this->createMessage($event);
65			$this->getChannel()->basic_publish($message, $this->exchange, $this->buildRoutingKey($event));
66			} catch (InvalidConfigException $exception) {
67			$this->logger->critical($exception->getMessage());
68			}
69			}
70
71			protected function getChannel(): AMQPChannel
72			{
73			if ($this->channel === null) {
74			$this->channel = $channel = $this->amqp->channel();
75			$channel->exchange_declare($this->exchange, $this->exchangeType, false, true, true, false, false);
76			}
77
78			return $this->channel;
79			}
80
81			private function createMessage($event): AMQPMessage
82			{
83			if (!$event instanceof \JsonSerializable) {
84			throw new InvalidConfigException('Event "' . get_class($event) . '" can not be sent to exchange');
85			}
86
87			return new AMQPMessage(json_encode($event->jsonSerialize(), JSON_UNESCAPED_UNICODE \| JSON_UNESCAPED_SLASHES), [
88			'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT,
89			'content_type' => 'application/json',
90			]);
91			}
92
93			/**
94			* Builds routing key for $event. Default logic:
95			*
96			* For events named with `Was` keyword (e.g. `ObjectWasChanged`) routing key will be `object.was.changed`.
97			* For other events [[InvalidConfigException]] will be thrown.
98			*
99			* You can override this method to implement own routing key generation logic.
100			*
101			* @param EventInterface $event
102			* @return string
103			* @throws InvalidConfigException when `Was` keyword
104			*/
105			public function buildRoutingKey(EventInterface $event)
106			{
107			$className = (new \ReflectionClass($event))->getShortName();
108			if (strpos($className, 'Was') === false) {
109			throw new InvalidConfigException("Event class name \"$className\" does not contain \"Was\" keyword and can not be processed with default logic.");
110			}
111
112			[$object, $eventName] = explode('Was', $className);
			0 ignored issues – show Bug introduced 2018-05-14 10:08 UTC by Report Bug Copy Issue Report The variable `$object` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history... Bug introduced 2018-05-14 10:08 UTC by Report Bug Copy Issue Report The variable `$eventName` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
113
114			$object = Inflector::camel2id($object);
			0 ignored issues – show Bug introduced 2018-05-14 10:08 UTC by Report Bug Copy Issue Report The variable `$object` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
115			$eventName = Inflector::camel2id($eventName);
			0 ignored issues – show Bug introduced 2018-05-14 10:08 UTC by Report Bug Copy Issue Report The variable `$eventName` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
116
117			return mb_strtolower("$object.was.$eventName");
118			}
119			}
120

hiqdev / hiapi

Push — master ( 4bcd21...430cdc )

PublishToExchangeListener::getChannel() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like