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.
<?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/>.

/**
 * Contains subplugin info class for payment gateways.
 *
 * @package   core_payment
 * @copyright 2019 Shamim Rezaie <shamim@moodle.com>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace core\plugininfo;

< defined('MOODLE_INTERNAL') || die(); <
/** * Payment gateway subplugin info class. * * @copyright 2019 Shamim Rezaie <shamim@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class paygw extends base {
> public function is_uninstall_allowed() { > public static function plugintype_supports_disabling(): bool { return true; > return true; } > } >
public function get_settings_section_name() { return 'paymentgateway' . $this->name; } public function load_settings(\part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) { global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them.
> /** @var \admin_root $ADMIN */
$ADMIN = $adminroot; // May be used in settings.php. $plugininfo = $this; // Also can be used inside settings.php. if (!$this->is_installed_and_upgraded()) { return; } if (!$hassiteconfig) { return; } $section = $this->get_settings_section_name(); $settings = null; if (file_exists($this->full_path('settings.php'))) { $settings = new \admin_settingpage($section, $this->displayname, 'moodle/site:config', $this->is_enabled() === false); include($this->full_path('settings.php')); // This may also set $settings to null. } if ($settings) { $ADMIN->add($parentnodename, $settings); } } public static function get_manage_url() { return new \moodle_url('/admin/settings.php', array('section' => 'managepaymentgateways')); } public static function get_enabled_plugins() { global $CFG; $order = (!empty($CFG->paygw_plugins_sortorder)) ? explode(',', $CFG->paygw_plugins_sortorder) : []; if ($order) { $plugins = \core_plugin_manager::instance()->get_installed_plugins('paygw'); $order = array_intersect($order, array_keys($plugins)); } return array_combine($order, $order); } public static function enable_plugin(string $pluginname, int $enabled): bool { global $CFG; $haschanged = false; $plugins = []; if (!empty($CFG->paygw_plugins_sortorder)) { $plugins = array_flip(explode(',', $CFG->paygw_plugins_sortorder)); } // Only set visibility if it's different from the current value. if ($enabled && !array_key_exists($pluginname, $plugins)) { $plugins[$pluginname] = $pluginname; $haschanged = true; } else if (!$enabled && array_key_exists($pluginname, $plugins)) { unset($plugins[$pluginname]); $haschanged = true; } if ($haschanged) { add_to_config_log('paygw_plugins_sortorder', !$enabled, $enabled, $pluginname); self::set_enabled_plugins(array_flip($plugins)); } return $haschanged; } /** * Sets the current plugin as enabled or disabled * When enabling tries to guess the sortorder based on default rank returned by the plugin. * * @param bool $newstate */ public function set_enabled(bool $newstate = true) { self::enable_plugin($this->name, $newstate); } /** * Set the list of enabled payment gateways in the specified sort order * To be used when changing settings or in unit tests. * * @param string|array $list list of plugin names without frankenstyle prefix - comma-separated string or an array */ public static function set_enabled_plugins($list) { if (empty($list)) { $list = []; } else if (!is_array($list)) { $list = explode(',', $list); } if ($list) { $plugins = \core_plugin_manager::instance()->get_installed_plugins('paygw'); $list = array_intersect($list, array_keys($plugins)); } set_config('paygw_plugins_sortorder', join(',', $list)); \core_plugin_manager::reset_caches(); } /** * Returns the list of currencies that the payment gateway supports. * * @return string[] An array of the currency codes in the three-character ISO-4217 format */ public function get_supported_currencies(): array { $classname = '\paygw_'.$this->name.'\gateway'; return $classname::get_supported_currencies(); } }