Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * This class contains a list of webservice functions related to the PayPal payment gateway.
 *
 * @package    paygw_paypal
 * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

declare(strict_types=1);

namespace paygw_paypal\external;

use core_payment\helper;
< use external_api; < use external_function_parameters; < use external_value; < use external_single_structure; < < defined('MOODLE_INTERNAL') || die(); < < require_once($CFG->libdir . '/externallib.php');
> use core_external\external_api; > use core_external\external_function_parameters; > use core_external\external_value; > use core_external\external_single_structure;
class get_config_for_js extends external_api { /** * Returns description of method parameters. * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'component' => new external_value(PARAM_COMPONENT, 'Component'), 'paymentarea' => new external_value(PARAM_AREA, 'Payment area in the component'), 'itemid' => new external_value(PARAM_INT, 'An identifier for payment area in the component'), ]); } /** * Returns the config values required by the PayPal JavaScript SDK. * * @param string $component * @param string $paymentarea * @param int $itemid * @return string[] */ public static function execute(string $component, string $paymentarea, int $itemid): array { self::validate_parameters(self::execute_parameters(), [ 'component' => $component, 'paymentarea' => $paymentarea, 'itemid' => $itemid, ]); $config = helper::get_gateway_configuration($component, $paymentarea, $itemid, 'paypal'); $payable = helper::get_payable($component, $paymentarea, $itemid); $surcharge = helper::get_gateway_surcharge('paypal'); return [ 'clientid' => $config['clientid'], 'brandname' => $config['brandname'], 'cost' => helper::get_rounded_cost($payable->get_amount(), $payable->get_currency(), $surcharge), 'currency' => $payable->get_currency(), ]; } /** * Returns description of method result value. * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'clientid' => new external_value(PARAM_TEXT, 'PayPal client ID'), 'brandname' => new external_value(PARAM_TEXT, 'Brand name'), 'cost' => new external_value(PARAM_FLOAT, 'Cost with gateway surcharge'), 'currency' => new external_value(PARAM_TEXT, 'Currency'), ]); } }