Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403] [Versions 402 and 403]

   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   * Manage enabled backpacks for the site.
  19   *
  20   * @package    core_badges
  21   * @copyright  2019 Damyon Wiese
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_badges\output;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  require_once($CFG->libdir . '/badgeslib.php');
  30  
  31  use core_badges\external\backpack_exporter;
  32  
  33  /**
  34   * Manage enabled backpacks renderable.
  35   *
  36   * @package    core_badges
  37   * @copyright  2019 Damyon Wiese
  38   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39   */
  40  class external_backpacks_page implements \renderable {
  41  
  42      /** @var \moodle_url Badges backpacks URL. */
  43      protected $url;
  44  
  45      /** @var array List the backpacks at site level. */
  46      protected $backpacks = [];
  47  
  48      /**
  49       * Constructor.
  50       * @param \moodle_url $url
  51       */
  52      public function __construct(\moodle_url $url) {
  53          $this->url = $url;
  54  
  55          $this->backpacks = badges_get_site_backpacks();
  56      }
  57  
  58      /**
  59       * Export this data so it can be used as the context for a mustache template.
  60       *
  61       * @param renderer_base $output Renderer base.
  62       * @return stdClass
  63       */
  64      public function export_for_template(\renderer_base $output) {
  65          global $PAGE;
  66  
  67          $rownumber = 0;
  68          $rowcount = count($this->backpacks);
  69  
  70          $data = new \stdClass();
  71          $data->baseurl = $this->url;
  72          $data->backpacks = array();
  73          $data->sesskey = sesskey();
  74          foreach ($this->backpacks as $backpack) {
  75              $exporter = new backpack_exporter($backpack);
  76              $backpack = $exporter->export($output);
  77              $backpack->cantest = ($backpack->apiversion == OPEN_BADGES_V2);
  78              $backpack->canmoveup = $rownumber > 0;
  79              $backpack->canmovedown = $rownumber < $rowcount - 1;
  80  
  81              $data->backpacks[] = $backpack;
  82              $rownumber++;
  83          }
  84  
  85          return $data;
  86      }
  87  }