Docs For Class Zend_Http_Cookie

## Class Zend_Http_Cookie

Description

Zend_Http_Cookie is a class describing an HTTP cookie and all it's parameters.

Zend_Http_Cookie is a class describing an HTTP cookie and all it's parameters. The class also enables validating whether the cookie should be sent to the server in a specified scenario according to the request URI, the expiry time and whether session cookies should be used or not. Generally speaking cookies should be contained in a Cookiejar object, or instantiated manually and added to an HTTP request.

See http://wp.netscape.com/newsref/std/cookie_spec.html for some specs.

- todo: replace asString() with __toString()
- license: Zend Framework License version 1.0
- copyright: Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com/)

Located in /Zend/Http/Cookie.php (line 43)

Variable Summary
string $domain
int $expires
string $name
string $path
boolean $secure
string $value
Method Summary
static Zend_Http_Cookie factory (string $cookieStr, [Zend_Uri_Http|string $ref_uri = null])
Zend_Http_Cookie __construct (string $name, string $value, string $domain, [int $expires = null], [string $path = null], [bool $secure = false])
string asString ()
string getDomain ()
int|null getExpiryTime ()
string getName ()
string getPath ()
string getValue ()
boolean isExpired ([int $now = null])
boolean isSecure ()
boolean isSessionCookie ()
boolean match (string|Zend_Uri_Http $uri, [boolean $matchSessionCookies = true], [int $now = null])
Variables
string $domain (line 71)

Cookie domain

- access: protected

int $expires (line 64)

Cookie expiry date

- access: protected

string $name (line 50)

Cookie name

- access: protected

string $path (line 78)

Cookie path

- access: protected

boolean $secure (line 85)

Whether the cookie is secure or not

- access: protected

string $value (line 57)

Cookie value

- access: protected

Methods
static method factory (line 257)

Generate a new Cookie object from a cookie string (for example the value of the Set-Cookie HTTP header)

- return: A new Zend_Http_Cookie object or false on failure.
- access: public

static Zend_Http_Cookie factory (string $cookieStr, [Zend_Uri_Http|string $ref_uri = null])

- string $cookieStr
- Zend_Uri_Http|string $ref_uri: Reference URI for default values (domain, path)

Constructor __construct (line 99)

Cookie object constructor

- access: public
- todo: Add validation of each one of the parameters (legal domain, etc.)

Zend_Http_Cookie __construct (string $name, string $value, string $domain, [int $expires = null], [string $path = null], [bool $secure = false])

- string $name
- string $value
- int $expires
- string $domain
- string $path
- bool $secure

asString (line 210)

Get the cookie as a string, suitable for sending as a "Cookie" header in an HTTP request

- access: public

string asString ()
getDomain (line 141)

Get cookie domain

- access: public

string getDomain ()
getExpiryTime (line 161)

Get the expiry time of the cookie, or null if no expiry time is set

- access: public

int|null getExpiryTime ()
getName (line 121)

Get Cookie name

- access: public

string getName ()
getPath (line 151)

Get the cookie path

- access: public

string getPath ()
getValue (line 131)

Get cookie value

- access: public

string getValue ()
isExpired (line 184)

Check whether the cookie has expired

Always returns true if the cookie is a session cookie (has no expiry time)

- access: public

boolean isExpired ([int $now = null])

- int $now: Timestamp to consider as "now"

isSecure (line 171)

Check whether the cookie should only be sent over secure connections

- access: public

boolean isSecure ()
isSessionCookie (line 199)

Check whether the cookie is a session cookie (has no expiry time set)

- access: public

boolean isSessionCookie ()
match (line 223)

Checks whether the cookie should be sent on not in a specific scenario

- access: public

boolean match (string|Zend_Uri_Http $uri, [boolean $matchSessionCookies = true], [int $now = null])

- string|Zend_Uri_Http $uri: URI to check against (secure, domain, path)
- boolean $matchSessionCookies: Whether to send session cookies
- int $now: Override the current time when checking for expiry time

Documentation generated on Sun, 29 Oct 2006 21:27:52 -0600 by phpDocumentor 1.3.0RC6