system system.base system.caching system.caching.dependencies system.collections system.console system.db system.db.ar system.db.schema system.db.schema.mssql system.db.schema.mysql system.db.schema.oci system.db.schema.pgsql system.db.schema.sqlite system.i18n system.i18n.gettext system.logging system.utils system.validators system.web system.web.actions system.web.auth system.web.filters system.web.helpers system.web.renderers system.web.services system.web.widgets system.web.widgets.captcha system.web.widgets.pagers

CList

system.collections
继承 class CList » CComponent
实现 IteratorAggregate, Traversable, ArrayAccess, Countable
子类 CFilterChain, CTypedList
可用自 1.0
版本 $Id$
CList implements an integer-indexed collection class.

You can access, append, insert, remove an item by using itemAt, add, insertAt, remove, and removeAt. To get the number of the items in the list, use getCount. CList can also be used like a regular array as follows,
$list[]=$item;  // append at the end
$list[$index]=$item; // $index must be between 0 and $list->Count
unset($list[$index]); // remove the item at $index
if(isset($list[$index])) // if the list has an item at $index
foreach($list as $index=>$item) // traverse each item in the list
$n=count($list); // returns the number of items in the list


To extend CList by doing additional operations with each addition or removal operation (e.g. performing type check), override insertAt(), and removeAt().

公共属性

隐藏继承的属性

属性类型描述被定义在
count integer the number of items in the list CList
iterator Iterator Returns an iterator for traversing the items in the list. CList
readOnly boolean whether this list is read-only or not. CList

公共方法

隐藏继承的方法

方法描述被定义在
__call() Calls the named method which is not a class method. CComponent
__construct() Constructor. CList
__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() Appends an item at the end of the list. CList
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 list. CList
contains() CList
copyFrom() Copies iterable data into the list. CList
count() Returns the number of items in the list. CList
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
getCount() CList
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getIterator() Returns an iterator for traversing the items in the list. CList
getReadOnly() CList
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
indexOf() CList
insertAt() Inserts an item at the specified position. CList
itemAt() Returns the item at the specified offset. CList
mergeWith() Merges iterable data into the map. CList
offsetExists() Returns whether there is an item at the specified offset. CList
offsetGet() Returns the item at the specified offset. CList
offsetSet() Sets the item at the specified offset. CList
offsetUnset() Unsets the item at the specified offset. CList
raiseEvent() Raises an event. CComponent
remove() Removes an item from the list. CList
removeAt() Removes an item at the specified position. CList
toArray() CList

受保护的方法

隐藏继承的方法

方法描述被定义在
setReadOnly() CList

属性详情

count 属性 只读
public integer getCount()

the number of items in the list

iterator 属性 只读
public Iterator getIterator()

Returns an iterator for traversing the items in the list. This method is required by the interface IteratorAggregate.

readOnly 属性
public boolean getReadOnly()
protected void setReadOnly(boolean $value)

whether this list is read-only or not. Defaults to false.

方法详情

__construct() 方法
public void __construct(array $data=NULL, boolean $readOnly=false)
$data array the initial data. Default is null, meaning no initialization.
$readOnly boolean whether the list is read-only

Constructor. Initializes the list with an array or an iterable object.

add() 方法
public integer add(mixed $item)
$item mixed new item
{return} integer the zero-based index at which the item is added

Appends an item at the end of the list.

clear() 方法
public void clear()

Removes all items in the list.

contains() 方法
public boolean contains(mixed $item)
$item mixed the item
{return} boolean whether the list contains the item

copyFrom() 方法
public void copyFrom(mixed $data)
$data mixed the data to be copied from, must be an array or object implementing Traversable

Copies iterable data into the list. Note, existing data in the list will be cleared first.

count() 方法
public integer count()
{return} integer number of items in the list.

Returns the number of items in the list. This method is required by Countable interface.

getCount() 方法
public integer getCount()
{return} integer the number of items in the list

getIterator() 方法
public Iterator getIterator()
{return} Iterator an iterator for traversing the items in the list.

Returns an iterator for traversing the items in the list. This method is required by the interface IteratorAggregate.

getReadOnly() 方法
public boolean getReadOnly()
{return} boolean whether this list is read-only or not. Defaults to false.

indexOf() 方法
public integer indexOf(mixed $item)
$item mixed the item
{return} integer the index of the item in the list (0 based), -1 if not found.

insertAt() 方法
public void insertAt(integer $index, mixed $item)
$index integer the specified position.
$item mixed new item

Inserts an item at the specified position. Original item at the position and the next items will be moved one step towards the end.

itemAt() 方法
public mixed itemAt(integer $index)
$index integer the index of the item
{return} mixed the item at the index

Returns the item at the specified offset. This method is exactly the same as offsetGet.

mergeWith() 方法
public void mergeWith(mixed $data)
$data mixed the data to be merged with, must be an array or object implementing Traversable

Merges iterable data into the map. New data will be appended to the end of the existing data.

offsetExists() 方法
public boolean offsetExists(integer $offset)
$offset integer the offset to check on
{return} boolean

Returns whether there is an item at the specified offset. This method is required by the interface ArrayAccess.

offsetGet() 方法
public mixed offsetGet(integer $offset)
$offset integer the offset to retrieve item.
{return} mixed the item at the offset

Returns the item at the specified offset. This method is required by the interface ArrayAccess.

offsetSet() 方法
public void offsetSet(integer $offset, mixed $item)
$offset integer the offset to set item
$item mixed the item value

Sets the item at the specified offset. This method is required by the interface ArrayAccess.

offsetUnset() 方法
public void offsetUnset(integer $offset)
$offset integer the offset to unset item

Unsets the item at the specified offset. This method is required by the interface ArrayAccess.

remove() 方法
public integer remove(mixed $item)
$item mixed the item to be removed.
{return} integer the index at which the item is being removed

Removes an item from the list. The list will first search for the item. The first item found will be removed from the list.

removeAt() 方法
public mixed removeAt(integer $index)
$index integer the index of the item to be removed.
{return} mixed the removed item.

Removes an item at the specified position.

setReadOnly() 方法
protected void setReadOnly(boolean $value)
$value boolean whether this list is read-only or not

toArray() 方法
public array toArray()
{return} array the list of items in array