Merge branch 'MDL-70130-310' of git://github.com/andrewnicols/moodle into MOODLE_310_...
[moodle.git] / payment / classes / local / callback / service_provider.php
CommitLineData
5337ca48
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/**
b63f17b5 18 * This file contains the \core_payment\local\local\callback\service_provider interface.
5337ca48
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
5337ca48 29/**
b63f17b5 30 * The service_provider interface for plugins to provide callbacks which are needed by the payment subsystem.
5337ca48
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 */
b63f17b5 35interface service_provider {
5337ca48
SR
36
37 /**
7d10f352 38 * @param string $paymentarea
52305c9a 39 * @param int $itemid An identifier that is known to the plugin
b63f17b5 40 * @return \core_payment\local\entities\payable
5337ca48 41 */
b63f17b5 42 public static function get_payable(string $paymentarea, int $itemid): \core_payment\local\entities\payable;
5337ca48
SR
43
44 /**
7d10f352 45 * @param string $paymentarea
52305c9a 46 * @param int $itemid An identifier that is known to the plugin
15a4e4c8 47 * @param int $paymentid payment id as inserted into the 'payments' table, if needed for reference
b63f17b5
SR
48 * @param int $userid The userid the order is going to deliver to
49 *
5337ca48
SR
50 * @return bool Whether successful or not
51 */
b63f17b5 52 public static function deliver_order(string $paymentarea, int $itemid, int $paymentid, int $userid): bool;
5337ca48 53}