mod/label/mod_form.php

   1 <?php
   2
   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/>.
  17
  18 /**
  19  * Add label form
  20  *
  21  * @package mod_label
  22  * @copyright  2006 Jamie Pratt
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die;
  27
  28 require_once ($CFG->dirroot.'/course/moodleform_mod.php');
  29
  30 class mod_label_mod_form extends moodleform_mod {
  31
  32     function definition() {
  33         global $PAGE;
  34
  35         $PAGE->force_settings_menu();
  36
  37         $mform = $this->_form;
  38
  39         $mform->addElement('header', 'generalhdr', get_string('general'));
  40
  41         // Add element for name.
  42         $mform->addElement('text', 'name', get_string('labelname', 'label'), array('size' => '64'));
  43         if (!empty($CFG->formatstringstriptags)) {
  44             $mform->setType('name', PARAM_TEXT);
  45         } else {
  46             $mform->setType('name', PARAM_CLEANHTML);
  47         }
  48         $mform->addHelpButton('name', 'labelname', 'label');
  49
  50         $this->standard_intro_elements(get_string('labeltext', 'label'));
  51
  52         // Label does not add "Show description" checkbox meaning that 'intro' is always shown on the course page.
  53         $mform->addElement('hidden', 'showdescription', 1);
  54         $mform->setType('showdescription', PARAM_INT);
  55
  56         $this->standard_coursemodule_elements();
  57
  58 //-------------------------------------------------------------------------------
  59 // buttons
  60         $this->add_action_buttons(true, false, null);
  61
  62     }
  63
  64     /**
  65      * Override validation in order to make name field non-required.
  66      *
  67      * @param array $data
  68      * @param array $files
  69      * @return array
  70      */
  71     public function validation($data, $files) {
  72         $errors = parent::validation($data, $files);
  73         // Name field should not be required.
  74         if (array_key_exists('name', $errors)) {
  75             if ($errors['name'] === get_string('required')) {
  76                 unset($errors['name']);
  77             }
  78         }
  79         return $errors;
  80     }
  81
  82 }