[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   * Class definition for the Recently accessed courses block.
  19   *
  20   * @package    block_recentlyaccessedcourses
  21   * @copyright  2018 Victor Deniz <victor@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  /**
  28   * Recently accessed courses block class.
  29   *
  30   * @package    block_recentlyaccessedcourses
  31   * @copyright  Victor Deniz <victor@moodle.com>
  32   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   */
  34  class block_recentlyaccessedcourses extends block_base {
  35      /**
  36       * Initialize class member variables
  37       */
  38      public function init() {
  39          $this->title = get_string('pluginname', 'block_recentlyaccessedcourses');
  40      }
  41  
  42      /**
  43       * Returns the contents.
  44       *
  45       * @return stdClass contents of block
  46       */
  47      public function get_content() {
  48          if (isset($this->content)) {
  49              return $this->content;
  50          }
  51  
  52          $renderable = new block_recentlyaccessedcourses\output\main();
  53          $renderer = $this->page->get_renderer('block_recentlyaccessedcourses');
  54  
  55          $this->content = new stdClass();
  56          $this->content->text = $renderer->render($renderable);
  57          $this->content->footer = '';
  58  
  59          return $this->content;
  60      }
  61  
  62      /**
  63       * Locations where block can be displayed.
  64       *
  65       * @return array
  66       */
  67      public function applicable_formats() {
  68          return array('my' => true);
  69      }
  70  
  71      /**
  72       * Allow the block to have a configuration page
  73       *
  74       * @return boolean
  75       */
  76      public function has_config() {
  77          return true;
  78      }
  79  
  80      /**
  81       * Return the plugin config settings for external functions.
  82       *
  83       * @return stdClass the configs for both the block instance and plugin
  84       * @since Moodle 3.8
  85       */
  86      public function get_config_for_external() {
  87          // Return all settings for all users since it is safe (no private keys, etc..).
  88          $configs = get_config('block_recentlyaccessedcourses');
  89  
  90          return (object) [
  91              'instance' => new stdClass(),
  92              'plugin' => $configs,
  93          ];
  94      }
  95  }