包 | system.web.widgets |
---|---|
继承 | abstract class CInputWidget » CWidget » CBaseController » CComponent |
子类 | CAutoComplete, CMaskedTextField, CMultiFileUpload, CStarRating |
源自 | 1.0 |
版本 | $Id: CInputWidget.php 3515 2011-12-28 12:29:24Z mdomba $ |
源码 |
CInputWidget 是各种收集用户输入的小物件类的基类。
CInputWidget 声明了输入小物件的通用属性。一个输入小物件 可以与一个模型和属性相关联,或与一个名字与值相关联。 如果是前者,小物件的名字与值将自动生成。 继承的子类可以使用resolveNameID 和 hasModel。
CInputWidget 声明了输入小物件的通用属性。一个输入小物件 可以与一个模型和属性相关联,或与一个名字与值相关联。 如果是前者,小物件的名字与值将自动生成。 继承的子类可以使用resolveNameID 和 hasModel。
公共属性
属性 | 类型 | 描述 | 定义在 |
---|---|---|---|
actionPrefix | string | actions的ID的前缀。 当微件在CController::actions中声明了 动作提供者,可以为其动作的ID指定前缀以区别 于别的微件或控制器。当微件用于控制器 的视图中时,必须配置同样的前缀。 | CWidget |
attribute | string | the 与此小物件相关联的属性。 这个名字可以包含方括号 (e. | CInputWidget |
controller | CController | 返回此微件所属的控制器。 | CWidget |
htmlOptions | array | 渲染输入标签时附加的HTML选项 | CInputWidget |
id | string | 返回此微件的ID。如果需要的话,将生产一个新的ID并将其返回。 | CWidget |
model | CModel | 与此小物件相关联的数据模型。 | CInputWidget |
name | string | 输入控件的名字。如果model没有设置,则必须设置此属性。 | CInputWidget |
owner | CBaseController | 返回此微件的所有者或创建者。 | CWidget |
skin | mixed | 微件使用的皮肤的名称。默认为“default”。 如果此属性设置为false,微件将不会有皮肤被使用。 | CWidget |
value | string | 输入控件的值 | CInputWidget |
viewPath | string | 返回包含此微件所需的视图文件的路径。 | CWidget |
公共方法
受保护方法
方法 | 描述 | 定义在 |
---|---|---|
hasModel() | 确定此小物件是否与一个数据模型相关联。 | CInputWidget |
resolveNameID() | CInputWidget |
属性详细
attribute
属性
public string $attribute;
the 与此小物件相关联的属性。 这个名字可以包含方括号 (e.g. 'name[1]') 用来收集表格式输入。
htmlOptions
属性
public array $htmlOptions;
渲染输入标签时附加的HTML选项
model
属性
public CModel $model;
与此小物件相关联的数据模型。
name
属性
public string $name;
输入控件的名字。如果model没有设置,则必须设置此属性。
value
属性
public string $value;
输入控件的值
方法详细
hasModel()
方法
protected boolean hasModel()
| ||
{return} | boolean | 此小物件是否与一个数据模型相关联。 |
protected function hasModel()
{
return $this->model instanceof CModel && $this->attribute!==null;
}
resolveNameID()
方法
protected array resolveNameID()
| ||
{return} | array | 输入控件的名字和ID。 |
protected function resolveNameID()
{
if($this->name!==null)
$name=$this->name;
else if(isset($this->htmlOptions['name']))
$name=$this->htmlOptions['name'];
else if($this->hasModel())
$name=CHtml::activeName($this->model,$this->attribute);
else
throw new CException(Yii::t('yii','{class} must specify "model" and "attribute" or "name" property values.',array('{class}'=>get_class($this))));
if(($id=$this->getId(false))===null)
{
if(isset($this->htmlOptions['id']))
$id=$this->htmlOptions['id'];
else
$id=CHtml::getIdByName($name);
}
return array($name,$id);
}