Index.rst 190 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


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

* Multi Forms
29
30
31
32

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

33
QFQ is used by configuring Typo3 content elements. Insert one or more QFQ content elements on a Typo3 page.
34
35
36
37
38
39
40
41
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)
^^^^^^^^^^^^^^^^^^^^^^^

42

43
44
45
46
47
48
49
50
 +-------------------+---------------------------------------------------------------------------------+
 | 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}} }}** |
 +-------------------+---------------------------------------------------------------------------------+
51
 | r                 | <record id> The form will load the record with the specified id                 |
52
53
 |                   | * Variants: **r = 123**, by SQL: **r = {{SELECT ...}}**                         |
 |                   | * If not specified, the default is '0'                                          |
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 +-------------------+---------------------------------------------------------------------------------+
 | <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                           |
 +-------------------+---------------------------------------------------------------------------------+
81
 | debugShowBodyText | If ='1' and config.ini:*showDebugInfo=yes*: shows a tooltip with bodytext       |
82
 +-------------------+---------------------------------------------------------------------------------+
83

84
85
.. _debug:

86
87
88
89
90
Debug
^^^^^

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

91
92
93
94
95
96
  * *yes*:

    * Form:

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

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

100
      *debugShowBodyText = 1*
101

102
  * *no*: No debug info.
103

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

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

Form
----

112
113
* Forms will be created by using the *Form editor* on the Typo3 frontend (HTML form).
* The Formeditor itself consist of two predefined QFQ forms: *form* and *formElement*
114
115
* 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.
116
* There are three types of forms which can roughly categorized into:
117

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

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

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

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

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

128
129
    * 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
130

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

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

Most fields of a form specification might contain:
137

Carsten  Rose's avatar
Carsten Rose committed
138
139
140
141
142
* ''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.

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

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

* Example:

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

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

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

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

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

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

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

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

166

167
168
* 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.
169
* 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
170
171
172
173
174
* If no value is found, the value is an <empty string>.

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

175
* URL (=GET) Parameter can be used in *forms* and *reports* as variables.
176
177
178
179
180
181
182
183
184
185
186
187
188
189
* 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
190
191
192
193

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

194
195
196
197
198
199
* 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
200

201
202
203
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| Name             | Form | Query | Pattern                                                                                 |
+==================+======+=======+=========================================================================================+
204
| **alnumx**       | Form | Query | [A-Za-z][0-9]@-_.,;: /() ÀÈÌÒÙàèìòùÁÉÍÓÚÝáéíóúýÂÊÎÔÛâêîôûÃÑÕãñõÄËÏÖÜŸäëïöüÿ             |
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **digit**        | Form | Query | [0-9].-+                                                                                |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **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
221
222
223
224
225


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

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

 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 |Name |Description                                                                             | Content                                                                    |
 +=====+========================================================================================+============================================================================+
231
 | F   | :ref:`STORE_FORM`: data not saved in database yet.                                     | All native *FormElements*. Recent values from the Browser.                 |
232
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
233
234
 | 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.                                         |                                                                            |
235
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
236
 | R   | :ref:`STORE_RECORD`: Record - the current record loaded in the form                    | All columns of the current record from the current table                   |
237
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
238
239
 | 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                   |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
240
241
 | 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   |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
242
 | D   | Default values column : The *table.column* specified *default value*.                  |                                                                            |
243
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
244
 | M   | Column type: The *table.column* specified *type*                                       |                                                                            |
245
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
246
 | C   | :ref:`STORE_CLIENT`: POST variable, if not found: GET variable                         | Parameter sent from the Client (=Browser).                                 |
247
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
248
 | T   | :ref:`STORE_TYPO3`: a) Bodytext (ttcontent record), b) Typo3 internal variables        | See Typo3 tt_content record configuration                                  |
249
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
250
 | V   | :ref:`STORE_VARS`: Generic variables                                                   |                                                                            |
251
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
252
253
 | 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.                                                      |                                                                            |
254
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
255
256
 | 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                                                   |                                                                            |
257
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
258
 | Y   | :ref:`STORE_SYSTEM`: a) Database, b) helper vars for logging/debugging:                |                                                                            |
259
 |     | SYSTEM_SQL_RAW ... SYSTEM_FORM_ELEMENT_COLUMN, c) Any custom fields: CONTACT, HELP, .. |                                                                            |
260
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
261

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

265
266
267
  * 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
268
269
270
271
272
273

.. _predefined-variable-names:

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

274
275
276
277
278
.. _STORE_FORM:

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

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

283
284
285
  * *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`.
286

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

.. _STORE_SIP:

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

298
* Sanatized: *no*
299
300
301
302
303
* 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`.

304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 +-------------------------+-----------------------------------------------------------+
 | 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                    |
 +-------------------------+-----------------------------------------------------------+
319
320
321
322
323
324

.. _STORE_RECORD:

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

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

329
330
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                   | Explanation                                                                                                                                      |
331
332
333
334
335
336
337
338
339
 +========================+==================================================================================================================================================+
 | <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
^^^^^^^^^^^^^^^^^^^

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

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

346
347
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                   | Explanation                                                                                                                                      |
348
349
350
 +========================+==================================================================================================================================================+
 | <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}}* |
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
351
352
353

.. _STORE_CLIENT:

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

357
358
* Sanatized: *yes*

359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | 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
382

383
384
.. _STORE_TYPO3:

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

388
389
* Sanatized: *no*

390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 +-------------------------+-------------------------------------------------------------------+----------+
 | 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                              |          |
 +-------------------------+-------------------------------------------------------------------+----------+
412
413
414

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

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

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

422
423
* Sanatized: *no*

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

436
437
438

.. _STORE_SYSTEM:

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

442
443
* Sanatized: *no*

444
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
 +-------------------------+--------------------------------------------------------------------------+
 | 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                        |
 +-------------------------+--------------------------------------------------------------------------+
499
500
501

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

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

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

511
* A SQL Statement might contain parameters, including additional SQL statements. Inner SQL queries will be executed first.
Carsten  Rose's avatar
Carsten Rose committed
512
* All variables will be substituted one by one from inner to outer.
513
* 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
514
* The number of variables inside an input field or a SQL statement is not limited.
515
* 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
516

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

519
  {{SELECT id, name FROM Person}}
520
521
  {{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}} }} }}
522

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

525
   {{!SELECT ...}}
526

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

529
530
Form: main
----------
Carsten  Rose's avatar
Carsten Rose committed
531

Carsten  Rose's avatar
Carsten Rose committed
532
533
534
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
573
574
575
576
577
578
579
580
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
| 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*.|
+-------------------------+----------------------------------------------------------+ Default: label=3, input=6, note=3                                                       |
|bsNoteColumns            | string                                                   |                                                                                         |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|parameter                | text                                                     | Misc additional parameters. See :ref:`form-parameter`                                   |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|deleted                  | string                                                   | 'yes'|'no'.                                                                             |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|modified                 | timestamp                                                | updated automatically through stored procedure                                          |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|created                  | datetime                                                 | set once through QFQ                                                                    |
+-------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
581

582
583
showButton
^^^^^^^^^^
584

585
Display or hide the button `new`, `delete`, `close`, `save`.
586
587

* *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.
588
* *delete*: This either deletes the current record only, or (if defined via action *FormElement* 'before Delete' ) any specified subrecords.
589
590
* *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.
591

592
* Default: show all buttons.
593

594
.. _form-parameter:
Carsten  Rose's avatar
Carsten Rose committed
595

596
597
parameter
^^^^^^^^^
Carsten  Rose's avatar
Carsten Rose committed
598

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

601
602
603
604
605
606
607
608
609
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| 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.                                            |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
610
| classBody              | string | HTML div with given class, surrounding all *FormElement*.                                                |
611
612
613
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| submitButtonText       | string | Show save button, with the <submitButtonText> at the bottom of the form                                  |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
614
615
| extraDeleteForm        | string | Name of a form which specifies how to delete the primary record and optional slave records               |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
616
617
618
619
620
621
622
623
| 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            |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
624

625
626
* Example:

627
628
  * maxVisiblePill = 5
  * class = container-fluid
629
  * classBody = qfq-form-right
630

631
632
submitButtonText
''''''''''''''''
633
634
635
636
637
638
639

* 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.

640
641
class
'''''
642
643
644
645
646
647
648
649
650

* 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`

651
652
classPill
'''''''''
653
654
655
656
657
658
659
660
661
662

* 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'.

663
664
classBody
'''''''''
665
666
667
668
669
670
671

* 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:

672
  1) adjust the background color of the *FormElement* area.
673
674
675
676
  1) make all form labels right align: `qfq-form-right`.

* 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)
677

678
679
680
681
682
683
684
685
686
687
688
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.
689
To not repeat such 'slave record delete definition', an 'extraDeleteForm' can be specified. If the user opens a record
690
691
692
693
694
695
696
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'

697
698
699
700
701
FormElements
------------
* Each *form* contains one or more *FormElement*.
* The *FormElements* are divided in three categories:
  
702
703
704
  * :ref:`class-container`
  * :ref:`class-native`
  * :ref:`class-action`
Carsten  Rose's avatar
Carsten Rose committed
705

706
* Ordering and grouping: Native *FormElements* and Container-Elements (both with feIdContainer=0) will be ordered by 'ord'.
Carsten  Rose's avatar
Carsten Rose committed
707
708
* Inside of a container, all nested elements will be displayed.

709
710
.. _class-container:

Carsten  Rose's avatar
Carsten Rose committed
711
712
713
Class: Container
----------------

714
715
* Pills are containers for 'fieldset' *and* / *or* 'native' *FormElements*.
* Fieldsets are containers for 'native' *FormElements*.
Carsten  Rose's avatar
Carsten Rose committed
716
717
718
719

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

720
* Native *FormElements* can be assigned to a fieldset.
Carsten  Rose's avatar
Carsten Rose committed
721
722
723
724
725
726
* name: technical name, used as HTML identifier.
* label: Shown title of the fieldset.

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

727
728
* Pill is synonymous for a tab. A pill looks like a tab.
* Pills are only available with mode render='bootstrap'.
729
* If there is at least one pill defined, every native *FormElement* needs to be assigned to a pill or to a fieldset.
730
* If there is at least one pill defined, every fieldset needs to be assigned to a pill.
Carsten  Rose's avatar
Carsten Rose committed
731
732
733

* Parameter:

734
735
736
737
  * FormElement.*name*: technical name, used as HTML identifier.
  * FormElement.*label*: Label shown on the corresponding pill button or inside the dropdown menu.
  * FormElement.*type*: *pill*
  * FormElement.*feIdContainer*: 0  # Pill's can't be nested.
738
  * Form.'''Parameter''': *maxVisiblePill=<nr>* Number of Pill-Buttons shown. Undefined means unlimited. Excess Pill buttons will be displayed as a dropdown menu.
Carsten  Rose's avatar
Carsten Rose committed
739

740
741
.. _class-native:

Carsten  Rose's avatar
Carsten Rose committed
742
743
744
Class: Native
-------------

745
746
Fields:

747
748
749
750
751
752
753
754
755
756
757
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
| Name          | Type                        | Description                                                                                       |
+===============+=============================+===================================================================================================+
| id            | int                         |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
| formId        | int                         |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|feIdContainer  | int                         |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|enabled        | enum('yes'|'no')            |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
758
759
|dynamicUpdate  | enum('yes'|'no')            | In the browser, *FormElements* with "dynamicUpdate='yes'"  will be updated depending on user      |
|               |                             | input. :ref:`dynamic-update`                                                                      |
760
761
762
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|name           | string                      |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
763
|label          | string                      | Label of *FormElement*. Depending on layout model, left or on top of the *FormElement*            |
764
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
765
766
767
|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.                                           |
768
|               |                             | *Disabled*: *FormElement* is not visible.                                                         |
769
770
771
772
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|class          | enum('native', 'action',    | Details below.                                                                                    |
|               | 'container')                |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
773
|type           | enum('checkbox', 'date', 'time', 'datetime',  'dateJQW', 'datetimeJQW', 'extra', 'gridJQW', 'text', 'editor', 'note',           |
774
|               | 'password', 'radio', 'select', 'subrecord', 'upload', 'fieldset', 'pill', 'beforeLoad', 'beforeSave',                           |
775
|               | 'beforeInsert', 'beforeUpdate', 'beforeDelete', 'afterLoad', 'afterSave', 'afterInsert', 'afterUpdate', 'afterDelete',          |
776
|               | 'sendMail')                                                                                                                     |
777
778
779
780
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|checkType      | enum('min|max', 'pattern',  |                                                                                                   |
|               | 'number', 'email')          |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
781
|checkPattern   | 'regexp'                    |If $check_type=='pattern': pattern to match                                                        |
782
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
783
|onChange       | string                      |List of *FormElement*-names of current form, separated by ', ', If one of the named *FormElements* |
784
785
|               |                             | change, reload own data / status / mode                                                           |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
786
|ord            | string                      | Display order of *FormElements* ('order' is a reserved keyword)                                   |
787
788
789
790
791
792
793
794
795
796
797
798
799
800
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|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.                                                                      |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
801
|note           | string                      |Note of *FormElement*. Depending on layout model, right or below of the *FormElement*.             |
802
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
803
|tooltip        | text                        |Display this text as tooltip on mouse over.                                                        |
804
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
805
|placeholder    | string                      |Text, displayed inside the input element in light grey.                                            |
806
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
807
|clientJs       | text                        |Javascript called on 'on change' *FormElement*                                                     |
808
809
810
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|value          | text                        |Default value                                                                                      |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
811
|sql1           | text                        |SQL query                                                                                          |
812
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
813
|parameter      | text                        |Might contain misc parameter. Depends on the type of *FormElement*.                                |
814
815
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|feGroup        | string                      | Comma-separated list of Typo3 FE Group ID. NOT SURE IF THIS WILL BE IMPLEMENTED. Native           |
816
817
|               |                             | *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     |
818
819
|               |                             | reference such FE-groups. Easy way of granting permission.                                        |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
820
|deleted        | string                      | 'yes'|'no'.                                                                                       |
821
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
822
|modified       | timestamp                   |updated automatically through stored procedure                                                     |
823
824
825
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|created        | datetime                    |set once through QFQ                                                                               |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
826

827
828
829
830
831
832
.. _fe-parameter-attributes:

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

See also at specific *FormElement* definitions.
833
834
835
836
837
838
839
840
841
842
843
844

+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| 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            |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+


845
846
Effect matrix
^^^^^^^^^^^^^
Carsten  Rose's avatar
Carsten Rose committed
847

848
849
850
851
852
853
854
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| Attribute        | checkbox | dateJQW | datetimeJQW |  gridJQW | extra  | text  | note | password | radio | select | subrecord | timeJQW | upload | editor |
+==================+==========+=========+=============+==========+========+=======+======+==========+=======+========+===========+=========+========+========+
|id                |Internal id                                                                                                                              |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|formId            |Form                                                                                                                            |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
855
|containerId       |Assign the *FormElement* to user defined fieldSet or pill                                                                       |        |
856
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
857
|enabled           |*FormElement* is active or not                                                                                                  |        |
858
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
859
|name              |Name of a column of the primary table. *FormElements* with a corresponding table will be saved automatically.                   |        |
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|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              |?                                                                                                                                        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
895
|*Additional attributes in Field 'parameter'. Typically in key=value format.*                                                                                |
896
897
898
899
900
901
902
903
904
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| type             | checkbox | dateJQW | datetimeJQW | gridJQW  | extra  | text  | note | password | radio | select | subrecord | timeJQW | upload | editor |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| accept           |?                                                                                                                                        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| alt              |?                                                                                                                               |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| autocomplete     |          |   -     |   -         |          |        |   -   |      |          |       |        |           |   -     |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
905
| autofocus        |   -      |   -     |   -         |          |        |   -   |      |   -      |   -   |   -    |           |   -     |   -    |   -    |
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| checkBoxMode     |   -      |   -     |             |          |        |       |      |          |       |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| checked          |   -      |         |             |          |        |   -   |      |          |   -   |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| unchecked        |   -      |         |             |          |        |   -   |      |          |   -   |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| label2           |   -      |         |             |          |        |       |      |          |   -   |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| itemList         |   -      |         |             |          |        |       |      |          |   -   |   -    |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| emptyItemAtStart |          |         |             |          |        |       |      |          |       |   -    |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| emptyItemAtEnd   |          |         |             |          |        |       |      |          |       |   -    |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| emptyHide        |          |         |             |          |        |       |      |          |       |   -    |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
923
924
| retype           |          | -       | -           |          |        | -     |      | -        |       |        |           | -       |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
925
926
| accept           |          |         |             |          |        |       |      |          |       |        |           |         |   -  3 |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
927
928
929
930
931
932
933
934
935
936
937
938
| slaveId          |          |         |             |          |        |       |      |          |       |        |           |         |   -    |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| fileDestination  |          |         |             |          |        |       |      |          |       |        |           |         |   -    |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| sqlBefore        |          |         |             |          |        |       |      |          |       |        |           |         |   -    |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| sqlInsert        |          |         |             |          |        |       |      |          |       |        |           |         |   -    |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| sqlDelete        |          |         |             |          |        |       |      |          |       |        |           |         |   -    |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| sqlAfter         |          |         |             |          |        |       |      |          |       |        |           |         |   -    |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
939

Carsten  Rose's avatar
Carsten Rose committed
940
941
942
943
* 1: A line break created every <size> elements. Easy way to make checkboxes or radio vertical instead of horizontal.
* 2: Any number >1 makes the 'select' input 'multiple' ready.
* See: https://www.w3.org/TR/html5/forms.html#file-upload-state-(type=file)

944
* All 'native' *FormElements* like 'input', 'checkbox', ...
Carsten  Rose's avatar
Carsten Rose committed
945

946
947
948
949
950
951
'autofocus': The first *FormElement* with this attribute will get the focus after form load. If there is no such attribute
 given to any *FormElement*, the attribute will be automatically assigned to the first editable *FormElement*.

To disable 'autofocus' on a form, set 'autofocus=0' on the first editable *FormElement*.

Note: If there are multiple pills defined on a form, only the first pill will be set with 'autofocus'.
952

Carsten  Rose's avatar
Carsten Rose committed
953
954
955
Type: checkbox
^^^^^^^^^^^^^^

956
Checkboxes can be rendered in mode:
Carsten  Rose's avatar
Carsten Rose committed
957

958
* *single*:
Carsten  Rose's avatar
Carsten Rose committed
959

960
  * One column in a table corresponds to one checkbox.
961
  * The value for statuses *checked* and *unchecked* are free to choose.
962
963
  * This mode is selected, if a) *checkBoxMode* = single, or b) *checkBoxMode* is missing **and** the number of fields of the column definition is <3.
  * *parameter*:
Carsten  Rose's avatar
Carsten Rose committed
964

965
966
    * *checkBoxMode* = single (optional)
    * *checked* = <value> (optional, the value which represents 'checked')
Carsten  Rose's avatar
Carsten Rose committed
967

968
      * If *checked* is empty or missing: If *type* = 'enum' or 'set', get first item of the definition. If *type* = string, get default.
Carsten  Rose's avatar
Carsten Rose committed
969

970
    * *unchecked* = <value> (optional, the value which represents 'unchecked')
Carsten  Rose's avatar
Carsten Rose committed
971

972
      * If *unchecked* is empty or missing: If *type* = 'enum' or 'set', get second item of checked. If *type* = 'string', get ''.
Carsten  Rose's avatar
Carsten Rose committed
973

974
    * *label2* = <value>       (Text right beside checkbox) (optional)
Carsten  Rose's avatar
Carsten Rose committed
975
976


977
978
* *multi*:

979
  * One column in a table represents multiple checkboxes. This is typically useful for the column type *set*.
980
981
982
983
984
985
986
987
988
989
  * The value for status *checked* are free to choose, the value for status *unchecked* is always the empty string.
  * Each field key (or the corresponding value from the key/value pair) will be rendered right beside the checkbox.
  * *parameter*

    * *checkBoxMode*: multi
    * *itemList* - E.g.:

      * ``itemList=red,blue,orange``
      * ``itemList=1:red,2:blue,3:orange``
      * ``itemList={{!SELECT id, value FROM someTable}}``
Carsten  Rose's avatar
Carsten Rose committed
990

991
  * *FormElement* Maxlength - vertical or horizontal alignment:
992
993
994
995

     * Value: '', 0, 1 - The radios will be aligned vertical.
     * Value: >1 - The readios will be aligned horizontal, with a linebreak every 'value' elements.

Carsten  Rose's avatar
Carsten Rose committed
996
997
998
Type: date
^^^^^^^^^^

999
1000
* Range datetime: '1000-01-01' to '9999-12-31' or '0000-00-00'. (http://dev.mysql.com/doc/refman/5.5/en/datetime.html)
* Optional: