Yii Framework v1.1.10 类参考
CMultiFileUpload
| 包 | system.web.widgets |
|---|---|
| 继承 | class CMultiFileUpload » CInputWidget » CWidget » CBaseController » CComponent |
| 源自 | 1.0 |
| 版本 | $Id: CMultiFileUpload.php 3515 2011-12-28 12:29:24Z mdomba $ |
| 源码 | framework/web/widgets/CMultiFileUpload.php |
CMultiFileUpload 生成一个允许同时上传多个文件的文件输入域。
这个类基于jQuery Multi File Upload plugin。 已上传的文件消息可以通过$_FILES[widget-name]访问，这个变量返回一个已上传文件组成的数组。 注意：你必须设置包含此字段的表单的“enctype”属性值为“multipart/form-data”。
示例：
这个类基于jQuery Multi File Upload plugin。 已上传的文件消息可以通过$_FILES[widget-name]访问，这个变量返回一个已上传文件组成的数组。 注意：你必须设置包含此字段的表单的“enctype”属性值为“multipart/form-data”。
示例：
<?php
$this->widget('CMultiFileUpload', array(
'model'=>$model,
'attribute'=>'files',
'accept'=>'jpg|gif',
'options'=>array(
'onFileSelect'=>'function(e, v, m){ alert("onFileSelect - "+v) }',
'afterFileSelect'=>'function(e, v, m){ alert("afterFileSelect - "+v) }',
'onFileAppend'=>'function(e, v, m){ alert("onFileAppend - "+v) }',
'afterFileAppend'=>'function(e, v, m){ alert("afterFileAppend - "+v) }',
'onFileRemove'=>'function(e, v, m){ alert("onFileRemove - "+v) }',
'afterFileRemove'=>'function(e, v, m){ alert("afterFileRemove - "+v) }',
),
));
?>
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| accept | string | the 允许上传的文件类型 (例如 "gif|jpg")。 注意：仍然需要在服务器端检测上传的文件类型是否被允许。 | CMultiFileUpload |
| actionPrefix | string | actions的ID的前缀。 当微件在CController::actions中声明了 动作提供者，可以为其动作的ID指定前缀以区别 于别的微件或控制器。当微件用于控制器 的视图中时，必须配置同样的前缀。 | CWidget |
| attribute | string | the 与此小物件相关联的属性。 这个名字可以包含方括号 (e. | CInputWidget |
| controller | CController | 返回此微件所属的控制器。 | CWidget |
| denied | string | 当上传文件的类型不允许时显示的消息。 | CMultiFileUpload |
| duplicate | string | 一个文件被选中两次时显示的消息。 | CMultiFileUpload |
| file | string | 用于显示已上传文件名的消息模板。 | CMultiFileUpload |
| htmlOptions | array | 渲染输入标签时附加的HTML选项 | CInputWidget |
| id | string | 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 | CWidget |
| max | integer | 可上传的最大文件数。如果设置为-1，表示不受限制。默认值是-1。 | CMultiFileUpload |
| model | CModel | 与此小物件相关联的数据模型。 | CInputWidget |
| name | string | 输入控件的名字。如果model没有设置，则必须设置此属性。 | CInputWidget |
| options | array | additional options that can be passed to the constructor of the multifile js object. | CMultiFileUpload |
| owner | CBaseController | 返回此微件的所有者或创建者。 | CWidget |
| remove | string | 移除按钮的标签。默认值是“Remove”。 | CMultiFileUpload |
| selected | string | 一个文件被选择时显示的消息。 | CMultiFileUpload |
| skin | mixed | 微件使用的皮肤的名称。默认为“default”。 如果此属性设置为false，微件将不会有皮肤被使用。 | CWidget |
| value | string | 输入控件的值 | CInputWidget |
| viewPath | string | 返回包含此微件所需的视图文件的路径。 | CWidget |
公共方法
受保护方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| getClientOptions() | 返回JavaScript选项 | CMultiFileUpload |
| hasModel() | 确定此小物件是否与一个数据模型相关联。 | CInputWidget |
| resolveNameID() | CInputWidget |
属性详细
accept
属性
public string $accept;
the 允许上传的文件类型 (例如 "gif|jpg")。 注意：仍然需要在服务器端检测上传的文件类型是否被允许。
clientOptions
属性
只读
protected array getClientOptions()
JavaScript选项
denied
属性
public string $denied;
当上传文件的类型不允许时显示的消息。
duplicate
属性
public string $duplicate;
一个文件被选中两次时显示的消息。
file
属性
（可用自 v1.1.3）
public string $file;
用于显示已上传文件名的消息模板。
max
属性
public integer $max;
可上传的最大文件数。如果设置为-1，表示不受限制。默认值是-1。
options
属性
（可用自 v1.1.7）
public array $options;
additional options that can be passed to the constructor of the multifile js object.
remove
属性
public string $remove;
移除按钮的标签。默认值是“Remove”。
selected
属性
public string $selected;
一个文件被选择时显示的消息。
方法详细
getClientOptions()
方法
|
protected array getClientOptions()
| ||
| {return} | array | JavaScript选项 |
源码： framework/web/widgets/CMultiFileUpload.php#117 (显示)
protected function getClientOptions()
{
$options=$this->options;
foreach(array('onFileRemove','afterFileRemove','onFileAppend','afterFileAppend','onFileSelect','afterFileSelect') as $event)
{
if(isset($options[$event]) && strpos($options[$event],'js:')!==0)
$options[$event]='js:'.$options[$event];
}
if($this->accept!==null)
$options['accept']=$this->accept;
if($this->max>0)
$options['max']=$this->max;
$messages=array();
foreach(array('remove','denied','selected','duplicate','file') as $messageName)
{
if($this->$messageName!==null)
$messages[$messageName]=$this->$messageName;
}
if($messages!==array())
$options['STRING']=$messages;
return $options;
}
registerClientScript()
方法
|
public void registerClientScript()
|
源码： framework/web/widgets/CMultiFileUpload.php#102 (显示)
public function registerClientScript()
{
$id=$this->htmlOptions['id'];
$options=$this->getClientOptions();
$options=$options===array()? '' : CJavaScript::encode($options);
$cs=Yii::app()->getClientScript();
$cs->registerCoreScript('multifile');
$cs->registerScript('Yii.CMultiFileUpload#'.$id,"jQuery(\"#{$id}\").MultiFile({$options});");
}
注册必须的CSS和JavaScript。
run()
方法
|
public void run()
|
源码： framework/web/widgets/CMultiFileUpload.php#86 (显示)
public function run()
{
list($name,$id)=$this->resolveNameID();
if(substr($name,-2)!=='[]')
$name.='[]';
if(isset($this->htmlOptions['id']))
$id=$this->htmlOptions['id'];
else
$this->htmlOptions['id']=$id;
$this->registerClientScript();
echo CHtml::fileField($name,'',$this->htmlOptions);
}
运行此小物件。 此方法注册所有必须的客户端脚本，渲染 多文件上传控件。