blocks/myoverview/block_myoverview.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  * Contains the class for the My overview block.
  19  *
  20  * @package    block_myoverview
  21  * @copyright  Mark Nelson <markn@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  * My overview block class.
  29  *
  30  * @package    block_myoverview
  31  * @copyright  Mark Nelson <markn@moodle.com>
  32  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33  */
  34 class block_myoverview extends block_base {
  35
  36     /**
  37      * Init.
  38      */
  39     public function init() {
  40         $this->title = get_string('pluginname', 'block_myoverview');
  41     }
  42
  43     /**
  44      * Returns the contents.
  45      *
  46      * @return stdClass contents of block
  47      */
  48     public function get_content() {
  49         if (isset($this->content)) {
  50             return $this->content;
  51         }
  52
  53         // Check if the tab to select wasn't passed in the URL, if so see if the user has any preference.
  54         if (!$tab = optional_param('myoverviewtab', null, PARAM_ALPHA)) {
  55             // Check if the user has no preference, if so get the site setting.
  56             if (!$tab = get_user_preferences('block_myoverview_last_tab')) {
  57                 $config = get_config('block_myoverview');
  58                 $tab = $config->defaulttab;
  59             }
  60         }
  61
  62         $renderable = new \block_myoverview\output\main($tab);
  63         $renderer = $this->page->get_renderer('block_myoverview');
  64
  65         $this->content = new stdClass();
  66         $this->content->text = $renderer->render($renderable);
  67         $this->content->footer = '';
  68
  69         return $this->content;
  70     }
  71
  72     /**
  73      * Locations where block can be displayed.
  74      *
  75      * @return array
  76      */
  77     public function applicable_formats() {
  78         return array('my' => true);
  79     }
  80
  81     /**
  82      * This block does contain a configuration settings.
  83      *
  84      * @return boolean
  85      */
  86     public function has_config() {
  87         return true;
  88     }
  89 }