PHPXRef 0.7.1 : moodle-2.8 : Detail view of Cookie.php

Zend Framework LICENSE

Copyright:	Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License:	http://framework.zend.com/license/new-bsd New BSD License
Version:	$Id$
File Size:	424 lines (12 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Zend_Http_Cookie:: (14 methods):
  __construct()
  getName()
  getValue()
  getDomain()
  getPath()
  getExpiryTime()
  isSecure()
  isExpired()
  isSessionCookie()
  match()
  __toString()
  fromString()
  matchCookieDomain()
  matchCookiePath()

Class: Zend_Http_Cookie - X-Ref

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.

__construct($name, $value, $domain, $expires = null, $path = null, $secure = false) X-Ref

Cookie object constructor

param: string $name
param: string $value
param: string $domain
param: int $expires
param: string $path
param: bool $secure

getName() X-Ref

Get Cookie name

return: string

getValue() X-Ref

Get cookie value

return: string

getDomain() X-Ref

Get cookie domain

return: string

getPath() X-Ref

Get the cookie path

return: string

getExpiryTime() X-Ref

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

return: int|null

isSecure() X-Ref

Check whether the cookie should only be sent over secure connections

return: boolean

isExpired($now = null) X-Ref

Check whether the cookie has expired

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

param: int $now Timestamp to consider as "now"
return: boolean

isSessionCookie() X-Ref

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

return: boolean

match($uri, $matchSessionCookies = true, $now = null) X-Ref

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

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

__toString() X-Ref

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

return: string

fromString($cookieStr, $refUri = null, $encodeValue = true) X-Ref

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

param: string $cookieStr
param: Zend_Uri_Http|string $refUri Reference URI for default values (domain, path)
param: boolean $encodeValue Weither or not the cookie's value should be
return: Zend_Http_Cookie A new Zend_Http_Cookie object or false on failure.

matchCookieDomain($cookieDomain, $host) X-Ref

Check if a cookie's domain matches a host name.

Used by Zend_Http_Cookie and Zend_Http_CookieJar for cookie matching

param: string $cookieDomain
param: string $host
return: boolean

matchCookiePath($cookiePath, $path) X-Ref

Check if a cookie's path matches a URL path

Used by Zend_Http_Cookie and Zend_Http_CookieJar for cookie matching

param: string $cookiePath
param: string $path
return: boolean

PHP Cross Reference of moodle-2.8

/lib/zend/Zend/Http/ -> Cookie.php (summary)

Defines 1 class