forms/lib/ResponseDefinitions.php at 30e54c4efea83584ad9bb4c34499ff141b5a366e · nextcloud/forms · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<?php

/**
 * SPDX-FileCopyrightText: 2024 Christian Hartmann <chris-hartmann@gmx.de>
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCA\Forms;

/**
 * @psalm-type FormsOption = array{
 *   id: int,
 *   questionId: int|float,
 *   text: string,
 *   order: ?int
 * }
 *
 * @psalm-type FormsOrder = array{
 *   order: int
 * }
 *
 * @psalm-type FormsQuestionExtraSettings = array{
 *   allowOtherAnswer?: bool,
 *   allowedFileExtensions?: list<string>,
 *   allowedFileTypes?: list<string>,
 *   dateMax?: int,
 *   dateMin?: int,
 *   dateRange?: bool,
 *   maxAllowedFilesCount?: int,
 *   maxFileSize?: int,
 *   optionsHighest?: 2|3|4|5|6|7|8|9|10,
 *   optionsLabelHighest?: string,
 *   optionsLabelLowest?: string,
 *   optionsLimitMax?: int,
 *   optionsLimitMin?: int,
 *   optionsLowest?: 0|1,
 *   shuffleOptions?: bool,
 *   timeMax?: int,
 *   timeMin?: int,
 *   timeRange?: bool,
 *   validationRegex?: string,
 *   validationType?: string
 * }
 *
 * @psalm-type FormsQuestionType = "dropdown"|"multiple"|"multiple_unique"|"date"|"time"|"short"|"long"|"file"|"datetime"|"section"
 *
 * @psalm-type FormsQuestion = array{
 *   id: int,
 *   formId: int,
 *   order: int,
 *   type: FormsQuestionType,
 *   isRequired: bool,
 *   text: string,
 *   name: string,
 *   description: string,
 *   extraSettings: FormsQuestionExtraSettings|\stdClass,
 *   options: list<FormsOption>,
 *   accept: list<string>,
 * }
 *
 * @psalm-type FormsAnswer = array{
 *   id: int,
 *   submissionId: int,
 *   fileId: ?int,
 *   questionId: int,
 *   questionName?: string,
 *   text: string
 * }
 *
 * @psalm-type FormsSubmission = array{
 *   id: int,
 *   formId: int,
 *   userId: string,
 *   timestamp: int,
 *   answers: list<FormsAnswer>,
 *   userDisplayName: string
 * }
 *
 * @psalm-type FormsSubmissions = array{
 *   submissions: list<FormsSubmission>,
 *   questions: list<FormsQuestion>,
 *   filteredSubmissionsCount: int
 * }
 *
 * @psalm-type FormsAccess = array{
 *   permitAllUsers?: bool,
 *   showToAllUsers?: bool
 * }
 *
 * @psalm-type FormsPermission = "edit"|"results"|"results_delete"|"submit"|"embed"
 *
 * @psalm-type FormsShare = array{
 *   id: int,
 *   formId: int,
 *   shareType: int,
 *   shareWith: string,
 *   permissions: list<FormsPermission>,
 *   displayName: string
 * }
 *
 * @psalm-type FormsPartialForm = array{
 *   id: int,
 *   hash: string,
 *   title: string,
 *   expires: int,
 *   permissions: list<FormsPermission>,
 *   partial: true,
 *   state: int,
 *   lockedBy: ?string,
 *   lockedUntil: ?int,
 * }
 *
 * @psalm-type FormsForm = array{
 *   id: int,
 *   hash: string,
 *   title: string,
 *   description: string,
 *   ownerId: string,
 *   created: int,
 *   access: FormsAccess,
 *   expires: int,
 *   fileFormat: ?string,
 *   fileId: ?int,
 *   filePath?: ?string,
 *   isAnonymous: bool,
 *   lastUpdated: int,
 *   submitMultiple: bool,
 *   allowEditSubmissions: bool,
 *   showExpiration: bool,
 *   canSubmit: bool,
 *   permissions: list<FormsPermission>,
 *   questions: list<FormsQuestion>,
 *   state: 0|1|2,
 *   lockedBy: ?string,
 *   lockedUntil: ?int,
 *   shares: list<FormsShare>,
 *   submissionCount?: int,
 *   submissionMessage: ?string,
 * }
 *
 * @psalm-type FormsUploadedFile = array{
 *   uploadedFileId: int,
 *   fileName: string
 * }
 */
class ResponseDefinitions {
}