CHttpCookie
| 包 | system.web |
|---|---|
| 继承 | class CHttpCookie » CComponent |
| 可用自 | 1.0 |
| 源码 | framework/web/CHttpCookie.php |
A CHttpCookie instance stores a single cookie, including the cookie name, value, domain, path, expire, and secure.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| 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 |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __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 |
| __toString() | Magic method to use the cookie object as a string without having to call value property first. | CHttpCookie |
| __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 |
| configure() | This method can be used to configure the CookieObject with an array | CHttpCookie |
| 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 |
属性详情
domain
属性
public string $domain;
domain of the cookie
expire
属性
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
属性
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
属性
public string $name;
name of the cookie
path
属性
public string $path;
the path on the server in which the cookie will be available on. The default is '/'.
secure
属性
public boolean $secure;
whether cookie should be sent via secure connection
value
属性
public string $value;
value of the cookie
方法详情
__construct()
方法
|
public void __construct(string $name, string $value, array $options=array (
))
| ||
| $name | string | name of this cookie |
| $value | string | value of this cookie |
| $options | array | the configuration array consisting of name-value pairs that are used to configure this cookie |
源码： framework/web/CHttpCookie.php#59 (显示)
public function __construct($name,$value,$options=array())
{
$this->name=$name;
$this->value=$value;
$this->configure($options);
}
Constructor.
__toString()
方法
（自版本 v1.1.11 可用）
|
public string __toString()
| ||
| {return} | string | The value of the cookie. If the value property is null an empty string will be returned. |
源码： framework/web/CHttpCookie.php#90 (显示)
public function __toString()
{
return (string)$this->value;
}
Magic method to use the cookie object as a string without having to call value property first.
$value = (string)$cookies['name'];
Note, that you still have to check if the cookie exists.
configure()
方法
（自版本 v1.1.11 可用）
|
public void configure(array $options=array (
))
| ||
| $options | array | the configuration array consisting of name-value pairs that are used to configure this cookie |
源码： framework/web/CHttpCookie.php#72 (显示)
public function configure($options=array())
{
foreach($options as $name=>$value)
{
if($name==='name'||$name==='value')
continue;
$this->$name=$value;
}
}
This method can be used to configure the CookieObject with an array Note: you cannot use this method to set the name and/or the value of the cookie