Issue #66: Add comments and version bump

Author: TomoTsuyuki

classes/search/cmsfield.php

@@ -56,8 +56,9 @@ public function get_document_recordset($modifiedfrom = 0, \context $context = nu
             return null;
         }
 
-        $sql = "SELECT mc.id, mc.course AS courseid, mc.typeid, mcf.name AS fieldname, mcd.id dataid,
-                       mcd.value AS value, mcd.valueformat AS valueformat,
+        // Search area is from customfield_data, but if the record is missing from activity, use default value.
+        $sql = "SELECT mc.id, mc.course AS courseid, mc.typeid, mcf.name AS fieldname, mcf.type,
+                       mcd.id dataid, mcd.value AS value, mcd.valueformat AS valueformat,
                        mcd.timecreated AS timecreated, mcd.timemodified AS timemodified
                   FROM {cms} mc
                   JOIN {customfield_data} mcd ON mc.id = mcd.instanceid
@@ -100,16 +101,15 @@ public function get_document($record, $options = []) {
             return false;
         }
 
+        // Get default value for cms custom field.
         if (is_null($this->defaultvalues)) {
             $defaultvalues = [];
-            // Get default value for cms custom field.
             $sql = "SELECT mct.id typeid, mcf.configdata, mcf.name fieldname
                       FROM {cms_types} mct
                       JOIN {customfield_category} mcc ON mcc.itemid = mct.id
                       JOIN {customfield_field} mcf ON mcf.categoryid = mcc.id
                      WHERE mcc.component = 'mod_cms' AND mcc.area = 'cmsfield' AND mcf.type IN ('textarea', 'text')";
             $cmstypes = $DB->get_records_sql($sql);
-            $defaultvalues = [];
             foreach ($cmstypes as $cmstype) {
                 $data = new \stdClass();
                 $configdata = json_decode($cmstype->configdata);
@@ -123,9 +123,17 @@ public function get_document($record, $options = []) {
 
         // Check if it's default value or not.
         if (empty($record->dataid)) {
-            $title = $this->defaultvalues[$record->typeid]->fieldname  ?? 'Default title';
-            $value = $this->defaultvalues[$record->typeid]->value ?? 'Default value';
-            $valueformat = $this->defaultvalues[$record->typeid]->valueformat ?? 'Default valueformat';
+            $title = $this->defaultvalues[$record->typeid]->fieldname  ?? '';
+            $value = $this->defaultvalues[$record->typeid]->value ?? '';
+            if (isset($this->defaultvalues[$record->typeid]->valueformat)) {
+                $valueformat = $this->defaultvalues[$record->typeid]->valueformat;
+            } else {
+                if ($record->type == 'textarea') {
+                    $valueformat = FORMAT_HTML;
+                } else {
+                    $valueformat = FORMAT_PLAIN;
+                }
+            }
         } else {
             $title = $record->fieldname;
             $value = $record->value;
@@ -216,10 +224,7 @@ protected function get_data($id) {
                       FROM {customfield_data} mcd
                       JOIN {cms} mc ON mc.id = mcd.instanceid
                      WHERE mcd.id = :id";
-            $this->cmsdata[$id] = $DB->get_record_sql($sql, ['id' => $id]);
-            if (!$this->cmsdata[$id]) {
-                throw new \dml_missing_record_exception('cms_data');
-            }
+            $this->cmsdata[$id] = $DB->get_record_sql($sql, ['id' => $id], MUST_EXIST);
         }
         return $this->cmsdata[$id];
     }

tests/search/search_test.php

@@ -78,6 +78,7 @@ public function setUp(): void {
         // Set \core_search::instance to the mock_search_engine as we don't require the search engine to be working to test this.
         $search = \testable_core_search::instance();
 
+        // Name for cms activity is using from "title_mustache".
         $cmstype = new cms_types();
         $cmstype->set('name', 'Overview')
             ->set('idnumber', 'overview')
@@ -134,7 +135,7 @@ public function test_get_document_recordset(): void {
 
         $course = self::getDataGenerator()->create_course();
 
-        // Name for cms is coming from "title_mustache" in cms_type.
+        // The name of cms activity is from cms_type, so we do not set when creating the activity.
         $generator = self::getDataGenerator()->get_plugin_generator('mod_cms');
         $record = new \stdClass();
         $record->course = $course->id;
@@ -219,7 +220,6 @@ public function test_default_content(): void {
 
         $course = self::getDataGenerator()->create_course();
 
-        // Name for cms is coming from "title_mustache" in cms_type.
         $generator = self::getDataGenerator()->get_plugin_generator('mod_cms');
         $record = new \stdClass();
         $record->course = $course->id;

version.php

@@ -25,7 +25,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version = 2024082700;
+$plugin->version = 2024082900;
 $plugin->requires = 2020061500; // Moodle 3.9.0 and above.
 $plugin->supported = [39, 401]; // Moodle 3.9 to 4.1 inclusive.
 $plugin->component = 'mod_cms';