b78cd427441de81b79edd8b4a4f55768db8f97f9
[moodle.git] / lib / editorlib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Utility classes and functions for text editor integration.
20  *
21  * @package    moodlecore
22  * @subpackage editor
23  * @copyright  2009 Petr Skoda (http://skodak.org)
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 /**
28  * Returns users preferred editor for given format
29  * @param int $format text format or null of none
30  * @return texeditor object
31  */
32 function get_preferred_texteditor($format=null) {
33     global $CFG, $USER;
35     if (empty($CFG->texteditors)) {
36         $CFG->texteditors = 'tinymce,textarea';
37     }
38     $active = explode(',', $CFG->texteditors);
40     // TODO: implement user preferences for text editors
42     // now find some plugin that supports format and is available
43     $editor = false;
44     foreach ($active as $editorname) {
45         if (!$e = get_texteditor($editorname)) {
46             continue;
47         }
48         if (!$e->supported_by_browser()) {
49             // bad luck, this editor is not compatible
50             continue;
51         }
52         if (!$supports = $e->get_supported_formats()) {
53             continue;
54         }
55         if (is_null($format)) {
56             // format does not matter
57             $editor = $e;
58             break;
59         }
60         if (in_array($format, $supports)) {
61             // editor supports this format, yay!
62             $editor = $e;
63             break;
64         }
65     }
67     if (!$editor) {
68         $editor = get_texteditor('textarea'); // must exist and can edit anything
69     }
71     return $editor;
72 }
74 /**
75  * Returns instance of text editor
76  * @param string $editorname name of editor (textarea, tinymce, ...)
77  * @return mixed texeditor instance or false if does not exist
78  */
79 function get_texteditor($editorname) {
80     global $CFG;
82     $libfile = "$CFG->libdir/editor/$editorname/lib.php";
83     if (!file_exists($libfile)) {
84         return false;
85     }
86     require_once($libfile);
87     $classname = $editorname.'_texteditor';
88     if (!class_exists($classname)) {
89         return false;
90     }
91     return new $classname();
92 }
94 /**
95  * Get the list of available editors
96  * @return array ('editorname'=>'localised editor name')
97  */
98 function get_available_editors() {
99     $editors = array();
100     foreach (get_list_of_plugins('lib/editor') as $editorname) {
101         $editors[$editorname] = get_string('modulename', 'editor_'.$editorname);
102     }
103     return $editors;
106 /**
107  * Base abstract text editor class.
108  */
109 abstract class texteditor {
110     /**
111      * Is editor supported in current browser?
112      * @return bool
113      */
114     public abstract function supported_by_browser();
116     /**
117      * Returns list of supported text formats
118      * @return array(FORMAT=>FORMAT)
119      */
120     public abstract function get_supported_formats();
122     /**
123      * Returns main preferred text format.
124      * @return int text format
125      */
126     public abstract function get_preferred_format();
128     /**
129      * Supports file picker and repos?
130      * @return book
131      */
132     public abstract function supports_repositories();
134     /**
135      * Returns textarea class in formslib editor element
136      * @return string
137      */
138     public abstract function get_editor_element_class();
140     /**
141      * Returns textarea class for legacy text editor
142      * @return string
143      */
144     public abstract function get_legacy_textarea_class();
146     /**
147      * Returns js script statements needed in html head.
148      * @return string
149      */
150     public abstract function header_js();
155 //=== DEPRECATED =====================
156 /**
157  * can_use_html_editor is deprecated...
158  */
159 function can_use_html_editor() {
160     //TODO: eradicate completely, replace with something else
162     $tinymyce = get_texteditor('tinymce');
163     return $tinymyce ->supported_by_browser();