Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
   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/>.
  16  
  17  /**
  18   * Chapter edit form
  19   *
  20   * @package    mod_book
  21   * @copyright  2004-2010 Petr Skoda {@link http://skodak.org}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die;
  26  
  27  require_once($CFG->libdir.'/formslib.php');
  28  
  29  class book_chapter_edit_form extends moodleform {
  30  
  31      function definition() {
  32          global $CFG;
  33  
  34          $chapter = $this->_customdata['chapter'];
  35          $options = $this->_customdata['options'];
  36  
  37          // Disabled subchapter option when editing first node.
  38          $disabledmsg = null;
  39          if ($chapter->pagenum == 1) {
  40              $disabledmsg = get_string('subchapternotice', 'book');
  41          }
  42  
  43          $mform = $this->_form;
  44  
  45          if (!empty($chapter->id)) {
  46              $mform->addElement('header', 'general', get_string('editingchapter', 'mod_book'));
  47          } else {
  48              $mform->addElement('header', 'general', get_string('addafter', 'mod_book'));
  49          }
  50  
  51          if (isset($chapter->currentchaptertitle)) {
  52              $mform->addElement('static', 'details',
  53                  get_string('previouschapter', 'mod_book'),
  54                  trim(format_string($chapter->currentchaptertitle, true))
  55              );
  56          }
  57  
  58          $mform->addElement('text', 'title', get_string('chaptertitle', 'mod_book'),
  59              ['size' => '30', 'maxlength' => '255']);
  60          $mform->setType('title', PARAM_RAW);
  61          $mform->addRule('title', null, 'required', null, 'client');
  62          $mform->addRule('title', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
  63  
  64          $mform->addElement('advcheckbox', 'subchapter', get_string('subchapter', 'mod_book'), $disabledmsg);
  65  
  66          $mform->addElement('editor', 'content_editor', get_string('content', 'mod_book'), null, $options);
  67          $mform->setType('content_editor', PARAM_RAW);
  68          $mform->addRule('content_editor', get_string('required'), 'required', null, 'client');
  69  
  70          if (core_tag_tag::is_enabled('mod_book', 'book_chapters')) {
  71              $mform->addElement('header', 'tagshdr', get_string('tags', 'tag'));
  72          }
  73          $mform->addElement('tags', 'tags', get_string('tags'),
  74              array('itemtype' => 'book_chapters', 'component' => 'mod_book'));
  75  
  76          $mform->addElement('hidden', 'id');
  77          $mform->setType('id', PARAM_INT);
  78  
  79          $mform->addElement('hidden', 'cmid');
  80          $mform->setType('cmid', PARAM_INT);
  81  
  82          $mform->addElement('hidden', 'pagenum');
  83          $mform->setType('pagenum', PARAM_INT);
  84  
  85          $this->add_action_buttons(true);
  86  
  87          // set the defaults
  88          $this->set_data($chapter);
  89      }
  90  
  91      function definition_after_data(){
  92          $mform = $this->_form;
  93          $pagenum = $mform->getElement('pagenum');
  94          if ($pagenum->getValue() == 1) {
  95              $mform->hardFreeze('subchapter');
  96          }
  97      }
  98  }