| 包 | system.web.form |
|---|---|
| 继承 | class CFormElementCollection » CMap » CComponent |
| 实现 | Countable, ArrayAccess, Traversable, IteratorAggregate |
| 源自 | 1.1 |
| 版本 | $Id: CFormElementCollection.php 3054 2011-03-12 21:30:21Z qiang.xue $ |
| 源码 |
CFormElementCollection 实现存储表单元素的集合。
因为CFormElementCollection继承自CMap，所以它可以向一个关联数组那样来使用。 例如，
CFormElementCollection 可以存储三种类型的值： 一种是配置数组，一种是CFormElement对象，一种是字符串， 正如上面例子中显示的那样，在内部，这些值将被转换为CFormElement对象。
因为CFormElementCollection继承自CMap，所以它可以向一个关联数组那样来使用。 例如，
$element=$collection['username'];
$collection['username']=array('type'=>'text', 'maxlength'=>128);
$collection['password']=new CFormInputElement(array('type'=>'password'),$form);
$collection[]='some string';
CFormElementCollection 可以存储三种类型的值： 一种是配置数组，一种是CFormElement对象，一种是字符串， 正如上面例子中显示的那样，在内部，这些值将被转换为CFormElement对象。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| count | integer | 返回map中的项目数。 | CMap |
| iterator | CMapIterator | 返回遍历这个列表的项目的迭代器。 | CMap |
| keys | array | 返回键名列表 | CMap |
| readOnly | boolean | 返回值说明这个列表是否为只读。默认为false。 | CMap |
公共方法
受保护方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| setReadOnly() | 设置设置这个列表是否为只读 | CMap |
方法详细
__construct()
方法
|
public void __construct(CForm $form, boolean $forButtons=false)
| ||
| $form | CForm | 拥有这个集合的表单对象 |
| $forButtons | boolean | 这个集合是否用来存储按钮。 |
public function __construct($form,$forButtons=false)
{
parent::__construct();
$this->_form=$form;
$this->_forButtons=$forButtons;
}
构造方法。
add()
方法
|
public void add(mixed $key, mixed $value)
| ||
| $key | mixed | 键名 |
| $value | mixed | 键值 |
public function add($key,$value)
{
if(is_array($value))
{
if(is_string($key))
$value['name']=$key;
if($this->_forButtons)
{
$class=$this->_form->buttonElementClass;
$element=new $class($value,$this->_form);
}
else
{
if(!isset($value['type']))
$value['type']='text';
if($value['type']==='string')
{
unset($value['type'],$value['name']);
$element=new CFormStringElement($value,$this->_form);
}
else if(!strcasecmp(substr($value['type'],-4),'form')) // a form
{
$class=$value['type']==='form' ? get_class($this->_form) : Yii::import($value['type']);
$element=new $class($value,null,$this->_form);
}
else
{
$class=$this->_form->inputElementClass;
$element=new $class($value,$this->_form);
}
}
}
else if($value instanceof CFormElement)
{
if(property_exists($value,'name') && is_string($key))
$value->name=$key;
$element=$value;
}
else
$element=new CFormStringElement(array('content'=>$value),$this->_form);
parent::add($key,$element);
$this->_form->addedElement($key,$element,$this->_forButtons);
}
增加一个项目到集合。 这个方法重写父类的的方法 来确保只有配置数组，字符串，或CFormElement对象 会被存储到集合中。
remove()
方法
|
public void remove(string $key)
| ||
| $key | string | 将要从集合中移除的元素的键名。 |
public function remove($key)
{
if(($item=parent::remove($key))!==null)
$this->_form->removedElement($key,$item,$this->_forButtons);
}
根据键名移除指定的元素。