Plupload上传插件中文文档
Plupload上傳插件中文幫助文檔
如有疑問，加群交流：646104701
下載地址：https://www.plupload.com/download/
?
配置參數
實例化一個plupload對象時，也就是 new plupload.Uploader()，需要傳入一個對象作為配置參數。后面內容中出現的plupload實例均是指new plupload.Uploader()得到的實例對象
| String / DOM | ? | 觸發文件選擇對話框的DOM元素，當點擊該元素后便后彈出文件選擇對話框。該值可以是DOM元素對象本身，也可以是該DOM元素的id |
| String | ? | 服務器端接收和處理上傳文件的腳本地址，可以是相對路徑(相對于當前調用Plupload的文檔)，也可以是絕對路徑 |
| Object | { } | 可以使用該參數來限制上傳文件的類型，大小等，該參數以對象的形式傳入，它包括三個屬性：mime_types：用來限定上傳文件的類型，為一個數組，該數組的每個元素又是一個對象，該對象有title和extensions兩個屬性，title為該過濾器的名稱，extensions為文件擴展名，有多個時用逗號隔開。該屬性默認為一個空數組，即不做限制。 max_file_size：用來限定上傳文件的大小，如果文件體積超過了該值，則不能被選取。值可以為一個數字，單位為b,也可以是一個字符串，由數字和單位組成，如’200kb’ prevent_duplicates：是否允許選取重復的文件，為true時表示不允許，為false時表示允許，默認為false。如果兩個文件的文件名和大小都相同，則會被認為是重復的文件 filters完整的配置示例如下(當然也可以只配置其中的某一項)： filters: { mime_types : [ //只允許上傳圖片和zip文件 { title : "Image files", extensions : "jpg,gif,png" }, { title : "Zip files", extensions : "zip" } ], max_file_size : '400kb', //最大只能上傳400kb的文件 prevent_duplicates : true //不允許選取重復文件 } |
| Object | ? | 設置上傳時的自定義頭信息，以鍵/值對的形式傳入，鍵代表頭信息屬性名，鍵代表屬性值。html4上傳方式不支持設置該屬性。 |
| Boolean | true | 為true時將以multipart/form-data的形式來上傳文件，為false 時則以二進制的格式來上傳文件。html4上傳方式不支持以二進制格式來上傳文件，在flash上傳方式中，二進制上傳也有點問題。并且二進制格式上傳還 需要在服務器端做特殊的處理。一般我們用multipart/form-data的形式來上傳文件就足夠了。 |
| Object | ? | 上傳時的附加參數，以鍵/值對的形式傳入，服務器端可是使用$_POST來獲取這些參數(以php為例)。比如： multipart_params: { one: '1', two: '2', three: { //值還可以是一個字面量對象 a: '4', b: '5' }, four: ['6', '7', '8'] //也可以是一個數組 } |
| Number | 0 | 當發生plupload.HTTP_ERROR錯誤時的重試次數，為0時表示不重試 |
| Number/String | 0 | 分片上傳文件時，每片文件被切割成的大小，為數字時單位為字節。也可以使用一個帶單位的字符串，如"200kb"。當該值為0時表示不使用分片上傳功能 |
| Object | ? | 可以使用該參數對將要上傳的圖片進行壓縮，該參數是一個對象，里面包括5個屬性：width：指定壓縮后圖片的寬度，如果沒有設置該屬性則默認為原始圖片的寬度 height：指定壓縮后圖片的高度，如果沒有設置該屬性則默認為原始圖片的高度 crop：是否裁剪圖片 quality：壓縮后圖片的質量，只對jpg格式的圖片有效，默認為90。quality可以跟width和height一起使用，但也可以單獨使用，單獨使用時，壓縮后圖片的寬高不會變化，但由于質量降低了，所以體積也會變小 preserve_headers：壓縮后是否保留圖片的元數據，true為保留，false為不保留,默認為true。刪除圖片的元數據能使圖片的體積減小一點點 resize參數的配置示例如下： resize: { width: 100, height: 100, crop: true, quality: 60, preserve_headers: false } |
| DOM/String/Array | ? | 指定了使用拖拽方式來選擇上傳文件時的拖拽區域，即可以把文件拖拽到這個區域的方式來選擇文件。該參數的值可以為一個DOM元素的id,也可是 DOM元素本身，還可以是一個包括多個DOM元素的數組。如果不設置該參數則拖拽上傳功能不可用。目前只有html5上傳方式才支持拖拽上傳。 |
| Boolean | true | 是否可以在文件瀏覽對話框中選擇多個文件，true為可以，false為不可以。默認true，即可以選擇多個文件。需要注意的是，在某些不支持 多選文件的環境中，默認值是false。比如在ios7的safari瀏覽器中，由于存在bug，造成不能多選文件。當然，在html4上傳方式中，也是 無法多選文件的。 |
| Mix | ? | 可以使用該參數來設置你必須需要的一些功能特征，Plupload會根據你的設置來選擇合適的上傳方式。因為，不同的上傳方式，支持的功能是不同 的，比如拖拽上傳只有html5上傳方式支持，圖片壓縮則只有html5,flash,silverlight上傳方式支持。該參數的值是一個混合類型， 可以是一個以逗號分隔的字符串， |
| Boolean | false | 當值為true時會為每個上傳的文件生成一個唯一的文件名，并作為額外的參數post到服務器端，參數明為name,值為生成的文件名。 |
| String | html5,flash, silverlight, html4 | 用來指定上傳方式，指定多個上傳方式請使用逗號隔開。一般情況下，你不需要配置該參數，因為Plupload默認會根據你的其他的參數配置來選擇 最合適的上傳方式。如果沒有特殊要求的話，Plupload會首先選擇html5上傳方式，如果瀏覽器不支持html5，則會使用flash或 silverlight，如果前面兩者也都不支持，則會使用最傳統的html4上傳方式。如果你想指定使用某個上傳方式，或改變上傳方式的優先順序，則你 可以配置該參數。 |
| String | file | 指定文件上傳時文件域的名稱，默認為file,例如在php中你可以使用$_FILES['file']來獲取上傳的文件信息 |
| DOM/String | ? | 用來指定Plupload所創建的html結構的父容器，默認為前面指定的browse_button的父元素。該參數的值可以是一個元素的id,也可以是DOM元素本身。 |
| String | js/Moxie.swf | flash上傳組件的url地址，如果是相對路徑，則相對的是調用Plupload的html文檔。當使用flash上傳方式會用到該參數。 |
| String | js/Moxie.xap | silverlight上傳組件的url地址，如果是相對路徑，則相對的是調用Plupload的html文檔。當使用silverlight上傳方式會用到該參數。 |
?
各種事件說明
要了解plupload的運行狀況，靠的就是在這些事件了
| 當Plupload初始化完成后觸發監聽函數參數：(uploader) uploader為當前的plupload實例對象 |
| 當Init事件發生后觸發監聽函數參數：(uploader) uploader為當前的plupload實例對象 |
| 當使用Plupload實例的setOption()方法改變當前配置參數后觸發監聽函數參數：(uploader,option_name,new_value,old_value) uploader為當前的plupload實例對象，option_name為發生改變的參數名稱，new_value為改變后的值，old_value為改變前的值 |
| 當調用plupload實例的refresh()方法后會觸發該事件，暫時不清楚還有什么其他動作會觸發該事件，但據我測試，把文件添加到上傳隊列后也會觸發該事件。監聽函數參數：(uploader) uploader為當前的plupload實例對象 |
| 當上傳隊列的狀態發生改變時觸發監聽函數參數：(uploader) uploader為當前的plupload實例對象 |
| 當上傳隊列中某一個文件開始上傳后觸發監聽函數參數：(uploader,file) uploader為當前的plupload實例對象，file為觸發此事件的文件對象 |
| 當隊列中的某一個文件正要開始上傳前觸發監聽函數參數：(uploader,file) uploader為當前的plupload實例對象，file為觸發此事件的文件對象 |
| 當上傳隊列發生變化后觸發，即上傳隊列新增了文件或移除了文件。QueueChanged事件會比FilesAdded或FilesRemoved事件先觸發監聽函數參數：(uploader) uploader為當前的plupload實例對象 |
| 會在文件上傳過程中不斷觸發，可以用此事件來顯示上傳進度監聽函數參數：(uploader,file) uploader為當前的plupload實例對象，file為觸發此事件的文件對象 |
| 當文件從上傳隊列移除后觸發監聽函數參數：(uploader,files) uploader為當前的plupload實例對象，files為一個數組，里面的元素為本次事件所移除的文件對象 |
| 暫不清楚該事件的意義，但根據測試得出，該事件會在每一個文件被添加到上傳隊列前觸發監聽函數參數：(uploader,file) uploader為當前的plupload實例對象，file為觸發此事件的文件對象 |
| 當文件添加到上傳隊列后觸發監聽函數參數：(uploader,files) uploader為當前的plupload實例對象，files為一個數組，里面的元素為本次添加到上傳隊列里的文件對象 |
| 當隊列中的某一個文件上傳完成后觸發監聽函數參數：(uploader,file,responseObject) uploader為當前的plupload實例對象，file為觸發此事件的文件對象，responseObject為服務器返回的信息對象，它有以下3個屬性： response：服務器返回的文本 responseHeaders：服務器返回的頭信息 status：服務器返回的http狀態碼，比如200 |
| 當使用文件小片上傳功能時，每一個小片上傳完成后觸發監聽函數參數：(uploader,file,responseObject) uploader為當前的plupload實例對象，file為觸發此事件的文件對象，responseObject為服務器返回的信息對象，它有以下5個屬性： offset：該文件小片在整體文件中的偏移量 response：服務器返回的文本 responseHeaders：服務器返回的頭信息 status：服務器返回的http狀態碼，比如200 total：該文件(指的是被切割成了許多文件小片的那個文件)的總大小，單位為字節 |
| 當上傳隊列中所有文件都上傳完成后觸發監聽函數參數：(uploader,files) uploader為當前的plupload實例對象，files為一個數組，里面的元素為本次已完成上傳的所有文件對象 |
| 當發生錯誤時觸發監聽函數參數：(uploader,errObject) uploader為當前的plupload實例對象，errObject為錯誤對象，它至少包含以下3個屬性(因為不同類型的錯誤，屬性可能會不同)： code：錯誤代碼，具體請參考plupload上定義的表示錯誤代碼的常量屬性 file：與該錯誤相關的文件對象 message：錯誤信息 |
| 當調用destroy方法時觸發監聽函數參數：(uploader) uploader為當前的plupload實例對象 |
?
Plupload實例的屬性
| Plupload實例的唯一標識id |
| 當前的上傳狀態，可能的值為plupload.STARTED或plupload.STOPPED，該值由Plupload實例的stop()或statr()方法控制。默認為plupload.STOPPED |
| 當前使用的上傳方式 |
| 當前的上傳隊列，是一個由上傳隊列中的文件對象組成的數組 |
| 當前的配置參數對象 |
| 表示總體進度信息的QueueProgress對象 |
四、Plupload實例的方法
| 初始化Plupload實例 |
| 設置某個特定的配置參數,option為參數名稱，value為要設置的參數值。option也可以為一個由參數名和參數值鍵/值對組成的對象，這樣就可以一次設定多個參數，此時該方法的第二個參數value會被忽略。 |
| 獲取當前的配置參數，參數option為需要獲取的配置參數名稱，如果沒有指定option，則會獲取所有的配置參數 |
| 刷新當前的plupload實例，暫時還不明白什么時候需要使用 |
| 開始上傳隊列中的文件 |
| 停止隊列中的文件上傳 |
| 禁用或啟用plupload的文件瀏覽按鈕,參數disable為true時為禁用，為false時為啟用。默認為true |
| 通過id來獲取文件對象 |
| 向上傳隊列中添加文件，如果成功添加了文件，會觸發FilesAdded事件。參數file為要添加的文件,可以是一個原生的文件,或者一個plupload文件對象,或者一個input[type="file"]元素,還可以是一個包括前面那幾種東西的數組；fileName為給該文件指定的名稱 |
| 從上傳隊列中移除文件，參數file為plupload文件對象或先前指定的文件名稱 |
| 從上傳隊列中移除一部分文件，start為開始移除文件在隊列中的索引，length為要移除的文件的數量，該方法的返回值為被移除的文件。該方法會觸發FilesRemoved 和QueueChanged事件 |
| 觸發某個事件。name為要觸發的事件名稱，Multiple為傳給該事件監聽函數的參數，是一個對象 |
| 用來判斷某個事件是否有監聽函數，name為事件名稱 |
| 給某個事件綁定監聽函數，name為事件名，func為監聽函數，scope為監聽函數的作用域，也就是監聽函數中this的指向 |
| 移除事件的監聽函數，name為事件名稱，func為要移除的監聽函數 |
| 移除所有事件的所有監聽函數 |
| 銷毀plupload實例 |
?
文件對象的屬性和方法
在很多事件監聽函數中，都會提供文件對象給你
| 文件id |
| 文件名，例如”myfile.gif” |
| 文件類型，例如”image/jpeg” |
| 文件大小，單位為字節，當啟用了客戶端壓縮功能后，該值可能會改變 |
| 文件的原始大小，單位為字節 |
| 文件已上傳部分的大小，單位為字節 |
| 文件已上傳部分所占的百分比，如50就代表已上傳了50% |
| 文件的狀態，可能為以下幾個值之一：plupload.QUEUED, plupload.UPLOADING, plupload.FAILED, plupload.DONE |
| 文件最后修改的時間 |
| 獲取原生的文件對象 |
| 獲取mOxie.File 對象，想了解mOxie是什么東西，可以看下https://github.com/moxiecode/moxie/wiki/API |
| 銷毀文件對象 |
?
QueueProgress 對象的屬性
plupload實例的total屬性是一個QueueProgress對象
| 上傳隊列中所有文件加起來的總大小，單位為字節 |
| 隊列中當前已上傳文件加起來的總大小,單位為字節 |
| 已完成上傳的文件的數量 |
| 上傳失敗的文件數量 |
| 隊列中剩下的(也就是除開已經完成上傳的文件)需要上傳的文件數量 |
| 整個隊列的已上傳百分比，如50就代表50% |
| 上傳速率，單位為 byte/s，也就是 字節/秒 |
?
Plupload命名空間上的屬性
Plupload的命名空間上有一些屬性，用來表示一些常量。記住，不是plupload實例的屬性，而是plupload的屬性
?
| 當前plupload的版本號 |
| 值為1，代表上傳隊列還未開始上傳或者上傳隊列中的文件已經上傳完畢時plupload實例的state屬性值 |
| 值為2，代表隊列中的文件正在上傳時plupload實例的state屬性值 |
| 值為1，代表某個文件已經被添加進隊列等待上傳時該文件對象的status屬性值 |
| 值為2，代表某個文件正在上傳時該文件對象的status屬性值 |
| 值為4，代表某個文件上傳失敗后該文件對象的status屬性值 |
| 值為5，代表某個文件上傳成功后該文件對象的status屬性值 |
| 值為-100，發生通用錯誤時的錯誤代碼 |
| 值為-200，發生http網絡錯誤時的錯誤代碼，例如服務氣端返回的狀態碼不是200 |
| 值為-300，發生磁盤讀寫錯誤時的錯誤代碼，例如本地上某個文件不可讀 |
| 值為-400，發生因為安全問題而產生的錯誤時的錯誤代碼 |
| 值為-500，初始化時發生錯誤的錯誤代碼 |
| 值為-600，當選擇的文件太大時的錯誤代碼 |
| 值為-601，當選擇的文件類型不符合要求時的錯誤代碼 |
| 值為-602，當選取了重復的文件而配置中又不允許有重復文件時的錯誤代碼 |
| 值為-700，發生圖片格式錯誤時的錯誤代碼 |
| 當發生內存錯誤時的錯誤代碼 |
| 值為-702，當文件大小超過了plupload所能處理的最大值時的錯誤代碼 |
轉載于:https://www.cnblogs.com/phpyangbo/p/8441066.html
總結
以上是生活随笔為你收集整理的Plupload上传插件中文文档的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 个人小软件冲刺01
- 下一篇： 3ds Max制作一面飘扬的旗帜效果图