Uploadify在線中文手冊
說明:手冊由 九霄實驗室 @九霄云仙 基于Uploadify v3.2(Flash-Based Multiple File Uploader )翻譯。
在部署一個Uploadify實例前,請確保滿足最低要求:
1.jQuery 1.4.x 或更高版本
2.Flash Player 9.0.24 或更高版本
3.支持PHP, ASP.Net, Cold Fusion的服務器環境(官方默認支持PHP)
下載最新版本的uploadify,解壓到服務器根目錄下的uploadify文件夾中,你可以看到以下文件:
Change Log.txt(uploadify的升級日志,部署時刪掉)
check-exists.php(用來檢查上傳目標文件夾里是否存在相同文件)
index.php(官方實例)
jquery.uploadify.js(上傳插件)
jquery.uploadify.min.js(壓縮版的上傳插件,部署時使用)
license.txt(許可證文件,部署時刪掉)
uploadify.css(上傳控件樣式表)
uploadify.php(上傳數據處理文件)
uploadify.swf(flash基礎文件)
uploadify-cancel.png(取消按鈕圖片)
在官方提供的實例文件中,是引用的jquery官方網站上的jquery庫,有需要的朋友還需要本地引用jquery庫。
下面我們看一看如何在你的項目上部署uploadify:
1.我們假定上傳控件部署在網站根目錄下的upload.
php中,uploadify文件夾位于網站根目錄中,上傳的文件保存在根目錄下的upload文件夾中,uploadify文件夾中包含check-exists.php、jquery.min.js 、jquery.uploadify.min.js、uploadify.css、uploadify.swf、uploadify-cancel.png。
2.引用jquery庫
<script type="text/javascript" src="/uploadify/jquery.min.js"></script>
3.引用uploadify腳本
<script type="text/javascript" src="/uploadify /jquery.uploadify.min.js"></script>
4.引用uploadify樣式表
`<link rel="stylesheet" type="text/css" href="uploadify.css" />`
<link rel="stylesheet" type="text/css" href="uploadify.css" />
5. 聲明一個普通的html文件上傳控件,并指定id
<input id="file_upload" name="file_upload" type="file" multiple="true">
`<input id="file_upload" name="file_upload" type="file" multiple="true">`
6. 將聲明的普通上傳控件與Uploadify插件綁定,并初始化
~~~
<script type="text/javascript">
$(function() {
$('#file_upload').uploadify({
'swf' : '/uploadify/uploadify.swf', //指定上傳控件的主體文件
'uploader' : '/uploadify/uploadify.php' //指定服務器端上傳處理文件
//其他配置項
});
});
</script>
~~~
屬性
auto布爾型
設置auto為true,當文件被添加至上傳隊列時,將會自動上傳。
buttonClass字符串
為上傳按鈕添加類名。
buttonCursor字符串
鼠標經過上傳按鈕時,鼠標的形狀。可選值為‘hand’(手形) 和 ‘arrow’(箭頭)。
buttonImage字符串
定義“瀏覽”按鈕背景圖像的路徑。給按鈕設置背景圖像的代碼最好寫在CSS文件中。
buttonText字符串
定義顯示在默認按鈕上的文本。
checkExisting字符串
定義檢查目標文件夾中是否存在同名文件的腳本文件路徑。
debug布爾型
當其值為true時,開啟SWFUpload調試模式。
fileObjName字符串
定義上傳數據處理文件中接收數據使用的文件對象名。
fileSizeLimit整型
上傳文件大小限制。
fileTypeDesc字符串
可選擇的文件類型的描述。此字符串出現在瀏覽文件對話框的文件類型下拉菜單中。
fileTypeExts字符串
定義允許上傳的文件后綴。
formDataJSON對象
定義在文件上傳時需要一同提交的其他數據對象。
height整型
上傳按鈕的高度(單位:像素)。
itemTemplate布爾型
itemTemplate選項允許你為每一個添加到隊列中選項設定一個不同HTML模板。
method字符串
上傳文件的提交方法,取值'post'或'get'。
multi布爾型
設置值為false時,一次只能選中一個文件。
overrideEventsJSON
該項定義了一組默認腳本中你不想執行的事件名稱。
preventCaching布爾型
如果設置為真,一個隨機的值添加到SWF文件的URL,因此它不會緩存。
progressData字符串
設置顯示在上傳進度條中的數據類型,可選項時百分比(percentage)或速度(speed)。
queueID字符串
queueID選項允許你設置一個擁有唯一ID的DOM元素來作為顯示上傳隊列的容器。
queueSizeLimit整型
上傳隊列中一次可容納的最大條數。
removeCompleted布爾型
不設置該選項或者將其設置為false,將使上傳隊列中的項目始終顯示于隊列中,直到點擊了關閉按鈕或者隊列被清空。
removeTimeout整型
設置上傳完成后從上傳隊列中移除的時間(單位:秒)。
requeueErrors布爾型
設置為真時,上傳隊列重置或上傳多次重試時,返回錯誤信息。
successTimeout整型
表示uploadify的成功等待時間(單位:秒,默認30秒)。
swf字符串
定義uploadify.swf的路徑。
uploader字符串
定義服務器端上傳數據處理腳本文件uploadify.swf的路徑。
uploadLimit整型
定義允許的最大上傳數量。
width整型
定義瀏覽按鈕的寬度。
事件
onCancel函數
設置onCancel選項,在文件上傳被取消時,將允許運行一個自定義函數。
onClearQueue函數
設置onClearQueue選項,上傳隊列清空(激活ancel方法)時,將允許運行一個自定義函數。
onDestroy函數
銷毀Uploadify實例(調用destroy方法)時觸發該事件。
onDialogClose函數
當瀏覽文件對話框關閉時觸發該事件。如果該事件被添加到overrideEvents屬性中,在添加文件到隊列中發生錯誤時,將不會彈出默認錯誤信息。
onDialogOpen函數
在瀏覽文件對話框被打開前一瞬觸發該事件。
onDisable函數
調用disable方法禁用Uploadify實例時觸發該事件。
onEnable函數
調用disable方法啟用Uploadify實例時觸發該事件。
onFallback函數
瀏覽器檢測不到兼容版本的Flash時觸發該事件。
onInit函數
調用Uploadify初始化結束時觸發該事件。
onQueueComplete函數
隊列中的所有文件被處理完成時觸發該事件。
onSelect函數
每添加一個文件至上傳隊列時觸發該事件。
onSelectError函數
選擇文件返回錯誤時觸發該事件。每一個文件返回錯誤都會觸發該事件。
onSWFReady函數
當flash按鈕載入完畢時觸發該事件。
onUploadComplete函數
每一個文件上傳完成都會觸發該事件,不管是上傳成功還是上傳失敗。
onUploadError函數
上傳失敗時觸發該事件。
onUploadProgress函數
上傳進度更新時觸發該事件。
onUploadStart函數
在開始上傳之前的瞬間會觸發該事件。
onUploadSuccess函數
每一個文件上傳成功時觸發該事件。
方法
cancel
取消上傳對象。
destroy
銷毀Uploadify實例,并返回原文件域。
disable
控制瀏覽按鈕是否可用。
settings
返回或更新一個Uploadify實例的值。
stop
停止當前上傳。
upload
上傳指定文件或隊列中的所有文件。