Class CHttpCookie

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

CComponent

CHttpCookie

Package: system\web
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/web/CHttpCookie.php

Methods summary
`public`	# `__construct( string $name, string $value, array $options = array() )` Constructor. Constructor. Parameters `$name` `string` $name name of this cookie `$value` `string` $value value of this cookie `$options` `array` $options the configuration array consisting of name-value pairs that are used to configure this cookie
`public`	# `configure( array $options = array() )` 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 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 Parameters `$options` `array` $options the configuration array consisting of name-value pairs that are used to configure this cookie Since 1.1.11
`public string`	# `__toString( )` 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. 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. Returns `string` The value of the cookie. If the value property is null an empty string will be returned. Since 1.1.11

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public string`	`$name`		# name of the cookie name of the cookie
`public string`	`$value`	`''`	# value of the cookie value of the cookie
`public string`	`$domain`	`''`	# domain of the cookie domain of the cookie
`public integer`	`$expire`	`0`	# the timestamp at which the cookie expires. This is the server timestamp. Defaults to 0, meaning "until the browser is closed". the timestamp at which the cookie expires. This is the server timestamp. Defaults to 0, meaning "until the browser is closed".
`public string`	`$path`	`'/'`	# the path on the server in which the cookie will be available on. The default is '/'. the path on the server in which the cookie will be available on. The default is '/'.
`public boolean`	`$secure`	`false`	# whether cookie should be sent via secure connection whether cookie should be sent via secure connection
`public boolean`	`$httpOnly`	`false`	# 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. 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.