Commit 92939a8a authored by Taylor Otwell's avatar Taylor Otwell

Added ability to create cookies using properties.

parent d380992a
...@@ -2,48 +2,128 @@ ...@@ -2,48 +2,128 @@
class Cookie { class Cookie {
/**
* The cookie name.
*
* @var string
*/
public $name;
/**
* The cookie value.
*
* @var mixed
*/
public $value;
/**
* The number of minutes the cookie should live.
*
* @var int
*/
public $lifetime = 0;
/**
* The path for which the cookie is available.
*
* @var string
*/
public $path = '/';
/**
* The domain for which the cookie is available.
*
* @var string
*/
public $domain = null;
/**
* Indicates if the cookie should only be sent over HTTPS.
*
* @var bool
*/
public $secure = false;
/**
* Create a new Cookie instance.
*
* @param string $name
* @return void
*/
public function __construct($name, $value = null)
{
$this->name = $name;
$this->value = $value;
}
/**
* Create a new Cookie instance.
*
* @param string $name
* @return Cookie
*/
public static function make($name, $value = null)
{
return new static($name, $value);
}
/**
* Send the current cookie instance to the user's machine.
*
* @return bool
*/
public function send()
{
if (is_null($this->name))
{
throw new \Exception("Error sending cookie. The cookie does not have a name.");
}
return static::put($this->name, $this->value, $this->lifetime, $this->path, $this->domain, $this->secure);
}
/** /**
* Determine if a cookie exists. * Determine if a cookie exists.
* *
* @param string $key * @param string $name
* @return bool * @return bool
*/ */
public static function has($key) public static function has($name)
{ {
return ( ! is_null(static::get($key))); return ( ! is_null(static::get($name)));
} }
/** /**
* Get the value of a cookie. * Get the value of a cookie.
* *
* @param string $key * @param string $name
* @param mixed $default * @param mixed $default
* @return string * @return string
*/ */
public static function get($key, $default = null) public static function get($name, $default = null)
{ {
return (array_key_exists($key, $_COOKIE)) ? $_COOKIE[$key] : $default; return (array_key_exists($name, $_COOKIE)) ? $_COOKIE[$name] : $default;
} }
/** /**
* Set a "permanent" cookie. The cookie will last 5 years. * Set a "permanent" cookie. The cookie will last 5 years.
* *
* @param string $key * @param string $name
* @param string $value * @param string $value
* @param string $path * @param string $path
* @param string $domain * @param string $domain
* @param bool $secure * @param bool $secure
* @return bool * @return bool
*/ */
public static function forever($key, $value, $path = '/', $domain = null, $secure = false) public static function forever($name, $value, $path = '/', $domain = null, $secure = false)
{ {
return static::put($key, $value, 2628000, $path, $domain, $secure); return static::put($name, $value, 2628000, $path, $domain, $secure);
} }
/** /**
* Set the value of a cookie. * Set the value of a cookie.
* *
* @param string $key * @param string $name
* @param string $value * @param string $value
* @param int $minutes * @param int $minutes
* @param string $path * @param string $path
...@@ -51,23 +131,23 @@ class Cookie { ...@@ -51,23 +131,23 @@ class Cookie {
* @param bool $secure * @param bool $secure
* @return bool * @return bool
*/ */
public static function put($key, $value, $minutes = 0, $path = '/', $domain = null, $secure = false) public static function put($name, $value, $minutes = 0, $path = '/', $domain = null, $secure = false)
{ {
if ($minutes < 0) if ($minutes < 0)
{ {
unset($_COOKIE[$key]); unset($_COOKIE[$name]);
} }
return setcookie($key, $value, ($minutes != 0) ? time() + ($minutes * 60) : 0, $path, $domain, $secure); return setcookie($name, $value, ($minutes != 0) ? time() + ($minutes * 60) : 0, $path, $domain, $secure);
} }
/** /**
* Delete a cookie. * Delete a cookie.
* *
* @param string $key * @param string $name
* @return bool * @return bool
*/ */
public static function forget($key) public static function forget($name)
{ {
return static::put($key, null, -60); return static::put($key, null, -60);
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment