MDL-28019 Added plugin tinymce_managefiles
[moodle.git] / lib / editor / tinymce / plugins / managefiles / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 defined('MOODLE_INTERNAL') || die();
19 /**
20  * Plugin for managing files embedded in the text editor
21  *
22  * @package   tinymce_managefiles
23  * @copyright 2013 Marina Glancy
24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
26 class tinymce_managefiles extends editor_tinymce_plugin {
27     /** @var array list of buttons defined by this plugin */
28     protected $buttons = array('managefiles');
30     /**
31      * Adjusts TinyMCE init parameters for tinymce_managefiles
32      *
33      * Adds file area restrictions parameters and actual 'managefiles' button
34      *
35      * @param array $params TinyMCE init parameters array
36      * @param context $context Context where editor is being shown
37      * @param array $options Options for this editor
38      */
39     protected function update_init_params(array &$params, context $context,
40             array $options = null) {
41         global $USER;
43         // Add parameters for filemanager
44         $params['managefiles'] = array('usercontext' => context_user::instance($USER->id)->id);
45         foreach (array('itemid', 'context', 'areamaxbytes', 'maxbytes', 'subdirs', 'return_types') as $key) {
46             if (isset($options[$key])) {
47                 if ($key === 'context' && is_object($options[$key])) {
48                     // Just context id is enough
49                     $params['managefiles'][$key] = $options[$key]->id;
50                 } else {
51                     $params['managefiles'][$key] = $options[$key];
52                 }
53             }
54         }
56         // Add button after moodlemedia button in advancedbuttons3.
57         $added = $this->add_button_after($params, 3, 'managefiles', 'moodlemedia', false);
59         // So, if no moodlemedia, add after 'image'.
60         if (!$added) {
61             $this->add_button_after($params, 3, 'managefiles', 'image');
62         }
64         // Add JS file, which uses default name.
65         $this->add_js_plugin($params);
66     }
68     protected function get_sort_order() {
69         return 310;
70     }
71 }