MDL-40313 Fix code and doc checker warnings.
[moodle.git] / question / classes / bank_search_condition_hide.php
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/>.
18 /**
19  * A search class to control whether hidden / deleted questions are hidden in the list.
20  *
21  * @package   core_question
22  * @copyright 2013 Ray Morris
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * This class controls whether hidden / deleted questions are hidden in the list.
30  *
31  * @copyright 2013 Ray Morris
32  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
34 class core_question_bank_search_condition_hide extends core_question_bank_search_condition {
35     /** @var bool Whether to include old "deleted" questions. */
36     protected $hide;
38     /** @var string SQL fragment to add to the where clause. */
39     protected $where;
41     /**
42      * Constructor.
43      * @param bool $hide whether to include old "deleted" questions.
44      */
45     public function __construct($hide = true) {
46         $this->hide = $hide;
47         if ($hide) {
48             $this->where = 'q.hidden = 0';
49         }
50     }
52     public function where() {
53         return  $this->where;
54     }
56     /**
57      * Print HTML to display the "Also show old questions" checkbox
58      */
59     public function display_options_adv() {
60         echo "<div>";
61         echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'showhidden',
62                                                    'value' => '0', 'id' => 'showhidden_off'));
63         echo html_writer::checkbox('showhidden', '1', (! $this->hide), get_string('showhidden', 'question'),
64                                    array('id' => 'showhidden_on', 'class' => 'searchoptions'));
65         echo "</div>\n";
66     }
67 }