Wiktor: Created page with '{{CKFinder_2.x_SSI_Warning}} == QuickUpload == Adds a file in a folder.
This command is pretty similar to the [[CKFinder/Server Side Integration/The Commands/FileUpload|File…'

2010-05-14T20:08:05Z

Created page with '{{CKFinder_2.x_SSI_Warning}} == QuickUpload == Adds a file in a folder. <br>This command is pretty similar to the [[CKFinder/Server Side Integration/The Commands/FileUpload|File…'

New page

{{CKFinder_2.x_SSI_Warning}}
== QuickUpload ==

Adds a file in a folder. <br>This command is pretty similar to the [[CKFinder/Server Side Integration/The Commands/FileUpload|FileUpload]] command. It is used by FCKeditor 2.x and CKEditor 3.x. There are some differences between data that is sent by FCKeditor and CKEditor (and expected response), please read documentation below carefully.

=== Sample Request ===

Upload a file in the root directory of the resource type “Files”.
<pre>connector.php?command=QuickUpload&type=Files&currentFolder=%2F</pre>
The request will be done using POST (instead of GET) and the data will encoded in “multipart/form-data”. Only one field will be posted, named '''“NewFile” (FCKeditor) or “upload” (CKEditor)''', containing the file uploaded data.

=== Response ===

This command doesn’t expect XML to be returned. Actually HTML must return with a <script> tag. The content type must be “text/html”. The JavaScript code expected by CKEditor and FCKeditor is different.

=== Sample Response (FCKeditor) ===
<pre><script type="text/javascript">
window.parent.OnUploadCompleted(0, '/ckfinder/userfiles/files/filename.txt', 'filename.txt', '')  ;
</script></pre>
<br>The "OnUploadCompleted" is a JavaScript function that is called to expose the upload result.

The possible values are:

* OnUploadCompleted( 0 , "/full/path/to/the/filename.txt", "filename.txt" ); : no errors found on the upload process.
* OnUploadCompleted( 1, "", "", "Reason" ); : the upload filed because of "Reason". Note: no paths being sent here, because uploading failed.
* OnUploadCompleted( 201 , "/full/path/to/the/filename.txt(1)", "filename.txt(1)" ); : the file has been uploaded successfully, but its name has been changed to "filename(1).ext".

Note that uploaded file names may contain non ASC-II chars.

=== Sample Response (CKEditor) ===

CKEditor sends some additional parameters when sending the QuickUpload command:
<pre>connector.php?command=QuickUpload&type=Images&currentFolder=%2F&CKEditor=editor1&CKEditorFuncNum=2&langCode=en</pre>
* CKEditor - the name of the CKEditor instance
* langCode - the current language code
* CKEditorFuncNum - a parameter to specify the callback function
(see: [[CKEditor_3.x/Developers_Guide/File_Browser_(Uploader)/Custom_File_Browser|Custom File Browser]])

There are no special error numbers in the callback function. Your script can return a url to use and a message to show to the user, both are optional so you can return just an URL that will be used in the dialog, or you can return a message that will be shown to the user, or a URL and a message (for example a warning that the file has been renamed and the new URL).

Thanks to the message and the "langCode" parameter you can use localized messages instead of having them in English.

<pre><script type='text/javascript'>window.parent.CKEDITOR.tools.callFunction(funcNum, fileUrl, message)</script></pre>

CKFinder 2.x/Server Side Integration/The Commands/QuickUpload - Revision history

Wiktor: Created page with '{{CKFinder_2.x_SSI_Warning}} == QuickUpload == Adds a file in a folder. This command is pretty similar to the [[CKFinder/Server Side Integration/The Commands/FileUpload|File…'

Wiktor: Created page with '{{CKFinder_2.x_SSI_Warning}} == QuickUpload == Adds a file in a folder.
This command is pretty similar to the [[CKFinder/Server Side Integration/The Commands/FileUpload|File…'