feat: consider editors in is_complete_response

Author: MHajoha

classes/local/attempt_ui/custom_xhtml_element.php

@@ -20,7 +20,9 @@
 use core\exception\coding_exception;
 use DOMElement;
 use DOMNode;
+use DOMXPath;
 use file_exception;
+use Iterator;
 use moodle_exception;
 use question_attempt;
 use stored_file_creation_exception;
@@ -34,6 +36,14 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 interface custom_xhtml_element {
+    /**
+     * Finds all matching elements within the provided DOMXPath.
+     *
+     * @param DOMXPath $xpath
+     * @return Iterator<static>
+     */
+    public static function find_all_in(DOMXPath $xpath): Iterator;
+
     /**
      * Parses the given DOMElement if possible.
      *

classes/local/attempt_ui/qpy_file_upload.php

@@ -22,8 +22,10 @@
 use DOMDocument;
 use DOMElement;
 use DOMNode;
+use DOMXPath;
 use file_exception;
 use form_filemanager;
+use Iterator;
 use moodle_exception;
 use qtype_questionpy\local\files\response_file_service;
 use qtype_questionpy\local\files\validatable_upload_limits;
@@ -47,7 +49,7 @@ class qpy_file_upload implements custom_xhtml_element {
      */
     private function __construct(
         /** @var DOMElement */
-        private readonly DOMElement $element,
+        public readonly DOMElement $element,
         /** @var string */
         public readonly string $name,
     ) {
@@ -156,4 +158,22 @@ private function render_writable(question_attempt $qa, question_ui_renderer $ren
         $html = $filesrenderer->render($fm);
         return dom_utils::html_to_fragment($this->element->ownerDocument, $html);
     }
+
+    /**
+     * Finds all matching elements within the provided DOMXPath.
+     *
+     * @param DOMXPath $xpath
+     * @return Iterator<static>
+     */
+    public static function find_all_in(DOMXPath $xpath): Iterator {
+        /** @var DOMElement $element */
+        foreach ($xpath->query('//qpy:file-upload') as $element) {
+            $upload = self::from_element($element);
+            if (!$upload) {
+                continue;
+            }
+
+            yield $upload;
+        }
+    }
 }

classes/local/attempt_ui/qpy_rich_text_editor.php

@@ -22,7 +22,9 @@
 use DOMDocumentFragment;
 use DOMElement;
 use DOMNode;
+use DOMXPath;
 use file_exception;
+use Iterator;
 use moodle_exception;
 use moodle_url;
 use MoodleQuickForm_editor;
@@ -65,7 +67,7 @@ class qpy_rich_text_editor implements custom_xhtml_element {
      */
     private function __construct(
         /** @var DOMElement */
-        private readonly DOMElement $element,
+        public readonly DOMElement $element,
         /** @var string */
         public readonly string $name,
         /** @var bool */
@@ -241,4 +243,22 @@ public function render_writable(question_ui_renderer $renderer, question_attempt
 
         return dom_utils::html_to_fragment($this->element->ownerDocument, $meditor->toHtml());
     }
+
+    /**
+     * Finds all matching elements within the provided DOMXPath.
+     *
+     * @param DOMXPath $xpath
+     * @return Iterator<static>
+     */
+    public static function find_all_in(DOMXPath $xpath): Iterator {
+        /** @var DOMElement $element */
+        foreach ($xpath->query('//qpy:rich-text-editor') as $element) {
+            $editor = self::from_element($element);
+            if (!$editor) {
+                continue;
+            }
+
+            yield $editor;
+        }
+    }
 }

classes/local/attempt_ui/question_ui_metadata_extractor.php

@@ -40,18 +40,26 @@ class question_ui_metadata_extractor {
     private DOMXPath $xpath;
 
     /**
-     * @var array|false $correctresponse `false` if not yet extracted, empty array if not set in the XML.
+     * @var array|null|false $correctresponse `false` if not yet extracted, null if not set in the XML.
      * @see \qtype_questionpy_question::get_correct_response()
      */
     private array|null|false $correctresponse = false;
 
     /**
-     * @var string[] $requiredfields `false` if not yet extracted.
+     * @var string[]|false $requiredfields `false` if not yet extracted.
      * @see \question_manually_gradable::is_complete_response()
      * @see \question_manually_gradable::is_gradable_response()
      */
     private array|false $requiredfields = false;
 
+    /**
+     * @var string[]|false $requirededitors `false` if not yet extracted.
+     * @see \question_manually_gradable::is_complete_response()
+     * @see \question_manually_gradable::is_gradable_response()
+     */
+    private array|false $requirededitors = false;
+
+
     /**
      * Parses the given XML and initializes a new {@see question_ui_metadata_extractor} instance.
      *
@@ -67,11 +75,11 @@ public function __construct(string $xml) {
     }
 
     /**
-     * Extracts the names of required fields from the question UI XML.
+     * Extracts the names of required main response fields from the question UI XML.
      *
      * @return string[]
      */
-    public function get_required_fields(): array {
+    public function get_required_response_fields(): array {
         if ($this->requiredfields !== false) {
             return $this->requiredfields;
         }
@@ -90,11 +98,29 @@ public function get_required_fields(): array {
             }
         }
 
-        // TODO: Include required WYSIWYG editor fields.
-
         return $this->requiredfields;
     }
 
+    /**
+     * Extracts the names of required rich text editors from the question UI XML.
+     *
+     * @return string[]
+     */
+    public function get_required_editors(): array {
+        if ($this->requirededitors !== false) {
+            return $this->requirededitors;
+        }
+
+        $this->requirededitors = [];
+        foreach (qpy_rich_text_editor::find_all_in($this->xpath) as $editor) {
+            if ($editor->required) {
+                $this->requirededitors[] = $editor->name;
+            }
+        }
+
+        return $this->requirededitors;
+    }
+
     /**
      * Returns the correct response for any fields that use the `@qpy:correct-response` attribute, or null if none do.
      *
@@ -132,7 +158,6 @@ public function get_correct_response(): ?array {
         return $this->correctresponse;
     }
 
-
     /**
      * Returns limits for all `<qpy:file-upload/>` and `<qpy:rich-text-editor/>` elements in the XML, indexed by their name.
      *
@@ -142,13 +167,11 @@ public function get_correct_response(): ?array {
     public function get_upload_limits(context $attemptcontext): array {
         $uploadlimits = [];
 
-        foreach ($this->xpath->query('//qpy:file-upload') as $element) {
-            $upload = qpy_file_upload::from_element($element);
+        foreach (qpy_file_upload::find_all_in($this->xpath) as $upload) {
             $uploadlimits[$upload->name] = $upload->get_limits_in($attemptcontext);
         }
 
-        foreach ($this->xpath->query('//qpy:rich-text-editor') as $element) {
-            $editor = qpy_rich_text_editor::from_element($element);
+        foreach (qpy_rich_text_editor::find_all_in($this->xpath) as $editor) {
             $uploadlimits[$editor->name] = $editor->get_limits_in($attemptcontext);
         }
 

classes/local/attempt_ui/question_ui_renderer.php

@@ -282,7 +282,7 @@ private function replace_shuffled_indices(DOMElement $container, DOMElement $ele
     }
 
     /**
-     * Renders all the `<qpy:file-upload/>`-elements.
+     * Renders all the `<qpy:file-upload/>` and `<qpy:rich-text-editor/>`-elements.
      *
      * @param question_attempt $qa
      * @throws file_exception
@@ -291,24 +291,14 @@ private function replace_shuffled_indices(DOMElement $container, DOMElement $ele
      * @throws moodle_exception
      */
     private function render_custom_elements(question_attempt $qa): void {
-        /** @var DOMElement $element */
-        foreach (iterator_to_array($this->xpath->query('//qpy:file-upload')) as $element) {
-            $newnode = qpy_file_upload::from_element($element);
-            if (!$newnode) {
-                continue;
-            }
-
-            $element->parentNode->replaceChild($newnode->render($qa, $this), $element);
+        /** @var qpy_file_upload $upload */
+        foreach (iterator_to_array(qpy_file_upload::find_all_in($this->xpath)) as $upload) {
+            $upload->element->parentNode->replaceChild($upload->render($qa, $this), $upload->element);
         }
 
-        /** @var DOMElement $element */
-        foreach (iterator_to_array($this->xpath->query('//qpy:rich-text-editor')) as $element) {
-            $newnode = qpy_rich_text_editor::from_element($element);
-            if (!$newnode) {
-                continue;
-            }
-
-            $element->parentNode->replaceChild($newnode->render($qa, $this), $element);
+        /** @var qpy_rich_text_editor $editor */
+        foreach (iterator_to_array(qpy_rich_text_editor::find_all_in($this->xpath)) as $editor) {
+            $editor->element->parentNode->replaceChild($editor->render($qa, $this), $editor->element);
         }
     }
 

question.php

@@ -334,11 +334,21 @@ public function is_complete_response(array $response): bool {
             return !empty($qpyresponse);
         }
 
-        foreach ($this->metadata->get_required_fields() as $requiredfield) {
+        foreach ($this->metadata->get_required_response_fields() as $requiredfield) {
             if (!isset($qpyresponse->{$requiredfield}) || $qpyresponse->{$requiredfield} === '') {
                 return false;
             }
         }
+
+        $editors = utils::get_qpy_editors_data($response);
+        foreach ($this->metadata->get_required_editors() as $requirededitorname) {
+            if (!isset($editors[$requirededitorname]) || $editors[$requirededitorname]->text === '') {
+                return false;
+            }
+        }
+
+        // TODO: Check if file uploads have their min-files satisfied (#220).
+
         return true;
     }
 

tests/local/attempt_ui/question_ui_metadata_extractor_test.php

@@ -42,6 +42,6 @@ public function test_should_extract_correct_metadata(): void {
             'my_text' => 'Lorem ipsum dolor sit amet.',
         ], $metadata->get_correct_response());
 
-        $this->assertEquals(['my_number'], $metadata->get_required_fields());
+        $this->assertEquals(['my_number'], $metadata->get_required_response_fields());
     }
 }