30df0b990ac6a39959eb93535b69d11e1c9c63db
[moodle.git] / payment / classes / external / get_gateways_for_currency.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/>.
17 /**
18  * This is the external API for this component.
19  *
20  * @package    core_payment
21  * @copyright  2019 Shamim Rezaie <shamim@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_payment\external;
27 use core_payment\helper;
28 use external_api;
29 use external_function_parameters;
30 use external_value;
31 use external_single_structure;
32 use external_multiple_structure;
34 defined('MOODLE_INTERNAL') || die();
36 require_once($CFG->libdir . '/externallib.php');
38 class get_gateways_for_currency extends external_api {
40     /**
41      * Returns description of method parameters.
42      *
43      * @return external_function_parameters
44      */
45     public static function execute_parameters(): external_function_parameters {
46         return new external_function_parameters(
47                 ['component' => new external_value(PARAM_COMPONENT, 'Component'),
48                     'componentid' => new external_value(PARAM_INT, 'Component id')]
49         );
50     }
52     /**
53      * Returns the list of gateways that can process payments in the given currency.
54      *
55      * @param string $component
56      * @param int $componentid
57      * @return \stdClass[]
58      */
59     public static function execute(string $component, int $componentid): array {
61         $params = external_api::validate_parameters(self::execute_parameters(), [
62             'component' => $component,
63             'componentid' => $componentid,
64         ]);
66         $list = [];
67         $gateways = \core_payment\helper::get_gateways_for_currency($params['component'], $params['componentid']);
68         [
69             'amount' => $amount,
70             'currency' => $currency
71         ] = \core_payment\helper::get_cost($params['component'], $params['componentid']);
73         foreach ($gateways as $gateway) {
74             $surcharge = \core_payment\helper::get_gateway_surcharge($gateway);
75             $list[] = (object)[
76                 'shortname' => $gateway,
77                 'name' => get_string('gatewayname', 'pg_' . $gateway),
78                 'description' => get_string('gatewaydescription', 'pg_' . $gateway),
79                 'surcharge' => $surcharge,
80                 'cost' => helper::get_cost_as_string(helper::get_cost_with_surcharge($amount, $surcharge, $currency), $currency),
81             ];
82         }
84         return $list;
85     }
87     /**
88      * Returns description of method result value.
89      *
90      * @return external_multiple_structure
91      */
92     public static function execute_returns(): external_multiple_structure {
93         return new external_multiple_structure(
94                 new external_single_structure([
95                     'shortname' => new external_value(PARAM_PLUGIN, 'Name of the plugin'),
96                     'name' => new external_value(PARAM_TEXT, 'Human readable name of the gateway'),
97                     'description' => new external_value(PARAM_TEXT, 'description of the gateway'),
98                     'surcharge' => new external_value(PARAM_INT, 'percentage of surcharge when using the gateway'),
99                     'cost' => new external_value(PARAM_TEXT,
100                         'Cost in human-readable form (amount plus surcharge with currency sign)'),
101                 ])
102         );
103     }