Merge branch 'MDL-70130-310' of git://github.com/andrewnicols/moodle into MOODLE_310_...
[moodle.git] / payment / classes / local / entities / payable.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  * The payable class.
19  *
20  * @package    core_payment
21  * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_payment\local\entities;
27 /**
28  * The payable class.
29  *
30  * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
31  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32  */
33 class payable {
34     private $amount;
35     private $currency;
36     private $accountid;
38     public function __construct(float $amount, string $currency, int $accountid) {
39         $this->amount = $amount;
40         $this->currency = $currency;
41         $this->accountid = $accountid;
42     }
44     /**
45      * Get the amount of the payable cost.
46      *
47      * @return float
48      */
49     public function get_amount(): float {
50         return $this->amount;
51     }
53     /**
54      * Get the currency of the payable cost.
55      *
56      * @return string
57      */
58     public function get_currency(): string {
59         return $this->currency;
60     }
62     /**
63      * Get the id of the payment account the cost is payable to.
64      *
65      * @return int
66      */
67     public function get_account_id(): int {
68         return $this->accountid;
69     }
70 }