[Summary view]

Differences Between: [Versions 310 and 311]

   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   * Payment subsystem callback implementation for enrol_fee.
  19   *
  20   * @package    enrol_fee
  21   * @category   payment
  22   * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace enrol_fee\payment;
  27  
  28  /**
  29   * Payment subsystem callback implementation for enrol_fee.
  30   *
  31   * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
  32   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   */
  34  class service_provider implements \core_payment\local\callback\service_provider {
  35  
  36      /**
  37       * Callback function that returns the enrolment cost and the accountid
  38       * for the course that $instanceid enrolment instance belongs to.
  39       *
  40       * @param string $paymentarea Payment area
  41       * @param int $instanceid The enrolment instance id
  42       * @return \core_payment\local\entities\payable
  43       */
  44      public static function get_payable(string $paymentarea, int $instanceid): \core_payment\local\entities\payable {
  45          global $DB;
  46  
  47          $instance = $DB->get_record('enrol', ['enrol' => 'fee', 'id' => $instanceid], '*', MUST_EXIST);
  48  
  49          return new \core_payment\local\entities\payable($instance->cost, $instance->currency, $instance->customint1);
  50      }
  51  
  52      /**
  53       * Callback function that returns the URL of the page the user should be redirected to in the case of a successful payment.
  54       *
  55       * @param string $paymentarea Payment area
  56       * @param int $instanceid The enrolment instance id
  57       * @return \moodle_url
  58       */
  59      public static function get_success_url(string $paymentarea, int $instanceid): \moodle_url {
  60          global $DB;
  61  
  62          $courseid = $DB->get_field('enrol', 'courseid', ['enrol' => 'fee', 'id' => $instanceid], MUST_EXIST);
  63  
  64          return new \moodle_url('/course/view.php', ['id' => $courseid]);
  65      }
  66  
  67      /**
  68       * Callback function that delivers what the user paid for to them.
  69       *
  70       * @param string $paymentarea
  71       * @param int $instanceid The enrolment instance id
  72       * @param int $paymentid payment id as inserted into the 'payments' table, if needed for reference
  73       * @param int $userid The userid the order is going to deliver to
  74       * @return bool Whether successful or not
  75       */
  76      public static function deliver_order(string $paymentarea, int $instanceid, int $paymentid, int $userid): bool {
  77          global $DB;
  78  
  79          $instance = $DB->get_record('enrol', ['enrol' => 'fee', 'id' => $instanceid], '*', MUST_EXIST);
  80  
  81          $plugin = enrol_get_plugin('fee');
  82  
  83          if ($instance->enrolperiod) {
  84              $timestart = time();
  85              $timeend   = $timestart + $instance->enrolperiod;
  86          } else {
  87              $timestart = 0;
  88              $timeend   = 0;
  89          }
  90  
  91          $plugin->enrol_user($instance, $userid, $instance->roleid, $timestart, $timeend);
  92  
  93          return true;
  94      }
  95  }