enrol_fee\payment\service_provider Class Reference

Payment subsystem callback implementation for enrol_fee. More...

Inheritance diagram for enrol_fee\payment\service_provider:

Static Public Member Functions
static	deliver_order (string $paymentarea, int $instanceid, int $paymentid, int $userid)
	Callback function that delivers what the user paid for to them.
static	get_payable (string $paymentarea, int $instanceid)
	Callback function that returns the enrolment cost and the accountid for the course that $instanceid enrolment instance belongs to.
static	get_success_url (string $paymentarea, int $instanceid)
	Callback function that returns the URL of the page the user should be redirected to in the case of a successful payment.

Detailed Description

Payment subsystem callback implementation for enrol_fee.

Copyright

2020 Shamim Rezaie shami.nosp@m.m@mo.nosp@m.odle..nosp@m.com

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

deliver_order()

static enrol_fee\payment\service_provider::deliver_order ( string $paymentarea, int $instanceid, int $paymentid, int $userid )

static

Callback function that delivers what the user paid for to them.

Parameters

string	$paymentarea
int	$instanceid	The enrolment instance id
int	$paymentid	payment id as inserted into the 'payments' table, if needed for reference
int	$userid	The userid the order is going to deliver to

Return values

bool	Whether successful or not

Implements core_payment\local\callback\service_provider.

get_payable()

static enrol_fee\payment\service_provider::get_payable ( string $paymentarea, int $instanceid )

static

Callback function that returns the enrolment cost and the accountid for the course that $instanceid enrolment instance belongs to.

Parameters

string	$paymentarea	Payment area
int	$instanceid	The enrolment instance id

Return values

core_payment\local\entities\payable

Implements core_payment\local\callback\service_provider.

get_success_url()

static enrol_fee\payment\service_provider::get_success_url ( string $paymentarea, int $instanceid )

static

Callback function that returns the URL of the page the user should be redirected to in the case of a successful payment.

Parameters

string	$paymentarea	Payment area
int	$instanceid	The enrolment instance id

Return values

moodle_url

Implements core_payment\local\callback\service_provider.

---

The documentation for this class was generated from the following file:

• enrol/fee/classes/payment/service_provider.php