mod/data/field/textarea/field.class.php

   1 <?php
   2 ///////////////////////////////////////////////////////////////////////////
   3 //                                                                       //
   4 // NOTICE OF COPYRIGHT                                                   //
   5 //                                                                       //
   6 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
   7 //          http://moodle.org                                            //
   8 //                                                                       //
   9 // Copyright (C) 1999-onwards Moodle Pty Ltd  http://moodle.com          //
  10 //                                                                       //
  11 // This program is free software; you can redistribute it and/or modify  //
  12 // it under the terms of the GNU General Public License as published by  //
  13 // the Free Software Foundation; either version 2 of the License, or     //
  14 // (at your option) any later version.                                   // //                                                                       //
  15 // This program is distributed in the hope that it will be useful,       //
  16 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
  18 // GNU General Public License for more details:                          //
  19 //                                                                       //
  20 //          http://www.gnu.org/copyleft/gpl.html                         //
  21 //                                                                       //
  22 ///////////////////////////////////////////////////////////////////////////
  23
  24 require_once($CFG->dirroot.'/lib/filelib.php');
  25 require_once($CFG->dirroot.'/repository/lib.php');
  26
  27 class data_field_textarea extends data_field_base {
  28
  29     var $type = 'textarea';
  30
  31     /**
  32      * Returns options for embedded files
  33      *
  34      * @return array
  35      */
  36     private function get_options() {
  37         if (!isset($this->field->param5)) {
  38             $this->field->param5 = 0;
  39         }
  40         $options = array();
  41         $options['trusttext'] = false;
  42         $options['forcehttps'] = false;
  43         $options['subdirs'] = false;
  44         $options['maxfiles'] = -1;
  45         $options['context'] = $this->context;
  46         $options['maxbytes'] = $this->field->param5;
  47         $options['changeformat'] = 0;
  48         $options['noclean'] = false;
  49         return $options;
  50     }
  51
  52     function display_add_field($recordid=0) {
  53         global $CFG, $DB, $OUTPUT, $PAGE;
  54
  55         $text   = '';
  56         $format = 0;
  57
  58         $str = '<div title="'.$this->field->description.'">';
  59
  60         editors_head_setup();
  61         $options = $this->get_options();
  62
  63         $itemid = $this->field->id;
  64         $field = 'field_'.$itemid;
  65
  66         if ($recordid && $content = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))){
  67             $format = $content->content1;
  68             $text = clean_text($content->content, $format);
  69             $text = file_prepare_draft_area($draftitemid, $this->context->id, 'mod_data', 'content', $content->id, $options, $text);
  70         } else {
  71             $draftitemid = file_get_unused_draft_itemid();
  72             $format = FORMAT_HTML;
  73         }
  74
  75         // get filepicker info
  76         //
  77         $fpoptions = array();
  78         if ($options['maxfiles'] != 0 ) {
  79             $args = new stdClass();
  80             // need these three to filter repositories list
  81             $args->accepted_types = array('web_image');
  82             $args->return_types = (FILE_INTERNAL | FILE_EXTERNAL);
  83             $args->context = $this->context;
  84             $args->env = 'filepicker';
  85             // advimage plugin
  86             $image_options = initialise_filepicker($args);
  87             $image_options->context = $this->context;
  88             $image_options->client_id = uniqid();
  89             $image_options->maxbytes = $options['maxbytes'];
  90             $image_options->env = 'editor';
  91             $image_options->itemid = $draftitemid;
  92
  93             // moodlemedia plugin
  94             $args->accepted_types = array('video', 'audio');
  95             $media_options = initialise_filepicker($args);
  96             $media_options->context = $this->context;
  97             $media_options->client_id = uniqid();
  98             $media_options->maxbytes  = $options['maxbytes'];
  99             $media_options->env = 'editor';
 100             $media_options->itemid = $draftitemid;
 101
 102             // advlink plugin
 103             $args->accepted_types = '*';
 104             $link_options = initialise_filepicker($args);
 105             $link_options->context = $this->context;
 106             $link_options->client_id = uniqid();
 107             $link_options->maxbytes  = $options['maxbytes'];
 108             $link_options->env = 'editor';
 109             $link_options->itemid = $draftitemid;
 110
 111             $fpoptions['image'] = $image_options;
 112             $fpoptions['media'] = $media_options;
 113             $fpoptions['link'] = $link_options;
 114         }
 115
 116         $editor = editors_get_preferred_editor($format);
 117         $strformats = format_text_menu();
 118         $formats =  $editor->get_supported_formats();
 119         foreach ($formats as $fid) {
 120             $formats[$fid] = $strformats[$fid];
 121         }
 122         $editor->set_text($text);
 123         $editor->use_editor($field, $options, $fpoptions);
 124         $str .= '<input type="hidden" name="'.$field.'_itemid" value="'.s($draftitemid).'" />';
 125         $str .= '<div><textarea id="'.$field.'" name="'.$field.'" rows="'.$this->field->param3.'" cols="'.$this->field->param2.'" spellcheck="true">'.s($text).'</textarea></div>';
 126         $str .= '<div><label class="accesshide" for="' . $field . '_content1">' . get_string('format') . '</label>';
 127         $str .= '<select id="' . $field . '_content1" name="'.$field.'_content1">';
 128         foreach ($formats as $key=>$desc) {
 129             $selected = ($format == $key) ? 'selected="selected"' : '';
 130             $str .= '<option value="'.s($key).'" '.$selected.'>'.$desc.'</option>';
 131         }
 132         $str .= '</select>';
 133         $str .= '</div>';
 134
 135         $str .= '</div>';
 136         return $str;
 137     }
 138
 139
 140     function display_search_field($value = '') {
 141         return '<label class="accesshide" for="f_' . $this->field->id . '">' . $this->field->name . '</label>' .
 142                '<input type="text" size="16" id="f_'.$this->field->id.'" name="f_'.$this->field->id.'" value="'.s($value).'" />';
 143     }
 144
 145     function parse_search_field() {
 146         return optional_param('f_'.$this->field->id, '', PARAM_NOTAGS);
 147     }
 148
 149     function generate_sql($tablealias, $value) {
 150         global $DB;
 151
 152         static $i=0;
 153         $i++;
 154         $name = "df_textarea_$i";
 155         return array(" ({$tablealias}.fieldid = {$this->field->id} AND ".$DB->sql_like("{$tablealias}.content", ":$name", false).") ", array($name=>"%$value%"));
 156     }
 157
 158     function print_after_form() {
 159     }
 160
 161
 162     function update_content($recordid, $value, $name='') {
 163         global $DB;
 164
 165         $content = new stdClass();
 166         $content->fieldid = $this->field->id;
 167         $content->recordid = $recordid;
 168
 169         $names = explode('_', $name);
 170         if (!empty($names[2])) {
 171             if ($names[2] == 'itemid') {
 172                 // the value will be retrieved by file_get_submitted_draft_itemid, do not need to save in DB
 173                 return true;
 174             } else {
 175                 $content->$names[2] = clean_param($value, PARAM_NOTAGS);  // content[1-4]
 176             }
 177         } else {
 178             $content->content = clean_param($value, PARAM_CLEAN);
 179         }
 180
 181         if ($oldcontent = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
 182             $content->id = $oldcontent->id;
 183         } else {
 184             $content->id = $DB->insert_record('data_content', $content);
 185             if (!$content->id) {
 186                 return false;
 187             }
 188         }
 189         if (!empty($content->content)) {
 190             $draftitemid = file_get_submitted_draft_itemid('field_'. $this->field->id. '_itemid');
 191             $options = $this->get_options();
 192             $content->content = file_save_draft_area_files($draftitemid, $this->context->id, 'mod_data', 'content', $content->id, $options, $content->content);
 193         }
 194         $rv = $DB->update_record('data_content', $content);
 195         return $rv;
 196     }
 197
 198     /**
 199      * Display the content of the field in browse mode
 200      *
 201      * @param int $recordid
 202      * @param object $template
 203      * @return bool|string
 204      */
 205     function display_browse_field($recordid, $template) {
 206         global $DB;
 207
 208         if ($content = $DB->get_record('data_content', array('fieldid' => $this->field->id, 'recordid' => $recordid))) {
 209             if (isset($content->content)) {
 210                 $options = new stdClass();
 211                 if ($this->field->param1 == '1') {  // We are autolinking this field, so disable linking within us
 212                     $options->filter = false;
 213                 }
 214                 $options->para = false;
 215                 $str = file_rewrite_pluginfile_urls($content->content, 'pluginfile.php', $this->context->id, 'mod_data', 'content', $content->id, $this->get_options());
 216                 $str = format_text($str, $content->content1, $options);
 217             } else {
 218                 $str = '';
 219             }
 220             return $str;
 221         }
 222         return false;
 223     }
 224
 225     /**
 226      * Whether this module support files
 227      *
 228      * @param string $relativepath
 229      * @return bool
 230      */
 231     function file_ok($relativepath) {
 232         return true;
 233     }
 234 }
 235