Pull CookieEncoder out of CookieBuilder, move into Cookie namespace.

Author: donatj

src/CookieBuilder.php renamed to src/Cookie/CookieBuilder.php

@@ -1,16 +1,13 @@
 <?php
 
-namespace Corpus\HttpMessageUtils;
+namespace Corpus\HttpMessageUtils\Cookie;
 
 use Psr\Http\Message\ResponseInterface;
 
 /**
  * Utility to build an HTTP Cookie header
- *
- * Inspired by and partly based on `hansott/psr7-cookies`
- * MIT License Copyright (c) 2017 Hans Ott [email protected]
  */
-class CookieBuilder {
+class CookieBuilder implements CookieInterface {
 
 	private string $name;
 	private string $value;
@@ -21,6 +18,8 @@ class CookieBuilder {
 	private bool $httpOnly;
 	private string $sameSite;
 
+	private CookieEncoder $encoder;
+
 	/**
 	 * @param string $name       The name of the cookie
 	 * @param int    $expiration The number of seconds for which this cookie will be valid. `time() + $expiration`
@@ -50,6 +49,8 @@ public function __construct(
 		$this->secure     = $secure;
 		$this->httpOnly   = $httpOnly;
 		$this->sameSite   = $sameSite;
+
+		$this->encoder = new CookieEncoder;
 	}
 
 	/**
@@ -76,15 +77,15 @@ public function apply( callable $callee = "\\setcookie" ) : bool {
 	 * `Set-Cookie` header representing this Cookie.
 	 */
 	public function responseWithHeaderAdded( ResponseInterface $response ) : ResponseInterface {
-		return $response->withAddedHeader('Set-Cookie', $this->toHeaderValue());
+		return $response->withAddedHeader('Set-Cookie', ($this->encoder)($this));
 	}
 
 	/**
 	 * Given a \Psr\Http\Message\ResponseInterface returns a new instance of ResponseInterface replacing any
 	 * `Set-Cookie` headers with one representing this Cookie.
 	 */
 	public function responseWithHeader( ResponseInterface $response ) : ResponseInterface {
-		return $response->withHeader('Set-Cookie', $this->toHeaderValue());
+		return $response->withHeader('Set-Cookie', ($this->encoder)($this));
 	}
 
 	/**
@@ -180,96 +181,36 @@ public function withSameSite( string $sameSite ) : self {
 		return $that;
 	}
 
-	/**
-	 * Get the cookie name.
-	 */
 	public function getName() : string {
 		return $this->name;
 	}
 
-	/**
-	 * Get the cookie value.
-	 */
 	public function getValue() : string {
 		return $this->value;
 	}
 
-	/**
-	 * Get the cookie expiration.
-	 */
 	public function getExpiration() : int {
 		return $this->expiration;
 	}
 
-	/**
-	 * Get the cookie path.
-	 */
 	public function getPath() : string {
 		return $this->path;
 	}
 
-	/**
-	 * Get the cookie domain.
-	 */
 	public function getDomain() : string {
 		return $this->domain;
 	}
 
-	/**
-	 * Get the cookie secure flag.
-	 */
 	public function isSecure() : bool {
 		return $this->secure;
 	}
 
-	/**
-	 * Get the cookie httpOnly flag.
-	 */
 	public function isHttpOnly() : bool {
 		return $this->httpOnly;
 	}
 
-	/**
-	 * Get the cookie SameSite value.
-	 */
 	public function getSameSite() : string {
 		return $this->sameSite;
 	}
 
-	/**
-	 * Get the cookie as a header value.
-	 */
-	public function toHeaderValue() : string {
-		$headerValue = sprintf('%s=%s', $this->name, urlencode($this->value));
-
-		if( $this->expiration !== 0 ) {
-			$headerValue .= sprintf(
-				'; expires=%s',
-				gmdate(DATE_RFC1123, time() + $this->expiration)
-			);
-		}
-
-		if( $this->path ) {
-			$headerValue .= sprintf('; path=%s', $this->path);
-		}
-
-		if( $this->domain ) {
-			$headerValue .= sprintf('; domain=%s', $this->domain);
-		}
-
-		if( $this->secure ) {
-			$headerValue .= '; secure';
-		}
-
-		if( $this->httpOnly ) {
-			$headerValue .= '; httponly';
-		}
-
-		if( $this->sameSite ) {
-			$headerValue .= sprintf('; samesite=%s', $this->sameSite);
-		}
-
-		return $headerValue;
-	}
-
 }

src/Cookie/CookieEncoder.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Corpus\HttpMessageUtils\Cookie;
+
+/**
+ * Utility to encode a Cookie into a `Set-Cookie` header
+ *
+ * Based on `hansott/psr7-cookies`
+ * MIT License Copyright (c) 2017 Hans Ott [email protected]
+ * @see https://github.com/hansott/psr7-cookies/blob/ec7bc4b3393677730b1e607c987328655d27dfbf/src/SetCookie.php#L160-L192
+ */
+class CookieEncoder implements CookieEncoderInterface {
+
+	public function __invoke( CookieInterface $cookie ) : string {
+		$headerValue = sprintf('%s=%s', $cookie->getName(), urlencode($cookie->getValue()));
+
+		if( $cookie->getExpiration() !== 0 ) {
+			$headerValue .= sprintf(
+				'; expires=%s',
+				gmdate(DATE_RFC1123, time() + $cookie->getExpiration())
+			);
+		}
+
+		if( $cookie->getPath() ) {
+			$headerValue .= sprintf('; path=%s', $cookie->getPath());
+		}
+
+		if( $cookie->getDomain() ) {
+			$headerValue .= sprintf('; domain=%s', $cookie->getDomain());
+		}
+
+		if( $cookie->isSecure() ) {
+			$headerValue .= '; secure';
+		}
+
+		if( $cookie->isHttpOnly() ) {
+			$headerValue .= '; httponly';
+		}
+
+		if( $cookie->getSameSite() ) {
+			$headerValue .= sprintf('; samesite=%s', $cookie->getSameSite());
+		}
+
+		return $headerValue;
+	}
+
+}

src/Cookie/CookieEncoderInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Corpus\HttpMessageUtils\Cookie;
+
+interface CookieEncoderInterface {
+
+	/**
+	 * Encode the given Cookie to a header string
+	 */
+	public function __invoke( CookieInterface $cookie ) : string;
+
+}

src/Cookie/CookieInterface.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Corpus\HttpMessageUtils\Cookie;
+
+interface CookieInterface {
+
+	/**
+	 * Get the cookie name.
+	 */
+	public function getName() : string;
+
+	/**
+	 * Get the cookie value.
+	 */
+	public function getValue() : string;
+
+	/**
+	 * Get the cookie expiration.
+	 */
+	public function getExpiration() : int;
+
+	/**
+	 * Get the cookie path.
+	 */
+	public function getPath() : string;
+
+	/**
+	 * Get the cookie domain.
+	 */
+	public function getDomain() : string;
+
+	/**
+	 * Get the cookie SameSite value.
+	 */
+	public function getSameSite() : string;
+
+	/**
+	 * Get the cookie httpOnly flag.
+	 */
+	public function isHttpOnly() : bool;
+
+	/**
+	 * Get the cookie secure flag.
+	 */
+	public function isSecure() : bool;
+
+}