Class THttpCookie

Description

THttpCookie class.

A THttpCookie instance stores a single cookie, including the cookie name, value, domain, path, expire, and secure.

  • author: Qiang Xue <qiang.xue@gmail.com>
  • version: $Id: THttpRequest.php 3099 2012-01-29 11:48:14Z ctrlaltca@gmail.com $
  • since: 3.0

Located in /Web/THttpRequest.php (line 988)

TComponent
   |
   --THttpCookie
Method Summary
THttpCookie __construct (string $name, string $value)
string getDomain ()
integer getExpire ()
boolean getHttpOnly ()
string getName ()
string getPath ()
boolean getSecure ()
string getValue ()
void setDomain (string $value)
void setExpire (integer $value)
void setHttpOnly (boolean $value)
void setName (string $value)
void setPath (string $value)
void setSecure (boolean $value)
void setValue (string $value)
Methods
Constructor __construct (line 1024)

Constructor.

  • access: public
THttpCookie __construct (string $name, string $value)
  • string $name: name of this cookie
  • string $value: value of this cookie
getDomain (line 1033)
  • return: the domain to associate the cookie with
  • access: public
string getDomain ()
getExpire (line 1049)
  • return: the time the cookie expires. This is a Unix timestamp so is in number of seconds since the epoch.
  • access: public
integer getExpire ()
getHttpOnly (line 1065)
  • return: if true the cookie value will be unavailable to JavaScript
  • access: public
boolean getHttpOnly ()
getName (line 1081)
  • return: the name of the cookie
  • access: public
string getName ()
getPath (line 1113)
  • return: the path on the server in which the cookie will be available on, default is '/'
  • access: public
string getPath ()
getSecure (line 1129)
  • return: whether the cookie should only be transmitted over a secure HTTPS connection
  • access: public
boolean getSecure ()
getValue (line 1097)
  • return: the value of the cookie
  • access: public
string getValue ()
setDomain (line 1041)
  • access: public
void setDomain (string $value)
  • string $value: the domain to associate the cookie with
setExpire (line 1057)
  • access: public
void setExpire (integer $value)
  • integer $value: the time the cookie expires. This is a Unix timestamp so is in number of seconds since the epoch.
setHttpOnly (line 1073)
  • access: public
void setHttpOnly (boolean $value)
  • boolean $value: if true the cookie value will be unavailable to JavaScript
setName (line 1089)
  • access: public
void setName (string $value)
  • string $value: the name of the cookie
setPath (line 1121)
  • access: public
void setPath (string $value)
  • string $value: the path on the server in which the cookie will be available on
setSecure (line 1137)
  • access: public
void setSecure (boolean $value)
  • boolean $value: ether the cookie should only be transmitted over a secure HTTPS connection
setValue (line 1105)
  • access: public
void setValue (string $value)
  • string $value: the value of the cookie

Inherited Methods

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__call()
TComponent::__get()
TComponent::__set()
TComponent::__sleep()
TComponent::__wakeup()

Documentation generated on Mon, 25 Jun 2012 14:38:22 +0200 by phpDocumentor 1.4.3