MDL-70287 core_payment: Improving existing and missing phpdocs
[moodle.git] / payment / classes / local / callback / service_provider.php
CommitLineData
22c68a81
SR
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/**
f5d94d63 18 * This file contains the \core_payment\local\local\callback\service_provider interface.
22c68a81
SR
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
27namespace core_payment\local\callback;
28
22c68a81 29/**
f5d94d63 30 * The service_provider interface for plugins to provide callbacks which are needed by the payment subsystem.
22c68a81
SR
31 *
32 * @copyright 2020 Shamim Rezaie <shamim@moodle.com>
33 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34 */
f5d94d63 35interface service_provider {
22c68a81
SR
36
37 /**
03b9d60b
SR
38 * Callback function that returns the cost of the given item in the specified payment area,
39 * along with the accountid that payments are paid to.
40 *
41 * @param string $paymentarea Payment area
d5a9d6e5 42 * @param int $itemid An identifier that is known to the plugin
f5d94d63 43 * @return \core_payment\local\entities\payable
22c68a81 44 */
f5d94d63 45 public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable;
22c68a81
SR
46
47 /**
03b9d60b
SR
48 * Callback function that delivers what the user paid for to them.
49 *
50 * @param string $paymentarea Payment area
d5a9d6e5 51 * @param int $itemid An identifier that is known to the plugin
1d479dc0 52 * @param int $paymentid payment id as inserted into the 'payments' table, if needed for reference
f5d94d63
SR
53 * @param int $userid The userid the order is going to deliver to
54 *
22c68a81
SR
55 * @return bool Whether successful or not
56 */
f5d94d63 57 public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool;
22c68a81 58}