Skip to the content.

Gyro-PHP > Documentation

• Home
• Downloads
• Tutorials
• Showcases
• Documentation
• Report Bug

contributions/javascript.ckeditor/lib/components/ckeditor.cls.php

Go to the documentation of this file.

<?php
/**
 * Component to include CKEditor on your page
 * 
 * @author Gerd Riesselmann
 * @ingroup CKEditor
 */
class CKEditor {
        const CONFIG_DEFAULT = 'default';
        
        private static $configs = array();
        
        /**
         * Enable CKEditor, and use given javascript file, to invoke it 
         */
        public static function enable(PageData $page_data, $config = self::CONFIG_DEFAULT) {
                if (!$config instanceof CKEditorConfig) {
                        $config = self::get_config($config);
                }
                
                $page_data->head->add_js_file('js/ckeditor/ckeditor.js');
                if (Load::is_module_loaded('javascript.jquery')) {
                        $page_data->head->add_js_file('js/ckeditor/adapters/jquery.js');
                }
                
                $page_data->head->add_js_file($config->init_file);
                
                // CKEditor path mus be set, else compressed version will not work
                $path = Config::get_value(Config::URL_BASEDIR) . 'js/ckeditor/';
                $page_data->head->add_js_snippet("var CKEDITOR_BASEPATH = '$path';", true);             
        }

        /**
         * Create a new config
         * 
         * @param sring $name
         * @param string $template Name of config to use as template
         * @return CKEditorConfig
         */
        public static function create_config($name, $template = self::CONFIG_DEFAULT) {
                $template = self::get_config($template);
                self::$configs[$name] = $template;
                HtmlText::register_editor($name, $template);
                return $template; 
        }
        
        /**
         * Returns config with given name
         * 
         * @param string $name
         * @return CKEditorConfig
         */
        private static function get_config($name) {
                $ret = Arr::get_item(self::$configs, $name, false);
                if ($ret === false) {
                        $ret = new CKEditorConfig();
                }
                return $ret;
        }
        
        /**
         * Returns all configs
         * 
         * @return array Array with config names as keys and CKEditorConfig instances as values
         */
        public static function get_all_configs() {
                return self::$configs;
        }
}

/**
 * CKEditor config
 * 
 * @author Gerd Riesselmann
 * @ingroup CKEditor
 */
class CKEditorConfig implements IRichtTextEditor {
        /**
         * The javascript file that fires up the WYM editor
         * 
         * @var string
         */
        public $init_file = 'js/ckeditor/default.js';
        
        // -----------------------
        // IRichTextEditor
        // -----------------------
        
        /**
         * Apply it
         * 
         * @param PageData $page_data
         * @param string $name Name of editor, can be found as class "rte_$name" on HTML textareas  
         */
        public function apply(PageData $page_data, $name) {
                CKEditor::enable($page_data, $this);
        }       
}

Imprint