Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]

   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   * Form for editing HTML block instances.
  19   *
  20   * @package   block_glossary_random
  21   * @copyright 2009 Tim Hunt
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  /**
  26   * Form for editing Random glossary entry block instances.
  27   *
  28   * @copyright 2009 Tim Hunt
  29   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  30   */
  31  class block_glossary_random_edit_form extends block_edit_form {
  32      protected function specific_definition($mform) {
  33          global $DB;
  34  
  35          // Fields for editing HTML block title and contents.
  36          $mform->addElement('header', 'configheader', get_string('blocksettings', 'block'));
  37  
  38          $mform->addElement('text', 'config_title', get_string('title', 'block_glossary_random'));
  39          $mform->setDefault('config_title', get_string('pluginname','block_glossary_random'));
  40          $mform->setType('config_title', PARAM_TEXT);
  41  
  42          // Select glossaries to put in dropdown box ...
  43          $glossaries = $DB->get_records_select_menu('glossary', 'course = ? OR globalglossary = ?',
  44              [$this->get_course_id(), 1], 'name', 'id,name');
  45          foreach($glossaries as $key => $value) {
  46              $glossaries[$key] = strip_tags(format_string($value, true));
  47          }
  48          $mform->addElement('select', 'config_glossary', get_string('select_glossary', 'block_glossary_random'), $glossaries);
  49  
  50          $mform->addElement('text', 'config_refresh', get_string('refresh', 'block_glossary_random'), array('size' => 5));
  51          $mform->setDefault('config_refresh', 0);
  52          $mform->setType('config_refresh', PARAM_INT);
  53  
  54          // and select quotetypes to put in dropdown box
  55          $types = array(
  56              0 => get_string('random','block_glossary_random'),
  57              1 => get_string('lastmodified','block_glossary_random'),
  58              2 => get_string('nextone','block_glossary_random'),
  59              3 => get_string('nextalpha','block_glossary_random')
  60          );
  61          $mform->addElement('select', 'config_type', get_string('type', 'block_glossary_random'), $types);
  62  
  63          $mform->addElement('selectyesno', 'config_showconcept', get_string('showconcept', 'block_glossary_random'));
  64          $mform->setDefault('config_showconcept', 1);
  65  
  66          $mform->addElement('static', 'footerdescription', '', get_string('whichfooter', 'block_glossary_random'));
  67  
  68          $mform->addElement('text', 'config_addentry', get_string('askaddentry', 'block_glossary_random'));
  69          $mform->setDefault('config_addentry', get_string('addentry', 'block_glossary_random'));
  70          $mform->setType('config_addentry', PARAM_NOTAGS);
  71  
  72          $mform->addElement('text', 'config_viewglossary', get_string('askviewglossary', 'block_glossary_random'));
  73          $mform->setDefault('config_viewglossary', get_string('viewglossary', 'block_glossary_random'));
  74          $mform->setType('config_viewglossary', PARAM_NOTAGS);
  75  
  76          $mform->addElement('text', 'config_invisible', get_string('askinvisible', 'block_glossary_random'));
  77          $mform->setDefault('config_invisible', get_string('invisible', 'block_glossary_random'));
  78          $mform->setType('config_invisible', PARAM_NOTAGS);
  79      }
  80  
  81      /**
  82       * Returns id of the course where this block is located (or siteid for the dashboard or non-course page)
  83       *
  84       * @return int
  85       */
  86      protected function get_course_id(): int {
  87          if ($this->block->instance->id) {
  88              return $this->block->course->id;
  89          } else if ($parentcontext = $this->block->context->get_course_context(false)) {
  90              return $parentcontext->instanceid;
  91          } else {
  92              return get_site()->id;
  93          }
  94      }
  95  
  96      /**
  97       * Display the configuration form when block is being added to the page
  98       *
  99       * @return bool
 100       */
 101      public static function display_form_when_adding(): bool {
 102          return true;
 103      }
 104  }