Contents
[hide]Introduction
Before reading this section, please read the installation and configuration instructions and make sure that the examples located in the _samples directory are working correctly.
The _samples directory contains HTML files with examples of launching CKFinder by using the JavaScript code as well as a php folder with examples of launching CKFinder by using the PHP language.
The following files are used when either the JavaScript or the PHP method of launching CKFinder is used:
-
ckfinder.jsin case of the JavaScript integration method, -
ckfinder_v1.jsin case of JavaScript V1 integration method (useful when migrating from CKFinder 1.x), -
ckfinder.phpin case of the PHP integration method.
Example
In order to launch CKFinder, you need to do three things:
- Create an instance of the
CKFinderclass. - Assign CKFinder properties.
- Call the
Create()method.
An example of creating CKFinder using a PHP class:
<?php
$finder = new CKFinder() ;
$finder->BasePath = '/ckfinder/' ;
$finder->SelectFunction = 'ShowFileInfo' ;
$finder->Width = 800 ;
$finder->Create() ;
?>
For a full working example please refer to the _samples directory of the installation package.
Integration methods
- JavaScript integration – the preferred integration method, simple yet powerful.
- JavaScript integration (V1) – the old "V1" way, useful when migrating from CKFinder 1.x because it makes it possible to reuse existing code.
- PHP integration – if you have not worked with JavaScript before or the JavaScript integration seems to be too complicated, it might be the way to go for you.