Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 39 and 401]

   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   * Search form renderable.
  19   *
  20   * @package    block_search_forums
  21   * @copyright  2016 Frédéric Massart - FMCorz.net
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace block_search_forums\output;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  use help_icon;
  29  use moodle_url;
  30  use renderable;
  31  use renderer_base;
  32  use templatable;
  33  
  34  /**
  35   * Search form renderable class.
  36   *
  37   * @package    block_search_forums
  38   * @copyright  2016 Frédéric Massart - FMCorz.net
  39   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  class search_form implements renderable, templatable {
  42  
  43      /** @var int The course ID. */
  44      protected $courseid;
  45      /** @var moodle_url The form action URL. */
  46      protected $actionurl;
  47      /** @var help_icon The help icon. */
  48      protected $helpicon;
  49  
  50      /**
  51       * Constructor.
  52       *
  53       * @param int $courseid The course ID.
  54       */
  55      public function __construct($courseid) {
  56          $this->courseid = $courseid;
  57          $this->actionurl = new moodle_url('/mod/forum/search.php', ['id' => $courseid]);
  58          $this->helpicon = new help_icon('search', 'core');
  59      }
  60  
  61      public function export_for_template(renderer_base $output) {
  62          $data = [
  63              'action' => $this->actionurl,
  64              'helpicon' => $this->helpicon->export_for_template($output),
  65              'hiddenfields' => (object) ['name' => 'id', 'value' => $this->courseid],
  66              'inputname' => 'search',
  67              'searchstring' => get_string('search')
  68          ];
  69          return $data;
  70      }
  71  
  72  }