CKFinder 1.x/Developers Guide/PHP/Integration - Revision history

Admin: moved CKFinder/Developers Guide/PHP/Integration to CKFinder 1.x/Developers Guide/PHP/Integration

2010-05-28T06:46:33Z

moved CKFinder/Developers Guide/PHP/Integration to CKFinder 1.x/Developers Guide/PHP/Integration

Wiktor at 11:52, 18 January 2010

2010-01-18T11:52:58Z

Wiktor: /* Properties */

2008-12-15T18:23:40Z

‎Properties

Wiktor at 18:17, 15 December 2008

2008-12-15T18:17:50Z

Wiktor: /* Examples */

2008-12-15T17:51:27Z

‎Examples

Wiktor: /* Properties */

2008-12-15T17:48:37Z

‎Properties

Wiktor: /* JavaScript */

2008-12-15T17:48:04Z

‎JavaScript

Wiktor: /* Properties */

2008-12-15T17:40:37Z

‎Properties

Wiktor: /* Properties */

2008-12-15T17:31:26Z

‎Properties

Wiktor: /* Introduction */

2008-12-15T17:30:09Z

‎Introduction

@@ Line 10: / Line 10: @@
 {{Integration Javascript Example}}
 The example of creating CKFinder using a PHP class:
-<pre>
+<source lang="php">
 <?php
 $finder = new CKFinder() ;
@@ Line 18: / Line 18: @@
 $finder->Create() ;
 ?>
-</pre>
+</source>
 For a full working examples please refer to the "'''_samples'''" directory. Note that in both cases it is required to include the integration file (ckfinder.js or ckfinder.php) to have access to the CKFinder class.

← Older revision		Revision as of 18:23, 15 December 2008
Line 23:		Line 23:

	{{Integration Javascript}}		{{Integration Javascript}}
−
−	~~== Properties ==~~
−
−	~~To use CKFinder, both integration methods can be used.~~
−	~~Regardless of chosen method, the following properties are available in the CKFinder object in both cases:~~

	{{Integration Properties}}		{{Integration Properties}}

← Older revision		Revision as of 18:17, 15 December 2008
Line 1:		Line 1:
−	== Introduction ==	+	{{Integration Introduction\|language=PHP\|ext=php\|classext=php}}
−	~~Before reading this section, please read the [[CKFinder/Developers_Guide/~~PHP~~/Installation~~\|~~installation]] and [[CKFinder/Developers_Guide/PHP/Configuration~~\|~~configuration]] instructions and make sure that the examples located in the "_samples" directory are working correctly.~~
−
−	~~The "_samples" directory with examples contains two directories: "'''js'''" and "'''php'''".~~
−	* The "'''js'''" folder stores examples of launching CKFinder using the JavaScript code.
−	* The "'''php~~'''" folder stores examples of launching CKFinder using the PHP language.~~
−
−	~~The following files are used when either javascript or PHP method of launching CKFinder is used:~~
−
−	* ckfinder.js in case of JavaScript integration method,
−	* ckfinder.php in case of PHP integration method.

	=== Examples ===		=== Examples ===

@@ Line 18: / Line 18: @@
-The example of creating CKFinder using a javascript object:
+{{Integration Javascript Example}}
 The example of creating CKFinder using a PHP class:
 <pre>

← Older revision		Revision as of 17:48, 15 December 2008
Line 49:		Line 49:
	Regardless of chosen method, the following properties are available in the CKFinder object in both cases:		Regardless of chosen method, the following properties are available in the CKFinder object in both cases:

−	* '''BasePath''' - The URL path for the installation folder of CKFinder. Default value: "/ckfinder/".	+	{{Integration Properties}}
−	* '''Width''' - The CKFinder width (for example: 600, '80%'). Default value: "100%".
−	* '''Height''' - The CKFinder height (for example: 500, '100%'). Default value: 400.
−	* '''SelectFunction''' - An optional function to be called when the user selects a file in CKFinder.
−	* '''SelectFunctionData''' - An optional argument of type string that will be passed to the "SelectFunction". Please refer to the js/popups.html file for a usage example.
−	* '''SelectThumbnailFunction''' - An optional function to be called when the user selects a thumbnail in CKFinder. Default value: "SelectFunction" (if "SelectFunction" is set).
−	* '''SelectThumbnailFunctionData''' - An optional argument of type string that will be passed to the "SelectThumbnailFunction". Default values are:
−	** SelectFunctionData - when "SelectThumbnailFunction" is not set
−	** null - when "SelectThumbnailFunction" is defined.
−	* '''DisableThumbnailSelection''' - If set to true, "Select thumbnail" item will not appear in the context menu. Default value: false.
−	* '''StartupPath''' - Resource Type and the name of the startup folder, separated with a colon (for example: "Files:/", "Images:/cars/"). If defined, CKFinder will open the selected folder automatically.
−	* '''StartupFolderExpanded''' - Used only when "StartupPath" is set. If set to true, the initial folder will be opened automatically on startup.
−	* '''RememberLastFolder''' - If set to true, CKFinder will remember the last used folder in a cookie. In some cases, it may be required to store the name of last used folder in separate cookies for different CKFinder instances, in such case, assign the "Id" property (explained below). Default value: true.
−	* '''Id''' - Used to identify the CKFinder object, optional. If set, the "Id" variable will be passed to the server connector on each request. When "RememberLastFolder" is enabled and the "Id" is set, CKFinder will remember the last directory in a separate cookie.
−	* '''ClassName''' - The name of the CSS class rule assigned to the CKFinder frame. Default value: "CKFinderFrame".

← Older revision	Revision as of 06:46, 28 May 2010
(No difference)

@@ Line 42: / Line 42: @@
 For a full working examples please refer to the "'''_samples'''" directory. Note that in both cases it is required to include the integration file (ckfinder.js or ckfinder.php) to have access to the CKFinder class.
-==== JavaScript ====
+{{Integration Javascript}}
 == Properties ==

@@ Line 75: / Line 75: @@
 * '''Height''' - The CKFinder height (for example: 500, '100%'). Default value: 400.
 * '''SelectFunction''' - An optional function to be called when the user selects a file in CKFinder.
-* '''SelectFunctionData''' - An optional argument of type string that will be passed to the "SelectFunction".
+* '''SelectFunctionData''' - An optional argument of type string that will be passed to the "SelectFunction". Please refer to the js/popups.html file for a usage example.
-* '''SelectThumbnailFunction''' - An optional function to be called when the user selects a thumbnail in CKFinder. Default value: SelectFunction (if set).
+* '''SelectThumbnailFunction''' - An optional function to be called when the user selects a thumbnail in CKFinder. Default value: "SelectFunction" (if "SelectFunction" is set).
 * '''SelectThumbnailFunctionData''' - An optional argument of type string that will be passed to the "SelectThumbnailFunction". Default values are:
-** SelectFunctionData - when SelectThumbnailFunction is set to null
+** SelectFunctionData - when "SelectThumbnailFunction" is not set
-** null - when SelectThumbnailFunction is defined.
+** null - when "SelectThumbnailFunction" is defined.
 * '''DisableThumbnailSelection''' - If set to true, "Select thumbnail" item will not appear in the context menu. Default value: false.
 * '''StartupPath''' - Resource Type and the name of the startup folder, separated with a colon (for example: "Files:/", "Images:/cars/"). If defined, CKFinder will open the selected folder automatically.
-* '''StartupFolderExpanded''' - Used only when StartupPath is set. If set to true, the initial folder will be opened automatically on startup.
+* '''StartupFolderExpanded''' - Used only when "StartupPath" is set. If set to true, the initial folder will be opened automatically on startup.
-* '''RememberLastFolder''' - If set to true, CKFinder will remember the last used folder in a cookie. In some cases, it may be required to store the name of last used folder in a separate cookies for different CKFinder instances, in such case, assign the "Id property" (explained below). Default value: true.
+* '''RememberLastFolder''' - If set to true, CKFinder will remember the last used folder in a cookie. In some cases, it may be required to store the name of last used folder in separate cookies for different CKFinder instances, in such case, assign the "Id" property (explained below). Default value: true.
-* '''Id''' - Used to identify the CKFinder object, optional. If set, the Id variable will be passed to the server connector on each request. When RememberLastFolder is enabled and the "Id" is set, CKFinder will remember the last directory in a separate cookie.
+* '''Id''' - Used to identify the CKFinder object, optional. If set, the "Id" variable will be passed to the server connector on each request. When "RememberLastFolder" is enabled and the "Id" is set, CKFinder will remember the last directory in a separate cookie.
 * '''ClassName''' -  The name of the CSS class rule assigned to the CKFinder frame. Default value: "CKFinderFrame".

← Older revision		Revision as of 17:31, 15 December 2008
Line 86:		Line 86:
	* '''Id''' - Used to identify the CKFinder object, optional. If set, the Id variable will be passed to the server connector on each request. When RememberLastFolder is enabled and the "Id" is set, CKFinder will remember the last directory in a separate cookie.		* '''Id''' - Used to identify the CKFinder object, optional. If set, the Id variable will be passed to the server connector on each request. When RememberLastFolder is enabled and the "Id" is set, CKFinder will remember the last directory in a separate cookie.
	* '''ClassName''' - The name of the CSS class rule assigned to the CKFinder frame. Default value: "CKFinderFrame".		* '''ClassName''' - The name of the CSS class rule assigned to the CKFinder frame. Default value: "CKFinderFrame".
−
−	~~To use CKFinder, both integration methods can be used, however the javascript integration method is more powerful~~

@@ Line 8: / Line 8: @@
 The following files are used when either javascript or PHP method of launching CKFinder is used:
-* ckfinder.js in case of JavaScript integration method
+* ckfinder.js in case of JavaScript integration method,
-* ckfinder.php in case of PHP integration method
+* ckfinder.php in case of PHP integration method.
 === Examples ===