CHttpCookie

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, array $options=array ( ))

public function __construct($name,$value,$options=array())
{
    $this->name=$name;
    $this->value=$value;
    $this->configure($options);
}

Constructor.

__toString() method (available since v1.1.11)

public string __toString()

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() method (available since v1.1.11)

public void configure(array $options=array ( ))

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