Add isExpired() to Cookie.

This will make comparison logic simpler in consumers of this class.
cakephp · Apr 11, 2017 · 9310ee7 · 9310ee7
1 parent b6ad881
commit 9310ee7
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 17 deletions.
diff --git a/src/Http/Cookie/Cookie.php b/src/Http/Cookie/Cookie.php
@@ -174,23 +174,6 @@ protected function getFormattedExpires()
         return $this->expiresAt->format(static::EXPIRES_FORMAT);
     }
 
-    /**
-     * Get the timestamp from the expiration time
-     *
-     * Timestamps are strings as large timestamps can overflow MAX_INT
-     * in 32bit systems.
-     *
-     * @return string|null The expiry time as a string timestamp.
-     */
-    public function getExpiresTimestamp()
-    {
-        if (!$this->expiresAt) {
-            return null;
-        }
-
-        return $this->expiresAt->format('U');
-    }
-
     /**
      * Returns a header value as string
      *
@@ -477,6 +460,41 @@ public function getExpiry()
         return $this->expiresAt;
     }
 
+    /**
+     * Get the timestamp from the expiration time
+     *
+     * Timestamps are strings as large timestamps can overflow MAX_INT
+     * in 32bit systems.
+     *
+     * @return string|null The expiry time as a string timestamp.
+     */
+    public function getExpiresTimestamp()
+    {
+        if (!$this->expiresAt) {
+            return null;
+        }
+
+        return $this->expiresAt->format('U');
+    }
+
+    /**
+     * Check if a cookie is expired when compared to $time
+     *
+     * Cookies without an expiration date always return false.
+     *
+     * @param \DatetimeInterface $time The time to test against. Defaults to 'now' in UTC.
+     * @return bool
+     */
+    public function isExpired(DatetimeInterface $time = null)
+    {
+        $time = $time ?: new DateTimeImmutable('now', new DateTimezone('UTC'));
+        if (!$this->expiresAt) {
+            return false;
+        }
+
+        return $this->expiresAt < $time;
+    }
+
     /**
      * Create a new cookie that will virtually never expire.
      *

diff --git a/tests/TestCase/Http/Cookie/CookieTest.php b/tests/TestCase/Http/Cookie/CookieTest.php
@@ -375,6 +375,27 @@ public function testWithExpiryChangesTimezone()
         $this->assertSame($date->format('U'), $new->getExpiresTimestamp());
     }
 
+    /**
+     * Test the isExpired method
+     *
+     * @return void
+     */
+    public function testIsExpired()
+    {
+        $date = Chronos::now();
+        $cookie = new Cookie('cakephp', 'yay');
+        $this->assertFalse($cookie->isExpired($date));
+
+        $cookie = new Cookie('cakephp', 'yay', $date);
+        $this->assertFalse($cookie->isExpired($date), 'same time, not expired');
+
+        $date = $date->modify('+10 seconds');
+        $this->assertTrue($cookie->isExpired($date), 'future now');
+
+        $date = $date->modify('-1 minute');
+        $this->assertFalse($cookie->isExpired($date), 'expires later');
+    }
+
     /**
      * Test the withName method
      *