Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
5a73f20
fix(api): reject an unknown cell type of a grid question
AndyScherzinger Nov 21, 2026
7c8a381
fix(api): reject a changed sub type before checking the extra settings
AndyScherzinger Nov 21, 2026
48ff6cb
feat(linearscale): add a rating sub type
AndyScherzinger Nov 21, 2026
3415233
feat(linearscale): draw a rating as stars, hearts or thumbs
global-prog Nov 21, 2026
c6b65f5
feat(linearscale): color the rating icons and size them consistently
Chartman123 Nov 22, 2026
5fb0290
refactor(linearscale): use the rating sub type constant in the icon c…
AndyScherzinger Nov 22, 2026
42f21a8
fix(linearscale): reject labels on a rating
AndyScherzinger Nov 22, 2026
c73321d
fix(linearscale): keep the rating icon choice in sync
AndyScherzinger Nov 22, 2026
c75a949
fix(a11y): name the options of a rating by their value
AndyScherzinger Nov 22, 2026
14656b2
fix(a11y): let the hidden radio of a rating cover its icon
AndyScherzinger Nov 22, 2026
0a9779d
test(e2e): cover the rating sub type of the linear scale
AndyScherzinger Nov 21, 2026
1aa086b
fix(linearscale): clear the required error once a value is picked
AndyScherzinger Nov 21, 2026
11193de
fix(a11y): reference only rendered elements from a linear scale
AndyScherzinger Nov 21, 2026
c5cab60
feat(results): show the average rating of a rating question
AndyScherzinger Nov 21, 2026
8f3eed6
fix(a11y): name the back entry of a question type's sub menu
AndyScherzinger Nov 21, 2026
7ac1892
feat(linearscale): choose the rating icon from a dropdown
AndyScherzinger Nov 21, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/API_v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,7 @@ Returns the questions and options of the given form (without submissions).
|-----------|---------|----------|-------------|
| _type_ | [QuestionType](DataStructure.md#question-types) | | The question-type of the new question |
| _text_ | String | yes | _Optional_ The text of the new question. |
| _subtype_ | String | yes | _Optional_ The sub type, stored as `extraSettings.questionType`: `checkbox`, `number` or `radio` for `grid`, `rating` for `linearscale` (a 1 to N scale drawn as icons). Any other value is rejected. |
| _position_ | Integer | yes | _(optional)_ 1-based position to insert the new question. When omitted the question is appended at the end. |
- Response: The new question object.

Expand Down
8 changes: 5 additions & 3 deletions docs/DataStructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,13 +263,15 @@ Optional extra settings for some [Question Types](#question-types)
| `timeMax` | `time` | string | - | Maximum allowed time to be chosen (as `HH:mm` string) |
| `timeMin` | `time` | string | - | Minimum allowed time to be chosen (as `HH:mm` string) |
| `timeRange` | `time` | Boolean | `true/false` | The time picker should query a time range |
| `optionsLowest` | `linearscale` | Integer | `0, 1` | Set the lowest value of the scale, default: `1` |
| `optionsLowest` | `linearscale` | Integer | `0, 1` | Set the lowest value of the scale, default: `1`; always `1` for the `rating` sub type |
| `optionsHighest` | `linearscale` | Integer | `2, 3, 4, 5, 6, 7, 8, 9, 10` | Set the highest value of the scale, default: `5` |
| `optionsLabelLowest` | `linearscale` | string | - | Set the label of the lowest value, default: `'Strongly disagree'` |
| `optionsLabelHighest` | `linearscale` | string | - | Set the label of the highest value, default: `'Strongly agree'` |
| `optionsLabelLowest` | `linearscale` | string | - | Set the label of the lowest value, default: `'Strongly disagree'`; not allowed for the `rating` sub type |
| `optionsLabelHighest` | `linearscale` | string | - | Set the label of the highest value, default: `'Strongly agree'`; not allowed for the `rating` sub type |
| `columns` | `grid` | Array | - | Array of column identifiers / labels for grid questions |
| `rows` | `grid` | Array | - | Array of row identifiers / labels for grid questions |
| `questionType` | `grid` | String | `checkbox`, `number`, `radio` | Type of cell for grid questions (checkbox, numeric input, or radio) |
| `questionType` | `linearscale` | String | `rating` | Sub type, fixed at creation; `rating` is a 1 to N scale drawn as icons; absent for a plain scale |
| `ratingIcon` | `linearscale` with `questionType` `rating` | string | `'star', 'heart', 'thumb'` | Set the icon of the rating, default: `'star'` |

### Option Types

Expand Down
14 changes: 14 additions & 0 deletions lib/Constants.php
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ class Constants {
public const ANSWER_GRID_TYPE_NUMBER = 'number';
public const ANSWER_GRID_TYPE_RADIO = 'radio';

public const ANSWER_LINEARSCALE_TYPE_RATING = 'rating';

// All AnswerTypes
public const ANSWER_TYPES = [
self::ANSWER_TYPE_COLOR,
Expand Down Expand Up @@ -221,6 +223,14 @@ class Constants {
'optionsHighest' => ['integer', 'NULL'],
'optionsLabelLowest' => ['string', 'NULL'],
'optionsLabelHighest' => ['string', 'NULL'],
'questionType' => ['string'],
'ratingIcon' => ['string', 'NULL'],
];

public const RATING_ICONS = [
'star',
'heart',
'thumb',
];

public const EXTRA_SETTINGS_GRID = [
Expand All @@ -239,6 +249,10 @@ class Constants {
self::ANSWER_GRID_TYPE_RADIO,
];

public const EXTRA_SETTINGS_LINEARSCALE_QUESTION_TYPE = [
self::ANSWER_LINEARSCALE_TYPE_RATING,
];

/**
* !! Keep in sync with src/mixins/ShareTypes.js !!
*/
Expand Down
20 changes: 13 additions & 7 deletions lib/Controller/ApiController.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
* @psalm-import-type FormsPartialForm from ResponseDefinitions
* @psalm-import-type FormsQuestion from ResponseDefinitions
* @psalm-import-type FormsQuestionType from ResponseDefinitions
* @psalm-import-type FormsQuestionGridCellType from ResponseDefinitions
* @psalm-import-type FormsQuestionSubtype from ResponseDefinitions
* @psalm-import-type FormsSubmission from ResponseDefinitions
* @psalm-import-type FormsSubmissions from ResponseDefinitions
* @psalm-import-type FormsUploadedFile from ResponseDefinitions
Expand Down Expand Up @@ -530,12 +530,13 @@ public function getQuestion(int $formId, int $questionId): DataResponse {
*
* @param int $formId the form id
* @param FormsQuestionType $type the new question type
* @param FormsQuestionGridCellType $subtype the new question subtype
* @param FormsQuestionSubtype $subtype the new question subtype
* @param string $text the new question title
* @param ?int $fromId (optional) id of the question that should be cloned
* @param ?int $position (optional) the position of the new question
* @return DataResponse<Http::STATUS_CREATED, FormsQuestion, array{}>
* @throws OCSBadRequestException Invalid type
* @throws OCSBadRequestException Invalid subtype
* @throws OCSBadRequestException Datetime question type no longer supported
* @throws OCSForbiddenException User has no permissions to get this form
* @throws OCSForbiddenException This form is archived and can not be modified
Expand Down Expand Up @@ -575,6 +576,11 @@ public function newQuestion(int $formId, ?string $type = null, ?string $subtype
throw new OCSBadRequestException('Datetime question type no longer supported');
}

$extraSettings = $subtype ? ['questionType' => $subtype] : [];
if (!$this->formsService->areExtraSettingsValid($extraSettings, $type)) {
Comment thread
AndyScherzinger marked this conversation as resolved.
Resolved
Comment thread
AndyScherzinger marked this conversation as resolved.
Resolved
throw new OCSBadRequestException('Invalid subtype');
}

// Retrieve all active questions sorted by Order.
$questions = $this->questionMapper->findByForm($formId);

Expand All @@ -599,7 +605,7 @@ public function newQuestion(int $formId, ?string $type = null, ?string $subtype
$question->setText($text);
$question->setDescription('');
$question->setIsRequired(false);
$question->setExtraSettings($subtype ? ['questionType' => $subtype] : []);
$question->setExtraSettings($extraSettings);

$question = $this->questionMapper->insert($question);

Expand Down Expand Up @@ -744,16 +750,16 @@ public function updateQuestion(int $formId, int $questionId, array $keyValuePair
throw new OCSForbiddenException('Please use reorderQuestions() to change order');
}

if (array_key_exists('extraSettings', $keyValuePairs) && !$this->formsService->areExtraSettingsValid($keyValuePairs['extraSettings'], $question->getType())) {
throw new OCSBadRequestException('Invalid extraSettings, will not update.');
}

if (array_key_exists('extraSettings', $keyValuePairs)
&& ($keyValuePairs['extraSettings']['questionType'] ?? null) !== ($question->getExtraSettings()['questionType'] ?? null)) {
$this->logger->debug('Not allowed to update \'extraSettings.questionType\'');
throw new OCSForbiddenException('Not allowed to update \'extraSettings.questionType\'');
}

if (array_key_exists('extraSettings', $keyValuePairs) && !$this->formsService->areExtraSettingsValid($keyValuePairs['extraSettings'], $question->getType())) {
throw new OCSBadRequestException('Invalid extraSettings, will not update.');
}

if ($form->getConfirmationEmailQuestionId() === $question->getId()
&& !$question->isEmailType($keyValuePairs['type'] ?? null, $keyValuePairs['extraSettings'] ?? null)) {
$form->setConfirmationEmailQuestionId(null);
Expand Down
3 changes: 2 additions & 1 deletion lib/ResponseDefinitions.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
* optionsLimitMax?: int,
* optionsLimitMin?: int,
* optionsLowest?: 0|1,
* ratingIcon?: "star"|"heart"|"thumb",
* shuffleOptions?: bool,
* timeMax?: string,
* timeMin?: string,
Expand All @@ -45,7 +46,7 @@
* }
*
* @psalm-type FormsQuestionType = "dropdown"|"multiple"|"multiple_unique"|"date"|"time"|"short"|"long"|"file"|"datetime"|"grid"|"linearscale"|"color"|"ranking"
* @psalm-type FormsQuestionGridCellType = "checkbox"|"number"|"radio"
* @psalm-type FormsQuestionSubtype = "checkbox"|"number"|"radio"|"rating"
*
* @psalm-type FormsQuestion = array{
* id: int,
Expand Down
24 changes: 24 additions & 0 deletions lib/Service/FormsService.php
Original file line number Diff line number Diff line change
Expand Up @@ -1051,6 +1051,30 @@ public function areExtraSettingsValid(array $extraSettings, string $questionType
|| isset($extraSettings['optionsHighest']) && ($extraSettings['optionsHighest'] < 2 || $extraSettings['optionsHighest'] > 10)) {
return false;
}

$subtype = $extraSettings['questionType'] ?? null;
if ($subtype !== null && !in_array($subtype, Constants::EXTRA_SETTINGS_LINEARSCALE_QUESTION_TYPE, true)) {
return false;
}

if ($subtype === Constants::ANSWER_LINEARSCALE_TYPE_RATING && ($extraSettings['optionsLowest'] ?? 1) !== 1) {
return false;
}

if (isset($extraSettings['ratingIcon'])
&& ($subtype !== Constants::ANSWER_LINEARSCALE_TYPE_RATING || !in_array($extraSettings['ratingIcon'], Constants::RATING_ICONS, true))) {
return false;
}
Comment thread
AndyScherzinger marked this conversation as resolved.
Resolved

if ($subtype === Constants::ANSWER_LINEARSCALE_TYPE_RATING
&& (isset($extraSettings['optionsLabelLowest']) || isset($extraSettings['optionsLabelHighest']))) {
return false;
}
} elseif ($questionType === Constants::ANSWER_TYPE_GRID) {
if (isset($extraSettings['questionType'])
&& !in_array($extraSettings['questionType'], Constants::EXTRA_SETTINGS_GRID_QUESTION_TYPE, true)) {
Comment thread
AndyScherzinger marked this conversation as resolved.
Resolved
return false;
}
}
return true;
}
Expand Down
15 changes: 12 additions & 3 deletions openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -575,6 +575,14 @@
1
]
},
"ratingIcon": {
"type": "string",
"enum": [
"star",
"heart",
"thumb"
]
},
"shuffleOptions": {
"type": "boolean"
},
Expand All @@ -598,12 +606,13 @@
}
}
},
"QuestionGridCellType": {
"QuestionSubtype": {
"type": "string",
"enum": [
"checkbox",
"number",
"radio"
"radio",
"rating"
]
},
"QuestionType": {
Expand Down Expand Up @@ -1700,7 +1709,7 @@
"description": "the new question type"
},
"subtype": {
"$ref": "#/components/schemas/QuestionGridCellType",
"$ref": "#/components/schemas/QuestionSubtype",
"default": null,
"description": "the new question subtype"
},
Expand Down
31 changes: 29 additions & 2 deletions playwright/e2e/a11y-question-inputs.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ import { test as formTest } from '../support/fixtures/form.ts'
import { test as appNavigationTest } from '../support/fixtures/navigation.ts'
import { test as randomUserTest } from '../support/fixtures/random-user.ts'
import { test as topBarTest } from '../support/fixtures/topBar.ts'
import { GridSubtype, QuestionType } from '../support/sections/QuestionType.ts'
import {
GridSubtype,
LinearScaleSubtype,
QuestionType,
} from '../support/sections/QuestionType.ts'
import { FormsView } from '../support/sections/TopBarSection.ts'

const test = mergeTests(randomUserTest, appNavigationTest, formTest, topBarTest)
Expand All @@ -18,6 +22,23 @@ test.beforeEach(async ({ page }) => {
await page.waitForURL(/apps\/forms\/$/)
})

test('The sub menu of a question type names its back entry', async ({
appNavigation,
form,
page,
}) => {
await appNavigation.clickNewForm()
await form.fillTitle('Test form')

await form.newQuestionButton.click()
await page
.getByRole('menuitem', { name: QuestionType.LinearScale, exact: true })
.click()
await expect(page.getByRole('menuitem').first()).toHaveAccessibleName(
'Linear scale, back to all question types',
)
})

test.describe('Accessibility: aria attributes on question inputs', () => {
test('Short answer with description has aria-labelledby and aria-describedby', async ({
appNavigation,
Expand Down Expand Up @@ -196,7 +217,7 @@ test.describe('Accessibility: aria attributes on question inputs', () => {
await appNavigation.clickNewForm()
await form.fillTitle('Test form')

await form.addQuestion(QuestionType.LinearScale)
await form.addQuestion(QuestionType.LinearScale, LinearScaleSubtype.Numbers)
const questions = await form.getQuestions()
await questions[0].fillTitle('Rate your experience')
await questions[0].fillDescription('From 1 to 5')
Expand All @@ -212,6 +233,12 @@ test.describe('Accessibility: aria attributes on question inputs', () => {
exact: true,
}),
).toBeVisible()
await expect(
questions[0].section.locator('fieldset.question-linear-scale__options'),
).not.toHaveAttribute('aria-labelledby')
await expect(
questions[0].section.getByRole('radio').first(),
).not.toHaveAttribute('aria-describedby')

await topBar.toggleView(FormsView.View)

Expand Down
14 changes: 11 additions & 3 deletions playwright/e2e/question-editing.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ import { expect, mergeTests } from '@playwright/test'
import { test as formTest } from '../support/fixtures/form.ts'
import { test as appNavigationTest } from '../support/fixtures/navigation.ts'
import { test as randomUserTest } from '../support/fixtures/random-user.ts'
import { QuestionType } from '../support/sections/QuestionType.ts'
import {
LinearScaleSubtype,
QuestionType,
} from '../support/sections/QuestionType.ts'

const test = mergeTests(randomUserTest, appNavigationTest, formTest)

Expand All @@ -32,7 +35,12 @@ test.describe('Question editing lifecycle', () => {

for (const type of questionTypes) {
test(`Add a ${type} question`, async ({ form }) => {
await form.addQuestion(type)
await form.addQuestion(
type,
type === QuestionType.LinearScale
? LinearScaleSubtype.Numbers
: undefined,
)

const questions = await form.getQuestions()
expect(questions).toHaveLength(1)
Expand Down Expand Up @@ -91,7 +99,7 @@ test.describe('Question editing lifecycle', () => {
form,
page,
}) => {
await form.addQuestion(QuestionType.LinearScale)
await form.addQuestion(QuestionType.LinearScale, LinearScaleSubtype.Numbers)
const question = (await form.getQuestions())[0]
await question.openActionsMenu()
const highest = page.getByRole('combobox', { name: 'Highest value' })
Expand Down
Loading
Loading