[Summary view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [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  /**
  19   * Defines an abstract class for filtering/searching the question bank.
  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   */
  25  
  26  namespace core_question\bank\search;
  27  
  28  /**
  29   * An abstract class for filtering/searching questions.
  30   *
  31   * See also {@see question_bank_view::init_search_conditions()}.
  32   * @copyright 2013 Ray Morris
  33   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  abstract class condition {
  36      /**
  37       * Return an SQL fragment to be ANDed into the WHERE clause to filter which questions are shown.
  38       * @return string SQL fragment. Must use named parameters.
  39       */
  40      abstract public function where();
  41  
  42      /**
  43       * Return parameters to be bound to the above WHERE clause fragment.
  44       * @return array parameter name => value.
  45       */
  46      public function params() {
  47          return [];
  48      }
  49  
  50      /**
  51       * Display GUI for selecting criteria for this condition. Displayed when Show More is open.
  52       *
  53       * Compare display_options(), which displays always, whether Show More is open or not.
  54       * @return bool|string HTML form fragment
  55       */
  56      public function display_options_adv() {
  57          return false;
  58      }
  59  
  60      /**
  61       * Display GUI for selecting criteria for this condition. Displayed always, whether Show More is open or not.
  62       *
  63       * Compare display_options_adv(), which displays when Show More is open.
  64       * @return bool|string HTML form fragment
  65       */
  66      public function display_options() {
  67          return false;
  68      }
  69  }