YII 类库手册
> YII 类库手册 > CCookieCollection
包 system.web
继承 class CcookieCollection » CMap » CComponent
实现 Countable, ArrayAccess, Traversable, IteratorAggregate
源自 1.0
版本 $Id: CHttpRequest.php 3560 2012-02-10 14:13:00Z mDOMba $
源码
CCookieCollection implements a collection class to store cookies.

You normally access it via CHttpRequest::getCookies().

Since CCookieCollection extends from CMap, it can be used like an associative array as follows: 
$cookies[$name]=new CHttpCookie($name,$value); // sends a cookie
$value=$cookies[$name]->value; // reads a cookie value
unset($cookies[$name]);  // removes a cookie

公共属性

属性 类型 描述 定义在
count integer 返回map中的项目数。 CMap
iterator CMapIterator 返回遍历这个列表的项目的迭代器。 CMap
keys array 返回键名列表 CMap
readOnly boolean 返回值说明这个列表是否为只读。默认为false。 CMap
request CHttpRequest the request instance CCookieCollection

受保护属性

属性 类型 描述 定义在
cookies array list of validated cookies CCookieCollection

公共方法

方法 描述 定义在
__call() 如果类中没有调的方法名，则调用这个方法。 CComponent
__construct() Constructor. CCookieCollection
__get() 返回一个属性值、一个事件处理程序列表或一个行为名称。 CComponent
__isset() 检查一个属性是否为null。 CComponent
__set() 设置一个组件的属性值。 CComponent
__unset() 设置一个组件的属性为null。 CComponent
add() Adds a cookie with the specified name. CCookieCollection
asa() 返回这个名字的行为对象。 CComponent
attachBehavior() 附加一个行为到组件。 CComponent
attachBehaviors() 附加一个行为列表到组件。 CComponent
attachEventHandler() 为事件附加一个事件处理程序。 CComponent
canGetProperty() 确定属性是否可读。 CComponent
canSetProperty() 确定属性是否可写。 CComponent
clear() 删除map中所有项目。 CMap
contains() CMap
copyFrom() 将迭代器中的数据复制到map。 CMap
count() 返回map中的项目数。 CMap
detachBehavior() 从组件中分离一个行为。 CComponent
detachBehaviors() 从组件中分离所有行为。 CComponent
detachEventHandler() 分离一个存在的事件处理程序。 CComponent
disableBehavior() 禁用一个附加行为。 CComponent
disableBehaviors() 禁用组件附加的所有行为。 CComponent
enableBehavior() 启用一个附加行为。 CComponent
enableBehaviors() 启用组件附加的所有行为。 CComponent
evaLuateExpression() 计算一个PHP表达式，或根据组件上下文执行回调。 CComponent
getCount() 返回map中的项目数。 CMap
getEventHandlers() 返回一个事件的附加处理程序列表。 CComponent
getIterator() 返回遍历这个列表的项目的迭代器。 CMap
getKeys() 返回返回键名列表 CMap
getReadOnly() 返回返回值说明这个列表是否为只读。默认为false。 CMap
getRequest() 返回the request instance CCookieCollection
hasEvent() 确定一个事件是否定义。 CComponent
hasEventHandler() 检查事件是否有附加的处理程序。 CComponent
hasProperty() 确定属性是否被定义。 CComponent
itemAt() 返回指定位置的项目。 CMap
mergeArray() 递归合并两个或多个数组。 CMap
mergeWith() 将迭代器的数据整合到map。 CMap
offsetExists() 返回值说明指定位置是否存在元素。 CMap
offsetGet() 返回值指定位置的元素。 CMap
offsetSet() 设置指定位置的元素。 CMap
offsetUnset() 删除指定位置的元素。 CMap
raiseEvent() 发起一个事件。 CComponent
remove() Removes a cookie with the specified name. CCookieCollection
toArray() CMap

受保护方法

方法 描述 定义在
addCookie() Sends a cookie. CCookieCollection
getCookies() 返回list of validated cookies CCookieCollection
removeCookie() Deletes a cookie. CCookieCollection
setReadOnly() 设置设置这个列表是否为只读 CMap

属性详细

cookies 属性 只读
protected array getCookies()

list of validated cookies

request 属性 只读
public CHttpRequest getRequest()

the request instance

方法详细

__construct() 方法
public void __construct(CHttpRequest $request)
$request CHttpRequest owner of this collection. 

public function __construct(CHttpRequest $request)
{
    $this->_request=$request;
    $this->copyfrom($this->getCookies());
    $this->_initialized=true;
}

Constructor.

add() 方法
public void add(mixed $name, CHttpCookie $cookie)
$name mixed Cookie name.
$cookie CHttpCookie Cookie object. 

public function add($name,$cookie)
{
    if($cookie instanceof CHttpCookie)
    {
        $this->remove($name);
        parent::add($name,$cookie);
        if($this->_initialized)
            $this->addCookie($cookie);
    }
    else
        throw new CException(Yii::t('yii','CHttpCookieCollection can only hold CHttpCookie objects.'));
}

Adds a cookie with the specified name. This overrides the parent implementation by performing additional operations for each newly added CHttpCookie object.

addCookie() 方法
protected void addCookie(CHttpCookie $cookie)
$cookie CHttpCookie cookie to be sent 

protected function addCookie($cookie)
{
    $value=$cookie->value;
    if($this->_request->enableCookieValidation)
        $value=Yii::app()->getSecurityManager()->hashData(serialize($value));
    if(version_compare(PHP_VERSION,'5.2.0','>='))
        setcookie($cookie->name,$value,$cookie->expire,$cookie->path,$cookie->domain,$cookie->secure,$cookie->httpOnly);
    else
        setcookie($cookie->name,$value,$cookie->expire,$cookie->path,$cookie->domain,$cookie->secure);
}

Sends a cookie.

getCookies() 方法
protected array getCookies()
{return} array list of validated cookies 

protected function getCookies()
{
    $cookies=array();
    if($this->_request->enableCookieValidation)
    {
        $sm=Yii::app()->getSecurityManager();
        foreach($_COOKIE as $name=>$value)
        {
            if(is_string($value) && ($value=$sm->validateData($value))!==false)
                $cookies[$name]=new CHttpCookie($name,@unserialize($value));
        }
    }
    else
    {
        foreach($_COOKIE as $name=>$value)
            $cookies[$name]=new CHttpCookie($name,$value);
    }
    return $cookies;
}

getRequest() 方法
public CHttpRequest getRequest()
{return} CHttpRequest the request instance 

public function getRequest()
{
    return $this->_request;
}

remove() 方法
public CHttpCookie remove(mixed $name)
$name mixed Cookie name.
{return} CHttpCookie The removed cookie object. 

public function remove($name)
{
    if(($cookie=parent::remove($name))!==null)
    {
        if($this->_initialized)
            $this->removeCookie($cookie);
    }
    return $cookie;
}

Removes a cookie with the specified name. This overrides the parent implementation by performing additional cleanup work when removing a CHttpCookie object.

removeCookie() 方法
protected void removeCookie(CHttpCookie $cookie)
$cookie CHttpCookie cookie to be deleted 

protected function removeCookie($cookie)
{
    if(version_compare(PHP_VERSION,'5.2.0','>='))
        setcookie($cookie->name,null,0,$cookie->path,$cookie->domain,$cookie->secure,$cookie->httpOnly);
    else
        setcookie($cookie->name,null,0,$cookie->path,$cookie->domain,$cookie->secure);
}

Deletes a cookie.

上一篇：
下一篇：