CCookieCollection
| Package | system.web |
|---|---|
| Inheritance | class CCookieCollection » CMap » CComponent |
| Implements | Countable, ArrayAccess, Traversable, IteratorAggregate |
| Since | 1.0 |
| Version | $Id: CHttpRequest.php 2171 2010-06-07 17:58:21Z qiang.xue $ |
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:
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
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| count | integer | the number of items in the map | CMap |
| iterator | CMapIterator | Returns an iterator for traversing the items in the list. | CMap |
| keys | array | the key list | CMap |
| readOnly | boolean | whether this map is read-only or not. | CMap |
| request | CHttpRequest | the request instance | CCookieCollection |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| cookies | array | list of validated cookies | CCookieCollection |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CCookieCollection |
| __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 |
| add() | Inserts an item at the specified position. | CCookieCollection |
| 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 |
| clear() | Removes all items in the map. | CMap |
| contains() | CMap | |
| copyFrom() | Copies iterable data into the map. | CMap |
| count() | Returns the number of items in the map. | CMap |
| 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 |
| getCount() | CMap | |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getIterator() | Returns an iterator for traversing the items in the list. | CMap |
| getKeys() | CMap | |
| getReadOnly() | CMap | |
| getRequest() | CCookieCollection | |
| 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 |
| itemAt() | Returns the item with the specified key. | CMap |
| mergeArray() | Merges two arrays into one recursively. | CMap |
| mergeWith() | Merges iterable data into the map. | CMap |
| offsetExists() | Returns whether there is an element at the specified offset. | CMap |
| offsetGet() | Returns the element at the specified offset. | CMap |
| offsetSet() | Sets the element at the specified offset. | CMap |
| offsetUnset() | Unsets the element at the specified offset. | CMap |
| raiseEvent() | Raises an event. | CComponent |
| remove() | Removes an item at the specified position. | CCookieCollection |
| toArray() | CMap |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| addCookie() | Sends a cookie. | CCookieCollection |
| getCookies() | CCookieCollection | |
| removeCookie() | Deletes a cookie. | CCookieCollection |
| setReadOnly() | CMap |
Property Details
cookies
property
read-only
protected array getCookies()
list of validated cookies
request
property
read-only
public CHttpRequest getRequest()
the request instance
Method Details
__construct()
method
|
public void __construct(CHttpRequest $request)
| ||
| $request | CHttpRequest | owner of this collection. |
Constructor.
add()
method
|
public void add(integer $name, mixed $cookie)
| ||
| $name | integer | the specified position. |
| $cookie | mixed | new item |
Inserts an item at the specified position. This overrides the parent implementation by performing additional operations for each newly added CHttpCookie object.
addCookie()
method
|
protected void addCookie(CHttpCookie $cookie)
| ||
| $cookie | CHttpCookie | cook to be sent |
Sends a cookie.
getCookies()
method
|
protected array getCookies()
| ||
| {return} | array | list of validated cookies |
getRequest()
method
|
public CHttpRequest getRequest()
| ||
| {return} | CHttpRequest | the request instance |
remove()
method
|
public mixed remove(integer $name)
| ||
| $name | integer | the index of the item to be removed. |
| {return} | mixed | the removed item. |
Removes an item at the specified position. This overrides the parent implementation by performing additional cleanup work when removing a TCookie object.
removeCookie()
method
|
protected void removeCookie(CHttpCookie $cookie)
| ||
| $cookie | CHttpCookie | cook to be deleted |
Deletes a cookie.