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