videlalvaro / php-amqplib

PhpAmqpLib/Channel/AbstractChannel.php

Doc Comments +12 added lines, -2 removed lines

@@ -70,7 +70,7 @@ 
 
     /**
      * @param AbstractConnection $connection
-     * @param $channel_id
+     * @param integer|null $channel_id
      * @throws \PhpAmqpLib\Exception\AMQPRuntimeException
      */
     public function __construct(AbstractConnection $connection, $channel_id)
@@ -234,7 +234,7 @@ 
      * @param $method_sig
      * @param string $args
      * @param null $pkt
-     * @return null|\PhpAmqpLib\Wire\AMQPWriter
+     * @return \PhpAmqpLib\Wire\AMQPWriter
      */
     protected function prepare_method_frame($method_sig, $args = '', $pkt = null)
     {
@@ -408,6 +408,10 @@ 
         $this->validate_frame($frame_type, 3, 'AMQP Content body');
     }
 
+    /**
+     * @param integer $expected_type
+     * @param string $expected_msg
+     */
     protected function validate_frame($frame_type, $expected_type, $expected_msg)
     {
         if ($frame_type != $expected_type) {
@@ -444,6 +448,9 @@ 
         return mb_substr($payload, 4, mb_strlen($payload, 'ASCII') - 4, 'ASCII');
     }
 
+    /**
+     * @param string $method_sig
+     */
     protected function should_dispatch_method($allowed_methods, $method_sig)
     {
         $PROTOCOL_CONSTANTS_CLASS = self::$PROTOCOL_CONSTANTS_CLASS;
@@ -453,6 +460,9 @@ 
             || in_array($method_sig, $PROTOCOL_CONSTANTS_CLASS::$CLOSE_METHODS);
     }
 
+    /**
+     * @param string $method_sig
+     */
     protected function maybe_wait_for_content($method_sig)
     {
         $PROTOCOL_CONSTANTS_CLASS = self::$PROTOCOL_CONSTANTS_CLASS;

PhpAmqpLib/Channel/AMQPChannel.php

Doc Comments +10 added lines, -6 removed lines

@@ -226,7 +226,7 @@ 
     }
 
     /**
-     * @param $active
+     * @param boolean $active
      */
     protected function x_flow_ok($active)
     {
@@ -634,7 +634,7 @@ 
      * Confirms a queue definition
      *
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     protected function queue_declare_ok($args)
     {
@@ -783,7 +783,7 @@ 
      *
      * @param string $delivery_tag
      * @param bool $multiple
-     * @param $handler
+     * @param callable $handler
      */
     protected function internal_ack_handler($delivery_tag, $multiple, $handler)
     {
@@ -801,14 +801,18 @@ 
     }
 
     /**
-     * @param array $array
-     * @param $value
+     * @param AMQPMessage[] $array
+     * @param string $value
      * @return mixed
      */
     protected function get_keys_less_or_equal(array $array, $value)
     {
         $keys = array_reduce(
             array_keys($array),
+
+            /**
+             * @param string $key
+             */
             function ($keys, $key) use ($value) {
                 if (bccomp($key, $value, 0) <= 0) {
                     $keys[] = $key;
@@ -1418,7 +1422,7 @@ 
     /**
      * Helper method to get a particular method from $this->publishedMessages, removes it from the array and returns it.
      *
-     * @param $index
+     * @param string $index
      * @return AMQPMessage
      */
     protected function get_and_unset_message($index)

PhpAmqpLib/Connection/AbstractConnection.php

Doc Comments +5 added lines, -5 removed lines

@@ -435,7 +435,7 @@ 
     }
 
     /**
-     * @param $channel
+     * @param string $channel
      * @param $method_sig
      * @param string $args
      * @param null $pkt
@@ -454,7 +454,7 @@ 
      * @param $method_sig
      * @param string $args
      * @param AMQPWriter $pkt
-     * @return null|AMQPWriter
+     * @return AMQPWriter
      */
     protected function prepare_channel_method_frame($channel, $method_sig, $args = '', $pkt = null)
     {
@@ -769,9 +769,9 @@ 
 
     /**
      * @param $client_properties
-     * @param $mechanism
-     * @param $response
-     * @param $locale
+     * @param string $mechanism
+     * @param AMQPWriter $response
+     * @param string $locale
      */
     protected function x_start_ok($client_properties, $mechanism, $response, $locale)
     {

PhpAmqpLib/Helper/Protocol/Protocol080.php

Doc Comments +26 added lines, -18 removed lines

@@ -56,7 +56,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function connectionSecureOk($args)
     {
@@ -112,7 +112,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function connectionOpenOk($args)
     {
@@ -137,6 +137,7 @@ 
 
 
     /**
+     * @param integer $reply_code
      * @return array
      */
     public function connectionClose($reply_code, $reply_text = '', $class_id, $method_id)
@@ -201,7 +202,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return boolean[]
      */
     public static function channelFlowOk($args)
     {
@@ -227,6 +228,7 @@ 
 
 
     /**
+     * @param integer $reply_code
      * @return array
      */
     public function channelClose($reply_code, $reply_text = '', $class_id, $method_id)
@@ -280,6 +282,7 @@ 
 
 
     /**
+     * @param string $exchange
      * @return array
      */
     public function exchangeDeclare($ticket = 1, $exchange, $type = 'direct', $passive = false, $durable = false, $auto_delete = false, $internal = false, $nowait = false, $arguments = array())
@@ -308,6 +311,7 @@ 
 
 
     /**
+     * @param string $exchange
      * @return array
      */
     public function exchangeDelete($ticket = 1, $exchange, $if_unused = false, $nowait = false)
@@ -350,7 +354,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function queueDeclareOk($args)
     {
@@ -364,6 +368,7 @@ 
 
 
     /**
+     * @param string $exchange
      * @return array
      */
     public function queueBind($ticket = 1, $queue = '', $exchange, $routing_key = '', $nowait = false, $arguments = array())
@@ -408,7 +413,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function queuePurgeOk($args)
     {
@@ -435,7 +440,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function queueDeleteOk($args)
     {
@@ -447,6 +452,7 @@ 
 
 
     /**
+     * @param string $exchange
      * @return array
      */
     public function queueUnbind($ticket = 1, $queue = '', $exchange, $routing_key = '', $arguments = array())
@@ -517,7 +523,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function basicConsumeOk($args)
     {
@@ -529,6 +535,7 @@ 
 
 
     /**
+     * @param string $consumer_tag
      * @return array
      */
     public function basicCancel($consumer_tag, $nowait = false)
@@ -543,7 +550,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function basicCancelOk($args)
     {
@@ -633,7 +640,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function basicGetEmpty($args)
     {
@@ -658,6 +665,7 @@ 
 
 
     /**
+     * @param string $delivery_tag
      * @return array
      */
     public function basicReject($delivery_tag, $requeue = true)
@@ -749,7 +757,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function fileConsumeOk($args)
     {
@@ -775,7 +783,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function fileCancelOk($args)
     {
@@ -801,7 +809,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function fileOpenOk($args)
     {
@@ -941,7 +949,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function streamConsumeOk($args)
     {
@@ -967,7 +975,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function streamCancelOk($args)
     {
@@ -1169,7 +1177,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function testIntegerOk($args)
     {
@@ -1196,7 +1204,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function testStringOk($args)
     {
@@ -1223,7 +1231,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function testTableOk($args)
     {
@@ -1248,7 +1256,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function testContentOk($args)
     {

PhpAmqpLib/Helper/Protocol/Protocol091.php

Doc Comments +22 added lines, -10 removed lines

@@ -56,7 +56,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function connectionSecureOk($args)
     {
@@ -112,7 +112,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function connectionOpenOk($args)
     {
@@ -124,6 +124,7 @@ 
 
 
     /**
+     * @param integer $reply_code
      * @return array
      */
     public function connectionClose($reply_code, $reply_text = '', $class_id, $method_id)
@@ -188,7 +189,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function channelOpenOk($args)
     {
@@ -213,7 +214,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return boolean[]
      */
     public static function channelFlowOk($args)
     {
@@ -225,6 +226,7 @@ 
 
 
     /**
+     * @param integer $reply_code
      * @return array
      */
     public function channelClose($reply_code, $reply_text = '', $class_id, $method_id)
@@ -278,6 +280,7 @@ 
 
 
     /**
+     * @param string $exchange
      * @return array
      */
     public function exchangeDeclare($ticket = 0, $exchange, $type = 'direct', $passive = false, $durable = false, $auto_delete = false, $internal = false, $nowait = false, $arguments = array())
@@ -306,6 +309,7 @@ 
 
 
     /**
+     * @param string $exchange
      * @return array
      */
     public function exchangeDelete($ticket = 0, $exchange, $if_unused = false, $nowait = false)
@@ -332,6 +336,8 @@ 
 
 
     /**
+     * @param string $destination
+     * @param string $source
      * @return array
      */
     public function exchangeBind($ticket = 0, $destination, $source, $routing_key = '', $nowait = false, $arguments = array())
@@ -361,6 +367,8 @@ 
 
 
     /**
+     * @param string $destination
+     * @param string $source
      * @return array
      */
     public function exchangeUnbind($ticket = 0, $destination, $source, $routing_key = '', $nowait = false, $arguments = array())
@@ -406,7 +414,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function queueDeclareOk($args)
     {
@@ -420,6 +428,7 @@ 
 
 
     /**
+     * @param string $exchange
      * @return array
      */
     public function queueBind($ticket = 0, $queue = '', $exchange, $routing_key = '', $nowait = false, $arguments = array())
@@ -464,7 +473,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function queuePurgeOk($args)
     {
@@ -491,7 +500,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function queueDeleteOk($args)
     {
@@ -503,6 +512,7 @@ 
 
 
     /**
+     * @param string $exchange
      * @return array
      */
     public function queueUnbind($ticket = 0, $queue = '', $exchange, $routing_key = '', $arguments = array())
@@ -574,7 +584,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function basicConsumeOk($args)
     {
@@ -586,6 +596,7 @@ 
 
 
     /**
+     * @param string $consumer_tag
      * @return array
      */
     public function basicCancel($consumer_tag, $nowait = false)
@@ -600,7 +611,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function basicCancelOk($args)
     {
@@ -690,7 +701,7 @@ 
 
     /**
      * @param AMQPReader $args
-     * @return array
+     * @return string[]
      */
     public static function basicGetEmpty($args)
     {
@@ -715,6 +726,7 @@ 
 
 
     /**
+     * @param string $delivery_tag
      * @return array
      */
     public function basicReject($delivery_tag, $requeue = true)

PhpAmqpLib/Wire/AMQPReader.php

Doc Comments +1 added lines, -1 removed lines

@@ -521,7 +521,7 @@
     /**
      * Sets the timeout (second)
      *
-     * @param $timeout
+     * @param integer $timeout
      */
     public function setTimeout($timeout)
     {

PhpAmqpLib/Wire/AMQPWriter.php

Doc Comments +2 added lines, -2 removed lines

@@ -131,7 +131,7 @@ 
     /**
      * Write multiple bits as an octet
      *
-     * @param $bits
+     * @param boolean[] $bits
      * @return $this
      */
     public function write_bits($bits)
@@ -306,7 +306,7 @@ 
 
     /**
      * @param int $n
-     * @return array
+     * @return integer[]
      */
     private function splitIntoQuads($n)
     {

PhpAmqpLib/Wire/IO/StreamIO.php

Doc Comments +3 added lines, -3 removed lines

@@ -184,7 +184,7 @@ 
     /**
      * @param $len
      * @throws \PhpAmqpLib\Exception\AMQPIOException
-     * @return mixed|string
+     * @return string
      */
     public function read($len)
     {
@@ -239,7 +239,7 @@ 
     }
 
     /**
-     * @param $data
+     * @param string $data
      * @return mixed|void
      * @throws \PhpAmqpLib\Exception\AMQPRuntimeException
      * @throws \PhpAmqpLib\Exception\AMQPTimeoutException
@@ -374,7 +374,7 @@ 
     /**
      * @param $sec
      * @param $usec
-     * @return int|mixed
+     * @return integer
      */
     public function select($sec, $usec)
     {