Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/enrol/fee/classes/payment/ -> service_provider.php (source)

[Source view]

Differences Between: [Versions 310 and 401]

Payment subsystem callback implementation for enrol_fee.

Copyright: 2020 Shamim Rezaie <shamim@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 95 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

service_provider:: (3 methods):
  get_payable()
  get_success_url()
  deliver_order()


Class: service_provider  - X-Ref

Payment subsystem callback implementation for enrol_fee.

get_payable(string $paymentarea, int $instanceid)   X-Ref
Callback function that returns the enrolment cost and the accountid
for the course that $instanceid enrolment instance belongs to.

param: string $paymentarea Payment area
param: int $instanceid The enrolment instance id
return: \core_payment\local\entities\payable

get_success_url(string $paymentarea, int $instanceid)   X-Ref
Callback function that returns the URL of the page the user should be redirected to in the case of a successful payment.

param: string $paymentarea Payment area
param: int $instanceid The enrolment instance id
return: \moodle_url

deliver_order(string $paymentarea, int $instanceid, int $paymentid, int $userid)   X-Ref
Callback function that delivers what the user paid for to them.

param: string $paymentarea
param: int $instanceid The enrolment instance id
param: int $paymentid payment id as inserted into the 'payments' table, if needed for reference
param: int $userid The userid the order is going to deliver to
return: bool Whether successful or not