[Summary view]

   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   * Contains class for displaying a recipient.
  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\external;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use core\external\exporter;
  30  
  31  /**
  32   * Class for displaying a badge competency.
  33   *
  34   * @package   core_badges
  35   * @copyright 2019 Damyon Wiese
  36   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class recipient_exporter extends exporter {
  39  
  40      /**
  41       * Return the list of properties.
  42       *
  43       * @return array
  44       */
  45      protected static function define_properties() {
  46          return [
  47              'identity' => [
  48                  'type' => PARAM_RAW,
  49                  'description' => 'Hashed email address to issue badge to.',
  50              ],
  51              'plaintextIdentity' => [
  52                  'type' => PARAM_RAW,
  53                  'description' => 'Email address to issue badge to.',
  54                  'optional' => true,
  55              ],
  56              'salt' => [
  57                  'type' => PARAM_RAW,
  58                  'description' => 'Salt used to hash email.',
  59                  'optional' => true,
  60              ],
  61              'type' => [
  62                  'type' => PARAM_ALPHA,
  63                  'description' => 'Email',
  64              ],
  65              'hashed' => [
  66                  'type' => PARAM_BOOL,
  67                  'description' => 'Should be true',
  68              ],
  69          ];
  70      }
  71  
  72      /**
  73       * Returns a list of objects that are related.
  74       *
  75       * @return array
  76       */
  77      protected static function define_related() {
  78          return array(
  79              'context' => 'context',
  80          );
  81      }
  82  }