feat: add question name to form answer output

* Resolves #2700

This allows to identify question from within the UI,
as the user can see the name assigned to a question to identify
it when using the submissions in external places like workflows.

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

Author: susnux

docs/DataStructure.md

@@ -160,18 +160,20 @@ A submission-object describes a single submission by a user to a form.
 
 The actual answers of users on submission.
 
-| Property     | Type    | Restrictions  | Description                                     |
-| ------------ | ------- | ------------- | ----------------------------------------------- |
-| id           | Integer | unique        | An instance-wide unique id of the submission    |
-| submissionId | Integer |               | The id of the submission, the answer belongs to |
-| questionId   | Integer |               | The id of the question, the answer belongs to   |
-| text         | String  | max. 4096 ch. | The actual answer text, the user submitted      |
-
-```
+| Property     | Type    | Restrictions  | Description                                          |
+| ------------ | ------- | ------------- | ---------------------------------------------------- |
+| id           | Integer | unique        | An instance-wide unique id of the submission         |
+| submissionId | Integer |               | The id of the submission, the answer belongs to      |
+| questionId   | Integer |               | The id of the question, the answer belongs to        |
+| questionName | String  |               | The technical name that was assigned to the question |
+| text         | String  | max. 4096 ch. | The actual answer text, the user submitted           |
+
+```json
 {
   "id": 5,
   "submissionId": 5,
   "questionId": 1,
+  "questionName": "preference",
   "text": "Option 2"
 }
 ```

lib/Controller/ApiController.php

@@ -1182,10 +1182,24 @@ public function getSubmissions(int $formId, ?string $query = null, ?int $limit =
 			$submissions = $this->submissionService->getSubmissions($formId, $userId, $query, $limit, $offset);
 			$filteredSubmissionsCount = $this->submissionMapper->countSubmissions($formId, $userId, $query);
 		}
-		$questions = $this->formsService->getQuestions($formId);
+		$questions = [];
+		foreach($this->formsService->getQuestions($formId) as $question) {
+			$questions[$question['id']] = $question;
+		}
+		
 
 		// Append Display Names
-		$submissions = array_map(function (array $submission) {
+		$submissions = array_map(function (array $submission) use ($questions) {
+			if (!empty($submission['answers'])) {
+				$submission['answers'] = array_map(function (array $answer) use ($questions) {
+					$name = $questions[$answer['questionId']]['name'];
+					if ($name) {
+						$answer['questionName'] = $name;
+					}
+					return $answer;
+				}, $submission['answers']);
+			}
+
 			if (substr($submission['userId'], 0, 10) === 'anon-user-') {
 				// Anonymous User
 				// TRANSLATORS On Results when listing the single Responses to the form, this text is shown as heading of the Response.
@@ -1212,7 +1226,7 @@ public function getSubmissions(int $formId, ?string $query = null, ?int $limit =
 
 		$response = [
 			'submissions' => $submissions,
-			'questions' => $questions,
+			'questions' => array_values($questions),
 			'filteredSubmissionsCount' => $filteredSubmissionsCount,
 		];
 

lib/ResponseDefinitions.php

@@ -63,6 +63,7 @@
  *   submissionId: int,
  *   fileId: ?int,
  *   questionId: int,
+ *   questionName?: string,
  *   text: string
  * }
  *