PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class THttpCookieCollection

THttpCookieCollection class.

THttpCookieCollection implements a collection class to store cookies. Besides using all functionalities from TList, you can also retrieve a cookie by its name using either THttpCookieCollection::findCookieByName() or simply:

$cookie=$collection[$cookieName];
TComponent
Extended by TList implements IteratorAggregate, ArrayAccess, Countable
Extended by THttpCookieCollection
Package: System\Web
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at Web/THttpRequest.php
Methods summary
public
# __construct( mixed $owner = null )

Constructor.

Constructor.

Parameters

$owner
mixed
owner of this collection.

Throws

TInvalidDataTypeException
If data is not null and neither an array nor an iterator.

Overrides

TList::__construct()
public
# insertAt( integer $index, mixed $item )

Inserts an item at the specified position. This overrides the parent implementation by performing additional operations for each newly added THttpCookie object.

Inserts an item at the specified position. This overrides the parent implementation by performing additional operations for each newly added THttpCookie object.

Parameters

$index
integer
the specified position.
$item
mixed
new item

Throws

TInvalidDataTypeException
if the item to be inserted is not a THttpCookie object.

Overrides

TList::insertAt()
public mixed
# removeAt( integer $index )

Removes an item at the specified position. This overrides the parent implementation by performing additional cleanup work when removing a TCookie object.

Removes an item at the specified position. This overrides the parent implementation by performing additional cleanup work when removing a TCookie object.

Parameters

$index
integer
the index of the item to be removed.

Returns

mixed
the removed item.

Throws

TInvalidDataValueException
If the index specified exceeds the bound
TInvalidOperationException
if the list is read-only

Overrides

TList::removeAt()
public THttpCookie
# itemAt( integer|string $index )

Parameters

$index
integer|string
index of the cookie in the collection or the cookie's name

Returns

THttpCookie
the cookie found

Throws

TInvalidDataValueException
if the index is out of the range

Overrides

TList::itemAt()
public THttpCookie
# findCookieByName( string $name )

Finds the cookie with the specified name.

Finds the cookie with the specified name.

Parameters

$name
string
the name of the cookie to be looked for

Returns

THttpCookie
the cookie, null if not found
Methods inherited from TList
add(), clear(), contains(), copyFrom(), count(), getCount(), getIterator(), getReadOnly(), indexOf(), insertAfter(), insertBefore(), mergeWith(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), remove(), setReadOnly(), toArray()
Methods inherited from TComponent
__call(), __destruct(), __get(), __isset(), __set(), __sleep(), __unset(), __wakeup(), addParsedObject(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO