包 | system.collections |
---|---|
继承 | class CList » CComponent |
实现 | IteratorAggregate, Traversable, ArrayAccess, Countable |
子类 | CFilterChain, CTypedList |
源自 | 1.0 |
版本 | $Id: CList.php 3430 2011-11-02 23:10:03Z alexander.makarow@gmail.com $ |
源码 |
CList实现一个整数索引的集合类。
你可以通过使用 itemAt,add,insertAt,remove,以及removeAt访问,添加,插入,删除项目。 通过getCount,你可以取得这个列表的项目数。 如下所示,CList也可以当作一般数组来使用:
通过重写insertAt(),以为removeAt()To extend CList by doing additional operations with each addition or removal 你可以在拥有添加/删除操作的基础上扩展额外的操作(如类型检查)。
你可以通过使用 itemAt,add,insertAt,remove,以及removeAt访问,添加,插入,删除项目。 通过getCount,你可以取得这个列表的项目数。 如下所示,CList也可以当作一般数组来使用:
$list[]=$item; //在尾部添加 $list[$index]=$item; //$index一定要在0和$list->Count之间 unset($list[$index]); //删除指定$index的项目 if(isset($list[$index])) //如果列表中存在$index指定的项目 foreach($list as $index=>$item) //遍历列表中的项目 $n=count($list); //返回列表中的项目数
通过重写insertAt(),以为removeAt()To extend CList by doing additional operations with each addition or removal 你可以在拥有添加/删除操作的基础上扩展额外的操作(如类型检查)。
公共属性
属性 | 类型 | 描述 | 定义在 |
---|---|---|---|
count | integer | 返回列表的项目数。 | CList |
iterator | Iterator | 返回遍历这个项目列表的迭代器。 | CList |
readOnly | boolean | 返回值说明这个列表是否为只读。默认为false。 | CList |
公共方法
受保护方法
方法 | 描述 | 定义在 |
---|---|---|
setReadOnly() | 设置设置这个列表是否为只读 | CList |
属性详细
count
属性
只读
public integer getCount()
返回列表的项目数。
iterator
属性
只读
public Iterator getIterator()
返回遍历这个项目列表的迭代器。 此方法为接口IteratorAggregate强制要求实现。
readOnly
属性
返回值说明这个列表是否为只读。默认为false。
方法详细
__construct()
方法
public void __construct(array $data=NULL, boolean $readOnly=false)
| ||
$data | array | 初始化的数据。默认为null,意味着没有初始化。 |
$readOnly | boolean | 标识这个列表是否为只读。 |
public function __construct($data=null,$readOnly=false)
{
if($data!==null)
$this->copyFrom($data);
$this->setReadOnly($readOnly);
}
构造方法。 根据数组或者迭代对象初始化这个列表。
add()
方法
public integer add(mixed $item)
| ||
$item | mixed | 新的项目 |
{return} | integer | 返回在加入该项目的从零开始的索引 |
public function add($item)
{
$this->insertAt($this->_c,$item);
return $this->_c-1;
}
在列表尾部添加一个项目。
clear()
方法
public void clear()
|
public function clear()
{
for($i=$this->_c-1;$i>=0;--$i)
$this->removeAt($i);
}
删除列表中所有项目。
contains()
方法
public boolean contains(mixed $item)
| ||
$item | mixed | 项目对象 |
{return} | boolean | 返回值说明列表中是否包含这个项目。 |
public function contains($item)
{
return $this->indexOf($item)>=0;
}
copyFrom()
方法
public void copyFrom(mixed $data)
| ||
$data | mixed | 要复制的数据, 只能是数组或者继承于Traversable的对象。 |
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);
}
else if($data!==null)
throw new CException(Yii::t('yii','List data must be an array or an object implementing Traversable.'));
}
将迭代器中的数据复制到列表。 注意,列表中已经存在的数据会被首先删除。
count()
方法
public integer count()
| ||
{return} | integer | 返回列表的项目数。 |
public function count()
{
return $this->getCount();
}
返回列表的项目数。 此方法为接口Countable强制要求实现。
getCount()
方法
public integer getCount()
| ||
{return} | integer | 返回列表的项目数 |
public function getCount()
{
return $this->_c;
}
返回列表的项目数。
getIterator()
方法
public Iterator getIterator()
| ||
{return} | Iterator | 返回用来遍历列表中的项目的迭代器。 |
public function getIterator()
{
return new CListIterator($this->_d);
}
返回遍历这个项目列表的迭代器。 此方法为接口IteratorAggregate强制要求实现。
getReadOnly()
方法
public boolean getReadOnly()
| ||
{return} | boolean | 返回值说明这个列表是否为只读。默认为false。 |
public function getReadOnly()
{
return $this->_r;
}
indexOf()
方法
public integer indexOf(mixed $item)
| ||
$item | mixed | 项目对象 |
{return} | integer | 返回项目在列表中的索引值(基于0),-1表示没有找到。 |
public function indexOf($item)
{
if(($index=array_search($item,$this->_d,true))!==false)
return $index;
else
return -1;
}
insertAt()
方法
public void insertAt(integer $index, mixed $item)
| ||
$index | integer | 指定位置。 |
$item | mixed | 新的项目 |
public function insertAt($index,$item)
{
if(!$this->_r)
{
if($index===$this->_c)
$this->_d[$this->_c++]=$item;
else if($index>=0 && $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.'));
}
将项目插入到指定位置。 该位置的原项目和 它后面直到列表结束的项目会被删除。
itemAt()
方法
public mixed itemAt(integer $index)
| ||
$index | integer | 项目的索引值 |
{return} | mixed | 索引对应的项目。 |
public function itemAt($index)
{
if(isset($this->_d[$index]))
return $this->_d[$index];
else if($index>=0 && $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)));
}
返回指定位置的项目。 这个方法跟offsetGet是完全一样的。
mergeWith()
方法
public void mergeWith(mixed $data)
| ||
$data | mixed | 要合并的数据, 只能是数组或者继承于Traversable的对象. |
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);
}
else if($data!==null)
throw new CException(Yii::t('yii','List data must be an array or an object implementing Traversable.'));
}
将迭代器的数据整合到map 新的数据会添加到已存在的数据后面。
offsetExists()
方法
public boolean offsetExists(integer $offset)
| ||
$offset | integer | 要检查的位置 |
{return} | boolean |
public function offsetExists($offset)
{
return ($offset>=0 && $offset<$this->_c);
}
返回值说明列表中是否包含这个项目。 此方法为接口ArrayAccess强制要求实现。
offsetGet()
方法
public mixed offsetGet(integer $offset)
| ||
$offset | integer | 要插入项目的索引。 |
{return} | mixed | 返回该索引的项目。 |
public function offsetGet($offset)
{
return $this->itemAt($offset);
}
返回指定位置的项目。 此方法为接口ArrayAccess强制要求实现。
offsetSet()
方法
public void offsetSet(integer $offset, mixed $item)
| ||
$offset | integer | 要设置项目的位置 |
$item | mixed | 项目对象 |
public function offsetSet($offset,$item)
{
if($offset===null || $offset===$this->_c)
$this->insertAt($this->_c,$item);
else
{
$this->removeAt($offset);
$this->insertAt($offset,$item);
}
}
在指定位置插入项目。 此方法为接口ArrayAccess强制要求实现。
offsetUnset()
方法
public void offsetUnset(integer $offset)
| ||
$offset | integer | 要删除的项目。 |
public function offsetUnset($offset)
{
$this->removeAt($offset);
}
删除指定位置的项目。 此方法为接口ArrayAccess强制要求实现。
remove()
方法
public integer remove(mixed $item)
| ||
$item | mixed | 要删除的项目的索引。 |
{return} | integer | 返回已经删除的项目的索引。 |
public function remove($item)
{
if(($index=$this->indexOf($item))>=0)
{
$this->removeAt($index);
return $index;
}
else
return false;
}
从列表中删除一个项目。 这个列表首先会搜索这个项目。 在列表中第一个找到的项目会被删除。(也就是说, 列表中可能存在着相同的项目)
removeAt()
方法
public mixed removeAt(integer $index)
| ||
$index | integer | 要删除的项目的索引。 |
{return} | mixed | 返回已经删除的项目。 |
public function removeAt($index)
{
if(!$this->_r)
{
if($index>=0 && $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.'));
}
删除指定位置的项目。
setReadOnly()
方法
protected void setReadOnly(boolean $value)
| ||
$value | boolean | 设置这个列表是否为只读 |
protected function setReadOnly($value)
{
$this->_r=$value;
}
toArray()
方法
public array toArray()
| ||
{return} | array | 数组中的项目列表 |
public function toArray()
{
return $this->_d;
}