Versions
Look up a class, method, property or event

CList

Package system.collections
Inheritance class CList » CComponent
Implements IteratorAggregate, Traversable, ArrayAccess, Countable
Subclasses CFilterChain, CTypedList
Since 1.0
Source Code framework/collections/CList.php
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().

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
count integer Returns 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

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__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
evaluateExpression() Evaluates a PHP expression or callback under the context of this component. CComponent
getCount() Returns the number of items in the list. 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() Returns whether this list is read-only or not. Defaults to false. 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

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
setReadOnly() Sets whether this list is read-only or not CList

Property Details

count property read-only
public integer getCount()

Returns the number of items in the list.

iterator property read-only
public Iterator getIterator()

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

readOnly property
public boolean getReadOnly()
protected void setReadOnly(boolean $value)

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

Method Details

__construct() method
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
Source Code: framework/collections/CList.php#60 (show)
public function __construct($data=null,$readOnly=false)
{
    if(
$data!==null)
        
$this->copyFrom($data);
    
$this->setReadOnly($readOnly);
}

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

add() method
public integer add(mixed $item)
$item mixed new item
{return} integer the zero-based index at which the item is added
Source Code: framework/collections/CList.php#135 (show)
public function add($item)
{
    
$this->insertAt($this->_c,$item);
    return 
$this->_c-1;
}

Appends an item at the end of the list.

clear() method
public void clear()
Source Code: framework/collections/CList.php#220 (show)
public function clear()
{
    for(
$i=$this->_c-1;$i>=0;--$i)
        
$this->removeAt($i);
}

Removes all items in the list.

contains() method
public boolean contains(mixed $item)
$item mixed the item
{return} boolean whether the list contains the item
Source Code: framework/collections/CList.php#230 (show)
public function contains($item)
{
    return 
$this->indexOf($item)>=0;
}

copyFrom() method
public void copyFrom(mixed $data)
$data mixed the data to be copied from, must be an array or object implementing Traversable
Source Code: framework/collections/CList.php#261 (show)
public function copyFrom($data)
{
    if(
is_array($data) || ($data instanceof Traversable))
    {
        if(
$this->_c>0)
            
$this->clear();
        if(
$data instanceof CList)
            
$data=$data->_d;
        foreach(
$data as $item)
            
$this->add($item);
    }
    elseif(
$data!==null)
        throw new 
CException(Yii::t('yii','List data must be an array or an object implementing Traversable.'));
}

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

count() method
public integer count()
{return} integer number of items in the list.
Source Code: framework/collections/CList.php#98 (show)
public function count()
{
    return 
$this->getCount();
}

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

getCount() method
public integer getCount()
{return} integer the number of items in the list
Source Code: framework/collections/CList.php#107 (show)
public function getCount()
{
    return 
$this->_c;
}

Returns the number of items in the list.

getIterator() method
public Iterator getIterator()
{return} Iterator an iterator for traversing the items in the list.
Source Code: framework/collections/CList.php#88 (show)
public function getIterator()
{
    return new 
CListIterator($this->_d);
}

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

getReadOnly() method
public boolean getReadOnly()
{return} boolean whether this list is read-only or not. Defaults to false.
Source Code: framework/collections/CList.php#70 (show)
public function getReadOnly()
{
    return 
$this->_r;
}

indexOf() method
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.
Source Code: framework/collections/CList.php#239 (show)
public function indexOf($item)
{
    if((
$index=array_search($item,$this->_d,true))!==false)
        return 
$index;
    else
        return -
1;
}

insertAt() method
public void insertAt(integer $index, mixed $item)
$index integer the specified position.
$item mixed new item
Source Code: framework/collections/CList.php#149 (show)
public function insertAt($index,$item)
{
    if(!
$this->_r)
    {
        if(
$index===$this->_c)
            
$this->_d[$this->_c++]=$item;
        elseif(
$index>=&& $index<$this->_c)
        {
            
array_splice($this->_d,$index,0,array($item));
            
$this->_c++;
        }
        else
            throw new 
CException(Yii::t('yii','List index "{index}" is out of bound.',
                array(
'{index}'=>$index)));
    }
    else
        throw new 
CException(Yii::t('yii','The list is read only.'));
}

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() method
public mixed itemAt(integer $index)
$index integer the index of the item
{return} mixed the item at the index
Source Code: framework/collections/CList.php#119 (show)
public function itemAt($index)
{
    if(isset(
$this->_d[$index]))
        return 
$this->_d[$index];
    elseif(
$index>=&& $index<$this->_c// in case the value is null
        
return $this->_d[$index];
    else
        throw new 
CException(Yii::t('yii','List index "{index}" is out of bound.',
            array(
'{index}'=>$index)));
}

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

mergeWith() method
public void mergeWith(mixed $data)
$data mixed the data to be merged with, must be an array or object implementing Traversable
Source Code: framework/collections/CList.php#282 (show)
public function mergeWith($data)
{
    if(
is_array($data) || ($data instanceof Traversable))
    {
        if(
$data instanceof CList)
            
$data=$data->_d;
        foreach(
$data as $item)
            
$this->add($item);
    }
    elseif(
$data!==null)
        throw new 
CException(Yii::t('yii','List data must be an array or an object implementing Traversable.'));
}

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

offsetExists() method
public boolean offsetExists(integer $offset)
$offset integer the offset to check on
{return} boolean
Source Code: framework/collections/CList.php#301 (show)
public function offsetExists($offset)
{
    return (
$offset>=&& $offset<$this->_c);
}

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

offsetGet() method
public mixed offsetGet(integer $offset)
$offset integer the offset to retrieve item.
{return} mixed the item at the offset
Source Code: framework/collections/CList.php#313 (show)
public function offsetGet($offset)
{
    return 
$this->itemAt($offset);
}

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

offsetSet() method
public void offsetSet(integer $offset, mixed $item)
$offset integer the offset to set item
$item mixed the item value
Source Code: framework/collections/CList.php#324 (show)
public function offsetSet($offset,$item)
{
    if(
$offset===null || $offset===$this->_c)
        
$this->insertAt($this->_c,$item);
    else
    {
        
$this->removeAt($offset);
        
$this->insertAt($offset,$item);
    }
}

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

offsetUnset() method
public void offsetUnset(integer $offset)
$offset integer the offset to unset item
Source Code: framework/collections/CList.php#340 (show)
public function offsetUnset($offset)
{
    
$this->removeAt($offset);
}

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

remove() method
public integer remove(mixed $item)
$item mixed the item to be removed.
{return} integer the index at which the item is being removed
Source Code: framework/collections/CList.php#176 (show)
public function remove($item)
{
    if((
$index=$this->indexOf($item))>=0)
    {
        
$this->removeAt($index);
        return 
$index;
    }
    else
        return 
false;
}

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() method
public mixed removeAt(integer $index)
$index integer the index of the item to be removed.
{return} mixed the removed item.
Source Code: framework/collections/CList.php#193 (show)
public function removeAt($index)
{
    if(!
$this->_r)
    {
        if(
$index>=&& $index<$this->_c)
        {
            
$this->_c--;
            if(
$index===$this->_c)
                return 
array_pop($this->_d);
            else
            {
                
$item=$this->_d[$index];
                
array_splice($this->_d,$index,1);
                return 
$item;
            }
        }
        else
            throw new 
CException(Yii::t('yii','List index "{index}" is out of bound.',
                array(
'{index}'=>$index)));
    }
    else
        throw new 
CException(Yii::t('yii','The list is read only.'));
}

Removes an item at the specified position.

setReadOnly() method
protected void setReadOnly(boolean $value)
$value boolean whether this list is read-only or not
Source Code: framework/collections/CList.php#78 (show)
protected function setReadOnly($value)
{
    
$this->_r=$value;
}

toArray() method
public array toArray()
{return} array the list of items in array
Source Code: framework/collections/CList.php#250 (show)
public function toArray()
{
    return 
$this->_d;
}

Be the first person to leave a comment

Please to leave your comment.