3 * Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
4 * For licensing, see LICENSE.html or http://ckeditor.com/license
8 * \brief CKEditor class that can be used to create editor
9 * instances in PHP pages on server side.
10 * @see http://ckeditor.com
14 * $CKEditor = new CKEditor();
15 * $CKEditor->editor("editor1", "<p>Initial value.</p>");
21 * The version of %CKEditor.
23 const version
= '3.6.1';
25 * A constant string unique for each release of %CKEditor.
27 const timestamp
= 'B5GJ5GG';
30 * URL to the %CKEditor installation directory (absolute or relative to document root).
31 * If not set, CKEditor will try to guess it's path.
35 * $CKEditor->basePath = '/ckeditor/';
40 * An array that holds the global %CKEditor configuration.
41 * For the list of available options, see http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html
45 * $CKEditor->config['height'] = 400;
46 * // Use @@ at the beggining of a string to ouput it without surrounding quotes.
47 * $CKEditor->config['width'] = '@@screen.width * 0.8';
50 public $config = array();
52 * A boolean variable indicating whether CKEditor has been initialized.
53 * Set it to true only if you have already included
54 * <script> tag loading ckeditor.js in your website.
56 public $initialized = false;
58 * Boolean variable indicating whether created code should be printed out or returned by a function.
60 * Example 1: get the code creating %CKEditor instance and print it on a page with the "echo" function.
62 * $CKEditor = new CKEditor();
63 * $CKEditor->returnOutput = true;
64 * $code = $CKEditor->editor("editor1", "<p>Initial value.</p>");
65 * echo "<p>Editor 1:</p>";
69 public $returnOutput = false;
71 * An array with textarea attributes.
73 * When %CKEditor is created with the editor() method, a HTML <textarea> element is created,
74 * it will be displayed to anyone with JavaScript disabled or with incompatible browser.
76 public $textareaAttributes = array( "rows" => 8, "cols" => 60 );
78 * A string indicating the creation date of %CKEditor.
79 * Do not change it unless you want to force browsers to not use previously cached version of %CKEditor.
81 public $timestamp = "B5GJ5GG";
83 * An array that holds event listeners.
85 private $events = array();
87 * An array that holds global event listeners.
89 private $globalEvents = array();
94 * @param $basePath (string) URL to the %CKEditor installation directory (optional).
96 function __construct($basePath = null) {
97 if (!empty($basePath)) {
98 $this->basePath
= $basePath;
103 * Creates a %CKEditor instance.
104 * In incompatible browsers %CKEditor will downgrade to plain HTML <textarea> element.
106 * @param $name (string) Name of the %CKEditor instance (this will be also the "name" attribute of textarea element).
107 * @param $value (string) Initial value (optional).
108 * @param $config (array) The specific configurations to apply to this editor instance (optional).
109 * @param $events (array) Event listeners for this editor instance (optional).
113 * $CKEditor = new CKEditor();
114 * $CKEditor->editor("field1", "<p>Initial value.</p>");
119 * $CKEditor = new CKEditor();
121 * $config['toolbar'] = array(
122 * array( 'Source', '-', 'Bold', 'Italic', 'Underline', 'Strike' ),
123 * array( 'Image', 'Link', 'Unlink', 'Anchor' )
125 * $events['instanceReady'] = 'function (ev) {
126 * alert("Loaded: " + ev.editor.name);
128 * $CKEditor->editor("field1", "<p>Initial value.</p>", $config, $events);
131 public function editor($name, $value = "", $config = array(), $events = array())
134 foreach ($this->textareaAttributes
as $key => $val) {
135 $attr.= " " . $key . '="' . str_replace('"', '"', $val) . '"';
137 $out = "<textarea name=\"" . $name . "\"" . $attr . ">" . htmlspecialchars($value) . "</textarea>\n";
138 if (!$this->initialized
) {
139 $out .= $this->init();
142 $_config = $this->configSettings($config, $events);
144 $js = $this->returnGlobalEvents();
145 if (!empty($_config))
146 $js .= "CKEDITOR.replace('".$name."', ".$this->jsEncode($_config).");";
148 $js .= "CKEDITOR.replace('".$name."');";
150 $out .= $this->script($js);
152 if (!$this->returnOutput
) {
161 * Replaces a <textarea> with a %CKEditor instance.
163 * @param $id (string) The id or name of textarea element.
164 * @param $config (array) The specific configurations to apply to this editor instance (optional).
165 * @param $events (array) Event listeners for this editor instance (optional).
167 * Example 1: adding %CKEditor to <textarea name="article"></textarea> element:
169 * $CKEditor = new CKEditor();
170 * $CKEditor->replace("article");
173 public function replace($id, $config = array(), $events = array())
176 if (!$this->initialized
) {
177 $out .= $this->init();
180 $_config = $this->configSettings($config, $events);
182 $js = $this->returnGlobalEvents();
183 if (!empty($_config)) {
184 $js .= "CKEDITOR.replace('".$id."', ".$this->jsEncode($_config).");";
187 $js .= "CKEDITOR.replace('".$id."');";
189 $out .= $this->script($js);
191 if (!$this->returnOutput
) {
200 * Replace all <textarea> elements available in the document with editor instances.
202 * @param $className (string) If set, replace all textareas with class className in the page.
204 * Example 1: replace all <textarea> elements in the page.
206 * $CKEditor = new CKEditor();
207 * $CKEditor->replaceAll();
210 * Example 2: replace all <textarea class="myClassName"> elements in the page.
212 * $CKEditor = new CKEditor();
213 * $CKEditor->replaceAll( 'myClassName' );
216 public function replaceAll($className = null)
219 if (!$this->initialized
) {
220 $out .= $this->init();
223 $_config = $this->configSettings();
225 $js = $this->returnGlobalEvents();
226 if (empty($_config)) {
227 if (empty($className)) {
228 $js .= "CKEDITOR.replaceAll();";
231 $js .= "CKEDITOR.replaceAll('".$className."');";
235 $classDetection = "";
236 $js .= "CKEDITOR.replaceAll( function(textarea, config) {\n";
237 if (!empty($className)) {
238 $js .= " var classRegex = new RegExp('(?:^| )' + '". $className ."' + '(?:$| )');\n";
239 $js .= " if (!classRegex.test(textarea.className))\n";
240 $js .= " return false;\n";
242 $js .= " CKEDITOR.tools.extend(config, ". $this->jsEncode($_config) .", true);";
247 $out .= $this->script($js);
249 if (!$this->returnOutput
) {
258 * Adds event listener.
259 * Events are fired by %CKEditor in various situations.
261 * @param $event (string) Event name.
262 * @param $javascriptCode (string) Javascript anonymous function or function name.
266 * $CKEditor->addEventHandler('instanceReady', 'function (ev) {
267 * alert("Loaded: " + ev.editor.name);
271 public function addEventHandler($event, $javascriptCode)
273 if (!isset($this->events
[$event])) {
274 $this->events
[$event] = array();
277 if (!in_array($javascriptCode, $this->events
[$event])) {
278 $this->events
[$event][] = $javascriptCode;
283 * Clear registered event handlers.
284 * Note: this function will have no effect on already created editor instances.
286 * @param $event (string) Event name, if not set all event handlers will be removed (optional).
288 public function clearEventHandlers($event = null)
290 if (!empty($event)) {
291 $this->events
[$event] = array();
294 $this->events
= array();
299 * Adds global event listener.
301 * @param $event (string) Event name.
302 * @param $javascriptCode (string) Javascript anonymous function or function name.
306 * $CKEditor->addGlobalEventHandler('dialogDefinition', 'function (ev) {
307 * alert("Loading dialog: " + ev.data.name);
311 public function addGlobalEventHandler($event, $javascriptCode)
313 if (!isset($this->globalEvents
[$event])) {
314 $this->globalEvents
[$event] = array();
317 if (!in_array($javascriptCode, $this->globalEvents
[$event])) {
318 $this->globalEvents
[$event][] = $javascriptCode;
323 * Clear registered global event handlers.
324 * Note: this function will have no effect if the event handler has been already printed/returned.
326 * @param $event (string) Event name, if not set all event handlers will be removed (optional).
328 public function clearGlobalEventHandlers($event = null)
330 if (!empty($event)) {
331 $this->globalEvents
[$event] = array();
334 $this->globalEvents
= array();
339 * Prints javascript code.
343 private function script($js)
345 $out = "<script type=\"text/javascript\">";
346 $out .= "//<![CDATA[\n";
349 $out .= "</script>\n";
355 * Returns the configuration array (global and instance specific settings are merged into one array).
357 * @param $config (array) The specific configurations to apply to editor instance.
358 * @param $events (array) Event listeners for editor instance.
360 private function configSettings($config = array(), $events = array())
362 $_config = $this->config
;
363 $_events = $this->events
;
365 if (is_array($config) && !empty($config)) {
366 $_config = array_merge($_config, $config);
369 if (is_array($events) && !empty($events)) {
370 foreach ($events as $eventName => $code) {
371 if (!isset($_events[$eventName])) {
372 $_events[$eventName] = array();
374 if (!in_array($code, $_events[$eventName])) {
375 $_events[$eventName][] = $code;
380 if (!empty($_events)) {
381 foreach($_events as $eventName => $handlers) {
382 if (empty($handlers)) {
385 else if (count($handlers) == 1) {
386 $_config['on'][$eventName] = '@@'.$handlers[0];
389 $_config['on'][$eventName] = '@@function (ev){';
390 foreach ($handlers as $handler => $code) {
391 $_config['on'][$eventName] .= '('.$code.')(ev);';
393 $_config['on'][$eventName] .= '}';
402 * Return global event handlers.
404 private function returnGlobalEvents()
406 static $returnedEvents;
409 if (!isset($returnedEvents)) {
410 $returnedEvents = array();
413 if (!empty($this->globalEvents
)) {
414 foreach ($this->globalEvents
as $eventName => $handlers) {
415 foreach ($handlers as $handler => $code) {
416 if (!isset($returnedEvents[$eventName])) {
417 $returnedEvents[$eventName] = array();
419 // Return only new events
420 if (!in_array($code, $returnedEvents[$eventName])) {
421 $out .= ($code ?
"\n" : "") . "CKEDITOR.on('". $eventName ."', $code);";
422 $returnedEvents[$eventName][] = $code;
432 * Initializes CKEditor (executed only once).
434 private function init()
436 static $initComplete;
439 if (!empty($initComplete)) {
443 if ($this->initialized
) {
444 $initComplete = true;
449 $ckeditorPath = $this->ckeditorPath();
451 if (!empty($this->timestamp
) && $this->timestamp
!= "%"."TIMESTAMP%") {
452 $args = '?t=' . $this->timestamp
;
455 // Skip relative paths...
456 if (strpos($ckeditorPath, '..') !== 0) {
457 $out .= $this->script("window.CKEDITOR_BASEPATH='". $ckeditorPath ."';");
460 $out .= "<script type=\"text/javascript\" src=\"" . $ckeditorPath . 'ckeditor.js' . $args . "\"></script>\n";
463 if ($this->timestamp
!= self
::timestamp
) {
464 $extraCode .= ($extraCode ?
"\n" : "") . "CKEDITOR.timestamp = '". $this->timestamp
."';";
467 $out .= $this->script($extraCode);
470 $initComplete = $this->initialized
= true;
476 * Return path to ckeditor.js.
478 private function ckeditorPath()
480 if (!empty($this->basePath
)) {
481 return $this->basePath
;
485 * The absolute pathname of the currently executing script.
486 * Note: If a script is executed with the CLI, as a relative path, such as file.php or ../file.php,
487 * $_SERVER['SCRIPT_FILENAME'] will contain the relative path specified by the user.
489 if (isset($_SERVER['SCRIPT_FILENAME'])) {
490 $realPath = dirname($_SERVER['SCRIPT_FILENAME']);
494 * realpath - Returns canonicalized absolute pathname
496 $realPath = realpath( './' ) ;
500 * The filename of the currently executing script, relative to the document root.
501 * For instance, $_SERVER['PHP_SELF'] in a script at the address http://example.com/test.php/foo.bar
502 * would be /test.php/foo.bar.
504 $selfPath = dirname($_SERVER['PHP_SELF']);
505 $file = str_replace("\\", "/", __FILE__
);
507 if (!$selfPath ||
!$realPath ||
!$file) {
511 $documentRoot = substr($realPath, 0, strlen($realPath) - strlen($selfPath));
512 $fileUrl = substr($file, strlen($documentRoot));
513 $ckeditorUrl = str_replace("ckeditor_php5.php", "", $fileUrl);
519 * This little function provides a basic JSON support.
524 private function jsEncode($val)
530 return $val ?
'true' : 'false';
535 if (is_float($val)) {
536 return str_replace(',', '.', $val);
538 if (is_array($val) ||
is_object($val)) {
539 if (is_array($val) && (array_keys($val) === range(0,count($val)-1))) {
540 return '[' . implode(',', array_map(array($this, 'jsEncode'), $val)) . ']';
543 foreach ($val as $k => $v){
544 $temp[] = $this->jsEncode("{$k}") . ':' . $this->jsEncode($v);
546 return '{' . implode(',', $temp) . '}';
549 if (strpos($val, '@@') === 0)
550 return substr($val, 2);
551 if (strtoupper(substr($val, 0, 9)) == 'CKEDITOR.')
554 return '"' . str_replace(array("\\", "/", "\n", "\t", "\r", "\x08", "\x0c", '"'), array('\\\\', '\\/', '\\n', '\\t', '\\r', '\\b', '\\f', '\"'), $val) . '"';