CKFinder 2.x/Developers Guide/PHP/Plugins/Writing PHP - Revision history

Wiktor at 08:14, 26 May 2010

2010-05-26T08:14:52Z

2010-05-25T13:30:19Z

2010-05-25T09:32:02Z

2010-05-25T08:13:54Z

2010-05-25T08:10:04Z

2010-05-25T08:07:02Z

2010-05-25T08:05:21Z

‎Full source code

2010-05-25T07:18:08Z

‎Sample plugin: FileSize (adding new server side command - complete example)

2010-05-25T06:43:23Z

2010-05-17T20:43:02Z

@@ Line 39: / Line 39: @@
 $config['Hooks']['event'][] = array($object, 'someMethod');
 </source>
 ==== Available hooks ====

← Older revision		Revision as of 13:30, 25 May 2010
Line 1:		Line 1:
−	{{CKFinder 2.x Writing Plugins Introduction}}	+	__TOC__{{CKFinder 2.x Writing Plugins Introduction}}
	== Creating a plugin ==		== Creating a plugin ==

← Older revision		Revision as of 09:32, 25 May 2010
Line 142:		Line 142:

	==== Full source code ====		==== Full source code ====
		+	===== plugin.php =====
	The full source code of a plugin with all necessary security checks: (save the code as '''plugin.php''' in "plugins/myplugin" folder)		The full source code of a plugin with all necessary security checks: (save the code as '''plugin.php''' in "plugins/myplugin" folder)

@@ Line 59: / Line 59: @@
 but the advantage of defining it in plugin.php is that it will be enabled only when the server side plugin is also enabled.
-== Sample plugin: FileSize (adding new server side command - complete example) ==
+{{CKFinder_2.x Sample Plugin Introduction|ext=php}}
 For the sake of simplicity, we'll first create a simple '''plugin.php''' that just does exactly what we need:

@@ Line 41: / Line 41: @@
 ==== Available hooks ====
-<table border="1">
+{{CKFinder_2.x hooks table}}
 === Enabling JavaScript plugin ===

@@ Line 262: / Line 262: @@
 </source>
-.. and the client side (JavaScript) plugin that will call the FileSize command:
+{{CKFinder_2.x myplugin code}}
 {{#CUSTOMTITLE:Writing PHP Plugins}}

@@ Line 274: / Line 274: @@
 			var size = xml.selectSingleNode( 'Connector/FileSize/@size' );
-			api.openMsgDialog( "The exact size of a file is: " + size.value + " bytes");
+			api.openMsgDialog( "", "The exact size of a file is: " + size.value + " bytes");
 		} );
 	});

@@ Line 95: / Line 95: @@
 <Error number="0"/>
 <CurrentFolder path="/" url="/ckfinder/userfiles/files/" acl="255"/>
-<FileSize size="5647"/>  <------
+<FileSize size="5647"/>
 </Connector>
 </source>

← Older revision		Revision as of 06:43, 25 May 2010
Line 1:		Line 1:
−	CKFinder ~~functionality can be extended with server side plugins~~. ~~Althought the full source code of CKFinder server connector is available and it can be changed in any way, a much better way of enhancing CKFinder connector is to create a plugin.~~	+	{{CKFinder 2.x Writing Plugins Introduction}}
−
−	~~The main advantages of plugins are:~~
−	* Upgrades are much easier.
−	* The plugin code is in a single place.
−	* Plugins ~~can be easily turned off when are not needed anymore.~~
−
−	~~Common use cases:~~
−
−	* Adding new server side command (i.e. fileditor and imageresize plugin).
−	* Working with uploaded file (i.e. watermark plugin).
−	* Extending the information returned by the Init command (i.e. imageresize plugin).
−
	== Creating a plugin ==		== Creating a plugin ==

@@ Line 192: / Line 192: @@
 ==== Full source code ====
-The full source code of a plugin with all necessary security checks:
+The full source code of a plugin with all necessary security checks: (save the code as '''plugin.php''' in "plugins/myplugin" folder)
 <source lang="php">
@@ Line 275: / Line 275: @@
 .. and the client side (JavaScript) plugin that will call the FileSize command:
-(save the code as '''plugin.js''' in "myplugin" folder)
+(save the code as '''plugin.js''' in "plugins/myplugin" folder)
 <source>
 CKFinder.addPlugin( 'myplugin', function( api ) {