[Summary view] [Print] [Text view]

   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   * Renderer for availability display.
  19   *
  20   * @package core_availability
  21   * @copyright 2014 The Open University
  22   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  /**
  26   * Renderer for availability display.
  27   *
  28   * @package core_availability
  29   * @copyright 2014 The Open University
  30   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31   */
  32  class core_availability_renderer extends plugin_renderer_base {
  33      /**
  34       * Renders HTML for the result of two or more availability restriction
  35       * messages being combined in a list.
  36       *
  37       * The supplied messages should already take account of the 'not' option,
  38       * e.g. an example message could be 'User profile field Department must
  39       * not be set to Maths'.
  40       *
  41       * This function will not be called unless there are at least two messages.
  42       *
  43       * @param bool $root True if this is a root-level list for an activity
  44       * @param bool $andoperator True if the messages are being combined as AND
  45       * @param bool $roothidden True if the root level should use 'hidden' message
  46       * @param array $messages Messages to render
  47       * @return string Combined HTML
  48       */
  49      public function multiple_messages($root, $andoperator, $roothidden, array $messages) {
  50          // Get initial message.
  51          $out = get_string('list_' . ($root ? 'root_' : '') .
  52                  ($andoperator ? 'and' : 'or') . ($roothidden ? '_hidden' : ''),
  53                  'availability');
  54  
  55          // Make the list.
  56          $out .= html_writer::start_tag('ul');
  57          foreach ($messages as $message) {
  58              $out .= html_writer::tag('li', $message);
  59          }
  60          $out .= html_writer::end_tag('ul');
  61          return $out;
  62      }
  63  }