[Summary 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   * Handles displaying the calendar upcoming events block.
  19   *
  20   * @package    block_calendar_upcoming
  21   * @copyright  2004 Eloy Lafuente (stronk7) {@link http://stronk7.com}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  class block_calendar_upcoming extends block_base {
  25  
  26      /**
  27       * Initialise the block.
  28       */
  29      public function init() {
  30          $this->title = get_string('pluginname', 'block_calendar_upcoming');
  31      }
  32  
  33      /**
  34       * Return the content of this block.
  35       *
  36       * @return stdClass the content
  37       */
  38      public function get_content() {
  39          global $CFG;
  40  
  41          require_once($CFG->dirroot.'/calendar/lib.php');
  42  
  43          if ($this->content !== null) {
  44              return $this->content;
  45          }
  46          $this->content = new stdClass;
  47          $this->content->text = '';
  48          $this->content->footer = '';
  49  
  50          $courseid = $this->page->course->id;
  51          $categoryid = ($this->page->context->contextlevel === CONTEXT_COURSECAT) ? $this->page->category->id : null;
  52          $calendar = \calendar_information::create(time(), $courseid, $categoryid);
  53          list($data, $template) = calendar_get_view($calendar, 'upcoming_mini');
  54  
  55          $renderer = $this->page->get_renderer('core_calendar');
  56          $this->content->text .= $renderer->render_from_template($template, $data);
  57  
  58          $url = new \moodle_url('/calendar/view.php', ['view' => 'upcoming']);
  59          if ($courseid != SITEID) {
  60              $url->param('course', $this->page->course->id);
  61          } else if (!empty($categoryid)) {
  62              $url->param('category', $this->page->category->id);
  63          }
  64  
  65          $this->content->footer = html_writer::div(
  66              html_writer::link($url, get_string('gotocalendar', 'block_calendar_upcoming')),
  67              'gotocal'
  68          );
  69  
  70          return $this->content;
  71      }
  72  
  73      /**
  74       * Get the upcoming event block content.
  75       *
  76       * @param array $events list of events
  77       * @param \moodle_url|string $linkhref link to event referer
  78       * @param boolean $showcourselink whether links to courses should be shown
  79       * @return string|null $content html block content
  80       * @deprecated since 3.4
  81       */
  82      public static function get_upcoming_content($events, $linkhref = null, $showcourselink = false) {
  83          debugging(
  84                  'get_upcoming_content() is deprecated. ' .
  85                  'Please see block_calendar_upcoming::get_content() for the correct API usage.',
  86                  DEBUG_DEVELOPER
  87              );
  88  
  89          $content = '';
  90          $lines = count($events);
  91  
  92          if (!$lines) {
  93              return $content;
  94          }
  95  
  96          for ($i = 0; $i < $lines; ++$i) {
  97              if (!isset($events[$i]->time)) {
  98                  continue;
  99              }
 100              $events[$i] = calendar_add_event_metadata($events[$i]);
 101              $content .= '<div class="event"><span class="icon c0">' . $events[$i]->icon . '</span>';
 102              if (!empty($events[$i]->referer)) {
 103                  // That's an activity event, so let's provide the hyperlink.
 104                  $content .= $events[$i]->referer;
 105              } else {
 106                  if (!empty($linkhref)) {
 107                      $href = calendar_get_link_href(new \moodle_url(CALENDAR_URL . $linkhref), 0, 0, 0,
 108                          $events[$i]->timestart);
 109                      $href->set_anchor('event_' . $events[$i]->id);
 110                      $content .= \html_writer::link($href, $events[$i]->name);
 111                  } else {
 112                      $content .= $events[$i]->name;
 113                  }
 114              }
 115              $events[$i]->time = str_replace('&raquo;', '<br />&raquo;', $events[$i]->time);
 116              if ($showcourselink && !empty($events[$i]->courselink)) {
 117                  $content .= \html_writer::div($events[$i]->courselink, 'course');
 118              }
 119              $content .= '<div class="date">' . $events[$i]->time . '</div></div>';
 120              if ($i < $lines - 1) {
 121                  $content .= '<hr />';
 122              }
 123          }
 124  
 125          return $content;
 126      }
 127  }