Revision as of 11:35, 26 April 2011 (view source) Wiktor (talk | contribs) (Added draft of Writing Java Plugins article) Newer edit →

(No difference)

---

Revision as of 11:35, 26 April 2011

CKFinder functionality can be extended with server-side plugins. Although the full source code of the CKFinder server connector is available and can be modified in any way desired, a much better way of enhancing the CKFinder connector is to create a plugin.

The main advantages of plugins are:

• Upgrades are much easier.
• The plugin code is stored in a single place.
• Plugins can be easily disabled when they are not needed anymore.

Common use cases:

• Adding a new server-side command (i.e. fileditor and imageresize plugin).
• Working with uploaded files (i.e. watermark plugin).
• Extending information returned by the Init command (i.e. imageresize plugin).

Creating a plugin

Step1: Create plugin folder

Step2: Add plugin definition

Step3: Enable plugin

Java plugin system

Events

CKFinder provides several events that can be used to extend the functionality of the CKFinder application. Assigning a class (also known as an event handler) to an event will cause that function to be called at the appropriate point in the main CKFinder code, to perform whatever additional task(s) the developer thinks would be useful at that point. Each event can have multiple event listeners assigned to it.

Available events

Hook	Since	Description
AfterFileUpload	2.0	Executed after successful file upload.
BeforeExecuteCommand	2.0	Executed before a server side command is executed.
InitCommand	2.0	Executed straight before sending the result of the Init command.