SAM-IT / php-proxy-protocol

src/Header.php

Doc Comments +20 added lines, -1 removed lines

@@ -70,7 +70,7 @@ 
         }
     }
     /**
-     * @return uint16_t
+     * @return string|null
      */
     protected function getAddressLength()
     {
@@ -80,6 +80,10 @@ 
 
     }
 
+    /**
+     * @param string $address
+     * @param string $protocol
+     */
     protected function encodeAddress($address, $protocol) {
         if ($this->version == 1) {
             return $address;
@@ -102,6 +106,11 @@ 
         return $result;
     }
 
+    /**
+     * @param integer $version
+     * @param string $address
+     * @param string $protocol
+     */
     protected static function decodeAddress($version, $address, $protocol)
     {
         if ($version == 1) {
@@ -134,6 +143,10 @@ 
         return $this->encodeAddress($this->sourceAddress, $this->protocol) . ($this->version == 1 ? " " : "") .$this->encodeAddress($this->targetAddress, $this->protocol);
     }
 
+    /**
+     * @param integer $port
+     * @param string $protocol
+     */
     protected function encodePort($port, $protocol) {
         if ($this->version == 1) {
             return $port;
@@ -241,6 +254,9 @@ 
         }
     }
 
+    /**
+     * @param string $data
+     */
     protected static function parseVersion1($data)
     {
         $parts = explode("\x20", $data);
@@ -256,6 +272,9 @@ 
         }
     }
 
+    /**
+     * @param string $data
+     */
     protected static function parseVersion2($data)
     {
         $version = ord(substr($data, 12, 1)) >> 4;

Spacing +6 added lines, -6 removed lines

@@ -131,7 +131,7 @@ 
      */
     protected function getAddresses()
     {
-        return $this->encodeAddress($this->sourceAddress, $this->protocol) . ($this->version == 1 ? " " : "") .$this->encodeAddress($this->targetAddress, $this->protocol);
+        return $this->encodeAddress($this->sourceAddress, $this->protocol) . ($this->version == 1 ? " " : "") . $this->encodeAddress($this->targetAddress, $this->protocol);
     }
 
     protected function encodePort($port, $protocol) {
@@ -220,7 +220,7 @@ 
      */
     public static function parseHeader(&$data)
     {
-        foreach(self::$signatures as $version => $signature) {
+        foreach (self::$signatures as $version => $signature) {
             // Match.
             if (strncmp($data, $signature, strlen($signature)) === 0) {
                 if ($version === 1) {
@@ -263,10 +263,10 @@ 
         $protocol = substr($data, 13, 1);
 
         $pos = 16;
-        $sourceAddress = self::decodeAddress($version, substr($data, $pos, self::$lengths[$protocol] / 2  - 2), $protocol);
-        $pos += self::$lengths[$protocol] / 2  - 2;
-        $targetAddress = self::decodeAddress($version, substr($data, $pos, self::$lengths[$protocol] / 2  - 2), $protocol);
-        $pos += self::$lengths[$protocol] / 2  - 2;
+        $sourceAddress = self::decodeAddress($version, substr($data, $pos, self::$lengths[$protocol] / 2 - 2), $protocol);
+        $pos += self::$lengths[$protocol] / 2 - 2;
+        $targetAddress = self::decodeAddress($version, substr($data, $pos, self::$lengths[$protocol] / 2 - 2), $protocol);
+        $pos += self::$lengths[$protocol] / 2 - 2;
         $sourcePort = unpack('n', substr($data, $pos, 2))[1];
         $targetPort = unpack('n', substr($data, $pos + 2, 2))[1];
 

src/PortConnection.php

Doc Comments +4 added lines, -1 removed lines

@@ -49,7 +49,7 @@ 
     }
 
     /**
-     * @param $address
+     * @param string $address
      * @return string
      * @todo Make parent function protected.
      */
@@ -58,6 +58,9 @@ 
         return trim(substr($address, 0, strrpos($address, ':')), '[]');
     }
 
+    /**
+     * @param string $address
+     */
     protected function parsePort($address)
     {
         return end($parts = explode(':', $address));