availability/renderer.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/>.
  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 core_availability_multiple_messages $renderable Multiple messages
  44      * @return string Combined HTML
  45      */
  46     public function render_core_availability_multiple_messages(
  47             core_availability_multiple_messages $renderable) {
  48         // Get initial message.
  49         $out = get_string('list_' . ($renderable->root ? 'root_' : '') .
  50                 ($renderable->andoperator ? 'and' : 'or') . ($renderable->treehidden ? '_hidden' : ''),
  51                 'availability');
  52
  53         // Make the list.
  54         $out .= html_writer::start_tag('ul');
  55         foreach ($renderable->items as $item) {
  56             if (is_string($item)) {
  57                 $str = $item;
  58             } else {
  59                 $str = $this->render($item);
  60             }
  61             $out .= html_writer::tag('li', $str);
  62         }
  63         $out .= html_writer::end_tag('ul');
  64         return $out;
  65     }
  66 }