blocks/lp/block_lp.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  * Block LP main file.
  19  *
  20  * @package    block_lp
  21  * @copyright  2016 Frédéric Massart - FMCorz.net
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 defined('MOODLE_INTERNAL') || die();
  26
  27 /**
  28  * Block LP class.
  29  *
  30  * @package    block_lp
  31  * @copyright  2016 Frédéric Massart - FMCorz.net
  32  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33  */
  34 class block_lp extends block_base {
  35
  36     /**
  37      * Applicable formats.
  38      *
  39      * @return array
  40      */
  41     public function applicable_formats() {
  42         return array('site' => true, 'course' => true, 'my' => true);
  43     }
  44
  45     /**
  46      * Init.
  47      *
  48      * @return void
  49      */
  50     public function init() {
  51         $this->title = get_string('pluginname', 'block_lp');
  52     }
  53
  54     /**
  55      * Get content.
  56      *
  57      * @return stdClass
  58      */
  59     public function get_content() {
  60         if (isset($this->content)) {
  61             return $this->content;
  62         }
  63         $this->content = new stdClass();
  64
  65         if (!get_config('core_competency', 'enabled')) {
  66             return $this->content;
  67         }
  68
  69         // Block needs a valid, non-guest user to be logged-in in order to display the user's learning plans.
  70         if (isloggedin() && !isguestuser()) {
  71             $summary = new \block_lp\output\summary();
  72             if (!$summary->has_content()) {
  73                 return $this->content;
  74             }
  75
  76             $renderer = $this->page->get_renderer('block_lp');
  77             $this->content->text = $renderer->render($summary);
  78             $this->content->footer = '';
  79         }
  80
  81         return $this->content;
  82     }
  83
  84     /**
  85      * This block shouldn't be added to a page if the competencies advanced feature is disabled.
  86      *
  87      * @param moodle_page $page
  88      * @return bool
  89      */
  90     public function can_block_be_added(moodle_page $page): bool {
  91         return get_config('core_competency', 'enabled');
  92     }
  93 }