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

Anna: Article contents proof-read and formatted

2012-05-29T10:16:55Z

Article contents proof-read and formatted

Show changes

J.swiderski at 13:20, 28 May 2012

2012-05-28T13:20:06Z

J.swiderski at 13:13, 28 May 2012

2012-05-28T13:13:43Z

J.swiderski at 12:58, 28 May 2012

2012-05-28T12:58:48Z

Wiktor: Created page with '{{CKFinder_2.x_SSI_Warning}} == FileUpload == Adds a file in a folder. It generates a POST === Sample Request === Upload a file in the root directory of the resource type “F…'

2010-05-14T20:07:41Z

Created page with '{{CKFinder_2.x_SSI_Warning}} == FileUpload == Adds a file in a folder. It generates a POST === Sample Request === Upload a file in the root directory of the resource type “F…'

New page

{{CKFinder_2.x_SSI_Warning}}
== FileUpload ==

Adds a file in a folder. It generates a POST

=== Sample Request ===

Upload a file in the root directory of the resource type “Files”.
<pre>connector.php?command=FileUpload&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”, containing the file uploaded data.

=== Sample Response ===
<pre><script type="text/javascript">
window.parent.OnUploadCompleted( 0, '' ) ;
</script></pre>

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 "OnUploadCompleted" is a JavaScript function that is called to expose the upload result.

The possible values are:

* OnUploadCompleted( 0 ) : no errors found on the upload process.
* OnUploadCompleted( 1, 'Reason' ) : the upload filed because of "Reason".
* OnUploadCompleted( 201, 'FileName(1).ext' ) : the file has been uploaded successfully, but its name has been changed to "FileName(1).ext".
* OnUploadCompleted( 202 ) : invalid file.

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

← Older revision		Revision as of 13:20, 28 May 2012
Line 82:		Line 82:
	<strong style="font-size:14px;color:#000000;">3. The Request Contains the <code>CKFinderFuncNum</code> Parameter</strong>		<strong style="font-size:14px;color:#000000;">3. The Request Contains the <code>CKFinderFuncNum</code> Parameter</strong>

−	<note>This method is currently not being used by core CKFinder. It was introduced in version 2.0 in order to allow custom dialog windows created for CKFinder for uploading files (Please note that such dialog windows should use file elements - [http://docs.cksource.com/ckfinder_2.x_api/symbols/CKFinder.dialog.definition.file.html please see]	+	<note>This method is currently not being used by core CKFinder. It was introduced in version 2.0 in order to allow custom dialog windows created for CKFinder for uploading files (Please note that such dialog windows should use file elements - [http://docs.cksource.com/ckfinder_2.x_api/symbols/CKFinder.dialog.definition.file.html please see]</note>
−	</note>

@@ Line 24: / Line 24: @@
 ===Available Response Structures:===
-====1. A request contains the <code>response_type=txt</code> parameter====
+<strong style="font-size:14px;color:#000000;">1. A request contains the <code>response_type=txt</code> parameter</strong>
-<b>This is the response method used by CKFinder for HTML5 and Flash uploads.</b> It was introduced in CKFinder 2.1. Anyone using a custom server-side connector should adjust the code to use this method.
+<strong>This is the response method used by CKFinder for HTML5 and Flash uploads.</strong> It was introduced in CKFinder 2.1. Anyone using a custom server-side connector should adjust the code to use this method.
-<b>Sample request:</b>
+<strong>Sample request:</strong>
 <pre>connector.php?command=FileUpload&type=Files&currentFolder=%2F&response_type=txt&langCode=en</pre>
-<b>Sample response:</b>
+<strong>Sample response:</strong>
 <pre>
 testName.png|
@@ Line 41: / Line 41: @@
 Some example values:
-*	<b>testName.png|</b> &ndash; no errors found during the upload process. The response consists of the file name and the pipe character with no error message to follow.
+*	<strong>testName.png|</strong> &ndash; no errors found during the upload process. The response consists of the file name and the pipe character with no error message to follow.
-*	<b>|Invalid file. The file size is too big.</b> &ndash; the file was not uploaded (we do not have its name), but the error was reported and can be returned to the client.
+*	<strong>|Invalid file. The file size is too big.</strong> &ndash; the file was not uploaded (we do not have its name), but the error was reported and can be returned to the client.
-*	 <b>testName(1).png| A file with the same name is already available. The uploaded file was renamed to "testName(1).png</b> &ndash;  the file was uploaded, but an unexpected condition has occurred so the error message is returned as well.
+*	 <strong>testName(1).png| A file with the same name is already available. The uploaded file was renamed to "testName(1).png</strong> &ndash;  the file was uploaded, but an unexpected condition has occurred so the error message is returned as well.
@@ Line 53: / Line 53: @@
-====2. Response Structure for Simple HTML Uploads====
+<strong style="font-size:14px;color:#000000;">2. Response Structure for Simple HTML Uploads</strong>
 This method is used for old browsers that do not support HTML5, where Flash cannot be installed for some reason and the only way to upload a file is to use the old classic HTML4 upload method.
-<b>Sample request:</b>
+<strong>Sample request:</strong>
 <pre>connector.php?command=FileUpload&type=Files&currentFolder=%2F&langCode=en</pre>
-<b>Sample response:</b>
+<strong>Sample response:</strong>
 <pre>
 <script type="text/javascript">
@@ Line 71: / Line 71: @@
 Some example values:
-*	<b>OnUploadCompleted( 0 )</b> &ndash; no errors found during the upload process.
+*	<strong>OnUploadCompleted( 0 )</strong> &ndash; no errors found during the upload process.
-*	<b>OnUploadCompleted( 1, 'Reason' )</b> &ndash; the upload failed because of the reason given.
+*	<strong>OnUploadCompleted( 1, 'Reason' )</strong> &ndash; the upload failed because of the reason given.
-*	<b>OnUploadCompleted( 201, 'FileName(1).ext' )</b> &ndash; the file was uploaded successfully, but its name was changed to "FileName(1).ext".
+*	<strong>OnUploadCompleted( 201, 'FileName(1).ext' )</strong> &ndash; the file was uploaded successfully, but its name was changed to "FileName(1).ext".
-*	<b>OnUploadCompleted( 202 )</b>  &ndash; invalid file.
+*	<strong>OnUploadCompleted( 202 )</strong>  &ndash; invalid file.
@@ Line 80: / Line 80: @@
 Note that if this method is used, the content type must be <code>text/html</code>.
-====3. The Request Contains the <code>CKFinderFuncNum</code> Parameter====
+<strong style="font-size:14px;color:#000000;">3. The Request Contains the <code>CKFinderFuncNum</code> Parameter</strong>
 <note>This method is currently not being used by core CKFinder. It was introduced in version 2.0 in order to allow custom dialog windows created for CKFinder for uploading files (Please note that such dialog windows should use file elements - [http://docs.cksource.com/ckfinder_2.x_api/symbols/CKFinder.dialog.definition.file.html please see]
@@ Line 86: / Line 86: @@
-<b>Sample request:</b>
+<strong>Sample request:</strong>
 <pre>connector.php?command=FileUpload&type=Files&currentFolder=%2F&CKFinderFuncNum=2&langCode=en</pre>
-CKFinderFuncNum  &ndash; It is an automatically generated parameter that stores anonymous callback function reference number (random value) used to pass the URL (fileUrl)  and/or error message (message).
+<strong>CKFinderFuncNum</strong>  &ndash; It is an automatically generated parameter that stores anonymous callback function reference number (random value) used to pass the URL (fileUrl)  and/or error message (message).
-<b>Sample response:</b>
+<strong>Sample response:</strong>
 <pre>
 <script type='text/javascript'>window.parent.CKFINDER.tools.callFunction(funcNum, fileUrl, message)</script>
 </pre>
-*	<b>funcNum</b> &ndash; this is the CKFinderFuncNum parameter that was sent in a request.
+*	<strong>funcNum</strong> &ndash; this is the CKFinderFuncNum parameter that was sent in a request.
-*	<b>fileUrl</b> &ndash; the URL to the uploaded file (optional). If the file was not uploaded, this argument remains empty.
+*	<strong>fileUrl</strong> &ndash; the URL to the uploaded file (optional). If the file was not uploaded, this argument remains empty.
-*	<b>message</b> &ndash; the error message (optional).
+*	<strong>message</strong> &ndash; the error message (optional).

@@ Line 3: / Line 3: @@
 Adds a file in a folder. It generates a POST
 === Sample Request ===
-Upload a file in the root directory of the resource type “Files”.
+Upload a file to the root directory of the <code>Files</code> resource type.
-<pre>connector.php?command=FileUpload&amp;type=Files&amp;currentFolder=%2F</pre>
+<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”, containing the file uploaded data.
+connector.php?command=FileUpload&type=Files&currentFolder=%2F&response_type=txt&langCode=en
 === Sample Response ===
-<pre>&lt;script type="text/javascript"&gt;
+The response depends on upload method used and parameters that were sent in the request. There are three types of responses that can be sent from the server to the client.
- window.parent.OnUploadCompleted( 0, '' )&nbsp;;
-&lt;/script&gt;</pre>
+===Available Response Structures:===
-The possible values are:
+There are no special error numbers given in the callback function. Your script can return a URL to use and a message to show to the user &mdash; both are optional, so you can just return a URL that will be used in the dialog window, 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 was renamed along with the new URL).
-* OnUploadCompleted( 0 )&nbsp;: no errors found on the upload process.
+Thanks to the <code>langCode</code> parameter in the request you can use localized messages instead of having them in English.
-* OnUploadCompleted( 1, 'Reason' )&nbsp;: the upload filed because of "Reason".
+Note that if this method is used, the content type must be <code>text/html</code>.
-Note that uploaded file names may contain non ASC-II chars.
+The following code shows how to send back the URL of the uploaded file from the PHP connector: