Merge branch 'improvement/185'

Close #185

Author: michalbundyra

src/Header/SetCookie.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @see       https://github.com/zendframework/zend-http for the canonical source repository
- * @copyright Copyright (c) 2005-2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2019 Zend Technologies USA Inc. (https://www.zend.com)
  * @license   https://github.com/zendframework/zend-http/blob/master/LICENSE.md New BSD License
  */
 
@@ -190,15 +190,15 @@ public static function fromString($headerLine, $bypassHeaderFieldName = false)
      *
      * @todo Add validation of each one of the parameters (legal domain, etc.)
      *
-     * @param   string              $name
-     * @param   string              $value
-     * @param   int|string|DateTime $expires
-     * @param   string              $path
-     * @param   string              $domain
-     * @param   bool                $secure
-     * @param   bool                $httponly
-     * @param   string              $maxAge
-     * @param   int                 $version
+     * @param string|null              $name
+     * @param string|null              $value
+     * @param int|string|DateTime|null $expires
+     * @param string|null              $path
+     * @param string|null              $domain
+     * @param bool                     $secure
+     * @param bool                     $httponly
+     * @param int|null                 $maxAge
+     * @param int|null                 $version
      */
     public function __construct(
         $name = null,
@@ -302,9 +302,9 @@ public function getFieldValue()
     }
 
     /**
-     * @param string $name
+     * @param  string|null $name
+     * @return $this
      * @throws Exception\InvalidArgumentException
-     * @return SetCookie
      */
     public function setName($name)
     {
@@ -314,16 +314,16 @@ public function setName($name)
     }
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getName()
     {
         return $this->name;
     }
 
     /**
-     * @param string $value
-     * @return SetCookie
+     * @param  string|null $value
+     * @return $this
      */
     public function setValue($value)
     {
@@ -332,19 +332,17 @@ public function setValue($value)
     }
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getValue()
     {
         return $this->value;
     }
 
     /**
-     * Set version
-     *
-     * @param int $version
+     * @param  int|null $version
+     * @return $this
      * @throws Exception\InvalidArgumentException
-     * @return SetCookie
      */
     public function setVersion($version)
     {
@@ -356,20 +354,16 @@ public function setVersion($version)
     }
 
     /**
-     * Get version
-     *
-     * @return int
+     * @return int|null
      */
     public function getVersion()
     {
         return $this->version;
     }
 
     /**
-     * Set Max-Age
-     *
-     * @param int $maxAge
-     * @return SetCookie
+     * @param  int $maxAge
+     * @return $this
      */
     public function setMaxAge($maxAge)
     {
@@ -382,22 +376,16 @@ public function setMaxAge($maxAge)
     }
 
     /**
-     * Get Max-Age
-     *
-     * @return int
+     * @return int|null
      */
     public function getMaxAge()
     {
         return $this->maxAge;
     }
 
     /**
-     * Set Expires
-     *
-     * @param int|string|DateTime $expires
-     *
-     * @return self
-     *
+     * @param  int|string|DateTime|null $expires
+     * @return $this
      * @throws Exception\InvalidArgumentException
      */
     public function setExpires($expires)
@@ -435,13 +423,13 @@ public function setExpires($expires)
     }
 
     /**
-     * @param bool $inSeconds
-     * @return int|string
+     * @param  bool $inSeconds
+     * @return int|string|null
      */
     public function getExpires($inSeconds = false)
     {
         if ($this->expires === null) {
-            return;
+            return null;
         }
         if ($inSeconds) {
             return $this->expires;
@@ -450,8 +438,8 @@ public function getExpires($inSeconds = false)
     }
 
     /**
-     * @param string $domain
-     * @return SetCookie
+     * @param  string|null $domain
+     * @return $this
      */
     public function setDomain($domain)
     {
@@ -461,16 +449,16 @@ public function setDomain($domain)
     }
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getDomain()
     {
         return $this->domain;
     }
 
     /**
-     * @param string $path
-     * @return SetCookie
+     * @param  string|null $path
+     * @return $this
      */
     public function setPath($path)
     {
@@ -480,16 +468,16 @@ public function setPath($path)
     }
 
     /**
-     * @return string
+     * @return string|null
      */
     public function getPath()
     {
         return $this->path;
     }
 
     /**
-     * @param  bool $secure
-     * @return SetCookie
+     * @param  bool|null $secure
+     * @return $this
      */
     public function setSecure($secure)
     {
@@ -504,7 +492,7 @@ public function setSecure($secure)
      * Set whether the value for this cookie should be quoted
      *
      * @param  bool $quotedValue
-     * @return SetCookie
+     * @return $this
      */
     public function setQuoteFieldValue($quotedValue)
     {
@@ -513,16 +501,16 @@ public function setQuoteFieldValue($quotedValue)
     }
 
     /**
-     * @return bool
+     * @return bool|null
      */
     public function isSecure()
     {
         return $this->secure;
     }
 
     /**
-     * @param  bool $httponly
-     * @return SetCookie
+     * @param  bool|null $httponly
+     * @return $this
      */
     public function setHttponly($httponly)
     {
@@ -534,7 +522,7 @@ public function setHttponly($httponly)
     }
 
     /**
-     * @return bool
+     * @return bool|null
      */
     public function isHttponly()
     {
@@ -546,7 +534,7 @@ public function isHttponly()
      *
      * Always returns false if the cookie is a session cookie (has no expiry time)
      *
-     * @param int $now Timestamp to consider as "now"
+     * @param int|null $now Timestamp to consider as "now"
      * @return bool
      */
     public function isExpired($now = null)
@@ -582,6 +570,12 @@ public function hasQuoteFieldValue()
         return $this->quoteFieldValue;
     }
 
+    /**
+     * @param  string $requestDomain
+     * @param  string $path
+     * @param  bool   $isSecure
+     * @return bool
+     */
     public function isValidForRequest($requestDomain, $path, $isSecure = false)
     {
         if ($this->getDomain() && (strrpos($requestDomain, $this->getDomain()) === false)) {
@@ -604,7 +598,7 @@ public function isValidForRequest($requestDomain, $path, $isSecure = false)
      *
      * @param string|\Zend\Uri\Uri $uri URI to check against (secure, domain, path)
      * @param bool $matchSessionCookies Whether to send session cookies
-     * @param int $now Override the current time when checking for expiry time
+     * @param int|null $now Override the current time when checking for expiry time
      * @return bool
      * @throws Exception\InvalidArgumentException If URI does not have HTTP or HTTPS scheme.
      */
@@ -651,7 +645,6 @@ public function match($uri, $matchSessionCookies = true, $now = null)
      *
      * @param  string $cookieDomain
      * @param  string $host
-     *
      * @return bool
      */
     public static function matchCookieDomain($cookieDomain, $host)
@@ -677,11 +670,19 @@ public static function matchCookiePath($cookiePath, $path)
         return (strpos($path, $cookiePath) === 0);
     }
 
+    /**
+     * @return string
+     */
     public function toString()
     {
         return 'Set-Cookie: ' . $this->getFieldValue();
     }
 
+    /**
+     * @param  array $headers
+     * @return string
+     * @throws Exception\RuntimeException
+     */
     public function toStringMultipleHeaders(array $headers)
     {
         $headerLine = $this->toString();