Cleanup (#33)

* Fixed course_settings GET param

* Shows error if no gateways are enabled

* Throw error if client ID is not set

* Added plugin->requires to version.php

* Course cost cannot be set below 0

* Fixed Travis errors

* Minor Cleanup

* Update purchase.php

Added newline to end of file

* lib cleanup

* version cleanup

* settings cleanup

* Purchase cleanup

* course settings cleanup

* course settings form cleanup

* purchase form cleanup

* paymentgateway cleanup

* object payment gateway cleanup

* settings cleanup 2

* get string fixes

* function name fix

* Fixed bug

* Various fixes

* Paypal Cleanup

* Various Cleanups

* End of file err fix

* Author fix

* Travis Fixes

* Travis Fixes

* Travis fixes

* Travis Fixes

* Moved currency setting to main settings

* Fixed Travis error

* Fixed Travis error

Co-authored-by: Mitch1404 <[email protected]>

Author: harunaka11037

classes/form/course_settings_form.php

@@ -15,33 +15,36 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Creates a settings page for a course.
- *
- * File         payment_settings_form.php
- * Encoding     UTF-8
+ * Form for the course settings page.
  *
  * @package     tool_paymentplugin
+ * @author      Mitchell Halpin
+ * @author      Haruki Nakagawa
  *
  * @copyright   MAHQ
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  **/
 
 namespace tool_paymentplugin\form;
+
 defined('MOODLE_INTERNAL') || die();
 
 require_once($CFG->libdir.'/formslib.php');
 
 class course_settings_form extends \moodleform {
 
+    /**
+     * Creates the form for course settings.
+     *
+     * @return void
+     */
     public function definition() {
         global $DB;
 
         $thisform = $this->_form;
         $courseid = $this->_customdata['id'];
-
         $thisform->addElement('text', 'coursecost', 'Course Cost');
         $thisform->setType('coursecost', PARAM_INT);
-
         $tablename = 'tool_paymentplugin_course';
         $cost = 0;
 
@@ -51,11 +54,19 @@ public function definition() {
         }
 
         $thisform->setDefault('coursecost', $cost);
-
         $this->add_action_buttons(true);
     }
+
+    /**
+     * Additional validation checks
+     *
+     * @return array of errors
+     */
+    public function validation($data, $files) {
+        $errors = parent::validation($data, $files);
+        if ($data['coursecost'] < 0) {
+            $errors['coursecost'] = get_string('errorcoursecost', 'tool_paymentplugin');
+        }
+        return $errors;
+    }
 }
-// DB->insert_record();
-// See https://docs.moodle.org/dev/Data_manipulation_API for reference.
-// See https://docs.moodle.org/dev/XMLDB_editor for reference.
-// See https://docs.moodle.org/dev/Upgrade_API#install.php for reference.

classes/form/purchase_form.php

@@ -15,18 +15,16 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Creates a settings page for a course.
- *
- * File         purchase.php
- * Encoding     UTF-8
+ * Course Purchase Form.
  *
  * @package     tool_paymentplugin
+ * @author      Haruki Nakagawa
  *
  * @copyright   MAHQ
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  **/
 
- namespace tool_paymentplugin\form;
+namespace tool_paymentplugin\form;
 
 defined('MOODLE_INTERNAL') || die();
 
@@ -35,21 +33,22 @@
 
 class purchase_form extends \moodleform {
 
+    /**
+     * Creates the form for course purchases.
+     *
+     * @return void
+     */
     public function definition() {
         global $DB;
 
         $thisform = $this->_form;
         $courseid = $this->_customdata['id'];
 
         $thehtml = '<div class="purchase-buttons">';
-
         $paymentgateways = paymentgateway::get_all_enabled_gateway_objects();
-        $size = count($paymentgateways);
-
         foreach ($paymentgateways as $paymentgateway) {
             $thehtml .= $paymentgateway->payment_button($courseid);
         }
-
         $thehtml .= '</div>';
 
         $thisform->addElement('html', $thehtml);

classes/paymentgateway/object_paymentgateway.php

@@ -17,10 +17,8 @@
 /**
  * Abstract class for all payment gateway objects.
  *
- * File         object_paymentgateway.php
- * Encoding     UTF-8
- *
  * @package     tool_paymentplugin
+ * @author      Mitchell Halpin
  *
  * @copyright   MAHQ
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
@@ -31,28 +29,56 @@
 defined ('MOODLE_INTERNAL') || die();
 
 abstract class object_paymentgateway {
+
+    // Name of payment gateway.
     public $name;
 
+    /**
+     * @param string name of gateway
+     */
     public function __construct($name) {
         $this->name = $name;
     }
 
+    /**
+     * Gets the display name with 'Payment Gateway' appened on the end.
+     *
+     * @return string name of gateway + 'Payment Gateway'
+     */
+    public function get_display_name_appended() {
+        return get_string('pluginname', 'paymentgateway_'.$this->name).' '.get_string('paymentgateway', 'tool_paymentplugin');
+    }
+
+    /**
+     * Gets the display name of the gateway.
+     *
+     * @return string name of gateway
+     */
     public function get_display_name() {
         return get_string('pluginname', 'paymentgateway_'.$this->name);
     }
-    public function get_readable_name() {
-        return get_string('pluginnamebasic', 'paymentgateway_'.$this->name);
-    }
 
+    /**
+     * Checks if the plugin is enabled in the admin settings for this plugin.
+     *
+     * @return boolean TRUE if enabled, FALSE otherwise.
+     */
     public function is_enabled() {
         $enabled = get_config('paymentgateway_'.$this->name, 'enabled') &&
-            !get_config('tool_paymentplugin_gsettings', 'disablePurchases');
+            !get_config('tool_paymentplugin_settings', 'disableall');
         if ($enabled == 1) {
             return true;
         }
         return false;
     }
 
+    /**
+     * Gets the pyment gateway button in a html acceptable form.
+     *
+     * @param int course id
+     *
+     * @return html of the payment gateway button.
+     */
     public function payment_button($courseid) {
     }
 }

classes/plugininfo/paymentgateway.php

@@ -17,11 +17,8 @@
 /**
  * Defines the subplugin type 'paymentgateway'
  *
- * File         paymentgateway.php
- * Encoding     UTF-8
- *
  * @package     tool_paymentplugin
- * Should the author from the mfa file be put in as author here?
+ * @author      Mitchell Halpin - Based heavily off code done by 'Catalyst AU'
  *
  * @copyright   MAHQ
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
@@ -31,12 +28,10 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-// See https://docs.moodle.org/dev/Subplugins#Settings_pages.
 class paymentgateway extends \core\plugininfo\base  {
 
     /**
-     * Finds all payment gateways.
-     * @author Catalyst AU
+     * gets all payment gateways.
      *
      * @return array of gateway objects.
      */
@@ -52,7 +47,11 @@ public static function get_all_gateway_objects() {
         return self::sort_gateways_by_order($return);
     }
 
-
+    /**
+     * Gets all enabled payment gateway objects.
+     *
+     * @return array of gateway objects
+     */
     public static function get_all_enabled_gateway_objects() {
         $gateways = self::get_all_gateway_objects();
         $returnarr = array();
@@ -64,7 +63,13 @@ public static function get_all_enabled_gateway_objects() {
         return $returnarr;
     }
 
-
+    /**
+     * Get specific gateway object
+     *
+     * @param string name of payment gateway
+     *
+     * @return paymentgateway or null
+     */
     public static function get_gateway_object($name) {
         foreach (\core_plugin_manager::instance()->get_plugins_of_type('paymentgateway') as $gateway) {
             if ($gateway->name == $name) {
@@ -76,10 +81,8 @@ public static function get_gateway_object($name) {
         }
     }
 
-
     /**
      * Sorts payment gateways by configured order.
-     * @author Catalyst AU
      *
      * @param array of gateway objects
      *
@@ -103,16 +106,15 @@ public static function sort_gateways_by_order($unsorted) {
         return $sorted;
     }
 
-     /* Loads factor settings to the settings tree
-     *
-     * This function usually includes settings.php file in plugins folder.
-     * Alternatively it can create a link to some settings page (instance of admin_externalpage)
+    /**
+     * Loads all payment gateway settings.
      *
      * @param \part_of_admin_tree $adminroot
      * @param string $parentnodename
      * @param bool $hassiteconfig whether the current user has moodle/site:config capability
+     *
+     * @return void or null
      */
-
     public function load_settings(\part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
 
         if (!$this->is_installed_and_upgraded()) {

course_settings.php

@@ -17,10 +17,8 @@
 /**
  * Creates a settings page for a course.
  *
- * File         course_settings.php
- * Encoding     UTF-8
- *
  * @package     tool_paymentplugin
+ * @author      Mitchell Halpin
  *
  * @copyright   MAHQ
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
@@ -29,34 +27,28 @@
 require_once(__DIR__.'/../../../config.php');
 use tool_paymentplugin\form\course_settings_form;
 
-$courseid = optional_param('id', 0, PARAM_INT);
-if (empty($courseid)) {
-        throw new moodle_exception('No valid course id detected.');
-}
-
+// Page Setup.
+$courseid = required_param('id', PARAM_INT);
+$PAGE->set_url(new moodle_url('/admin/tool/paymentplugin/course_settings.php', array('id' => $courseid)));
 $course = get_course($courseid);
+$context = \context_course::instance($course->id);
+$PAGE->set_context($context);
+$PAGE->set_pagelayout('admin');
+
+// Check user access.
 require_login($courseid, true);
-$coursecontext = context_course::instance(course_get_format($course)->get_course()->id);
-require_capability('moodle/course:create', $coursecontext);
+require_capability('moodle/course:create', $context);
 
 // Set up the page.
 $title = get_string('coursesettings_management:title', 'tool_paymentplugin');
-$PAGE->set_url('/admin/tool/paymentplugin/course_settings.php');
-$PAGE->set_pagelayout('admin'); // What this do?
-$PAGE->set_context(context_course::instance($courseid));
-$PAGE->set_cacheable(false); // What this do?
-
 $PAGE->set_heading($title);
 $PAGE->navbar->add($title, new moodle_url('/admin/tool/paymentplugin/course_settings.php'));
 
-// Displaying the page.
+// Display Page.
 echo $OUTPUT->header();
 
-// Create settings form.
-$args = array(
-    'course' => $course,
-    'id' => $courseid,
-    );
+// Course Settings Form.
+$args = array('course' => $course, 'id' => $courseid);
 $paymentform = new course_settings_form(new moodle_url('/admin/tool/paymentplugin/course_settings.php',
      array('id' => $courseid)), $args);
 

lang/en/tool_paymentplugin.php

@@ -17,9 +17,6 @@
 /**
  * Language file for payment plugin. EN.
  *
- * File         tool_paymentplugin.php
- * Encoding     UTF-8
- *
  * @package     tool_paymentplugin
  *
  * @copyright   MAHQ
@@ -28,23 +25,23 @@
 
     // General.
     $string['pluginname'] = 'Payment Plugin';
-    $string['gsettings'] = 'Payment Plugin Settings';
-
-    // Global Settings.
-    $string['gsettingsdisableallpurchase'] = 'Disable All Payment Gateways';
-    $string['gsettingsmulti1'] = 'Installed Payment Gateways';
+    $string['adminsettingsheading'] = 'Payment Plugin Settings';
+    $string['paymentgateway'] = 'Payment Gateway';
 
-    // Course Settings.
-    $string['coursesettings:title'] = "Course Enrolment";
-    $string['coursesettings_management:title'] = "Payment Settings";
+    // Admin Settings.
+    $string['gatewaydisableall:text'] = 'Disable All Payment Gateways';
+    $string['gatewaylist:heading'] = 'Enable\Disable Payment Gateways';
+    $string['gatewaylist:desc'] = '{$a->installed} installed payment gateways. {$a->enabled} currently enabled.';
+    $string['gatewayenable:text'] = 'Enable {$a}';
 
-    // Subplugin Settings.
-    $string['tool_paymentplugin_subsettings/heading'] = "Enable\Disable Payment Gateways";
-    $string['tool_paymentplugin_subsettings/headingdesc'] = " installed payment gateways.";
-    $string['tool_paymentplugin_subsettings/headingdesc2'] = " currently enabled.";
+    $string['settings:currency'] = 'Currency';
+    $string['settings:currencydesc'] = 'currency under development';
+    $string['settings:currencyUSD'] = 'USD';
+    $string['settings:currencyAUD'] = 'AUD';
 
-    $string['settingsdisablepurchase'] = 'Enable';
-    $string['settingsdisablepurchasedesc'] = 'If box is checked, users will be able to make purchases via this payment gateway.';
+    // Course Settings.
+    $string['coursesettings:title'] = 'Course Enrolment';
+    $string['coursesettings_management:title'] = 'Payment Settings';
 
     // Subplugin Types.
     $string['subplugintype_paymentgateway'] = 'Payment Gateway';
@@ -53,3 +50,7 @@
     // Purchase page.
     $string['purchasepagetitle'] = 'Purchase course';
     $string['purchasepagecourse'] = 'You are buying the course: "{$a->name}" for ${$a->cost}.';
+
+    // Errors.
+    $string['errorcoursecost'] = 'Please insert a valid number.';
+    $string['errornothingenabled'] = 'No payment gateways have been enabled! Please contact the site administrator for details.';