WebSVN – Moodle – Diff – /enrol/fee/classes/plugin.php

  * @package    enrol_fee
  * @copyright  2019 Shamim Rezaie <shamim@moodle.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
+use core\output\single_button;
+use core_enrol\output\enrol_page;
 /**
  * Fee enrolment plugin implementation.
+ *
  * @copyright  2019 Shamim Rezaie <shamim@moodle.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class enrol_fee_plugin extends enrol_plugin {
+    /**
+     * How this enrolment method should be displayed on the "Enrolment methods" page
+     *
+     * @param stdClass $instance
+     * @return string
+     */
+    public function get_instance_name_for_management_page(stdClass $instance): string {
+        $result = $this->get_instance_name($instance);
+        if (strlen((string)$instance->customchar1)) {
+            $context = context_course::instance($instance->courseid);
+            $result .= html_writer::empty_tag('br') .
+                html_writer::tag('em', format_string($instance->customchar1, true, ['context' => $context]));
+        }
+        return $result;
+    }
     /**
      * Returns the list of currencies that the payment subsystem supports and therefore we can work with.
+     *
      * @return array[currencycode => currencyname]
      * Add new instance of enrol plugin.
      * @param object $course
      * @param array $fields instance fields
      * @return int id of new instance, null if can not be created
      */
-    public function add_instance($course, array $fields = null) {
+    public function add_instance($course, ?array $fields = null) {
         if ($fields && !empty($fields['cost'])) {
             $fields['cost'] = unformat_float($fields['cost']);
+        }
         return parent::add_instance($course, $fields);
+    }
             $data->cost = unformat_float($data->cost);
+        }
         return parent::update_instance($instance, $data);
+    }
-    /**
-     * Creates course enrol form, checks if form submitted
-     * and enrols user if necessary. It can also redirect.
-     *
-     * @param stdClass $instance
-     * @return string html text, usually a form in a text box
-     */
+    #[\Override]
-    public function enrol_page_hook(stdClass $instance) {
-        return $this->show_payment_info($instance);
-    }
-    /**
-     * Returns optional enrolment instance description text.
-     *
-     * This is used in detailed course information.
-     *
-     *
-     * @param object $instance
-     * @return string short html text
-     */
-    public function get_description_text($instance) {
-        return $this->show_payment_info($instance);
-    }
-    /**
-     * Generates payment information to display on enrol/info page.
-     *
-     * @param stdClass $instance
-     * @return false|string
-     * @throws coding_exception
-     * @throws dml_exception
-     */
-    private function show_payment_info(stdClass $instance) {
+    public function enrol_page_hook(stdClass $instance) {
-        global $USER, $OUTPUT, $DB;
-        ob_start();
+        global $USER, $OUTPUT, $DB, $PAGE;
         if ($DB->record_exists('user_enrolments', array('userid' => $USER->id, 'enrolid' => $instance->id))) {
-            return ob_get_clean();
+            return '';
         }
         if ($instance->enrolstartdate != 0 && $instance->enrolstartdate > time()) {
-            return ob_get_clean();
+            return '';
+        }
         if ($instance->enrolenddate != 0 && $instance->enrolenddate < time()) {
             $cost = (float) $this->get_config('cost');
         } else {
             $cost = (float) $instance->cost;
+        }
+        $name = !empty($instance->name) ?
+            format_string($instance->name, true, ['context' => $context]) :
+            get_string('paymentrequired');
         if (abs($cost) < 0.01) { // No cost, other enrolment methods (instances) should be used.
+            $notification = new \core\output\notification(get_string('nocost', 'enrol_fee'), 'error', false);
+            $notification->set_extra_classes(['mb-0']);
+            $enrolpage = new enrol_page(
+                instance: $instance,
+                header: $name,
+                body: $OUTPUT->render($notification));
-            echo '<p>'.get_string('nocost', 'enrol_fee').'</p>';
+            return $OUTPUT->render($enrolpage);
+        } else {
+            if (isguestuser() || !isloggedin()) {
+                $button = new single_button(new moodle_url(get_login_url()), get_string('loginsite'),
+                     'get', single_button::BUTTON_PRIMARY);
+            } else {
+                $PAGE->requires->js_call_amd('core_payment/gateways_modal', 'init');
+                $button = new single_button(
+                    $PAGE->url,
+                    get_string('sendpaymentbutton', 'enrol_fee'),
+                    'post',
+                    single_button::BUTTON_PRIMARY,
+                    [
+                        'data-action' => 'core_payment/triggerPayment',
+                        'data-component' => 'enrol_fee',
+                        'data-paymentarea' => 'fee',
+                        'data-itemid' => $instance->id,
+                        'data-cost' => $cost,
+                        'data-successurl' => \enrol_fee\payment\service_provider::get_success_url('fee', $instance->id)->out(false),
+                        'data-description' => get_string('purchasedescription', 'enrol_fee',
+                            format_string($course->fullname, true, ['context' => $context])),
+                    ]);
-        } else {
+            }
             $data = [
+            $body = $OUTPUT->render_from_template('enrol_fee/enrol_page', [
-                'isguestuser' => isguestuser() || !isloggedin(),
+                'cost' => \core_payment\helper::get_cost_as_string($cost, $instance->currency),
-                'cost' => \core_payment\helper::get_cost_as_string($cost, $instance->currency),
+            ]);
-                'instanceid' => $instance->id,
+            $enrolpage = new enrol_page(
-                'description' => get_string('purchasedescription', 'enrol_fee',
+                instance: $instance,
-                    format_string($course->fullname, true, ['context' => $context])),
+                header: $name,
-                'successurl' => \enrol_fee\payment\service_provider::get_success_url('fee', $instance->id)->out(false),
+                body: $body,
-            ];
+                buttons: [$button]);
-            echo $OUTPUT->render_from_template('enrol_fee/payment_region', $data);
-        }
             return $OUTPUT->render($enrolpage);
         return $OUTPUT->box(ob_get_clean());
+    }
      * Add elements to the edit instance form.
+     *
      * @param stdClass $instance
      * @param MoodleQuickForm $mform
      * @param context $context
-     * @return bool
      */
     public function edit_instance_form($instance, MoodleQuickForm $mform, $context) {
         $mform->addElement('text', 'name', get_string('custominstancename', 'enrol'));
+        $mform->setType('name', PARAM_TEXT);
+        $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
+        $mform->addElement('text', 'customchar1', get_string('instancedescription', 'enrol_fee'));
+        $mform->setType('customchar1', PARAM_TEXT);
+        $mform->addHelpButton('customchar1', 'instancedescription', 'enrol_fee');
-        $mform->setType('name', PARAM_TEXT);
+        $mform->addRule('customchar1', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
         $options = $this->get_status_options();
      * @param array $files array of uploaded files "element_name"=>tmp_file_path
      * @param object $instance The instance loaded from the DB
      * @param context $context The context of the instance we are editing
      * @return array of "element_name"=>"error_description" if there are errors,
      *         or an empty array if everything is OK.
-     * @return void
      */
     public function edit_instance_validation($data, $files, $instance, $context) {
         $errors = array();

Proyectos de Subversion Moodle

(root)/enrol/fee/classes/plugin.php – Rev 1 → 1441