| 1 | 
           efrain | 
           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 | 
            * This file contains a class definition for the Basic Outcomes service
  | 
        
        
            | 
            | 
           19 | 
            *
  | 
        
        
            | 
            | 
           20 | 
            * @package    ltiservice_basicoutcomes
  | 
        
        
            | 
            | 
           21 | 
            * @copyright  2019 Stephen Vickers
  | 
        
        
            | 
            | 
           22 | 
            * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  | 
        
        
            | 
            | 
           23 | 
            */
  | 
        
        
            | 
            | 
           24 | 
              | 
        
        
            | 
            | 
           25 | 
           namespace ltiservice_basicoutcomes\local\service;
  | 
        
        
            | 
            | 
           26 | 
              | 
        
        
            | 
            | 
           27 | 
           defined('MOODLE_INTERNAL') || die();
  | 
        
        
            | 
            | 
           28 | 
              | 
        
        
            | 
            | 
           29 | 
           /**
  | 
        
        
            | 
            | 
           30 | 
            * A service implementing Basic Outcomes.
  | 
        
        
            | 
            | 
           31 | 
            *
  | 
        
        
            | 
            | 
           32 | 
            * @package    ltiservice_basicoutcomes
  | 
        
        
            | 
            | 
           33 | 
            * @since      Moodle 3.7
  | 
        
        
            | 
            | 
           34 | 
            * @copyright  2019 Stephen Vickers
  | 
        
        
            | 
            | 
           35 | 
            * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  | 
        
        
            | 
            | 
           36 | 
            */
  | 
        
        
            | 
            | 
           37 | 
           class basicoutcomes extends \mod_lti\local\ltiservice\service_base {
  | 
        
        
            | 
            | 
           38 | 
              | 
        
        
            | 
            | 
           39 | 
               /** Scope for accessing the service */
  | 
        
        
            | 
            | 
           40 | 
               const SCOPE_BASIC_OUTCOMES = 'https://purl.imsglobal.org/spec/lti-bo/scope/basicoutcome';
  | 
        
        
            | 
            | 
           41 | 
              | 
        
        
            | 
            | 
           42 | 
               /**
  | 
        
        
            | 
            | 
           43 | 
                * Class constructor.
  | 
        
        
            | 
            | 
           44 | 
                */
  | 
        
        
            | 
            | 
           45 | 
               public function __construct() {
  | 
        
        
            | 
            | 
           46 | 
              | 
        
        
            | 
            | 
           47 | 
                   parent::__construct();
  | 
        
        
            | 
            | 
           48 | 
                   $this->id = 'basicoutcomes';
  | 
        
        
            | 
            | 
           49 | 
                   $this->name = 'Basic Outcomes';
  | 
        
        
            | 
            | 
           50 | 
              | 
        
        
            | 
            | 
           51 | 
               }
  | 
        
        
            | 
            | 
           52 | 
              | 
        
        
            | 
            | 
           53 | 
               /**
  | 
        
        
            | 
            | 
           54 | 
                * Get the resources for this service.
  | 
        
        
            | 
            | 
           55 | 
                *
  | 
        
        
            | 
            | 
           56 | 
                * @return array
  | 
        
        
            | 
            | 
           57 | 
                */
  | 
        
        
            | 
            | 
           58 | 
               public function get_resources() {
  | 
        
        
            | 
            | 
           59 | 
              | 
        
        
            | 
            | 
           60 | 
                   if (empty($this->resources)) {
  | 
        
        
            | 
            | 
           61 | 
                       $this->resources = array();
  | 
        
        
            | 
            | 
           62 | 
                       $this->resources[] = new \ltiservice_basicoutcomes\local\resources\basicoutcomes($this);
  | 
        
        
            | 
            | 
           63 | 
                   }
  | 
        
        
            | 
            | 
           64 | 
              | 
        
        
            | 
            | 
           65 | 
                   return $this->resources;
  | 
        
        
            | 
            | 
           66 | 
              | 
        
        
            | 
            | 
           67 | 
               }
  | 
        
        
            | 
            | 
           68 | 
               /**
  | 
        
        
            | 
            | 
           69 | 
                * Get the scope(s) permitted for the tool relevant to this service.
  | 
        
        
            | 
            | 
           70 | 
                *
  | 
        
        
            | 
            | 
           71 | 
                * @return array
  | 
        
        
            | 
            | 
           72 | 
                */
  | 
        
        
            | 
            | 
           73 | 
               public function get_permitted_scopes() {
  | 
        
        
            | 
            | 
           74 | 
              | 
        
        
            | 
            | 
           75 | 
                   $scopes = array();
  | 
        
        
            | 
            | 
           76 | 
                   if (!isset($this->get_typeconfig()['acceptgrades']) || ($this->get_typeconfig()['acceptgrades'] != LTI_SETTING_NEVER)) {
  | 
        
        
            | 
            | 
           77 | 
                       $scopes[] = self::SCOPE_BASIC_OUTCOMES;
  | 
        
        
            | 
            | 
           78 | 
                   }
  | 
        
        
            | 
            | 
           79 | 
              | 
        
        
            | 
            | 
           80 | 
                   return $scopes;
  | 
        
        
            | 
            | 
           81 | 
              | 
        
        
            | 
            | 
           82 | 
               }
  | 
        
        
            | 
            | 
           83 | 
              | 
        
        
            | 
            | 
           84 | 
               /**
  | 
        
        
            | 
            | 
           85 | 
                * Get the scope(s) permitted for the tool relevant to this service.
  | 
        
        
            | 
            | 
           86 | 
                *
  | 
        
        
            | 
            | 
           87 | 
                * @return array
  | 
        
        
            | 
            | 
           88 | 
                */
  | 
        
        
            | 
            | 
           89 | 
               public function get_scopes() {
  | 
        
        
            | 
            | 
           90 | 
                   return [self::SCOPE_BASIC_OUTCOMES];
  | 
        
        
            | 
            | 
           91 | 
               }
  | 
        
        
            | 
            | 
           92 | 
              | 
        
        
            | 
            | 
           93 | 
               /**
  | 
        
        
            | 
            | 
           94 | 
                * Return an array of key/claim mapping allowing LTI 1.1 custom parameters
  | 
        
        
            | 
            | 
           95 | 
                * to be transformed to LTI 1.3 claims.
  | 
        
        
            | 
            | 
           96 | 
                *
  | 
        
        
            | 
            | 
           97 | 
                * @return array Key/value pairs of params to claim mapping.
  | 
        
        
            | 
            | 
           98 | 
                */
  | 
        
        
            | 
            | 
           99 | 
               public function get_jwt_claim_mappings(): array {
  | 
        
        
            | 
            | 
           100 | 
                   return [
  | 
        
        
            | 
            | 
           101 | 
                       'lis_outcome_service_url' => [
  | 
        
        
            | 
            | 
           102 | 
                           'suffix' => 'bo',
  | 
        
        
            | 
            | 
           103 | 
                           'group' => 'basicoutcome',
  | 
        
        
            | 
            | 
           104 | 
                           'claim' => 'lis_outcome_service_url',
  | 
        
        
            | 
            | 
           105 | 
                           'isarray' => false
  | 
        
        
            | 
            | 
           106 | 
                       ],
  | 
        
        
            | 
            | 
           107 | 
                       'lis_result_sourcedid' => [
  | 
        
        
            | 
            | 
           108 | 
                           'suffix' => 'bo',
  | 
        
        
            | 
            | 
           109 | 
                           'group' => 'basicoutcome',
  | 
        
        
            | 
            | 
           110 | 
                           'claim' => 'lis_result_sourcedid',
  | 
        
        
            | 
            | 
           111 | 
                           'isarray' => false
  | 
        
        
            | 
            | 
           112 | 
                       ]
  | 
        
        
            | 
            | 
           113 | 
                   ];
  | 
        
        
            | 
            | 
           114 | 
               }
  | 
        
        
            | 
            | 
           115 | 
              | 
        
        
            | 
            | 
           116 | 
           }
  |