Index.rst 202 KB
Newer Older
Carsten  Rose's avatar
Carsten Rose committed
1
.. ==================================================
2
.. Header hierachy
3
.. ==
4
5
6
7
8
9
..  --
..   ^^
..    ''
..     ;;
..      ,,
..
10
11
12
13
14
15
16
17
18
19
20
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt


.. _users-manual:

Users manual
============

Carsten  Rose's avatar
Carsten Rose committed
21
The QFQ extension is activated through tt-content records. One or more tt-content records per page are necessary to render
22
*forms*, *reports* (exports) or to perform *delete* and *save* commands submitted by a QFQ form.
23

24
Features not implemented yet
25
26
27
----------------------------

* Multi Forms
28
29
30
31

QFQ content element
-------------------

32
QFQ is used by configuring Typo3 content elements. Insert one or more QFQ content elements on a Typo3 page.
33
34
35
36
37
38
39
40
Specify column and language per content record as wished.

The title of the QFQ content element will not be rendered. It's only visible in the backend for orientation.


QFQ Keywords (Bodytext)
^^^^^^^^^^^^^^^^^^^^^^^

41

42
43
44
45
46
47
48
49
 +-------------------+---------------------------------------------------------------------------------+
 | Name              | Explanation                                                                     |
 +===================+=================================================================================+
 | form              | Formname defined in ttcontent record bodytext                                   |
 |                   | * Fix. E.g.: **form = person**                                                  |
 |                   | * by SIP: **form = {{form}}**                                                   |
 |                   | * by SQL: **form = {{SELECT c.form FROM conference AS c WHERE c.id={{a:C}} }}** |
 +-------------------+---------------------------------------------------------------------------------+
50
 | r                 | <record id> The form will load the record with the specified id                 |
51
52
 |                   | * Variants: **r = 123**, by SQL: **r = {{SELECT ...}}**                         |
 |                   | * If not specified, the default is '0'                                          |
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
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.db        | Select a DB. Only necessary if a different than the standard DB should be used. |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fbeg      | Start token for every field (=column)                                           |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fend      | End token for every field (=column)                                             |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.head      | Start token for whole <level>                                                   |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.tail      | End token for whole <level>                                                     |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rbeg      | Start token for row.                                                            |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rbgd      | Alternating (per row) token                                                     |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rend      | End token for row. Will be rendered **before** subsequent levels are processed  |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.renr      | End token for row. Will be rendered **after** subsequent levels are processed   |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rsep      | Seperator token between rows                                                    |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fsep      | Seperator token between fields (=columns)                                       |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.sql       | SQL Query                                                                       |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.althead   | If <level>.sql is empty, these token will be rendered                           |
 +-------------------+---------------------------------------------------------------------------------+
80
 | debugShowBodyText | If ='1' and config.ini:*showDebugInfo=yes*: shows a tooltip with bodytext       |
81
 +-------------------+---------------------------------------------------------------------------------+
82

83
84
.. _debug:

85
86
87
88
89
Debug
^^^^^

* config.ini: *SHOW_DEBUG_INFO = yes|no|auto*

90
91
92
93
94
95
  * *yes*:

    * Form:

      * For every internal link/button, show tooltips with decoded SIP on mouseover.
      * Shows 'Edit form' (wrench symbol) button on a form.
96

97
    * Report: Will be configured per tt-content record.
98

99
      *debugShowBodyText = 1*
100

101
  * *no*: No debug info.
102

103
  * *auto*: Depending if there is a Typo3 BE session, set internally:
104

105
106
    * *SHOW_DEBUG_INFO = yes*  (BE session exist)
    * *SHOW_DEBUG_INFO = no*   (no BE session)
Carsten  Rose's avatar
Carsten Rose committed
107
108
109
110

Form
----

111
* Forms will be created by using the *QFQ Form Editor* on the Typo3 frontend (HTML form).
112
* The Formeditor itself consist of two predefined QFQ forms: *form* and *formElement*
113
114
* Every form consist of a) a *Form* record and b) multiple *FormElement* records.
* A form is assigned to a  *table*. Such a table is called the *primary table* for this form.
115
* There are three types of forms which can roughly categorized into:
116

117
  * *Simple* form: the form acts on one record, stored in one table.
118

Carsten  Rose's avatar
Carsten Rose committed
119
    * The form will create necessary SQL commands for insert, update and delete (only primary record) automatically.
120

121
  * *Advanced* form: the form acts on multiple records, stored in more than one table.
122

123
    * Fields of the primary table acts like a *simple* form, all other fields have to be specified with *addNupdate* records.
124

125
  * *Multi* form: the form acts simultanously on more than one record. All records use the same *FormElements*.
126

127
128
    * The *FormElements* are defined as a regular *simple* / or *advanced* form, plus a SQL Query, which selects and
      iterates over all records. Those records will be loaded at the same time.
Carsten  Rose's avatar
Carsten Rose committed
129

130
.. _variables:
Carsten  Rose's avatar
Carsten Rose committed
131

132
133
Variable (incl. mixed SQL Statement)
------------------------------------
Carsten  Rose's avatar
Carsten Rose committed
134
135

Most fields of a form specification might contain:
136

Carsten  Rose's avatar
Carsten Rose committed
137
138
139
140
141
* ''constants'' (=strings), this is the standard use case.
* ''variables'' retrieved from the stores (see below),
* ''SQL statements'' (limited set of),
* or any combination of the above.

142
* A variable (or SQL) statement is surrounded by curly braces:
Carsten  Rose's avatar
Carsten Rose committed
143

144
  *{{VarName[:<store / prio>[:<sanitize class>[:<escape>]]]}}*
Carsten  Rose's avatar
Carsten Rose committed
145
146
147

* Example:

148
  *{{r}}*
Carsten  Rose's avatar
Carsten Rose committed
149

150
151
152
153
  *{{index:FS}}*

  *{{name:FS:alnumx:s}}*

154
  *{{SELECT name FROM person WHERE id=1234}}*
Carsten  Rose's avatar
Carsten Rose committed
155

156
  *{{SELECT name FROM person WHERE id={{r}} }}*
Carsten  Rose's avatar
Carsten Rose committed
157

158
  *{{SELECT name FROM person WHERE id={{key1:C:alnumx}} }}*
Carsten  Rose's avatar
Carsten Rose committed
159

160
* Leading and trailing spaces inside curly braces are removed.
Carsten  Rose's avatar
Carsten Rose committed
161

162
163
  * *{{ SELECT "Hello World"   }}* acts as *{{SELECT "Hello World"}}*
  * *{{ varname   }}* acts as *{{varname}}*
Carsten  Rose's avatar
Carsten Rose committed
164

165

166
167
* There are several stores, from where to retrieve the value. If a value is not found in one store, the next store is searched,
  until a value is found or there are no more stores available.
168
* If anywhere along the line an empty string is found, this **is** a value: therefore, the search will stop.
Carsten  Rose's avatar
Carsten Rose committed
169
170
171
172
173
* If no value is found, the value is an <empty string>.

URL Parameter
-------------

174
* URL (=GET) Parameter can be used in *forms* and *reports* as variables.
175
176
177
178
179
180
181
182
183
184
185
186
187
188
* If a value violates a parameter sanitize class, the value becomes an empty string.

Escape
------

* Variables used in SQL Statements might cause trouble, if they contain single or double ticks.
* Escaping of single or double is defined by the parameter <escape> (fourth parameter):

  * 's' - single ticks will be escaped.
  * 'd' - double ticks will be escaped.

* It's not possible to escape single and double ticks at the same time.
* Which of them to escape (single or double) depends on the surrounding SQL query.
* Escaping is only necessary inside of SQL queries.
Carsten  Rose's avatar
Carsten Rose committed
189
190
191
192

Sanitize class
--------------

193
194
195
196
197
198
* All values in Store *C* (Client) and store *F* (Form) will be sanitized:
* All :ref:`predefined-variable-names` have a specific default sanitize class. For these variables, it's not necessary
  to specify a sanitize class.
* All other variables (Store: C, F) get by default the sanitize class defined in the corresponding form. If not defined
  the default class is 'digit'.
* A default sanitize class can be overwritten by individual definition: *{{a:C:all}}*
Carsten  Rose's avatar
Carsten Rose committed
199

200
201
202
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| Name             | Form | Query | Pattern                                                                                 |
+==================+======+=======+=========================================================================================+
203
| **alnumx**       | Form | Query | [A-Za-z][0-9]@-_.,;: /() ÀÈÌÒÙàèìòùÁÉÍÓÚÝáéíóúýÂÊÎÔÛâêîôûÃÑÕãñõÄËÏÖÜŸäëïöüÿ             |
204
+------------------+------+-------+-----------------------------------------------------------------------------------------+
205
206
207
| **digit**        | Form | Query | [0-9]                                                                                   |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **numerical**    | Form | Query | [0-9.-+]                                                                                |
208
209
210
211
212
213
214
215
216
217
218
219
220
221
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **email**        | Form | Query | [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}                                          |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **min|max**      | Form |       | Compares the value against an lower and upper limit (numeric or string).                |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **min|max date** | Form |       | Compares the value against an lower and upper date or datetime.                         |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **pattern**      | Form |       | Compares the value against a regexp.                                                    |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **allbut**       | Form | Query | All characters allowed, but not [ ]  { } % & \ #. The used regexp: '^[^\[\]{}%&\\#]+$', |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **all**          | Form | Query | no sanitizing                                                                           |
+------------------+------+-------+-----------------------------------------------------------------------------------------+

Carsten  Rose's avatar
Carsten Rose committed
222
223
224
225
226


Store / prio
------------

227
228
229
230
231
Only variables that are known in a specified store can be substituted.

 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 |Name |Description                                                                             | Content                                                                    |
 +=====+========================================================================================+============================================================================+
232
 | F   | :ref:`STORE_FORM`: data not saved in database yet.                                     | All native *FormElements*. Recent values from the Browser.                 |
233
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
234
235
 | S   | :ref:`STORE_SIP`: Client parameter 's' will indicate the current SIP, which will be    | sip, r (record_id), form                                                   |
 |     | loaded from the SESSION repo to the SIP-Store.                                         |                                                                            |
236
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
237
 | R   | :ref:`STORE_RECORD`: Record - the current record loaded in the form                    | All columns of the current record from the current table                   |
238
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
239
240
 | B   | :ref:`STORE_BEFORE`: Record - the current record loaded in the form before any update  | All columns of the current record from the current table                   |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
241
242
 | P   | Parent record. E.g.: on multi forms the current record of the outer query              | All columns of the MultiSQL Statement from the table for the current row   |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
243
 | D   | Default values column : The *table.column* specified *default value*.                  |                                                                            |
244
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
245
 | M   | Column type: The *table.column* specified *type*                                       |                                                                            |
246
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
247
 | C   | :ref:`STORE_CLIENT`: POST variable, if not found: GET variable                         | Parameter sent from the Client (=Browser).                                 |
248
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
249
 | T   | :ref:`STORE_TYPO3`: a) Bodytext (ttcontent record), b) Typo3 internal variables        | See Typo3 tt_content record configuration                                  |
250
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
251
 | V   | :ref:`STORE_VARS`: Generic variables                                                   |                                                                            |
252
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
253
254
 | 0   | *Zero* - allways value: 0, might be helpful if a variable is empty or undefined and    | Any key                                                                    |
 |     | will be used in an SQL statement.                                                      |                                                                            |
255
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
256
257
 | E   | *Empty* - allways an empty string, might be helpful if a variable is empty or undefined| Any key                                                                    |
 |     | and will be used in an SQL statement                                                   |                                                                            |
258
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
259
 | Y   | :ref:`STORE_SYSTEM`: a) Database, b) helper vars for logging/debugging:                |                                                                            |
260
 |     | SYSTEM_SQL_RAW ... SYSTEM_FORM_ELEMENT_COLUMN, c) Any custom fields: CONTACT, HELP, .. |                                                                            |
261
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
262

263
* Default *<prio>*: *FSRVD* - Form / SIP / Record / Vars / Table definition.
Carsten  Rose's avatar
Carsten Rose committed
264
265
* Hint: Preferable, parameter should be submitted by SIP, not by Client (=URL).

266
267
268
  * Warning: Data submitted via 'Client' can be easily spoofed and altered.
  * Best: Data submitted via SIP never leaves the server, cannot be spoofed or altered by the user.
  * SIPs can _only_ be defined by using *Report*. Inside of *Report* use columns 'Link' (with attribute 's'), 'page?' or 'Page?'.
Carsten  Rose's avatar
Carsten Rose committed
269
270
271
272
273
274

.. _predefined-variable-names:

Predefined variable names
-------------------------

275
276
277
278
279
.. _STORE_FORM:

Store: *FORM* - F
^^^^^^^^^^^^^^^^^

280
* Sanatized: *yes*
281
282
283
* Represents the values in the form, typically before saving them.
* Used for:

284
285
286
  * *FormElements* who will be rerendered, after a parent *FormElement* has been changed by the user.
  * *FormElement* actions, before saving the form.
  * Values will be sanitized by the class configured in corresponding the *FormElement*. By default, the sanitize class is `alnumx`.
287

Carsten  Rose's avatar
Carsten Rose committed
288
289
290
291
292
 +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                            | Explanation                                                                                                                                |
 +=================================+============================================================================================================================================+
 | <FormElement name>              | Name of native *FormElement*. To get, exactly and only, the specified *FormElement* (for 'p_id'): *{{p_id:F}}*                             |
 +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
293
294
295
296
297
298

.. _STORE_SIP:

Store: *SIP* - S
^^^^^^^^^^^^^^^^

299
* Sanatized: *no*
300
301
302
303
304
* Filled automatically by creating links. E.g.:

  * in `Report` by using `_page?` or `_link` (with active 's')
  * in `Form` by using subrecords: 'new', 'edit', 'delete' links (system) or by column type `_page?`, `_link`.

305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 +-------------------------+-----------------------------------------------------------+
 | Name                    | Explanation                                               |
 +=========================+===========================================================+
 | sip                     | 13 char uniqid                                            |
 +-------------------------+-----------------------------------------------------------+
 | r                       | current record id                                         |
 +-------------------------+-----------------------------------------------------------+
 | form                    | current form name                                         |
 +-------------------------+-----------------------------------------------------------+
 | table                   | current table name                                        |
 +-------------------------+-----------------------------------------------------------+
 | urlparam                | all non Typo3 paramter in one string                      |
 +-------------------------+-----------------------------------------------------------+
 | <user defined>          | additional user defined link parameter                    |
 +-------------------------+-----------------------------------------------------------+
320
321
322
323
324
325

.. _STORE_RECORD:

Store: *RECORD* - R
^^^^^^^^^^^^^^^^^^^

326
* Sanatized: *no*
327
328
329
* Current record loaded in Form.
* If r=0, alle values are empty.

330
331
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                   | Explanation                                                                                                                                      |
332
333
334
335
336
337
338
339
340
 +========================+==================================================================================================================================================+
 | <column name>          | Name of a column of the primary table (as defined in the current form). To get, exactly and only, the specified form *FormElement*: *{{p_id:R}}* |
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+

.. _STORE_BEFORE:

Store: *BEFORE* - B
^^^^^^^^^^^^^^^^^^^

341
* Sanatized: *no*
342
* Current record loaded in Form without any modification.
343
344
* If r=0, alle values are empty.

345
346
This store is handy to compare new and old values of a form.

347
348
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                   | Explanation                                                                                                                                      |
349
350
351
 +========================+==================================================================================================================================================+
 | <column name>          | Name of a column of the primary table (as defined in the current form). To get, exactly and only, the specified form *FormElement*: *{{p_id:R}}* |
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
352
353
354

.. _STORE_CLIENT:

355
Store: *CLIENT* - C
Carsten  Rose's avatar
Carsten Rose committed
356
357
^^^^^^^^^^^^^^^^^^^

358
359
* Sanatized: *yes*

360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                    | Explanation                                                                                                                              |
 +=========================+==========================================================================================================================================+
 | s                       | =SIP                                                                                                                                     |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | r                       | record id. Typically stored in SIP, rarely specified on the URL                                                                          |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | keySemId                | always current Semester Id                                                                                                               |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | keySemIdUser            | *{{keySemIdUser}}*, may be changed by user                                                                                               |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | HTTP_HOST               | current HTTP HOST                                                                                                                        |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | REMOTE_ADDR             | Client IP address                                                                                                                        |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | '$_SERVER[*]'           | All other variables accessable by *$_SERVER[]*. Only the often used have a pre-defined sanitize class.                                   |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | form                    | Unique name of current form                                                                                                              |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | ANREDE                  | *{{sex}}* == male >> Sehr geehrter Herr, *{{sex}}* == female  Sehr geehrte Frau                                                          |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | EANREDE                 | *{{sex}}* == male >> Dear Mr., *{{sex}}* == female >> Dear Mrs.                                                                          |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
383

384
385
.. _STORE_TYPO3:

386
Store: *TYPO3* (Bodytext) - T
Carsten  Rose's avatar
Carsten Rose committed
387
388
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

389
390
* Sanatized: *no*

391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 +-------------------------+-------------------------------------------------------------------+----------+
 | Name                    | Explanation                                                       | Note     |
 +=========================+===================================================================+==========+
 | form                    | Formname defined in ttcontent record bodytext                     | see note |
 |                         |                                                                   |          |
 |                         | * Fix. E.g. *form = person*                                       |          |
 |                         | * via SIP. E.g. *form = {{form}}*                                 |          |
 +-------------------------+-------------------------------------------------------------------+----------+
 | pageId                  | Record id of current Typo3 page                                   | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
 | pageType                | Current selected page type (typically URL parameter 'type')       | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
 | pageLanguage            | Current selected page language (typically URL parameter 'L')      | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
 | ttcontentUid            | Record id of current Typo3 content element                        | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
 | feUser                  | Logged in Typo3 FE User                                           |          |
 +-------------------------+-------------------------------------------------------------------+----------+
 | feUserUid               | Logged in Typo3 FE User uid                                       |          |
 +-------------------------+-------------------------------------------------------------------+----------+
 | feUserGroup             | FE groups of logged in Typo3 FE User                              |          |
 +-------------------------+-------------------------------------------------------------------+----------+
413
414
415

* **note**: not available
  * in 'dynamicUpdate' or
416
  * by *FormElement* class 'action' with type 'beforeSave', 'afterSave', 'beforeDelete', 'afterDelete'.
417
418

.. _STORE_VARS:
Carsten  Rose's avatar
Carsten Rose committed
419

420
421
422
Store: *VARS* - V
^^^^^^^^^^^^^^^^^

423
424
* Sanatized: *no*

425
426
427
428
429
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                    | Explanation                                                                                                                                |
 +=========================+============================================================================================================================================+
 | random                  | random string with length of 32 chars, alphanum                                                                                            |
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
430
 | slaveId                 | see *FormElement* `action`                                                                                                                 |
431
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
432
 | filename                | Original filename of an uploaded file via an 'upload'-FormElement. Valid only during processing of the current 'upload'-formElement.       |
433
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
434
 | fileDestinaton          | Destination (path & filename) for an uploaded file. Defined in an 'upload'-FormElement.parameter. Valid: same as 'filename'.               |
435
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
436

437
438
439

.. _STORE_SYSTEM:

440
Store: *SYSTEM* - Y
441
442
^^^^^^^^^^^^^^^^^^^

443
444
* Sanatized: *no*

445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 +-------------------------+--------------------------------------------------------------------------+
 | Name                    | Explanation                                                              |
 +=========================+==========================================================================+
 | DB_USER                 | defined in config.ini                                                    |
 +-------------------------+--------------------------------------------------------------------------+
 | DB_SERVER               | defined in config.ini                                                    |
 +-------------------------+--------------------------------------------------------------------------+
 | DB_NAME                 | defined in config.ini                                                    |
 +-------------------------+--------------------------------------------------------------------------+
 | DB_INIT                 | defined in config.ini                                                    |
 +-------------------------+--------------------------------------------------------------------------+
 | SQL_LOG                 | defined in config.ini                                                    |
 +-------------------------+--------------------------------------------------------------------------+
 | SQL_LOG_MODE            | defined in config.ini                                                    |
 +-------------------------+--------------------------------------------------------------------------+
 | SHOW_DEBUG_INFO         | defined in config.ini                                                    |
 +-------------------------+--------------------------------------------------------------------------+
 | CSS_LINK_CLASS_INTERNAL | defined in config.ini                                                    |
 +-------------------------+--------------------------------------------------------------------------+
 | CSS_LINK_CLASS_EXTERNAL | defined in config.ini                                                    |
 +-------------------------+--------------------------------------------------------------------------+
 | CSS_CLASS_QFQ_CONTAINER | defined in config.ini                                                    |
 +-------------------------+--------------------------------------------------------------------------+
 | EXT_PATH                | computed during runtime                                                  |
 +-------------------------+--------------------------------------------------------------------------+
 | SITE_PATH               | computed during runtime                                                  |
 +-------------------------+--------------------------------------------------------------------------+
 | DATE_FORMAT             | defined in config.ini                                                    |
 +-------------------------+--------------------------------------------------------------------------+
 | class                   | defined in config.ini (CSS_CLASS_QFQ_FORM) or form definition            |
 +-------------------------+--------------------------------------------------------------------------+
 | classPill               | defined in config.ini (CSS_CLASS_QFQ_FORM_PILL) or form definition       |
 +-------------------------+--------------------------------------------------------------------------+
 | classBody               | defined in config.ini (CSS_CLASS_QFQ_FORM_BODY) or form definition       |
 +-------------------------+--------------------------------------------------------------------------+
 | data-pattern-error      | defined in config.ini or form definition                                 |
 +-------------------------+--------------------------------------------------------------------------+
 | data-require-error      | defined in config.ini or form definition                                 |
 +-------------------------+--------------------------------------------------------------------------+
 | data-match-error        | defined in config.ini or form definition                                 |
 +-------------------------+--------------------------------------------------------------------------+
 | data-error              | defined in config.ini or form definition                                 |
 +-------------------------+--------------------------------------------------------------------------+
 | bsLabelColumns          | defined in config.ini (FORM_BS_LABEL_COLUMNS) or form definition         |
 +-------------------------+--------------------------------------------------------------------------+
 | bsInputColumns          | defined in config.ini (FORM_BS_INPUT_COLUMNS) or form definition         |
 +-------------------------+--------------------------------------------------------------------------+
 | bsNoteColumns           | defined in config.ini (FORM_BS_NOTE_COLUMNS) or form definition          |
 +-------------------------+--------------------------------------------------------------------------+
 | sqlFinal                | computed during runtime, used for error reporting                        |
 +-------------------------+--------------------------------------------------------------------------+
 | sqlParamArray           | computed during runtime, used for error reporting                        |
 +-------------------------+--------------------------------------------------------------------------+
 | sqlCount                | computed during runtime, used for error reporting                        |
 +-------------------------+--------------------------------------------------------------------------+
500
501
502

SQL Statement
-------------
Carsten  Rose's avatar
Carsten Rose committed
503

504
* The detection of an SQL command is case *insensitive*.
505
* Leading  whitespace will be skipped.
506
* The following commands are interpreted as SQL commands:
Carsten  Rose's avatar
Carsten Rose committed
507

508
  * SELECT
509
510
  * INSERT, UPDATE, DELETE, REPLACE, TRUNCATE
  * SHOW, DESCRIBE, EXPLAIN, SET
Carsten  Rose's avatar
Carsten Rose committed
511

512
* A SQL Statement might contain parameters, including additional SQL statements. Inner SQL queries will be executed first.
Carsten  Rose's avatar
Carsten Rose committed
513
* All variables will be substituted one by one from inner to outer.
514
* Maximum recursion depth: 5 (a recursion depth of 2 is sometimes used for mailing with templates, 3 and more probably confuses too much and is therefore not practicable, but supported until depth of 5)
Carsten  Rose's avatar
Carsten Rose committed
515
* The number of variables inside an input field or a SQL statement is not limited.
516
* A resultset of a SQL statement will be imploded over all: concat all columns of a row, concat all rows - there is no glue string.
Carsten  Rose's avatar
Carsten Rose committed
517

518
* Example::
Carsten  Rose's avatar
Carsten Rose committed
519

520
  {{SELECT id, name FROM Person}}
521
522
  {{SELECT id, name, IF({{feUser}}=0,'Yes','No')  FROM Vorlesung WHERE sem_id={{keySemId:Y}} }}
  {{SELECT id, city FROM Address AS adr WHERE adr.p_id={{SELECT id FROM Account AS acc WHERE acc.name={{feUser}} }} }}
523

524
* Special case for SELECT input fields. To deliver a result array specify an '!' before the SELECT: ::
525

526
   {{!SELECT ...}}
527

528
  * This is only possible for the outermost SELECT.
529

530
531
.. _form-main:

532
533
Form: main
----------
Carsten  Rose's avatar
Carsten Rose committed
534

Carsten  Rose's avatar
Carsten Rose committed
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
| Name                    | Type                                                     | Description                                                                             |
+=========================+==========================================================+=========================================================================================+
|id                       | int, autoincrement                                       | created by by MySQL                                                                     |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|name                     | string                                                   | unique and speaking name of the form. Form will be identified by this name              |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|title                    | string                                                   | Title, shown on/above the form.                                                         |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|noteInternal             | textarea                                                 | Internal notes: special functionality, used variables, ...                              |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|tableName                | string                                                   | Primay table of the form                                                                |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|permitNew                | enum('sip', 'logged_in', 'logged_out', 'always', 'never')| Default: sip                                                                            |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|permitEdit               | enum('sip', 'logged_in', 'logged_out', 'always', 'never')| Default: sip                                                                            |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|render                   | enum('plain','table', 'bootstrap')                       | Default bootstrap                                                                       |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|requiredParameter        | string                                                   | Name of required SIP parameter, seperated by comma. '#' as comment delimiter            |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|showButton               | set('new', 'delete', 'close', 'save')                    | Default 'new,delete,close,save'. Shown buttons in the upper right corner of the form.   |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|multiMode                | enum('none','horizontal','vertical')                     | Default 'none'                                                                          |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|multiSql                 | text                                                     | Optional. SQL Query which selects all records to edit.                                  |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|multiDetailForm          | string                                                   | Optional. Form to open, if a record is selected to edit (double click on record line)   |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|multiDetailFormParameter | string                                                   | Optional. Translated Parameter submitted to detailform (like subrecord parameter)       |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|forwardMode              | string: 'auto | no | page'                               |                                                                                         |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|forwardPage              | string / query                                           | If $forward=="page": page to jump to                                                    |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|bsLabelColumns           | string                                                   | The bootstrap grid system is based on 12 columns. The sum of *bsLabelColumns*,          |
+-------------------------+----------------------------------------------------------+ *bsInputColumns* and *bsNoteColumns* should be 12. These values here are the base values|
|bsInputColumns           | string                                                   | for all *FormElements*. Exceptions per *FormElement* can be specified per *FormElement*.|
573
+-------------------------+----------------------------------------------------------+ Default: label=3, input=6, note=3. See :ref:`form-layout`.                              |
Carsten  Rose's avatar
Carsten Rose committed
574
575
|bsNoteColumns            | string                                                   |                                                                                         |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
576
|parameter                | text                                                     | Misc additional parameters. See :ref:`form-parameter`.                                  |
Carsten  Rose's avatar
Carsten Rose committed
577
578
579
580
581
582
583
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|deleted                  | string                                                   | 'yes'|'no'.                                                                             |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|modified                 | timestamp                                                | updated automatically through stored procedure                                          |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|created                  | datetime                                                 | set once through QFQ                                                                    |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
584

585
586
showButton
^^^^^^^^^^
587

588
Display or hide the button `new`, `delete`, `close`, `save`.
589
590

* *new*: Creates a new record. If the form needs any special parameter via SIP or Client, hide this 'new' button - the necessary parameter are not provided.
591
* *delete*: This either deletes the current record only, or (if defined via action *FormElement* 'before Delete' ) any specified subrecords.
592
593
* *close*: Close the current form. If there are changes, a popup opens and ask to save / close / cancel. The last page from the history will be shown.
* *save*: Save the form.
594

595
* Default: show all buttons.
596

597
.. _form-parameter:
Carsten  Rose's avatar
Carsten Rose committed
598

599
600
parameter
^^^^^^^^^
Carsten  Rose's avatar
Carsten Rose committed
601

602
* The following parameter are optional and can be configured in the *Form.parameter* field.
Carsten  Rose's avatar
Carsten Rose committed
603

604
605
  * Comments: lines starting with a '#' are treated as a comment and will not be parsed.

606
607
608
609
610
611
612
613
614
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| Name                   | Type   | Description                                                                                              |
+========================+========+==========================================================================================================+
| maxVisiblePill         | int    | Show pills upto <maxVisiblePill> as button, all further in a dropdown menu. Eg.: maxVisiblePill=3        |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| class                  | string | HTML div with given class, surrounding the whole form. Eg.: class=container-fluid                        |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| classPill              | string | HTML div with given class, surrounding the `pill` title line.                                            |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
615
| classBody              | string | HTML div with given class, surrounding all *FormElement*.                                                |
616
617
618
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| submitButtonText       | string | Show save button, with the <submitButtonText> at the bottom of the form                                  |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
619
620
| extraDeleteForm        | string | Name of a form which specifies how to delete the primary record and optional slave records               |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
621
622
623
624
625
626
627
628
| data-pattern-error     | string | Pattern violation: Text for error message used for all FormElements of current form                      |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-required-error    | string | Required violation: Text for error message used for all FormElements of current form                     |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-match-error       | string | Match violation: Text for error message used for all FormElements of current form                        |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-error             | string | If none specific is defined: Text for error message used for all FormElements of current form            |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
629
630
| buttonOnChangeClass    | string | Color for save button after user modified some content or current form. E.g.: 'btn-info alert-info'      +
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
631

632
633
* Example:

634
635
  * maxVisiblePill = 5
  * class = container-fluid
636
  * classBody = qfq-form-right
637

638
639
submitButtonText
''''''''''''''''
640
641
642
643
644
645
646

* Optional.
* Default: Empty
* Empty: a 'submit' button with a Bootstrap glyph 'check' symbol is rendered at the *top right corner* of the form.
* Non Empty: a 'submit' button, with <submitButtonText>, is rendered at the bottom of the form (without a 'check' glyph
  symbol). Typically 'ShowButton: Save' will be unchecked to hide the regular save glyph symbol.

647
648
class
'''''
649
650
651
652
653
654
655
656
657

* Optional.
* Default: `container`
* Any CSS class name(s) can be specified.
* Check `typo3conf/ext/qfq/Resources/Public/Css/qfq-bs.css` for predefined classes.
* Typical use: adjust the floating rules of the form.
  * See: http://getbootstrap.com/css/#overview-container
  * Expand the form over the whole area: `container-fluid`

658
659
classPill
'''''''''
660
661
662
663
664
665
666
667
668
669

* Optional.
* Default: `qfq-color-grey-1`
* Any CSS class name(s) can be specified.
* Check `typo3conf/ext/qfq/Resources/Public/Css/qfq-bs.css` for predefined classes.
* Typical use: adjust the background color of the `pill title` area.
* Predefined background colors: `qfq-color-white`, `qfq-color-grey-1` (dark), `qfq-color-grey-2` (light),
  `qfq-color-blue-1` (dark), `qfq-color-blue-2`. (light)
* `classPill` is only visible on forms with container elemants of type 'Pill'.

670
671
classBody
'''''''''
672
673
674
675
676
677
678

* Optional.
* Default: `qfq-color-grey-2`
* Any CSS class name(s) can be specified.
* Check `typo3conf/ext/qfq/Resources/Public/Css/qfq-bs.css` for predefined classes.
* Typical use:

679
680
  * adjust the background color of the *FormElement* area.
  * make all form labels right align: `qfq-form-right`.
681
682
683

* Predefined background colors: `qfq-color-white`, `qfq-color-grey-1` (dark), `qfq-color-grey-2` (light),
  `qfq-color-blue-1` (dark), `qfq-color-blue-2`. (light)
684

685
686
687
688
689
690
691
692
693
694
695
submitButtonText
''''''''''''''''

If specified and non empty, display a regular submit button at the bottom of the page with the given text.
This gives the form a ordinary HTML-form look'n' feel. With this option, the standard buttons on the top right border
should be hided to not confuse the user.

extraDeleteForm
'''''''''''''''

Depending on the database definition, it might be necessary to delete the primary record *and* corresponding slave records.
696
To not repeat such 'slave record delete definition', an 'extraDeleteForm' can be specified. If the user opens a record
697
698
699
700
701
702
703
in a form and clicks on the 'delete' button, a defined 'extraDeleteForm'-form will be used to delete primary and slave
records instead of using the current form.
E.g. if there are multiple different forms to work on the same table, all of theses forms might reference to the same
'extraDeleteForm'-form. This simplifies the maintenance.

The 'extraDeleteForm' parameter might be specified for a 'form' and/or for 'subrecords'

704
705
FormElements
------------
706

707
708
709
* Each *form* contains one or more *FormElement*.
* The *FormElements* are divided in three categories:
  
710
711
712
  * :ref:`class-container`
  * :ref:`class-native`
  * :ref:`class-action`
Carsten  Rose's avatar
Carsten Rose committed
713

714
* Ordering and grouping: Native *FormElements* and Container-Elements (both with feIdContainer=0) will be ordered by 'ord'.
Carsten  Rose's avatar
Carsten Rose committed
715
* Inside of a container, all nested elements will be displayed.
716
* Technical, it's *not* necessary to configure a FormElement for the primary index column `id`.
717
718
719
720
* Additional options to a *FormElement* will be configured via the *FormElement.parameter* field (analog to *Form.parameter*
  for *Forms* ).

  * Comments: lines starting with a '#' are treated as a comment and will not be parsed.
Carsten  Rose's avatar
Carsten Rose committed
721

722
723
.. _class-container:

Carsten  Rose's avatar
Carsten Rose committed
724
725
726
Class: Container
----------------

727
728
* Pills are containers for 'fieldset' *and* / *or* 'native' *FormElements*.
* Fieldsets are containers for 'native' *FormElements*.
729
* TemplateGroups are containers for 'fieldset' *and* / *or* 'native' *FormElements*.
Carsten  Rose's avatar
Carsten Rose committed
730
731
732
733

Type: fieldset
^^^^^^^^^^^^^^

734
* Native *FormElements* can be assigned to a fieldset.
735
736
737
738
* FormElement settings:

  * *name*: technical name, used as HTML identifier.
  * *label*: Shown title of the fieldset.
Carsten  Rose's avatar
Carsten Rose committed
739
740
741
742

Type: pill
^^^^^^^^^^

743
744
* Pill is synonymous for a tab. A pill looks like a tab.
* Pills are only available with mode render='bootstrap'.
745
* If there is at least one pill defined, every native *FormElement* needs to be assigned to a pill or to a fieldset.
746
* If there is at least one pill defined, every fieldset needs to be assigned to a pill.
Carsten  Rose's avatar
Carsten Rose committed
747

748
749
750
751
752
* FormElement settings:

  * *name*: technical name, used as HTML identifier.
  * *label*: Label shown on the corresponding pill button or inside the dropdown menu.
  * *type*: *pill*
753
  * *feIdContainer*: `0`  - Pill's can't be nested.
754
  * *parameter*:
Carsten  Rose's avatar
Carsten Rose committed
755

756
    * *maxVisiblePill*: `<nr>` - Number of Pill-Buttons shown. Undefined means unlimited. Excess Pill buttons will be
757
      displayed as a dropdown menu.
Carsten  Rose's avatar
Carsten Rose committed
758

759
760
.. _class-native:

Carsten  Rose's avatar
Carsten Rose committed
761
762
763
764
765
766
767
768
769
Type: templateGroup
^^^^^^^^^^^^^^^^^^^

*TemplateGroups* will be used to create a series of grouped (by the given *templateGroup*) *FormElements*.

FormElements can be assigned to a *templateGroup*. These *templateGroup* will be rendered upto *n*-times. On 'form load'
only a single (=first) copy of the *templateGroup* will be shown. Below the last copy of the *templateGroup* an 'add'-button is
shown. If the user click on it, an additional copy of the *templateGroup* is displayed. This can be repeated up to
*templateGroup.maxLength* times. Also, the user can 'remove' previously created copies by clicking on a remove button near
770
beside every *templateGroup*. The first copy of a templateGroup can't be removed.
Carsten  Rose's avatar
Carsten Rose committed
771

772
* FormElement settings:
Carsten  Rose's avatar
Carsten Rose committed
773

774
775
  * *label*: Shown in the FormElement-editor *container* field.
  * *maxLength*: Maximum number of copies of the current *templateGroup*. Default: 5.
776
  * *bsLabelColumn*, *bsInputColumn*, *bsNoteColumn*: column widths for row with the 'Add' button.
777
778
779
780
781
782
783
784
  * *parameter*:

    * *tgAddClass*: Class of the 'add' button. Default: `btn btn-default`.
    * *tgAddText*: Text shown on the button. Default: `Add`.
    * *tgRemoveClass*: Class of the 'remove' button. Default: `btn btn-default`.
    * *tgRemoveText*: Text shown on the button. Default: `Remove`.
    * *tgClass*: Class wrapped around every copy of the *templateGroup*. E.g. the class `qfq-child-margin-top` adds a
      margin between two copies of the *templateGroup*. Default: empty
Carsten  Rose's avatar
Carsten Rose committed
785

786
Multiple *templateGroups* per form are allowed.
Carsten  Rose's avatar
Carsten Rose committed
787
788

The name of the native FormElements, inside the templateGroup, which represents the effective table columns, uses the placeholder
789
`%d`. E.g. the columns `grade1`, `grade2`, `grade3` needs a *FormElement.name* = `grade%d`. The counting will always start with 1.
790
The placeholder `%d` can also be used in the *FormElement.label*
Carsten  Rose's avatar
Carsten Rose committed
791

Carsten  Rose's avatar
Carsten Rose committed
792
793
794
Class: Native
-------------

795
796
Fields:

797
798
799
800
801
802
803
804
805
806
807
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
| Name          | Type                        | Description                                                                                       |
+===============+=============================+===================================================================================================+
| id            | int                         |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
| formId        | int                         |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|feIdContainer  | int                         |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|enabled        | enum('yes'|'no')            |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
808
809
|dynamicUpdate  | enum('yes'|'no')            | In the browser, *FormElements* with "dynamicUpdate='yes'"  will be updated depending on user      |
|               |                             | input. :ref:`dynamic-update`                                                                      |
810
811
812
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|name           | string                      |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
813
|label          | string                      | Label of *FormElement*. Depending on layout model, left or on top of the *FormElement*            |
814
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
815
816
817
|mode           | enum('show', 'readonly',    | *Show*: regular user input field. This is the default.                                            |
|               | 'required',                 | *Required*: User has to specify a value. Typically, an <empty string> represents 'no value'.      |
|               | 'disabled' )                | *Readonly*: user can't change any data. Data not saved.                                           |
818
|               |                             | *Disabled*: *FormElement* is not visible.                                                         |
819
820
821
822
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|class          | enum('native', 'action',    | Details below.                                                                                    |
|               | 'container')                |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
823
|type           | enum('checkbox', 'date', 'time', 'datetime',  'dateJQW', 'datetimeJQW', 'extra', 'gridJQW', 'text', 'editor', 'note',           |
824
|               | 'password', 'radio', 'select', 'subrecord', 'upload', 'fieldset', 'pill', 'beforeLoad', 'beforeSave',                           |
825
|               | 'beforeInsert', 'beforeUpdate', 'beforeDelete', 'afterLoad', 'afterSave', 'afterInsert', 'afterUpdate', 'afterDelete',          |
826
|               | 'sendMail')                                                                                                                     |
827
828
829
830
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|checkType      | enum('min|max', 'pattern',  |                                                                                                   |
|               | 'number', 'email')          |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
831
|checkPattern   | 'regexp'                    |If $check_type=='pattern': pattern to match                                                        |
832
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
833
|onChange       | string                      |List of *FormElement*-names of current form, separated by ', ', If one of the named *FormElements* |
834
835
|               |                             | change, reload own data / status / mode                                                           |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
836
|ord            | string                      | Display order of *FormElements* ('order' is a reserved keyword)                                   |
837
838
839
840
841
842
843
844
845
846
847
848
849
850
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|tabindex       | string                      |HTML tabindex attribute                                                                            |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|size           | string                      |Visible length of input element. Might be ommited, depending on the choosen form layout.           |
|               |                             |Format: <width>,<height> (in characters)                                                           |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|bsLabelColumns | string                      | Number of bootstrap grid columns for label. By default empty, value inherits from the form.       |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|bsInputColumns | string                      | Number of bootstrap grid columns for input. By default empty, value inherits from the form.       |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|bsNoteColumns  | string                      | Number of bootstrap grid columns for note. By default empty, value inherits from the form.        |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|maxLength      | string                      |Maximum characters for input.                                                                      |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
851
|note           | string                      |Note of *FormElement*. Depending on layout model, right or below of the *FormElement*.             |
852
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
853
|tooltip        | text                        |Display this text as tooltip on mouse over.                                                        |
854
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
855
|placeholder    | string                      |Text, displayed inside the input element in light grey.                                            |
856
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
857
|clientJs       | text                        |Javascript called on 'on change' *FormElement*                                                     |
858
859
860
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|value          | text                        |Default value                                                                                      |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
861
|sql1           | text                        |SQL query                                                                                          |
862
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
863
|parameter      | text                        |Might contain misc parameter. Depends on the type of *FormElement*.                                |
864
865
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|feGroup        | string                      | Comma-separated list of Typo3 FE Group ID. NOT SURE IF THIS WILL BE IMPLEMENTED. Native           |
866
867
|               |                             | *FormElements*, fieldsets and pills can be assigned to feGroups. Group status: show, hidden,      |
|               |                             | disabled. Group Access: FE-Groups. User will be assigned to FE-Groups and the form definition     |
868
869
|               |                             | reference such FE-groups. Easy way of granting permission.                                        |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
870
|deleted        | string                      | 'yes'|'no'.                                                                                       |
871
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
872
|modified       | timestamp                   |updated automatically through stored procedure                                                     |
873
874
875
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|created        | datetime                    |set once through QFQ                                                                               |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
876

877
878
879
880
881
882
.. _fe-parameter-attributes:

Attributes defined in the parameter field
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

See also at specific *FormElement* definitions.
883
884
885
886
887
888
889
890
891
892

+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-pattern-error     | string | Pattern violation: Text for error message used for all FormElements of current form                      |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-required-error    | string | Required violation: Text for error message used for all FormElements of current form                     |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-match-error       | string | Match violation: Text for error message used for all FormElements of current form                        |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-error             | string | If none specific is defined: Text for error message used for all FormElements of current form            |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
893
894
895
896
| htmlBefore             | string | HTML Code wrapped before the complete *FormElement*                                                      |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| htmlAfter              | string | HTML Code wrapped after the complete *FormElement*                                                       |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
897
898
899
900
901
902
903
904
| wrapRow                | string | If specified, skip default wrapping (`<div class='col-md-?>`). Instead the given string is used.         |
+------------------------+--------+                                                                                                          |
| wrapInput              | string |                                                                                                          |
+------------------------+--------+                                                                                                          |
| wrapInput              | string |                                                                                                          |
+------------------------+--------+                                                                                                          |
| wrapNote               | string |                                                                                                          |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
905

906
907
Effect matrix
^^^^^^^^^^^^^
Carsten  Rose's avatar
Carsten Rose committed
908

909
910
911
912
913
914
915
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| Attribute        | checkbox | dateJQW | datetimeJQW |  gridJQW | extra  | text  | note | password | radio | select | subrecord | timeJQW | upload | editor |
+==================+==========+=========+=============+==========+========+=======+======+==========+=======+========+===========+=========+========+========+
|id                |Internal id                                                                                                                              |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|formId            |Form                                                                                                                            |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
916
|containerId       |Assign the *FormElement* to user defined fieldSet or pill                                                                       |        |
917
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
918
|enabled           |*FormElement* is active or not                                                                                                  |        |
919
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
920
|name              |Name of a column of the primary table. *FormElements* with a corresponding table will be saved automatically.                   |        |
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|label             |Label shown to the user.                                                                                                        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|mode              |show, readonly, required, lock, disable.                                                                                        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|class             |native                                                                                                                          |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|type              | checkbox | dateJQW | datetimeJQW |  gridJQW | extra  | text  | note | password | radio | select | subrecord | timeJQW | upload |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|checkType         |          |   -     |   -         |          |        |   -   |      |   -      |       |        |           |   -     |        |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|checkPattern      |          |   -     |   -         |          |        |   -   |      |   -      |       |        |           |   -     |        |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|onChange          |   -      |   -     |   -         |          |        |   -   |      |   -      |   -   |   -    |           |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|ord               |   -      |   -     |   -         |   -      |   -    |   -   |   -  |   -      |   -   |   -    |   -       |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|tabindex          |   -      |   -     |   -         |   -      |   -    |   -   |   -  |   -      |   -   |   -    |   -       |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|size              |   -      |         |             |          |        |   -   |      |   -      |   -   |   -  2 |           |   -     |   -  ? |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|maxLength         |   1      |         |             |          |        |   -   |      |   -      |   - 1 |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|note              |   -      |   -     |   -         |          |        |   -   |   -  |   -      |   -   |   -    |   -       |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|tooltip           |   -      |   -     |   -         |          |        |   -   |      |   -      |   -   |   -    |           |   -     |   -    |   ?    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|placeholder       |          |   -     |   -         |          |        |   -   |      |          |       |        |           |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|clientJs          |          |   -     |   -         |   -      |        |   -   |      |   -      |   -   |   -    |           |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|value             |   -      |   -     |   -         |   -      |   -    |   -   |   -  |   -      |   -   |   -    |           |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|sql1              |?                                                                                                                                        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
956
|*Additional attributes in Field 'parameter'. Typically in key=value format.*                                                                                |
957
958
959
960
961
962
963
964
965
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| type             | checkbox | dateJQW | datetimeJQW | gridJQW  | extra  | text  | note | password | radio | select | subrecord | timeJQW | upload | editor |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| accept           |?                                                                                                                                        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| alt              |?                                                                                                                               |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| autocomplete     |          |   -     |   -         |          |        |   -   |      |          |       |        |           |   -     |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
966
| autofocus        |   -      |   -     |   -         |          |        |   -   |      |   -      |   -   |   -    |           |   -     |   -    |   -    |
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| checkBoxMode     |   -      |   -     |             |          |        |       |      |          |       |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| checked          |   -      |         |             |          |        |   -   |      |          |   -   |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| unchecked        |   -      |         |             |          |        |   -   |      |          |   -   |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| label2           |   -      |         |             |          |        |       |      |          |   -   |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| itemList         |   -      |         |             |          |        |       |      |          |   -   |   -    |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| emptyItemAtStart |          |         |             |          |        |       |      |          |       |   -    |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| emptyItemAtEnd   |          |         |             |          |        |       |      |          |       |   -    |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| emptyHide        |          |         |             |          |        |       |      |          |       |   -    |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
984
985
| retype           |          | -       | -           |          |        | -     |      | -        |       |        |           | -       |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
986
987
| accept           |          |         |             |          |        |       |      |          |       |        |           |         |   -  3 |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
988
989
990
991
992
993
994
995
996
997
998
999
| slaveId          |          |         |             |          |        |       |      |          |       |        |           |         |   -    |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| fileDestination  |          |         |             |          |        |       |      |          |       |        |           |         |   -    |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| sqlBefore        |          |         |             |          |        |       |      |          |       |        |           |         |   -    |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| sqlInsert        |          |         |             |          |        |       |      |          |       |        |           |         |   -    |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| sqlDelete        |          |         |             |          |        |       |      |          |       |        |           |         |   -    |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| sqlAfter         |          |         |             |          |        |       |      |          |       |        |           |         |   -    |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
1000