134784240fa894d0fdfe55723d2e6099bcb5f96d
[moodle.git] / payment / gateway / paypal / classes / external / get_config_for_js.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 class contains a list of webservice functions related to the PayPal payment gateway.
19  *
20  * @package    pg_paypal
21  * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 declare(strict_types=1);
27 namespace pg_paypal\external;
29 use core_payment\helper;
30 use external_api;
31 use external_function_parameters;
32 use external_value;
33 use external_single_structure;
35 defined('MOODLE_INTERNAL') || die();
37 require_once($CFG->libdir . '/externallib.php');
39 class get_config_for_js extends external_api {
41     /**
42      * Returns description of method parameters.
43      *
44      * @return external_function_parameters
45      */
46     public static function execute_parameters(): external_function_parameters {
47         return new external_function_parameters([
48             'component' => new external_value(PARAM_COMPONENT, ''),
49             'componentid' => new external_value(PARAM_INT, ''),
50         ]);
51     }
53     /**
54      * Returns the full URL of the PayPal JavaScript SDK.
55      *
56      * @return string[]
57      */
58     public static function execute($component, $componentid): array {
59         self::validate_parameters(self::execute_parameters(), [
60             'component' => $component,
61             'componentid' => $componentid,
62         ]);
64         $config = helper::get_gateway_configuration($component, $componentid, 'paypal');
65         $cost = helper::get_cost($component, $componentid);
66         $surcharge = helper::get_gateway_surcharge('paypal');
68         return [
69             'clientid' => $config['clientid'],
70             'brandname' => $config['brandname'],
71             'cost' => helper::get_cost_with_surcharge($cost['amount'], $surcharge, $cost['currency']),
72             'currency' => $cost['currency'],
73         ];
74     }
76     /**
77      * Returns description of method result value.
78      *
79      * @return external_single_structure
80      */
81     public static function execute_returns(): external_single_structure {
82         return new external_single_structure([
83             'clientid' => new external_value(PARAM_TEXT, 'PayPal client ID'),
84             'brandname' => new external_value(PARAM_TEXT, 'Brand name'),
85             'cost' => new external_value(PARAM_FLOAT, 'Cost with gateway surcharge'),
86             'currency' => new external_value(PARAM_TEXT, 'Currency'),
87         ]);
88     }
89 }