[Summary view]

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]

   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 the \core_payment\local\local\callback\service_provider interface.
  19   *
  20   * Plugins should implement this if they use payment subsystem.
  21   *
  22   * @package core_payment
  23   * @copyright 2020 Shamim Rezaie <shamim@moodle.com>
  24   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  
  27  namespace core_payment\local\callback;
  28  
  29  /**
  30   * The service_provider interface for plugins to provide callbacks which are needed by the payment subsystem.
  31   *
  32   * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  interface service_provider {
  36  
  37      /**
  38       * @param string $paymentarea
  39       * @param int $itemid An identifier that is known to the plugin
  40       * @return \core_payment\local\entities\payable
  41       */
  42      public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable;
  43  
  44      /**
  45       * @param string $paymentarea
  46       * @param int $itemid An identifier that is known to the plugin
  47       * @param int $paymentid payment id as inserted into the 'payments' table, if needed for reference
  48       * @param int $userid The userid the order is going to deliver to
  49       *
  50       * @return bool Whether successful or not
  51       */
  52      public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool;
  53  }