fix backend code and API docs

Signed-off-by: Christian Hartmann <chris-hartmann@gmx.de>

Author: Chartman123

docs/API_v3.md

@@ -653,6 +653,9 @@ Get all Submissions to a Form
   | Parameter | Type | Description |
   |-----------|---------|-------------|
   | _formId_ | Integer | ID of the form to get the submissions for |
+- Parameters:
+  | Parameter | Type | Description |
+  |------------------|----------|-------------|
   | _query_ | String | Phrase for full text search |
   | _limit_ | Integer | How many items to get |
   | _offset_ | Integer | How many items to skip for a pagination |

lib/Controller/ApiController.php

@@ -1132,7 +1132,10 @@ public function reorderOptions(int $formId, int $questionId, array $newOrder) {
 	 * Get all the submissions of a given form
 	 *
 	 * @param int $formId of the form
-	 * @param ?string $fileFormat the file format that should be used for the download. Defaults to `null`
+	 * @param ?string $query (optional) A search query to filter submissions
+	 * @param ?int $limit (optional) The maximum number of submissions to retrieve. Defaults to `null`
+	 * @param int $offset (optional) The offset for pagination. Defaults to `0`
+	 * @param ?string $fileFormat (optional) The file format that should be used for the download. Defaults to `null`
 	 *                            Possible values:
 	 *                            - `csv`: Comma-separated value
 	 *                            - `ods`: OpenDocument Spreadsheet
@@ -1147,7 +1150,7 @@ public function reorderOptions(int $formId, int $questionId, array $newOrder) {
 	#[NoAdminRequired()]
 	#[BruteForceProtection(action: 'form')]
 	#[ApiRoute(verb: 'GET', url: '/api/v3/forms/{formId}/submissions')]
-	public function getSubmissions(int $formId, ?string $query = null, int $limit = 20, int $offset = 0, ?string $fileFormat = null): DataResponse|DataDownloadResponse {
+	public function getSubmissions(int $formId, ?string $query = null, ?int $limit = null, int $offset = 0, ?string $fileFormat = null): DataResponse|DataDownloadResponse {
 		$form = $this->getFormIfAllowed($formId, Constants::PERMISSION_RESULTS);
 
 		if ($fileFormat !== null) {

lib/Db/SubmissionMapper.php

@@ -7,7 +7,6 @@
 
 namespace OCA\Forms\Db;
 
-use OC\DB\QueryBuilder\QueryFunction;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Db\QBMapper;
 use OCP\DB\QueryBuilder\IQueryBuilder;
@@ -30,35 +29,43 @@ public function __construct(
 	}
 
 	/**
-	 * @param int $formId
-	 * @param ?string $query
-	 * @param int $limit
-	 * @param int $offset
-	 * @throws DoesNotExistException if not found
-	 * @return Submission[]
+	 * Retrieves a list of submissions for a specific form.
+	 *
+	 * @param int $formId The ID of the form whose submissions are being retrieved.
+	 * @param ?string $query An optional search query to filter the submissions.
+	 * @param ?int $limit The maximum number of submissions to retrieve, default: all submissions
+	 * @param int $offset The number of submissions to skip before starting to retrieve, default: 0
+	 * 
+	 * @throws DoesNotExistException If no submissions are found for the given form ID.
+	 * 
+	 * @return Submission[] An array of Submission objects.
 	 */
-	public function findByForm(int $formId, ?string $query = null, int $limit = 20, int $offset = 0): array {
+	public function findByForm(int $formId, ?string $query = null, ?int $limit = null, int $offset = 0): array {
 		$qb = $this->db->getQueryBuilder();
 
-		if ($query) {
-			$qb->select('MAX(submissions.id) AS id, MAX(submissions.form_id) AS form_id, MAX(submissions.user_id) AS user_id, MAX(submissions.timestamp) AS timestamp')
-				->join('submissions', $this->answerMapper->getTableName(), 'answers', $qb->expr()->eq('submissions.id', 'answers.submission_id'))
-				->where($qb->expr()->like('answers.text', $qb->createNamedParameter('%' . $query . '%')))
-				->groupBy('submissions.id');
-		} else {
-			$qb->select('*');
-		}
-
-		$qb->from($this->getTableName(), 'submissions')
-			->andWhere(
-				$qb->expr()->eq('form_id', $qb->createNamedParameter($formId, IQueryBuilder::PARAM_INT))
+		// Select all columns from the submissions table
+		$qb->select('submissions.*')
+			->from($this->getTableName(), 'submissions')
+			->where(
+				$qb->expr()->eq('submissions.form_id', $qb->createNamedParameter($formId, IQueryBuilder::PARAM_INT))
 			)
-			//Newest submissions first
-			->orderBy('timestamp', 'DESC')
-			->setMaxResults($limit)
-			->setFirstResult($offset);
-
-		//var_dump($qb->getSQL());exit;
+			// Newest submissions first
+			->orderBy('submissions.timestamp', 'DESC')
+			->setFirstResult($offset)
+			->setMaxResults($limit);
+
+		// If a query is provided, join the answers table and filter by the query text
+		if ($query !== null) {
+			$qb->join(
+				'submissions',
+				$this->answerMapper->getTableName(),
+				'answers',
+				$qb->expr()->eq('submissions.id', 'answers.submission_id')
+			)
+			->andWhere(
+				$qb->expr()->like('answers.text', $qb->createNamedParameter('%' . $query . '%'))
+			);
+		}
 
 		return $this->findEntities($qb);
 	}
@@ -100,38 +107,50 @@ public function hasFormSubmissionsByUser(Form $form, string $userId): bool {
 	}
 
 	/**
-	 * Count submissions by form
-	 * @param int $formId ID of the form to count submissions
-	 * @throws \Exception
+	 * Counts the number of submissions associated with a specific form.
+	 *
+	 * @param int $formId The ID of the form for which submissions are to be counted.
+	 * @param ?string $searchString An optional search string to filter submissions by their answers.
+	 * @return int The total number of submissions for the specified form.
+	 * @throws \Exception If an error occurs during the count operation.
 	 */
 	public function countSubmissions(int $formId, ?string $searchString = null): int {
 		return $this->countSubmissionsWithFilters($formId, null, -1, $searchString);
 	}
 
 	/**
-	 * Count submissions by form with optional filters
-	 * @param int $formId ID of the form to count submissions
-	 * @param string|null $userId optionally limit submissions to the one of that user
-	 * @param int $limit allows to limit the query selection. If -1, the restriction is ignored
-	 * @throws \Exception
+	 * Count submissions by form with optional filters.
+	 *
+	 * @param int $formId The ID of the form for which submissions are to be counted.
+	 * @param string|null $userId Optionally limit submissions to those made by the specified user.
+	 * @param int $limit The maximum number of submissions to count. If -1, no limit is applied.
+	 * @param string|null $searchString An optional search string to filter submissions by their answers.
+	 * 
+	 * @return int The total number of submissions matching the specified filters.
+	 * 
+	 * @throws \Exception If an error occurs during the count operation.
 	 */
 	protected function countSubmissionsWithFilters(int $formId, ?string $userId = null, int $limit = -1, ?string $searchString = null): int {
 		$qb = $this->db->getQueryBuilder();
 
-		if ($searchString) {
-			$query = $qb->select(new QueryFunction('COUNT(DISTINCT submissions.id) AS num_submissions'))
-				->join('submissions', $this->answerMapper->getTableName(), 'answers', $qb->expr()->eq('submissions.id', 'answers.submission_id'))
-				->andWhere($qb->expr()->like('answers.text', $qb->createNamedParameter('%' . $searchString . '%')));
-		} else {
-			$query = $qb->select($qb->func()->count('*', 'num_submissions'));
-		}
-
-		$query
+		$query = $qb->select($qb->func()->count('submissions.id', 'num_submissions'))
 			->from($this->getTableName(), 'submissions')
-			->where($qb->expr()->eq('form_id', $qb->createNamedParameter($formId, IQueryBuilder::PARAM_INT)));
+			->where($qb->expr()->eq('submissions.form_id', $qb->createNamedParameter($formId, IQueryBuilder::PARAM_INT)));
 
 		if (!is_null($userId)) {
-			$query->andWhere($qb->expr()->eq('user_id', $qb->createNamedParameter($userId, IQueryBuilder::PARAM_STR)));
+			$query->andWhere($qb->expr()->eq('submissions.user_id', $qb->createNamedParameter($userId, IQueryBuilder::PARAM_STR)));
+		}
+
+		if (!is_null($searchString)) {
+			$query->join(
+				'submissions',
+				$this->answerMapper->getTableName(),
+				'answers',
+				$qb->expr()->eq('submissions.id', 'answers.submission_id')
+			)
+			->andWhere(
+				$qb->expr()->like('answers.text', $qb->createNamedParameter('%' . $searchString . '%'))
+			);
 		}
 
 		if ($limit !== -1) {

lib/Service/SubmissionService.php

@@ -91,6 +91,9 @@ private function getAnswers(int $submissionId): array {
 	 * Get all submissions of a form
 	 *
 	 * @param int $formId the form id
+	 * @param ?string $query optional search query to filter submissions
+	 * @param ?int $limit the maximum number of submissions to return
+	 * @param int $offset the number of submissions to skip
 	 * @return list<array{
 	 *     id: int,
 	 *     formId: int,
@@ -99,7 +102,7 @@ private function getAnswers(int $submissionId): array {
 	 *     answers: list<FormsAnswer>,
 	 * }>
 	 */
-	public function getSubmissions(int $formId, ?string $query = null, int $limit = 20, int $offset = 0): array {
+	public function getSubmissions(int $formId, ?string $query = null, ?int $limit = null, int $offset = 0): array {
 		$submissionList = [];
 		try {
 			$submissionEntities = $this->submissionMapper->findByForm($formId, $query, $limit, $offset);