UEditor後端配置項說明

後端配置項說明

ueditor的配置項分爲兩類：前端配置項 和 後端配置項

前端配置項具體看這個文檔：前端配置項說明

本文檔介紹後端配置項的使用

參數配置

前後端的配置統一寫在後端(PHP版本的config在php/config.json)，編輯器實例化時，異步讀取後端配置信息，覆蓋到前端的配置裏。

各處配置優先級

後端獲取的配置項 > 實例化傳入的配置項 > ueditor.config.js文件的配置項。

讀取配置項

讀取配置項可以通過getOpt方法讀取

var lang = ue.getOpt('lang'); //默認返回：zh-cn

相關方法和事件

實例化的ue對象上有以下幾個方法：

• [方法]：loadServerConfig 執行這個方法，會向後端請求config

• [方法]：isServerConfigLoaded 判斷是否已加載後端config

• [方法]：afterConfigReady 加載後端配置項結束後會執行回調函數，假如已加載，立即執行該回調函數

• [事件]：serverConfigLoaded 加載後端配置項結束後，會觸發這個事件

配置項說明

1. 上傳圖片配置項

• imageActionName {String} [默認值："uploadimage"] //執行上傳圖片的action名稱,
• imageFieldName {String} [默認值："upfile"] //提交的圖片表單名稱
• imageMaxSize {Number} [默認值：2048000] //上傳大小限制，單位B
• imageAllowFiles {String} , //上傳圖片格式顯示

  //默認值：
  [".png", ".jpg", ".jpeg", ".gif", ".bmp"]

• imageCompressEnable {Boolean} [默認值：true] //是否壓縮圖片,默認是true
• imageCompressBorder {Number} [默認值：1600] //圖片壓縮最長邊限制
• imageInsertAlign {String} [默認值："none"] //插入的圖片浮動方式
• imageUrlPrefix {String} [默認值：""] //圖片訪問路徑前綴
• imagePathFormat {String} [默認值："/ueditor/php/upload/image/{yyyy}{mm}{dd}/{time}{rand:6}"] //上傳保存路徑,可以自定義保存路徑和文件名格式，上傳路徑配置

2. 塗鴉圖片上傳配置項

• scrawlActionName {String} [默認值："uploadscrawl"] //執行上傳塗鴉的action名稱
• scrawlFieldName {String} [默認值："upfile"] //提交的圖片表單名稱
• scrawlPathFormat {String} [默認值："/ueditor/php/upload/image/{yyyy}{mm}{dd}/{time}{rand:6}"] //上傳保存路徑,可以自定義保存路徑和文件名格式，上傳路徑配置
• scrawlMaxSize {Number} [默認值：2048000] //上傳大小限制，單位B
• scrawlUrlPrefix {String} [默認值：""] //圖片訪問路徑前綴
• scrawlInsertAlign {String} [默認值："none"]

3. 截圖工具上傳

• snapscreenActionName {String} [默認值："uploadimage"] //執行上傳截圖的action名稱
• snapscreenPathFormat {String} [默認值："/ueditor/php/upload/image/{yyyy}{mm}{dd}/{time}{rand:6}"] //上傳保存路徑,可以自定義保存路徑和文件名格式，上傳路徑配置
• snapscreenUrlPrefix {String} [默認值：""] //圖片訪問路徑前綴
• snapscreenInsertAlign {String} "none", //插入的圖片浮動方式

4. 抓取遠程圖片配置

• catcherLocalDomain {Array} 默認值：["127.0.0.1", "localhost", "img.baidu.com"]//例外的圖片抓取域名
• catcherActionName {String} [默認值："catchimage"] //執行抓取遠程圖片的action名稱
• catcherFieldName {String} [默認值："source"] //提交的圖片列表表單名稱
• catcherPathFormat {String} [默認值："/ueditor/php/upload/image/{yyyy}{mm}{dd}/{time}{rand:6}"] //上傳保存路徑,可以自定義保存路徑和文件名格式，上傳路徑配置
• catcherUrlPrefix {String} [默認值：""] //圖片訪問路徑前綴
• catcherMaxSize {Number} [默認值：2048000] //上傳大小限制，單位B
• catcherAllowFiles {Array}, //抓取圖片格式顯示

  //默認值：
  [".png", ".jpg", ".jpeg", ".gif", ".bmp"]

5. 上傳視頻配置

• videoActionName {String} [默認值："uploadvideo"] //執行上傳視頻的action名稱
• videoFieldName {String} [默認值："upfile"] //提交的視頻表單名稱
• videoPathFormat {String} [默認值："/ueditor/php/upload/video/{yyyy}{mm}{dd}/{time}{rand:6}"] //上傳保存路徑,可以自定義保存路徑和文件名格式，上傳路徑配置
• videoUrlPrefix {String} [默認值：""] //視頻訪問路徑前綴
• videoMaxSize {Number} [默認值：102400000] //上傳大小限制，單位B，默認100MB，注意修改服務器的大小限制
• videoAllowFiles {Array}, //上傳視頻格式顯示

  //默認值：
  [
      ".flv", ".swf", ".mkv", ".avi", ".rm", ".rmvb", ".mpeg", ".mpg", ".ogg", ".ogv", ".mov", ".wmv", ".mp4", ".webm", ".mp3", ".wav", ".mid"
  ]

6. 上傳文件配置

• fileActionName {String} [默認值："uploadfile"] //controller裏,執行上傳視頻的action名稱
• fileFieldName {String} [默認值："upfile"] //提交的文件表單名稱
• filePathFormat {String} [默認值："/ueditor/php/upload/file/{yyyy}{mm}{dd}/{time}{rand:6}"] //上傳保存路徑,可以自定義保存路徑和文件名格式，上傳路徑配置
• fileUrlPrefix {String} [默認值：""] //文件訪問路徑前綴
• fileMaxSize {Number} [默認值：51200000] //上傳大小限制，單位B，默認50MB，注意修改服務器的大小限制
• fileAllowFiles {Array}, //上傳文件格式顯示

  //默認值：
  [
      ".png", ".jpg", ".jpeg", ".gif", ".bmp",
      ".flv", ".swf", ".mkv", ".avi", ".rm", ".rmvb", ".mpeg", ".mpg",
      ".ogg", ".ogv", ".mov", ".wmv", ".mp4", ".webm", ".mp3", ".wav", ".mid",
      ".rar", ".zip", ".tar", ".gz", ".7z", ".bz2", ".cab", ".iso",
      ".doc", ".docx", ".xls", ".xlsx", ".ppt", ".pptx", ".pdf", ".txt", ".md", ".xml"
  ]

7. 列出指定目錄下的圖片

• imageManagerActionName {String} [默認值："listimage"] //執行圖片管理的action名稱
• imageManagerListPath {String} [默認值："/ueditor/php/upload/image/"] //指定要列出圖片的目錄
• imageManagerListSize {String} [默認值：20] //每次列出文件數量
• imageManagerUrlPrefix {String} [默認值：""] //圖片訪問路徑前綴
• imageManagerInsertAlign {String} [默認值："none"] //插入的圖片浮動方式
• imageManagerAllowFiles {Array}, //列出的文件類型

  //默認值：
  [".png", ".jpg", ".jpeg", ".gif", ".bmp"]

8. 列出指定目錄下的文件

• fileManagerActionName {String} [默認值："listfile"] //執行文件管理的action名稱
• fileManagerListPath {String} [默認值："/ueditor/php/upload/file/"] //指定要列出文件的目錄
• fileManagerUrlPrefix {String} [默認值：""] //文件訪問路徑前綴
• fileManagerListSize {String} [默認值：20] //每次列出文件數量
• fileManagerAllowFiles {Array} //列出的文件類型

  //默認值：
  [
      ".png", ".jpg", ".jpeg", ".gif", ".bmp",
      ".flv", ".swf", ".mkv", ".avi", ".rm", ".rmvb", ".mpeg", ".mpg",
      ".ogg", ".ogv", ".mov", ".wmv", ".mp4", ".webm", ".mp3", ".wav", ".mid",
      ".rar", ".zip", ".tar", ".gz", ".7z", ".bz2", ".cab", ".iso",
      ".doc", ".docx", ".xls", ".xlsx", ".ppt", ".pptx", ".pdf", ".txt", ".md", ".xml"
  ]