|
| 1 | +<?php |
| 2 | + |
| 3 | +/* |
| 4 | + * This file is part of the Symfony package. |
| 5 | + * |
| 6 | + * (c) Fabien Potencier <[email protected]> |
| 7 | + * |
| 8 | + * For the full copyright and license information, please view the LICENSE |
| 9 | + * file that was distributed with this source code. |
| 10 | + */ |
| 11 | + |
| 12 | +namespace Symfony\Component\VarDumper\Caster; |
| 13 | + |
| 14 | +use Symfony\Component\VarDumper\Cloner\Stub; |
| 15 | + |
| 16 | +/** |
| 17 | + * Casts Amqp related classes to array representation. |
| 18 | + * |
| 19 | + * @author Grégoire Pineau <[email protected]> |
| 20 | + * |
| 21 | + * @final |
| 22 | + */ |
| 23 | +class AmqpCaster |
| 24 | +{ |
| 25 | + private const FLAGS = [ |
| 26 | + \AMQP_DURABLE => 'AMQP_DURABLE', |
| 27 | + \AMQP_PASSIVE => 'AMQP_PASSIVE', |
| 28 | + \AMQP_EXCLUSIVE => 'AMQP_EXCLUSIVE', |
| 29 | + \AMQP_AUTODELETE => 'AMQP_AUTODELETE', |
| 30 | + \AMQP_INTERNAL => 'AMQP_INTERNAL', |
| 31 | + \AMQP_NOLOCAL => 'AMQP_NOLOCAL', |
| 32 | + \AMQP_AUTOACK => 'AMQP_AUTOACK', |
| 33 | + \AMQP_IFEMPTY => 'AMQP_IFEMPTY', |
| 34 | + \AMQP_IFUNUSED => 'AMQP_IFUNUSED', |
| 35 | + \AMQP_MANDATORY => 'AMQP_MANDATORY', |
| 36 | + \AMQP_IMMEDIATE => 'AMQP_IMMEDIATE', |
| 37 | + \AMQP_MULTIPLE => 'AMQP_MULTIPLE', |
| 38 | + \AMQP_NOWAIT => 'AMQP_NOWAIT', |
| 39 | + \AMQP_REQUEUE => 'AMQP_REQUEUE', |
| 40 | + ]; |
| 41 | + |
| 42 | + private const EXCHANGE_TYPES = [ |
| 43 | + \AMQP_EX_TYPE_DIRECT => 'AMQP_EX_TYPE_DIRECT', |
| 44 | + \AMQP_EX_TYPE_FANOUT => 'AMQP_EX_TYPE_FANOUT', |
| 45 | + \AMQP_EX_TYPE_TOPIC => 'AMQP_EX_TYPE_TOPIC', |
| 46 | + \AMQP_EX_TYPE_HEADERS => 'AMQP_EX_TYPE_HEADERS', |
| 47 | + ]; |
| 48 | + |
| 49 | + /** |
| 50 | + * @return array |
| 51 | + */ |
| 52 | + public static function castConnection(\AMQPConnection $c, array $a, Stub $stub, bool $isNested) |
| 53 | + { |
| 54 | + $prefix = Caster::PREFIX_VIRTUAL; |
| 55 | + |
| 56 | + $a += [ |
| 57 | + $prefix.'is_connected' => $c->isConnected(), |
| 58 | + ]; |
| 59 | + |
| 60 | + // Recent version of the extension already expose private properties |
| 61 | + if (isset($a["\x00AMQPConnection\x00login"])) { |
| 62 | + return $a; |
| 63 | + } |
| 64 | + |
| 65 | + // BC layer in the amqp lib |
| 66 | + if (method_exists($c, 'getReadTimeout')) { |
| 67 | + $timeout = $c->getReadTimeout(); |
| 68 | + } else { |
| 69 | + $timeout = $c->getTimeout(); |
| 70 | + } |
| 71 | + |
| 72 | + $a += [ |
| 73 | + $prefix.'is_connected' => $c->isConnected(), |
| 74 | + $prefix.'login' => $c->getLogin(), |
| 75 | + $prefix.'password' => $c->getPassword(), |
| 76 | + $prefix.'host' => $c->getHost(), |
| 77 | + $prefix.'vhost' => $c->getVhost(), |
| 78 | + $prefix.'port' => $c->getPort(), |
| 79 | + $prefix.'read_timeout' => $timeout, |
| 80 | + ]; |
| 81 | + |
| 82 | + return $a; |
| 83 | + } |
| 84 | + |
| 85 | + /** |
| 86 | + * @return array |
| 87 | + */ |
| 88 | + public static function castChannel(\AMQPChannel $c, array $a, Stub $stub, bool $isNested) |
| 89 | + { |
| 90 | + $prefix = Caster::PREFIX_VIRTUAL; |
| 91 | + |
| 92 | + $a += [ |
| 93 | + $prefix.'is_connected' => $c->isConnected(), |
| 94 | + $prefix.'channel_id' => $c->getChannelId(), |
| 95 | + ]; |
| 96 | + |
| 97 | + // Recent version of the extension already expose private properties |
| 98 | + if (isset($a["\x00AMQPChannel\x00connection"])) { |
| 99 | + return $a; |
| 100 | + } |
| 101 | + |
| 102 | + $a += [ |
| 103 | + $prefix.'connection' => $c->getConnection(), |
| 104 | + $prefix.'prefetch_size' => $c->getPrefetchSize(), |
| 105 | + $prefix.'prefetch_count' => $c->getPrefetchCount(), |
| 106 | + ]; |
| 107 | + |
| 108 | + return $a; |
| 109 | + } |
| 110 | + |
| 111 | + /** |
| 112 | + * @return array |
| 113 | + */ |
| 114 | + public static function castQueue(\AMQPQueue $c, array $a, Stub $stub, bool $isNested) |
| 115 | + { |
| 116 | + $prefix = Caster::PREFIX_VIRTUAL; |
| 117 | + |
| 118 | + $a += [ |
| 119 | + $prefix.'flags' => self::extractFlags($c->getFlags()), |
| 120 | + ]; |
| 121 | + |
| 122 | + // Recent version of the extension already expose private properties |
| 123 | + if (isset($a["\x00AMQPQueue\x00name"])) { |
| 124 | + return $a; |
| 125 | + } |
| 126 | + |
| 127 | + $a += [ |
| 128 | + $prefix.'connection' => $c->getConnection(), |
| 129 | + $prefix.'channel' => $c->getChannel(), |
| 130 | + $prefix.'name' => $c->getName(), |
| 131 | + $prefix.'arguments' => $c->getArguments(), |
| 132 | + ]; |
| 133 | + |
| 134 | + return $a; |
| 135 | + } |
| 136 | + |
| 137 | + /** |
| 138 | + * @return array |
| 139 | + */ |
| 140 | + public static function castExchange(\AMQPExchange $c, array $a, Stub $stub, bool $isNested) |
| 141 | + { |
| 142 | + $prefix = Caster::PREFIX_VIRTUAL; |
| 143 | + |
| 144 | + $a += [ |
| 145 | + $prefix.'flags' => self::extractFlags($c->getFlags()), |
| 146 | + ]; |
| 147 | + |
| 148 | + $type = isset(self::EXCHANGE_TYPES[$c->getType()]) ? new ConstStub(self::EXCHANGE_TYPES[$c->getType()], $c->getType()) : $c->getType(); |
| 149 | + |
| 150 | + // Recent version of the extension already expose private properties |
| 151 | + if (isset($a["\x00AMQPExchange\x00name"])) { |
| 152 | + $a["\x00AMQPExchange\x00type"] = $type; |
| 153 | + |
| 154 | + return $a; |
| 155 | + } |
| 156 | + |
| 157 | + $a += [ |
| 158 | + $prefix.'connection' => $c->getConnection(), |
| 159 | + $prefix.'channel' => $c->getChannel(), |
| 160 | + $prefix.'name' => $c->getName(), |
| 161 | + $prefix.'type' => $type, |
| 162 | + $prefix.'arguments' => $c->getArguments(), |
| 163 | + ]; |
| 164 | + |
| 165 | + return $a; |
| 166 | + } |
| 167 | + |
| 168 | + /** |
| 169 | + * @return array |
| 170 | + */ |
| 171 | + public static function castEnvelope(\AMQPEnvelope $c, array $a, Stub $stub, bool $isNested, int $filter = 0) |
| 172 | + { |
| 173 | + $prefix = Caster::PREFIX_VIRTUAL; |
| 174 | + |
| 175 | + $deliveryMode = new ConstStub($c->getDeliveryMode().(2 === $c->getDeliveryMode() ? ' (persistent)' : ' (non-persistent)'), $c->getDeliveryMode()); |
| 176 | + |
| 177 | + // Recent version of the extension already expose private properties |
| 178 | + if (isset($a["\x00AMQPEnvelope\x00body"])) { |
| 179 | + $a["\0AMQPEnvelope\0delivery_mode"] = $deliveryMode; |
| 180 | + |
| 181 | + return $a; |
| 182 | + } |
| 183 | + |
| 184 | + if (!($filter & Caster::EXCLUDE_VERBOSE)) { |
| 185 | + $a += [$prefix.'body' => $c->getBody()]; |
| 186 | + } |
| 187 | + |
| 188 | + $a += [ |
| 189 | + $prefix.'delivery_tag' => $c->getDeliveryTag(), |
| 190 | + $prefix.'is_redelivery' => $c->isRedelivery(), |
| 191 | + $prefix.'exchange_name' => $c->getExchangeName(), |
| 192 | + $prefix.'routing_key' => $c->getRoutingKey(), |
| 193 | + $prefix.'content_type' => $c->getContentType(), |
| 194 | + $prefix.'content_encoding' => $c->getContentEncoding(), |
| 195 | + $prefix.'headers' => $c->getHeaders(), |
| 196 | + $prefix.'delivery_mode' => $deliveryMode, |
| 197 | + $prefix.'priority' => $c->getPriority(), |
| 198 | + $prefix.'correlation_id' => $c->getCorrelationId(), |
| 199 | + $prefix.'reply_to' => $c->getReplyTo(), |
| 200 | + $prefix.'expiration' => $c->getExpiration(), |
| 201 | + $prefix.'message_id' => $c->getMessageId(), |
| 202 | + $prefix.'timestamp' => $c->getTimeStamp(), |
| 203 | + $prefix.'type' => $c->getType(), |
| 204 | + $prefix.'user_id' => $c->getUserId(), |
| 205 | + $prefix.'app_id' => $c->getAppId(), |
| 206 | + ]; |
| 207 | + |
| 208 | + return $a; |
| 209 | + } |
| 210 | + |
| 211 | + private static function extractFlags(int $flags): ConstStub |
| 212 | + { |
| 213 | + $flagsArray = []; |
| 214 | + |
| 215 | + foreach (self::FLAGS as $value => $name) { |
| 216 | + if ($flags & $value) { |
| 217 | + $flagsArray[] = $name; |
| 218 | + } |
| 219 | + } |
| 220 | + |
| 221 | + if (!$flagsArray) { |
| 222 | + $flagsArray = ['AMQP_NOPARAM']; |
| 223 | + } |
| 224 | + |
| 225 | + return new ConstStub(implode('|', $flagsArray), $flags); |
| 226 | + } |
| 227 | +} |
0 commit comments