improve cookie class comments.

This commit is contained in:
Taylor Otwell 2011-06-16 20:29:21 -05:00
parent df235f3fb7
commit fb66bf532d
1 changed files with 9 additions and 11 deletions

View File

@ -47,6 +47,11 @@ class Cookie {
/** /**
* Create a new Cookie instance. * Create a new Cookie instance.
* *
* Note: Cookies can be sent using the Cookie::put method.
* However, the number of parameters that method requires
* is somewhat cumbersome. Instantiating a new Cookie class
* and setting the properties can be a little easier on the eyes.
*
* @param string $name * @param string $name
* @return void * @return void
*/ */
@ -76,7 +81,7 @@ public function send()
{ {
if (is_null($this->name)) if (is_null($this->name))
{ {
throw new \Exception("Error sending cookie. The cookie does not have a name."); throw new \Exception("Attempting to send cookie without a name.");
} }
return static::put($this->name, $this->value, $this->lifetime, $this->path, $this->domain, $this->secure); return static::put($this->name, $this->value, $this->lifetime, $this->path, $this->domain, $this->secure);
@ -90,15 +95,7 @@ public function send()
*/ */
public static function has($name) public static function has($name)
{ {
foreach (func_get_args() as $key) return ! is_null(static::get($key));
{
if (is_null(static::get($key)))
{
return false;
}
}
return true;
} }
/** /**
@ -129,7 +126,8 @@ public static function forever($name, $value, $path = '/', $domain = null, $secu
} }
/** /**
* Set the value of a cookie. * Set the value of a cookie. If a negative number of minutes is
* specified, the cookie will be deleted.
* *
* @param string $name * @param string $name
* @param string $value * @param string $value