| (2 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
To load CKFinder, we need to include a CKFinder class definition first. | To load CKFinder, we need to include a CKFinder class definition first. | ||
| − | Supposing that you have [[CKFinder_2.x/Developers_Guide/ | + | Supposing that you have [[CKFinder_2.x/Developers_Guide/PHP/Installation|installed]] CKFinder at the "ckfinder" directory at the root of your web site, here you have an example: |
<source language="php"> | <source language="php"> | ||
<?php | <?php | ||
| + | // Make sure you're using correct path here | ||
require_once 'ckfinder/ckfinder.php'; | require_once 'ckfinder/ckfinder.php'; | ||
?> | ?> | ||
| Line 27: | Line 28: | ||
</source> | </source> | ||
(put this code anywhere inside of the <code><body></code> tag). For an example please check the standalone sample distributed with CKFinder (_samples/php/standalone.php). | (put this code anywhere inside of the <code><body></code> tag). For an example please check the standalone sample distributed with CKFinder (_samples/php/standalone.php). | ||
| + | |||
| + | {{CKFinder_2.x V1 Integration Properties}} | ||
| + | {{#CUSTOMTITLE:PHP Integration}} | ||
Latest revision as of 15:05, 17 May 2010
Contents
PHP integration
The PHP integration method might be useful if you haven't worked with JavaScript before or the JavaScript integration seems to be too complicated.
Step 1: Loading CKFinder
To load CKFinder, we need to include a CKFinder class definition first.
Supposing that you have installed CKFinder at the "ckfinder" directory at the root of your web site, here you have an example:
<?php // Make sure you're using correct path here require_once 'ckfinder/ckfinder.php'; ?>
With the above file loaded, the CKFinder class is ready to be used.
Step 2: Creating an Application Instance
Next thing to do, to have the CKFinder up & running, is creating an application instance:
<?php $finder = new CKFinder(); $finder->BasePath = '/ckfinder/'; $finder->Create(); ?>
(put this code anywhere inside of the <body> tag). For an example please check the standalone sample distributed with CKFinder (_samples/php/standalone.php).
Properties
The following properties are available in the CKFinder object:
- BasePath - The URL path for the installation folder of CKFinder. Default value: "/ckfinder/".
- 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".
- DisableThumbnailSelection - If set to true, "Select thumbnail" item will not appear in the context menu. Default value: false.
- ResourceType - Resource type to display. By default CKFinder displays all available resource types. If ResourceType property is set, CKFinder will display only specified resource type (e.g. "Files", "Images").
- 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".