MDL-63729 badges: Return new DB tables data in WS

moodle · Nov 9, 2018 · 5bb1889 · 5bb1889
1 parent 18d27ac
commit 5bb1889
Show file tree

Hide file tree

Showing 7 changed files with 438 additions and 7 deletions.
diff --git a/badges/classes/external.php b/badges/classes/external.php
@@ -124,9 +124,10 @@ public static function get_user_badges($userid = 0, $courseid = 0, $page = 0, $p
 
         foreach ($userbadges as $badge) {
             $context = ($badge->type == BADGE_TYPE_SITE) ? context_system::instance() : context_course::instance($badge->courseid);
+            $canconfiguredetails = has_capability('moodle/badges:configuredetails', $context);
 
             // If the user is viewing another user's badge and doesn't have the right capability return only part of the data.
-            if ($USER->id != $user->id and !has_capability('moodle/badges:configuredetails', $context)) {
+            if ($USER->id != $user->id and !$canconfiguredetails) {
                 $badge = (object) array(
                     'id' => $badge->id,
                     'name' => $badge->name,
@@ -146,7 +147,40 @@ public static function get_user_badges($userid = 0, $courseid = 0, $page = 0, $p
                 );
             }
 
-            $exporter = new user_badge_exporter($badge, array('context' => $context));
+            // Create a badge instance to be able to get the endorsement and other info.
+            $badgeinstance = new badge($badge->id);
+            $endorsement = $badgeinstance->get_endorsement();
+            $competencies = $badgeinstance->get_alignment();
+            $relatedbadges = $badgeinstance->get_related_badges();
+
+            if (!$canconfiguredetails) {
+                // Return only the properties visible by the user.
+
+                if (!empty($competencies)) {
+                    foreach ($competencies as $competency) {
+                        unset($competency->targetdescription);
+                        unset($competency->targetframework);
+                        unset($competency->targetcode);
+                    }
+                }
+
+                if (!empty($relatedbadges)) {
+                    foreach ($relatedbadges as $relatedbadge) {
+                        unset($relatedbadge->version);
+                        unset($relatedbadge->language);
+                        unset($relatedbadge->type);
+                    }
+                }
+            }
+
+            $related = array(
+                'context' => $context,
+                'endorsement' => $endorsement ? $endorsement : null,
+                'competencies' => $competencies,
+                'relatedbadges' => $relatedbadges,
+            );
+
+            $exporter = new user_badge_exporter($badge, $related);
             $result['badges'][] = $exporter->export($PAGE->get_renderer('core'));
         }
 

diff --git a/badges/classes/external/competency_exporter.php b/badges/classes/external/competency_exporter.php
@@ -0,0 +1,94 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Contains competency class for displaying a badge competency.
+ *
+ * @package   core_badges
+ * @copyright 2018 Dani Palou <dani@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_badges\external;
+
+defined('MOODLE_INTERNAL') || die();
+
+use core\external\exporter;
+
+/**
+ * Class for displaying a badge competency.
+ *
+ * @package   core_badges
+ * @copyright 2018 Dani Palou <dani@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class competency_exporter extends exporter {
+
+    /**
+     * Return the list of properties.
+     *
+     * @return array
+     */
+    protected static function define_properties() {
+        return [
+            'id' => [
+                'type' => PARAM_INT,
+                'description' => 'Competency id',
+            ],
+            'badgeid' => [
+                'type' => PARAM_INT,
+                'description' => 'Badge id',
+            ],
+            'targetname' => [
+                'type' => PARAM_TEXT,
+                'description' => 'Target name',
+            ],
+            'targeturl' => [
+                'type' => PARAM_URL,
+                'description' => 'Target URL',
+            ],
+            'targetdescription' => [
+                'type' => PARAM_TEXT,
+                'description' => 'Target description',
+                'null' => NULL_ALLOWED,
+                'optional' => true,
+            ],
+            'targetframework' => [
+                'type' => PARAM_TEXT,
+                'description' => 'Target framework',
+                'null' => NULL_ALLOWED,
+                'optional' => true,
+            ],
+            'targetcode' => [
+                'type' => PARAM_TEXT,
+                'description' => 'Target code',
+                'null' => NULL_ALLOWED,
+                'optional' => true,
+            ]
+        ];
+    }
+
+    /**
+     * Returns a list of objects that are related.
+     *
+     * @return array
+     */
+    protected static function define_related() {
+        return array(
+            'context' => 'context',
+        );
+    }
+}
diff --git a/badges/classes/external/endorsement_exporter.php b/badges/classes/external/endorsement_exporter.php
@@ -0,0 +1,95 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Contains endorsement class for displaying a badge endorsement.
+ *
+ * @package   core_badges
+ * @copyright 2018 Dani Palou <dani@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_badges\external;
+
+defined('MOODLE_INTERNAL') || die();
+
+use core\external\exporter;
+
+/**
+ * Class for displaying a badge endorsement.
+ *
+ * @package   core_badges
+ * @copyright 2018 Dani Palou <dani@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class endorsement_exporter extends exporter {
+
+    /**
+     * Return the list of properties.
+     *
+     * @return array
+     */
+    protected static function define_properties() {
+        return [
+            'id' => [
+                'type' => PARAM_INT,
+                'description' => 'Endorsement id',
+            ],
+            'badgeid' => [
+                'type' => PARAM_INT,
+                'description' => 'Badge id',
+            ],
+            'issuername' => [
+                'type' => PARAM_TEXT,
+                'description' => 'Endorsement issuer name',
+            ],
+            'issuerurl' => [
+                'type' => PARAM_URL,
+                'description' => 'Endorsement issuer URL',
+            ],
+            'issueremail' => [
+                'type' => PARAM_RAW,
+                'description' => 'Endorsement issuer email',
+            ],
+            'claimid' => [
+                'type' => PARAM_URL,
+                'description' => 'Claim URL',
+                'null' => NULL_ALLOWED,
+            ],
+            'claimcomment' => [
+                'type' => PARAM_NOTAGS,
+                'description' => 'Claim comment',
+                'null' => NULL_ALLOWED,
+            ],
+            'dateissued' => [
+                'type' => PARAM_INT,
+                'description' => 'Date issued',
+                'default' => 0,
+            ]
+        ];
+    }
+
+    /**
+     * Returns a list of objects that are related.
+     *
+     * @return array
+     */
+    protected static function define_related() {
+        return array(
+            'context' => 'context',
+        );
+    }
+}
diff --git a/badges/classes/external/related_info_exporter.php b/badges/classes/external/related_info_exporter.php
@@ -0,0 +1,85 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Contains related class for displaying information of a related badge.
+ *
+ * @package   core_badges
+ * @copyright 2018 Dani Palou <dani@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_badges\external;
+
+defined('MOODLE_INTERNAL') || die();
+
+use core\external\exporter;
+
+/**
+ * Class for displaying information of a related badge.
+ *
+ * @package   core_badges
+ * @copyright 2018 Dani Palou <dani@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class related_info_exporter extends exporter {
+
+    /**
+     * Return the list of properties.
+     *
+     * @return array
+     */
+    protected static function define_properties() {
+        return [
+            'id' => [
+                'type' => PARAM_INT,
+                'description' => 'Badge id',
+            ],
+            'name' => [
+                'type' => PARAM_TEXT,
+                'description' => 'Badge name',
+            ],
+            'version' => [
+                'type' => PARAM_TEXT,
+                'description' => 'Version',
+                'optional' => true,
+                'null' => NULL_ALLOWED,
+            ],
+            'language' => [
+                'type' => PARAM_NOTAGS,
+                'description' => 'Language',
+                'optional' => true,
+                'null' => NULL_ALLOWED,
+            ],
+            'type' => [
+                'type' => PARAM_INT,
+                'description' => 'Type',
+                'optional' => true,
+            ],
+        ];
+    }
+
+    /**
+     * Returns a list of objects that are related.
+     *
+     * @return array
+     */
+    protected static function define_related() {
+        return array(
+            'context' => 'context',
+        );
+    }
+}