JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.1
[ckeditor.git] / _samples / php / events.php
diff --git a/_samples/php/events.php b/_samples/php/events.php
new file mode 100644 (file)
index 0000000..583e05e
--- /dev/null
@@ -0,0 +1,129 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
+<!--\r
+Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
+For licensing, see LICENSE.html or http://ckeditor.com/license\r
+-->\r
+<html xmlns="http://www.w3.org/1999/xhtml">\r
+<head>\r
+       <title>Sample - CKEditor</title>\r
+       <meta content="text/html; charset=utf-8" http-equiv="content-type"/>\r
+       <link href="../sample.css" rel="stylesheet" type="text/css"/>\r
+</head>\r
+<body>\r
+       <h1>\r
+               CKEditor Sample\r
+       </h1>\r
+       <!-- This <div> holds alert messages to be display in the sample page. -->\r
+       <div id="alerts">\r
+               <noscript>\r
+                       <p>\r
+                               <strong>CKEditor requires JavaScript to run</strong>. In a browser with no JavaScript\r
+                               support, like yours, you should still see the contents (HTML data) and you should\r
+                               be able to edit it normally, without a rich editor interface.\r
+                       </p>\r
+               </noscript>\r
+       </div>\r
+       <!-- This <fieldset> holds the HTML that you will usually find in your pages. -->\r
+       <fieldset title="Output">\r
+               <legend>Output</legend>\r
+               <form action="../sample_posteddata.php" method="post">\r
+                       <p>\r
+                               <label>Editor 1:</label><br/>\r
+                       </p>\r
+<?php\r
+\r
+/**\r
+ * Adds global event, will hide "Target" tab in Link dialog in all instances.\r
+ */\r
+function CKEditorHideLinkTargetTab(&$CKEditor) {\r
+\r
+       $function = 'function (ev) {\r
+               // Take the dialog name and its definition from the event data\r
+               var dialogName = ev.data.name;\r
+               var dialogDefinition = ev.data.definition;\r
+\r
+               // Check if the definition is from the Link dialog.\r
+               if ( dialogName == "link" )\r
+                       dialogDefinition.removeContents("target")\r
+       }';\r
+\r
+       $CKEditor->addGlobalEventHandler('dialogDefinition', $function);\r
+}\r
+\r
+/**\r
+ * Adds global event, will notify about opened dialog.\r
+ */\r
+function CKEditorNotifyAboutOpenedDialog(&$CKEditor) {\r
+       $function = 'function (evt) {\r
+               alert("Loading dialog: " + evt.data.name);\r
+       }';\r
+\r
+       $CKEditor->addGlobalEventHandler('dialogDefinition', $function);\r
+}\r
+\r
+// Include CKEditor class.\r
+include("../../ckeditor.php");\r
+\r
+// Create class instance.\r
+$CKEditor = new CKEditor();\r
+\r
+// Set configuration option for all editors.\r
+$CKEditor->config['width'] = 750;\r
+\r
+// Path to CKEditor directory, ideally instead of relative dir, use an absolute path:\r
+//   $CKEditor->basePath = '/ckeditor/'\r
+// If not set, CKEditor will try to detect the correct path.\r
+$CKEditor->basePath = '../../';\r
+\r
+// The initial value to be displayed in the editor.\r
+$initialValue = '<p>This is some <strong>sample text</strong>. You are using <a href="http://ckeditor.com/">CKEditor</a>.</p>';\r
+\r
+// Event that will be handled only by the first editor.\r
+$CKEditor->addEventHandler('instanceReady', 'function (evt) {\r
+       alert("Loaded editor: " + evt.editor.name);\r
+}');\r
+\r
+// Create first instance.\r
+$CKEditor->editor("editor1", $initialValue);\r
+\r
+// Clear event handlers, instances that will be created later will not have\r
+// the 'instanceReady' listener defined a couple of lines above.\r
+$CKEditor->clearEventHandlers();\r
+?>\r
+                       <p>\r
+                               <label>Editor 2:</label><br/>\r
+                       </p>\r
+<?php\r
+// Configuration that will be used only by the second editor.\r
+$config['width'] = '600';\r
+$config['toolbar'] = 'Basic';\r
+\r
+// Add some global event handlers (for all editors).\r
+CKEditorHideLinkTargetTab($CKEditor);\r
+CKEditorNotifyAboutOpenedDialog($CKEditor);\r
+\r
+// Event that will be handled only by the second editor.\r
+// Instead of calling addEventHandler(), events may be passed as an argument.\r
+$events['instanceReady'] = 'function (evt) {\r
+       alert("Loaded second editor: " + evt.editor.name);\r
+}';\r
+\r
+// Create second instance.\r
+$CKEditor->editor("editor2", $initialValue, $config, $events);\r
+?>\r
+                               <input type="submit" value="Submit"/>\r
+                       </p>\r
+               </form>\r
+       </fieldset>\r
+       <div id="footer">\r
+               <hr />\r
+               <p>\r
+                       CKEditor - The text editor for Internet - <a href="http://ckeditor.com/">http://ckeditor.com</a>\r
+               </p>\r
+               <p id="copy">\r
+                       Copyright &copy; 2003-2010, <a href="http://cksource.com/">CKSource</a> - Frederico\r
+                       Knabben. All rights reserved.\r
+               </p>\r
+       </div>\r
+</body>\r
+</html>\r