MDL-69166 enrol_fee: use template for payment btn & properly format cost
[moodle.git] / payment / classes / helper.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  * Contains helper class for the payment subsystem.
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;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Helper class for the payment subsystem.
31  *
32  * @copyright  2019 Shamim Rezaie <shamim@moodle.com>
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class helper {
37     /**
38      * Returns an accumulated list of supported currencies by all payment gateways.
39      *
40      * @return string[] An array of the currency codes in the three-character ISO-4217 format
41      */
42     public static function get_supported_currencies(): array {
43         $currencies = [];
45         $plugins = \core_plugin_manager::instance()->get_enabled_plugins('pg');
46         foreach ($plugins as $plugin) {
47             $classname = '\pg_' . $plugin . '\gateway';
49             $currencies += $classname::get_supported_currencies();
50         }
52         $currencies = array_unique($currencies);
54         return $currencies;
55     }
57     /**
58      * Returns the list of gateways that can process payments in the given currency.
59      *
60      * @param string $currency The currency in the three-character ISO-4217 format.
61      * @return string[]
62      */
63     public static function get_gateways_for_currency(string $currency): array {
64         $gateways = [];
66         $plugins = \core_plugin_manager::instance()->get_enabled_plugins('pg');
67         foreach ($plugins as $plugin) {
68             $classname = '\pg_' . $plugin . '\gateway';
70             $currencies = $classname::get_supported_currencies();
71             if (in_array($currency, $currencies)) {
72                 $gateways[] = $plugin;
73             }
74         }
76         return $gateways;
77     }
79     /**
80      * Returns the attributes to place on a pay button.
81      *
82      * @param float $amount Amount of payment
83      * @param string $currency Currency of payment
84      * @param string $component Name of the component that the componentid belongs to
85      * @param int $componentid An internal identifier that is used by the component
86      * @param string $description Description of the payment
87      * @return array
88      */
89     public static function gateways_modal_link_params(float $amount, string $currency, string $component, int $componentid,
90             string $description): array {
91         return [
92             'id' => 'gateways-modal-trigger',
93             'role' => 'button',
94             'data-amount' => $amount,
95             'data-currency' => $currency,
96             'data-component' => $component,
97             'data-componentid' => $componentid,
98             'data-description' => $description,
99         ];
100     }
102     /**
103      * Asks the cost from the related component.
104      *
105      * @param string $component Name of the component that the componentid belongs to
106      * @param int $componentid An internal identifier that is used by the component
107      * @return array['amount' => float, 'currency' => string]
108      * @throws \moodle_exception
109      */
110     public static function get_cost(string $component, int $componentid): array {
111         $cost = component_class_callback("$component\\payment\\provider", 'get_cost', [$componentid]);
113         if ($cost === null) {
114             throw new \moodle_exception('callbacknotimplemented', 'core_payment', '', $component);
115         }
117         return $cost;
118     }
120     /**
121      * Delivers what the user paid for.
122      *
123      * @param string $component Name of the component that the componentid belongs to
124      * @param int $componentid An internal identifier that is used by the component
125      * @return bool Whether successful or not
126      * @throws \moodle_exception
127      */
128     public static function deliver_order(string $component, int $componentid): bool {
129         $result = component_class_callback("$component\\payment\\provider", 'deliver_order', [$componentid]);
131         if ($result === null) {
132             throw new \moodle_exception('callbacknotimplemented', 'core_payment', '', $component);
133         }
135         return $result;
136     }
138     /**
139      * Stores essential information about the payment and returns the "id" field of the payment record in DB.
140      * Each payment gateway may then store the additional information their way.
141      *
142      * @param string $component Name of the component that the componentid belongs to
143      * @param int $componentid An internal identifier that is used by the component
144      * @param int $userid Id of the user who is paying
145      * @param float $amount Amount of payment
146      * @param string $currency Currency of payment
147      * @param string $gateway The gateway that is used for the payment
148      * @return int
149      */
150     public static function save_payment(string $component, int $componentid, int $userid, float $amount, string $currency,
151             string $gateway): int {
152         global $DB;
154         $record = new \stdClass();
155         $record->component = $component;
156         $record->componentid = $componentid;
157         $record->userid = $userid;
158         $record->amount = $amount;
159         $record->currency = $currency;
160         $record->gateway = $gateway;
161         $record->timecreated = $record->timemodified = time();
163         $id = $DB->insert_record('payments', $record);
165         return $id;
166     }