Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
paygw_paypal\gateway Class Reference

The gateway class for PayPal payment gateway. More...

Inheritance diagram for paygw_paypal\gateway:
core_payment\gateway

Static Public Member Functions

static add_configuration_to_gateway_form (\core_payment\form\account_gateway $form)
 Configuration form for the gateway instance.
 
static add_configuration_to_gateway_form (\core_payment\form\account_gateway $form)
 Configuration form for the gateway instance.
 
static get_supported_currencies ()
 Returns the list of currencies that the payment gateway supports.
 
static validate_gateway_form (\core_payment\form\account_gateway $form, stdClass $data, array $files, array &$errors)
 Validates the gateway configuration form.
 
static validate_gateway_form (\core_payment\form\account_gateway $form, stdClass $data, array $files, array &$errors)
 Validates the gateway configuration form.
 

Detailed Description

The gateway class for PayPal payment gateway.

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

Member Function Documentation

◆ add_configuration_to_gateway_form() [1/2]

static core_payment\gateway::add_configuration_to_gateway_form ( \core_payment\form\account_gateway $form)
staticabstractinherited

Configuration form for the gateway instance.

Use $form->get_mform() to access the MoodleQuickForm instance

Parameters
core_payment\form\account_gateway$form

◆ add_configuration_to_gateway_form() [2/2]

static paygw_paypal\gateway::add_configuration_to_gateway_form ( \core_payment\form\account_gateway $form)
static

Configuration form for the gateway instance.

Use $form->get_mform() to access the MoodleQuickForm instance

Parameters
core_payment\form\account_gateway$form

◆ get_supported_currencies()

static paygw_paypal\gateway::get_supported_currencies ( )
static

Returns the list of currencies that the payment gateway supports.

Return values
string[]An array of the currency codes in the three-character ISO-4217 format

Reimplemented from core_payment\gateway.

◆ validate_gateway_form() [1/2]

static core_payment\gateway::validate_gateway_form ( \core_payment\form\account_gateway $form,
stdClass $data,
array $files,
array & $errors )
staticinherited

Validates the gateway configuration form.

Needs to be overridden to make sure the incomplete configuration can not be enabled.

Parameters
core_payment\form\account_gateway$form
stdClass$data
array$files
array$errorsform errors (passed by reference)

◆ validate_gateway_form() [2/2]

static paygw_paypal\gateway::validate_gateway_form ( \core_payment\form\account_gateway $form,
stdClass $data,
array $files,
array & $errors )
static

Validates the gateway configuration form.

Parameters
core_payment\form\account_gateway$form
stdClass$data
array$files
array$errorsform errors (passed by reference)

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