payment/classes/local/callback/provider.php

   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\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 defined('MOODLE_INTERNAL') || die();
  30
  31 /**
  32  * The provider interface for plugins to provide callbacks which are needed by the payment subsystem.
  33  *
  34  * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
  35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36  */
  37 interface provider {
  38
  39     /**
  40      * @param int $identifier An identifier that is known to the plugin
  41      * @return array['amount' => float, 'currency' => string, 'accountid' => int]
  42      */
  43     public static function get_cost(int $identifier): array;
  44
  45     /**
  46      * @param int $componentid 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      * @return bool Whether successful or not
  49      */
  50     public static function deliver_order(int $componentid, int $paymentid): bool;
  51 }