Uploadify 3.2 参数属性、事件、方法函数详解

一、属性
属性名称默认值说明autotrue设置为true当选择文件后就直接上传了，为false需要点击上传按钮才上传 。buttonClass”按钮样式buttonCursor‘hand’鼠标指针悬停在按钮上的样子buttonImagenull浏览按钮的图片的路径 。buttonText‘SELECT FILES’浏览按钮的文本。checkExistingfalse文件上传重复性检查程序，检查即将上传的文件在服务器端是否已存在，存在返回1，不存在返回0debugfalse如果设置为true则表示启用SWFUpload的调试模式fileObjName‘Filedata’文件上传对象的名称，如果命名为’the_files’，PHP程序可以用$_FILES['the_files']来处理上传的文件对象。fileSizeLimit0

上传文件的大小限制 ，如果为整数型则表示以KB为单位的大小，如果是字符串，则可以使用(B, KB, MB, or GB)为单位，比如’2MB’；

如果设置为0则表示无限制

fileTypeDesc‘All Files’这个属性值必须设置fileTypeExts属性后才有效，用来设置选择文件对话框中的提示文本，如设置fileTypeDesc为“请选择rar doc pdf文件”fileTypeExts‘*.*’设置可以选择的文件的类型，格式如：’*.doc;*.pdf;*.rar’ 。formData JSON格式上传每个文件的同时提交到服务器的额外数据，可在’onUploadStart’事件中使用’settings’方法动态设置。height30设置浏览按钮的高度 ，默认值itemTemplatefalse用于设置上传队列的HTML模版，可以使用以下标签：
instanceID – Uploadify实例的ID
fileID – 列队中此文件的ID,或者理解为此任务的ID
fileName – 文件的名称
fileSize – 当前上传文件的大小
插入模版标签时使用格式如：${fileName}methodPost提交方式Post或Getmultitrue设置为true时可以上传多个文件。overrideEvents 设置哪些事件可以被重写，JSON格式，如：’overrideEvents’ : ['onUploadProgress']preventCachingtrue如果为true，则每次上传文件时自动加上一串随机字符串参数，防止URL缓存影响上传结果progressData‘percentage’设置上传进度显示方式，percentage显示上传百分比，speed显示上传速度queueIDfalse设置上传队列容器DOM元素的ID，如果为false则自动生成一个队列容器。queueSizeLimit999队列最多显示的任务数量，如果选择的文件数量超出此限制，将会出发onSelectError事件。
注意此项并非最大文件上传数量，如果要限制最大上传文件数量，应设置uploadLimit。removeCompletedtrue是否自动将已完成任务从队列中删除，如果设置为false则会一直保留此任务显示。removeTimeout3如果设置了任务完成后自动从队列中移除，则可以规定从完成到被移除的时间间隔。requeueErrorsfalse如果设置为true，则单个任务上传失败后将返回错误，并重新加入任务队列上传。successTimeout30文件上传成功后服务端应返回成功标志，此项设置返回结果的超时时间swf‘uploadify.swf’uploadify.swf 文件的相对路径。uploaderuploadify.php后台处理程序的相对路径。uploadLimit999最大上传文件数量，如果达到或超出此限制将会触发onUploadError事件。width120设置文件浏览按钮的宽度。

 

二、事件事件名称说明onCancel(file)

当点击文件队列中文件的关闭按钮或点击取消上传时触发，file参数为被取消上传的文件对象

onClearQueue(queueItemCount)当调用函数cancel方法时触发，queueItemCount参数为被取消上传的文件数量。onDestroy()当destory方法被调用时触发onDialogClose(queueData)

当文件浏览框关闭时触发，如果将此事件被重写，则当向队列添加文件上传出错时不会弹出错误消息提示。

queueData对象包含如下属性：

• filesSelected 文件选择对话框中共选择了多少个文件
• filesQueued 已经向队列中添加了多少个文件
• filesReplaced 已经向队列中替换了多少个文件
• filesCancelled 取消了多少个文件 filesErrored 出错了多少个文件

onDialogOpen()当文件选择对话框弹出时立即出发，但可能在文件选择对话框被关闭之前并不能全部执行。onDisable()当disable方法禁用Uploadify上传按钮时被调用时触发。onEnable()当disable方法启用Uploadify上传按钮时被调用时触发。onFallback()当Uploadify初始化过程中检测到当前浏览器不支持flash时触发。onInit()首次初始化Uploadify结束时触发。onQueueComplete(queueData)

文件上传队列处理完毕后触发。

queueData对象包含如下属性：

• uploadsSuccessful – 上传成功的文件数量
• uploadsErrored – 上传失败的文件数量

onSelect(file)

选择文件后向队列中添加每个上传任务时都会触发。

onSelectError(file, errorCode, errorMsg)

选择文件后向队列中添加每个上传任务时如果失败都会触发。

file – 文件对象

errorCode – 错误代码如下：

• QUEUE_LIMIT_EXCEEDED – 任务数量超出队列限制；
• FILE_EXCEEDS_SIZE_LIMIT – 文件大小超出限制；
• ZERO_BYTE_FILE – 文件大小为0
• INVALID_FILETYPE – 文件类型不符合要求

errorMsg – 错误提示，可通过’this.queueData.errorMsg’定制

onSWFReady()Flash文件载入成功后触发。onUploadComplete(file)每个文件上传完毕后无论成功与否都会触发。onUploadError(file, errorCode, errorMsg, errorString)文件上传出错时触发，参数由服务端程序返回。onUploadProgress(file, bytesUploaded, bytesTotal, totalBytesUploaded, totalBytesTotal)

处理上传队列的过程中会多次触发此事件，每当任务状态有更新时都会触发。

• file – 文件对象
• bytesUploaded – 已上传的字节数
• bytesTotal – 文件总字节数
• totalBytesUploaded – 当前任务队列中全部文件已上传的总字节数
• totalBytesTotal – 当前任务队列中全部文件的总字节数

onUploadStart(file)当文件即将开始上传时立即触发onUploadSuccess(file, data, response)

当文件上传成功时触发

• file – 文件对象
• data – 服务端输出返回的信息
• response – 有输出时为true,如果无响应为false，如果返回的是false,当超过successTimeout设置的时间后假定为true

三、方法方法名称说明应用举例cancel(fileID, suppressEvent)

取消队列中的任务，不管此任务是否已经开始上传

• fileID – 要取消的文件ID，如果为空则取消队列中第一个任务，如果为’*'则取消所有任务
• suppressEvent – 是否阻止触发onUploadCancel事件，当清空队列时非常实用。

<a href="javascript:$(‘#file_upload’).uploadify(‘cancel’)">取消第一个</a>

<a href="javascript:$(‘#file_upload’).uploadify(‘cancel’, ‘*’)">清空队列</a>

<a href="javascript:$(‘#file_upload’).uploadify(‘upload’, ‘*’)">开始上传所有任务</a>

destroy()销毁Uploadify实例并将文件上传按钮恢复到原始状态<a href="javascript:$(‘#file_upload’).uploadify(‘destroy’)">销毁Uploadify实例</a>disable(setDisabled)

禁用或启用文件浏览按钮

setDisabled – 设置为true表示禁用，false为启用

<a href="javascript:$(‘#file_upload’).uploadify(‘disable’, true)">禁用按钮</a>

<a href="javascript:$(‘#file_upload’).uploadify(‘disable’, false)">启用按钮</a>

settings(name, value, resetObjects)

获取或设置Uploadify实例参数

• name – 属性名称，如果只提供属性名称则表示获取其值
• value – 属性值
• resetObjects – 设置为true时，更新postData对象将清空现有的值。否则，新的值将被添加到其末尾。

$(‘#file_upload’).uploadify(‘settings’,'buttonText’,'BROWSE’);

$(‘#file_upload’).uploadify(‘settings’,'buttonText’));

stop()停止当前正在上传的任务

<a href="javascript:$(‘#file_upload’).uploadify(‘upload’, ‘*’)">开始上传</a>

<a href="javascript:$(‘#file_upload’).uploadify(‘stop’)">停止上传</a>

upload(fileID)立即上传指定的文件，如果fileID为’*'表示上传所有文件，要指定上传多个文件，则将每个文件的fileID作为一个参数<a href="javascript:$(‘#file_upload’).uploadify(‘upload’,'*’)">开始上传所有文关于无法在formData获取到值得解决办法：在动态设置setting里设置就可以了，还是不知道是什么原因在直接配置文件里获取不到值。 另外如果将上传文件信息保存在session里要注意遍历的时候会有一点BUG，直接循环写入数据库会多出一组，原因暂时不明。

1.属性

名称

默认值

说明

swf

 

[必须设置]swf的路径

uploader

 

[必须设置]服务器端脚本文件路径

uploadLimit

999

最多上传文件数量

checkExisting

false

检查上传文件是否存在的服务器端脚本文件路径

queueID

 

显示上传文件队列的元素id，可以简单用一个div显示

queueSizeLimit

999

上传文件队列长度限制

auto

true

表示在选择文件后是否自动上传

multi

true

是否支持多文件上传

buttonClass

 

上传按钮样式类型

buttonCursor

hand

上传按钮Hover时的鼠标形状

buttonImage

NULL

上传按钮背景图片

buttonText

SELECT FILES

上传按钮显示文字

height

30

上传按钮高度

width

120

上传按钮宽度

debug

false

是否开启调试模式

fileObjName

FileData

文件对象名称，用于服务器端获取文件

fileSizeLimit

 

上传文件大小限制，默认单位是KB，如：”10KB”

fileTypeDesc

 

文件类型说明，在选择文件时可以看到

fileTypeExts

*.*

指定允许上传的文件类型，如：”*.jpg;*.gif”

formData

 

指定上传文件附带的其他数据，用于服务器端获取这些数据，如：{“id”:”001”,”name”:”LiJin”}包含两个键值对

method

post

和后台交互方式，也可以设置为get

overrideEvents

 

设置插件的某些事件可以被用户覆写，如：{“onUploadSuccess”}

preventCaching

true

若设置为true，一个随机数将被加载swf文件URL的后面，防止浏览器缓存

progressData

 

设置文件上传时显示的数据，可以设为上传速度或者百分比，分别对应speed和percentage

removeCompleted

true

表示上传文件完成后是否删除队列中的对应元素

removeTimeout

3

表示上传完成后多久删除队列中的进度条，单位为秒

requeueErrors

 

若设置为true，那么在上传过程中因为出错导致上传失败的文件将重新加入队列

successTimeout

30

表示文件上传完成后等待服务器响应的时间。超过该时间，那么将认为上传成功。单位为秒

2.事件

●onQueueComplete当队列中的所有文件全部完成上传时触发

1 function (stats) {2     alert("成功上传的文件数：" + stats.uploadsSuccessful + " -上传出错的文件数：" +3     stats.uploadsErrored + " -上传的文件总大小：" + stats.uploadSize);4 }

●onUploadComplete每个文件上传完成时触发

1 function (file) {2     alert("id:" + file.id + " -索引:" + file.index + " -文件名称:" + file.name +3      " -文件大小:" + file.size + " -文件类型:" + file.type + " -创建日期:" + file.creationdate +4      " -修改日期:" + file.modificationdate + " -文件状态:" + file.filestatus);5 }

●onUploadSuccess每个文件上传成功后触发

1 function (file , data, response) {2     alert("id:" + file.id + " -索引:" + file.index + " -文件名称:" + file.name +3      " -文件大小:" + file.size + " -文件类型:" + file.type + " -创建日期:" + file.creationdate +4      " -修改日期:" + file.modificationdate + " -文件状态:" + file.filestatus +5      " –服务器端消息:" + data + " –是否上传成功:" + response);6 }

●onUploadError每个文件上传出错时触发

1 function (file , errorCode, errorMsg , errorString) {2     alert("id:" + file.id + " -索引:" + file.index + " -文件名称:" + file.name +3      " -文件大小:" + file.size + " -文件类型:" + file.type + " -创建日期:" + file.creationdate +4      " -修改日期:" + file.modificationdate + " -文件状态:" + file.filestatus +5      " –错误代码:" + errorCode + " –错误描述:" + errorMsg + " –简要错误描述:" + errorString);6 }

●onUploadProgress上传进度发生变更时触发

1 function (file, bytesUploaded, bytesTotal, totalBytesUploaded, totalBytesTotal) {2     alert("当前文件已上传：" + bytesUploaded + "当前文件大小：" + bytesTotal +3     "队列已上传：" + totalBytesUploaded + "队列大小：" + totalBytesTotal);4 }

●onCancel在文件被移出上传队列时触发

1 function (file) {2     alert("id:" + file.id + " -索引:" + file.index + " -文件名称:" + file.name +3      " -文件大小:" + file.size + " -文件类型:" + file.type + " -创建日期:" + file.creationdate +4      " -修改日期:" + file.modificationdate + " -文件状态:" + file.filestatus);5 }

●onClearQueue在调用cancel方法且传入参数*时触发

1 function (queueItemCount) {2     alert("取消上传文件数量" + queueItemCount);3 }

1 <a href="javascript:$('#uploadify').uploadify('cancel','*')">取消上传</a>

●onDialogClose打开文件对话框关闭时触发

1 function (queue) {2     alert("选定的文件数：" + queue.filesSelected + "成功添加至队列的文件数：" + queue.filesQueued +3     "添加至队列发生错误的文件数：" + queue.filesErrored + "现有队列被替换文件数：" +4     queue.filesReplaced + "现有队列被取消文件数：" +5     queue.filesCancelled + "队列中的总文件数量：" + queue.Length);6 }

●onUploadStart每个文件上传开始时触发

1 function (file) {2     alert("id:" + file.id + " -索引:" + file.index + " -文件名称:" + file.name +3      " -文件大小:" + file.size + " -文件类型:" + file.type + " -创建日期:" + file.creationdate +4      " -修改日期:" + file.modificationdate + " -文件状态:" + file.filestatus);5 }

●onDialogOpen选择文件对话框打开时触发

1 function () {2     alert("打开");3 }

●onFallback没有兼容的flash时触发

1 function () {2     alert("flash不兼容");3 }

●onInit每次初始化一个队列时触发

1 function (instance) {2     alert(instance.settings.queueID);3 }

●onSelect选择文件后触发

1 function (file) {2     alert("id:" + file.id + " -索引:" + file.index + " -文件名称:" + file.name +3      " -文件大小:" + file.size + " -文件类型:" + file.type + " -创建日期:" + file.creationdate +4      " -修改日期:" + file.modificationdate + " -文件状态:" + file.filestatus);5 }

●onSelectError选择文件后出错时触发

1 function (file , errorCode, errorMsg ) {2     alert("id:" + file.id + " -索引:" + file.index + " -文件名称:" + file.name +3      " -文件大小:" + file.size + " -文件类型:" + file.type + " -创建日期:" + file.creationdate +4      " -修改日期:" + file.modificationdate + " -文件状态:" + file.filestatus +5      " –错误代码:" + errorCode + " –错误描述:" + errorMsg);6 }

3.方法

cancel、destroy、stop、upload用法一致，如：<a href="javascript:$('#uploadify').uploadify('upload','*')">上传</a>，其他方法视情况而定。