CHttpCookie
| Package | system.web |
|---|---|
| Inheritance | class CHttpCookie » CComponent |
| Since | 1.0 |
| Version | $Id: CHttpCookie.php 2799 2011-01-01 19:31:13Z qiang.xue $ |
| Source Code | framework/web/CHttpCookie.php |
A CHttpCookie instance stores a single cookie, including the cookie name, value, domain, path, expire, and secure.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| domain | string | domain of the cookie | CHttpCookie |
| expire | integer | the timestamp at which the cookie expires. | CHttpCookie |
| httpOnly | boolean | whether the cookie should be accessible only through the HTTP protocol. | CHttpCookie |
| name | string | name of the cookie | CHttpCookie |
| path | string | the path on the server in which the cookie will be available on. | CHttpCookie |
| secure | boolean | whether cookie should be sent via secure connection | CHttpCookie |
| value | string | value of the cookie | CHttpCookie |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CHttpCookie |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| raiseEvent() | Raises an event. | CComponent |
Property Details
domain
property
public string $domain;
domain of the cookie
expire
property
public integer $expire;
the timestamp at which the cookie expires. This is the server timestamp. Defaults to 0, meaning "until the browser is closed".
httpOnly
property
public boolean $httpOnly;
whether the cookie should be accessible only through the HTTP protocol. By setting this property to true, the cookie will not be accessible by scripting languages, such as JavaScript, which can effectly help to reduce identity theft through XSS attacks. Note, this property is only effective for PHP 5.2.0 or above.
name
property
public string $name;
name of the cookie
path
property
public string $path;
the path on the server in which the cookie will be available on. The default is '/'.
secure
property
public boolean $secure;
whether cookie should be sent via secure connection
value
property
public string $value;
value of the cookie
Method Details
__construct()
method
|
public void __construct(string $name, string $value)
| ||
| $name | string | name of this cookie |
| $value | string | value of this cookie |
Source Code: framework/web/CHttpCookie.php#58 (show)
public function __construct($name,$value)
{
$this->name=$name;
$this->value=$value;
}
Constructor.