CKFinder 2.x/Developers Guide/PHP/CKEditor Integration - Revision history

Anna at 09:47, 18 February 2013

2013-02-18T09:47:02Z

Anna: Switched JavaScript and PHP integration methods as PHP is not available for v4

2013-02-04T14:18:57Z

Switched JavaScript and PHP integration methods as PHP is not available for v4

Anna: Article contents proof-read and formatted

2011-04-21T10:02:49Z

Article contents proof-read and formatted

Wiktor at 10:25, 19 May 2010

2010-05-19T10:25:42Z

Wiktor at 07:32, 17 May 2010

2010-05-17T07:32:46Z

Wiktor: Created page with '= PHP = As of CKFinder 1.4.2 and CKEditor 3.1 it is possible to integrate CKFinder with CKEditor using PHP API. == SetupCKEditor == The static function '''SetupCKEditor()''' a…'

2010-05-14T19:42:44Z

Created page with '= PHP = As of CKFinder 1.4.2 and CKEditor 3.1 it is possible to integrate CKFinder with CKEditor using PHP API. == SetupCKEditor == The static function '''SetupCKEditor()''' a…'

New page

= PHP =

As of CKFinder 1.4.2 and CKEditor 3.1 it is possible to integrate CKFinder with CKEditor using PHP API.

== SetupCKEditor ==

The static function '''SetupCKEditor()''' accepts four arguments:

SetupCKEditor( $editorObj [, $basePath, $imageType, $flashType] )

* <code>editorObj</code> - CKEditor class instance.
* <code>basePath</code> - The path where CKFinder is installed (optional, default value: "/ckfinder/").
* <code>imageType</code> - Name of the resource type that should be used when CKFinder is launched from the Image dialog (optional).
* <code>flashType</code> - Name of the resource type that should be used when CKFinder is launched from the Flash dialog (optional).

==== Example 1 ====

<source lang="php">
<?php
// Make sure you're using correct paths here
include_once 'ckeditor/ckeditor.php';
include_once 'ckfinder/ckfinder.php';

$ckeditor = new CKEditor();
$ckeditor->basePath = '/ckeditor/';
CKFinder::SetupCKEditor($ckeditor, '/ckfinder/');
$ckeditor->editor('CKEditor1');
</source>

== SetupCKEditorObject ==

The '''SetupCKEditorObject()''' method accepts three arguments:

SetupCKEditorObject( $editorObj [, $imageType, $flashType] )

* <code>editorObj</code> - CKEditor class instance.
* <code>imageType</code> - Name of the resource type that should be used when CKFinder is launched from the Image dialog (optional).
* <code>flashType</code> - Name of the resource type that should be used when CKFinder is launched from the Flash dialog (optional).

==== Example 2 ====

<source lang="php">
<?php
// Make sure you're using correct paths here
include_once 'ckeditor/ckeditor.php';
include_once 'ckfinder/ckfinder.php';

$ckeditor = new CKEditor();
$ckeditor->basePath = '/ckeditor/';
$ckfinder = new CKFinder();
$ckfinder->BasePath = '/ckfinder/'; // Note: BasePath property in CKFinder class starts with capital letter
$ckfinder->SetupCKEditorObject($ckeditor);
$ckeditor->editor('CKEditor1');
</source>

== Manual integration ==

To instead configure CKEditor manually to use CKFinder, pass additional file browser configuration settings to the config property of the CKEditor instance:

==== Example 3 ====

<source lang="php">
<?php
// Make sure you're using correct path here
include_once 'ckeditor/ckeditor.php';

$ckeditor = new CKEditor();
$ckeditor->basePath = '/ckeditor/';
$ckeditor->config['filebrowserBrowseUrl'] = '/ckfinder/ckfinder.html';
$ckeditor->config['filebrowserImageBrowseUrl'] = '/ckfinder/ckfinder.html?type=Images';
$ckeditor->config['filebrowserFlashBrowseUrl'] = '/ckfinder/ckfinder.html?type=Flash';
$ckeditor->config['filebrowserUploadUrl'] = '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Files';
$ckeditor->config['filebrowserImageUploadUrl'] = '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Images';
$ckeditor->config['filebrowserFlashUploadUrl'] = '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Flash';
$ckeditor->editor('CKEditor1');
</source>

= JavaScript =
{{CKFinder_2.x CKEditor Integration|ext=php}}

@@ Line 2: / Line 2: @@
 {{CKFinder_2.x CKEditor Integration|ext=php|language=PHP}}
-= PHP =
+= PHP (CKEditor 3.x only) =
 CKFinder comes with built-in API to easily integrate it with [http://ckeditor.com CKEditor]. Check the <code>_samples</code> folder for more detailed examples.

@@ Line 1: / Line 1: @@
 = PHP =
 CKFinder comes with built-in API to easily integrate it with [http://ckeditor.com CKEditor]. Check the <code>_samples</code> folder for more detailed examples.
 == SetupCKEditor Function ==
@@ Line 76: / Line 81: @@
 $ckeditor->editor('CKEditor1');
 </source>

← Older revision		Revision as of 10:25, 19 May 2010
Line 77:		Line 77:

	= JavaScript =		= JavaScript =
−	{{CKFinder_2.x CKEditor Integration\|ext=php}}	+	{{CKFinder_2.x CKEditor Integration\|ext=php\|language=PHP}}

@@ Line 1: / Line 1: @@
 = PHP =
-CKFinder comes with built-in API to easily integrate it with [http://ckeditor.com CKEditor]. Check the "_samples" folder for specific examples of it.
+CKFinder comes with built-in API to easily integrate it with [http://ckeditor.com CKEditor]. Check the <code>_samples</code> folder for more detailed examples.
-== SetupCKEditor ==
+== SetupCKEditor Function ==
-The static function '''SetupCKEditor()''' accepts four arguments:
+The static <code>SetupCKEditor()</code> function accepts four arguments:
+<source lang="php">
- SetupCKEditor( $editorObj [, $basePath, $imageType, $flashType] )
+SetupCKEditor( $editorObj [, $basePath, $imageType, $flashType] )
-* <code>editorObj</code> - CKEditor class instance.
+* <code>editorObj</code> &ndash; the CKEditor class instance.
-* <code>basePath</code> - The path where CKFinder is installed (optional, default value: "/ckfinder/").
+* <code>basePath</code> &ndash; the path where CKFinder is installed (optional, default value: <code>/ckfinder/</code>).
-* <code>imageType</code> - Name of the resource type that should be used when CKFinder is launched from the Image dialog (optional).
+* <code>imageType</code> &ndash; the name of the resource type that should be used when CKFinder is launched from the '''Image Properties''' dialog window (optional).
-* <code>flashType</code> - Name of the resource type that should be used when CKFinder is launched from the Flash dialog (optional).
+* <code>flashType</code> &ndash; the name of the resource type that should be used when CKFinder is launched from the '''Flash Properties''' dialog window (optional).
 ==== Example 1 ====
 <source lang="php">
- <?php
+<?php
- // Make sure you're using correct paths here
+// Make sure you are using correct paths here.
- include_once 'ckeditor/ckeditor.php';
+include_once 'ckeditor/ckeditor.php';
- include_once 'ckfinder/ckfinder.php';
+include_once 'ckfinder/ckfinder.php';
- $ckeditor = new CKEditor();
+$ckeditor = new CKEditor();
- $ckeditor->basePath = '/ckeditor/';
+$ckeditor->basePath = '/ckeditor/';
- CKFinder::SetupCKEditor($ckeditor, '/ckfinder/');
+CKFinder::SetupCKEditor($ckeditor, '/ckfinder/');
- $ckeditor->editor('CKEditor1');
+$ckeditor->editor('CKEditor1');
 </source>
-== SetupCKEditorObject ==
+== SetupCKEditorObject Method ==
 The '''SetupCKEditorObject()''' method accepts three arguments:
- SetupCKEditorObject( $editorObj [, $imageType, $flashType] )
+* <code>editorObj</code> &ndash; the CKEditor class instance.
+* <code>imageType</code> &ndash; the name of the resource type that should be used when CKFinder is launched from the '''Image Properties''' dialog window (optional).
-* <code>editorObj</code> - CKEditor class instance.
+* <code>flashType</code> &ndash; the name of the resource type that should be used when CKFinder is launched from the '''Flash Properties''' dialog window (optional).
 ==== Example 2 ====
 <source lang="php">
- <?php
+<?php
- // Make sure you're using correct paths here
+// Make sure you are using correct paths here.
- include_once 'ckeditor/ckeditor.php';
+include_once 'ckeditor/ckeditor.php';
- include_once 'ckfinder/ckfinder.php';
+include_once 'ckfinder/ckfinder.php';
- $ckeditor = new CKEditor();
+$ckeditor = new CKEditor();
- $ckeditor->basePath = '/ckeditor/';
+$ckeditor->basePath = '/ckeditor/';
- $ckfinder = new CKFinder();
+$ckfinder = new CKFinder();
- $ckfinder->BasePath = '/ckfinder/'; // Note: BasePath property in CKFinder class starts with capital letter
+$ckfinder->BasePath = '/ckfinder/'; // Note: the BasePath property in the CKFinder class starts with a capital letter.
- $ckfinder->SetupCKEditorObject($ckeditor);
+$ckfinder->SetupCKEditorObject($ckeditor);
- $ckeditor->editor('CKEditor1');
+$ckeditor->editor('CKEditor1');
 </source>
-== Manual integration ==
+== Manual Integration ==
+In order to configure CKEditor manually to use CKFinder, you will need to pass some additional file browser configuration settings to the <code>config</code> property of the CKEditor instance.
 ==== Example 3 ====
 <source lang="php">
- <?php
+<?php
- // Make sure you're using correct path here
+// Make sure you are using a correct path here.
- include_once 'ckeditor/ckeditor.php';
+include_once 'ckeditor/ckeditor.php';
- $ckeditor = new CKEditor();
+$ckeditor = new CKEditor();
- $ckeditor->basePath = '/ckeditor/';
+$ckeditor->basePath = '/ckeditor/';
- $ckeditor->config['filebrowserBrowseUrl'] = '/ckfinder/ckfinder.html';
+$ckeditor->config['filebrowserBrowseUrl'] = '/ckfinder/ckfinder.html';
- $ckeditor->config['filebrowserImageBrowseUrl'] = '/ckfinder/ckfinder.html?type=Images';
+$ckeditor->config['filebrowserImageBrowseUrl'] = '/ckfinder/ckfinder.html?type=Images';
- $ckeditor->config['filebrowserFlashBrowseUrl'] = '/ckfinder/ckfinder.html?type=Flash';
+$ckeditor->config['filebrowserFlashBrowseUrl'] = '/ckfinder/ckfinder.html?type=Flash';
- $ckeditor->config['filebrowserUploadUrl'] = '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Files';
+$ckeditor->config['filebrowserUploadUrl'] = '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Files';
- $ckeditor->config['filebrowserImageUploadUrl'] = '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Images';
+$ckeditor->config['filebrowserImageUploadUrl'] = '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Images';
- $ckeditor->config['filebrowserFlashUploadUrl'] = '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Flash';
+$ckeditor->config['filebrowserFlashUploadUrl'] = '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Flash';
- $ckeditor->editor('CKEditor1');
+$ckeditor->editor('CKEditor1');
 </source>
 = JavaScript =
 {{CKFinder_2.x CKEditor Integration|ext=php|language=PHP}}