MD-1661: Add form extensibility callbacks (PR moodleou#51)

Add protected properties ($modinfo, $course, $activitytype) and public
getters to report_editdates_form so other plugins can inspect form state.
Refactor definition() and validation() to use instance properties.

Add four plugin callback hooks:
- report_editdates_form_elements: inject extra form elements
- report_editdates_form_definition_after_data: called after form data set
- report_editdates_form_validation: add extra validation rules
- report_editdates_form_post_actions: modify submitted data before save

Document new callbacks in readme.md.

Ref: moodleou#51 (commit cd21173)
Made-with: Cursor

Author: dvdcastro

form.php

@@ -36,24 +36,69 @@
  */
 class report_editdates_form extends moodleform {
 
+    // BEGIN LSU MD-1661: Add properties and public getters for form extensibility callbacks
+    // See: https://github.com/moodleou/moodle-report_editdates/pull/51 (commit cd21173)
+    /**
+     * Mod info instance set for the form.
+     * @var \course_modinfo|null
+     */
+    protected $modinfo;
+
+    /**
+     * Course.
+     * @var \stdClass
+     */
+    protected $course;
+
+    /**
+     * Selected activity type.
+     * @var string
+     */
+    protected $activitytype;
+
+    /**
+     * Get course mod info instance set for the form.
+     * @return course_modinfo|null
+     */
+    public function get_modinfo(): ?course_modinfo {
+        return $this->modinfo;
+    }
+
+    /**
+     * Course object.
+     * @return \stdClass
+     */
+    public function get_course(): stdClass {
+        return $this->course;
+    }
+
+    /**
+     * Selected activity type.
+     * @return string
+     */
+    public function get_activitytype(): string {
+        return $this->activitytype;
+    }
+    // END LSU MD-1661: Add properties and public getters for form extensibility callbacks
+
     #[\Override]
     public function definition() {
         global $CFG, $DB, $PAGE;
         $mform = $this->_form;
 
-        $modinfo       = $this->_customdata['modinfo'];
-        $course        = $this->_customdata['course'];
-        $activitytype  = $this->_customdata['activitytype'];
+        $this->modinfo      = $this->_customdata['modinfo'];
+        $this->course       = $this->_customdata['course'];
+        $this->activitytype = $this->_customdata['activitytype'];
         $config = get_config('report_editdates');
 
         $coursehasavailability = !empty($CFG->enableavailability);
-        $coursehascompletion   = !empty($CFG->enablecompletion) && !empty($course->enablecompletion);
+        $coursehascompletion   = !empty($CFG->enablecompletion) && !empty($this->course->enablecompletion);
 
         // Context instance of the course.
-        $coursecontext = context_course::instance($course->id);
+        $coursecontext = context_course::instance($this->course->id);
 
         // Store current activity type.
-        $mform->addElement('hidden', 'activitytype', $activitytype);
+        $mform->addElement('hidden', 'activitytype', $this->activitytype);
         $mform->setType('activitytype', PARAM_PLUGIN);
 
         // Invisible static element. Used as the holder for a validation message sometimes.
@@ -69,11 +114,11 @@ public function definition() {
 
         $mform->addElement('date_time_selector', 'coursestartdate', get_string('startdate'));
         $mform->addHelpButton('coursestartdate', 'startdate');
-        $mform->setDefault('coursestartdate', $course->startdate);
+        $mform->setDefault('coursestartdate', $this->course->startdate);
 
         $mform->addElement('date_time_selector', 'courseenddate', get_string('enddate'), ['optional' => true]);
         $mform->addHelpButton('courseenddate', 'enddate');
-        $mform->setDefault('courseenddate', $course->enddate);
+        $mform->setDefault('courseenddate', $this->course->enddate);
 
         // If user is not capable, make it read only.
         if (!has_capability('moodle/course:update', $coursecontext)) {
@@ -91,8 +136,8 @@ public function definition() {
         $prevsectionnum = -1;
 
         // Cycle through all the sections in the course.
-        $cms = $modinfo->get_cms();
-        $sections = $modinfo->get_section_info_all();
+        $cms = $this->modinfo->get_cms();
+        $sections = $this->modinfo->get_section_info_all();
         $timeline = [];
         foreach ($sections as $sectionnum => $section) {
             $ismodadded = false;
@@ -105,7 +150,7 @@ public function definition() {
 
             // New section, create header.
             if ($prevsectionnum != $sectionnum) {
-                $sectionname = get_section_name($course, $section);
+                $sectionname = get_section_name($this->course, $section);
                 $headername = 'section' . $sectionnum . 'header';
                 $mform->addElement('header', $headername, $sectionname);
                 $mform->setExpanded($headername, false);
@@ -163,8 +208,8 @@ public function definition() {
             }
 
             // Cycle through each module in a section.
-            if (isset($modinfo->sections[$sectionnum])) {
-                foreach ($modinfo->sections[$sectionnum] as $cmid) {
+            if (isset($this->modinfo->sections[$sectionnum])) {
+                foreach ($this->modinfo->sections[$sectionnum] as $cmid) {
                     $cm = $cms[$cmid];
 
                     // No need to display/continue if this module is not visible to user.
@@ -173,7 +218,7 @@ public function definition() {
                     }
 
                     // If activity filter is on, then filter module by activity type.
-                    if ($activitytype && ($cm->modname != $activitytype && $activitytype != "all")) {
+                    if ($this->activitytype && ($cm->modname != $this->activitytype && $this->activitytype != "all")) {
                         continue;
                     }
 
@@ -199,7 +244,7 @@ public function definition() {
 
                     // Call get_settings method for the acitivity/module.
                     // Get instance of the mod's date exractor class.
-                    $mod = report_editdates_mod_date_extractor::make($cm->modname, $course);
+                    $mod = report_editdates_mod_date_extractor::make($cm->modname, $this->course);
                     if ($mod && ($cmdatesettings = $mod->get_settings($cm))) {
                         // Added activity name on the form.
                         foreach ($cmdatesettings as $cmdatetype => $cmdatesetting) {
@@ -304,7 +349,7 @@ public function definition() {
 
             // Iterate though blocks array.
             foreach ($courseblocks as $blockid => $block) {
-                $blockdatextrator = report_editdates_block_date_extractor::make($block->blockname, $course);
+                $blockdatextrator = report_editdates_block_date_extractor::make($block->blockname, $this->course);
                 if ($blockdatextrator) {
                     // Create the block instance.
                     $blockobj = block_instance($block->blockname, $block, $PAGE);
@@ -354,17 +399,38 @@ public function definition() {
             $mform->addElement('static', 'timelineview', '');
             $mform->addElement('html', self::render_timeline_view($timeline));
         }
+
+        // BEGIN LSU MD-1661: Invoke report_editdates_form_elements callbacks for extensibility
+        // See: https://github.com/moodleou/moodle-report_editdates/pull/51 (commit cd21173)
+        $callbacks = get_plugins_with_function('report_editdates_form_elements', 'lib.php');
+        foreach ($callbacks as $type => $plugins) {
+            foreach ($plugins as $plugin => $pluginfunction) {
+                $pluginfunction($this, $this->_form);
+            }
+        }
+        // END LSU MD-1661: Invoke report_editdates_form_elements callbacks for extensibility
     }
 
+    // BEGIN LSU MD-1661: definition_after_data callback for form extensibility
+    // See: https://github.com/moodleou/moodle-report_editdates/pull/51 (commit cd21173)
+    /**
+     * Invoke callbacks after form data is set.
+     */
+    public function definition_after_data() {
+        $callbacks = get_plugins_with_function('report_editdates_form_definition_after_data', 'lib.php');
+        foreach ($callbacks as $type => $plugins) {
+            foreach ($plugins as $plugin => $pluginfunction) {
+                $pluginfunction($this, $this->_form);
+            }
+        }
+    }
+    // END LSU MD-1661: definition_after_data callback for form extensibility
+
     #[\Override]
     public function validation($data, $files) {
         global $CFG;
         $errors = parent::validation($data, $files);
 
-        $modinfo = $this->_customdata['modinfo'];
-        $course = $this->_customdata['course'];
-        $coursecontext = context_course::instance($course->id);
-
         $moddatesettings = [];
         $forceddatesettings = [];
         foreach ($data as $key => $value) {
@@ -399,7 +465,7 @@ public function validation($data, $files) {
             }
         }
 
-        $cms = $modinfo->get_cms();
+        $cms = $this->modinfo->get_cms();
 
         // Validating forced date settings.
         foreach ($forceddatesettings as $modid => $datesettings) {
@@ -420,7 +486,7 @@ public function validation($data, $files) {
             $cm = $cms[$modid];
             $moderrors = [];
 
-            if ($mod = report_editdates_mod_date_extractor::make($cm->modname, $course)) {
+            if ($mod = report_editdates_mod_date_extractor::make($cm->modname, $this->course)) {
                 $moderrors = $mod->validate_dates($cm, $datesettings);
                 if (!empty($moderrors)) {
                     foreach ($moderrors as $errorfield => $errorstr) {
@@ -430,6 +496,19 @@ public function validation($data, $files) {
             }
         }
 
+        // BEGIN LSU MD-1661: Invoke report_editdates_form_validation callbacks for extensibility
+        // See: https://github.com/moodleou/moodle-report_editdates/pull/51 (commit cd21173)
+        $callbacks = get_plugins_with_function('report_editdates_form_validation', 'lib.php');
+        foreach ($callbacks as $type => $plugins) {
+            foreach ($plugins as $plugin => $pluginfunction) {
+                $pluginerrors = $pluginfunction($this, $data);
+                if (!empty($pluginerrors)) {
+                    $errors = array_merge($errors, $pluginerrors);
+                }
+            }
+        }
+        // END LSU MD-1661: Invoke report_editdates_form_validation callbacks for extensibility
+
         if (!empty($errors)) {
             // If there are any validation errors, which may be hidden a long way down this
             // very big form, put a message at the top too.

index.php

@@ -93,6 +93,16 @@
     redirect($returnurl);
 
 } else if ($data = $mform->get_data()) {
+    // BEGIN LSU MD-1661: Invoke report_editdates_form_post_actions callbacks before processing
+    // See: https://github.com/moodleou/moodle-report_editdates/pull/51 (commit cd21173)
+    $callbacks = get_plugins_with_function('report_editdates_form_post_actions', 'lib.php');
+    foreach ($callbacks as $type => $plugins) {
+        foreach ($plugins as $plugin => $pluginfunction) {
+            $data = $pluginfunction($data, $course);
+        }
+    }
+    // END LSU MD-1661: Invoke report_editdates_form_post_actions callbacks before processing
+
     // Process submitted data.
 
     $moddatesettings = [];

readme.md

@@ -41,3 +41,15 @@ For other plugins, there is the option to put the class in the other plugin.
 You need to make a class called `mod_`_mymodname_`_report_editdates_integration`,
 which therefore goes in mod/_mymodname_/classes/report_editdates_integration.php.
 For blocks, the equivalent class is `block_`_myblock_`_report_editdates_integration`.
+
+## Available callbacks
+
+To be aligned with a core extension point for the activity form via core callbacks,
+this plugin allows developers to extend dates form the same way.
+
+Supported callbacks:
+
+* report_editdates_form_elements
+* report_editdates_form_definition_after_data
+* report_editdates_form_validation
+* report_editdates_form_post_actions