Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
   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  namespace core\oauth2\client;
  18  
  19  use core\oauth2\client;
  20  
  21  /**
  22   * Class clever - Custom client handler to fetch data from Clever
  23   *
  24   * @package    core
  25   * @copyright  2022 OpenStax
  26   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27   */
  28  class clever extends client {
  29      /**
  30       * Fetch the user id from the userinfo endpoint and then query userdata
  31       *
  32       * @return array|false
  33       */
  34      public function get_userinfo() {
  35          $userinfo = parent::get_userinfo();
  36          $userid = $userinfo['idnumber'];
  37  
  38          return $this->get_userdata($userid);
  39      }
  40  
  41      /**
  42       * Obtain user name and email data via the userdata endpoint
  43       *
  44       * @param string $userid User ID value
  45       * @return array|false
  46       */
  47      private function get_userdata($userid) {
  48          $url = $this->get_issuer()->get_endpoint_url('userdata');
  49          $url .= '/' . $userid;
  50  
  51          $response = $this->get($url);
  52          if (!$response) {
  53              return false;
  54          }
  55  
  56          $userinfo = json_decode($response);
  57          if (json_last_error() != JSON_ERROR_NONE) {
  58              debugging('Error encountered while decoding user information: ' . json_last_error_msg());
  59              return false;
  60          }
  61  
  62          return $this->map_userinfo_to_fields($userinfo);
  63      }
  64  }