Index.rst 132 KB
Newer Older
Carsten  Rose's avatar
Carsten Rose committed
1
.. ==================================================
2
3
4
5
6
7
8
9
10
11
12
13
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt


.. _users-manual:

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

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


18
Features not implemented yet
19
20
21
22
----------------------------

* Multi Forms
* File upload
23
* FormElement:
24

25
26
  * type=action (especially not *addNupdate*)
  * field dependencies (activating a parent element, activates child elements and vice versa)
27
  * Checkbox: some combinations not tested.
28
29
30
31

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

32
QFQ is used by configuring Typo3 content elements. Insert one or more QFQ content elements on a Typo3 page.
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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)
^^^^^^^^^^^^^^^^^^^^^^^

 +-----------------+---------------------------------------------------------------------------------+
 | 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}} }}** |
 +-----------------+---------------------------------------------------------------------------------+
 | <level>.db      | Select a DB. Only necessary if a different than the standard DB should be used. |
 +-----------------+---------------------------------------------------------------------------------+
 | <level>.debug   | Debug Level for *report*                                                        |
 +-----------------+---------------------------------------------------------------------------------+
 | <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                           |
76
77
78
79
80
81
82
 +-----------------+---------------------------------------------------------------------------------+

Debug
^^^^^

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

83
  * 'yes':
84

85
86
    * Show tooltips in forms filled with decoded SIP.
    * Shows 'Edit form' button in every form.
87

88
  * 'no': No debug info rendered in the output.
89

90
  * 'auto':
91

92
    * checks if there is a Typo3 BE Session.
93

94
95
      * yes: *SHOW_DEBUG_INFO = 'yes'*
      * no: *SHOW_DEBUG_INFO = 'no'*
Carsten  Rose's avatar
Carsten Rose committed
96
97
98
99

Form
----

100
* Forms will be created by using the *Form editor*. The Formeditor itself consist of two regular QFQ forms: *form* and *formElement*
101
102
103
104
* 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.
* There are three types of forms:

105
  * *Simple* form: the form acts on one record, stored in one table.
106

107
    * The form will create necessary SQL commands for insert, update and delete automatically.
108

109
  * *Advanced* form: the form acts on one record, stored in more than one table.
110

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

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

115
116
    * 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
117
118


119
120
Variable (incl. mixed SQL Statement)
------------------------------------
Carsten  Rose's avatar
Carsten Rose committed
121
122

Most fields of a form specification might contain:
123

Carsten  Rose's avatar
Carsten Rose committed
124
125
126
127
128
* ''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.

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

131
  *{{VarName[:<store / prio>[:<sanitize class>]]}}*
Carsten  Rose's avatar
Carsten Rose committed
132
133
134

* Example:

135
  *{{recordid}}*
Carsten  Rose's avatar
Carsten Rose committed
136

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

139
  *{{SELECT name FROM person WHERE id={{recordid}} }}*
Carsten  Rose's avatar
Carsten Rose committed
140

141
  *{{SELECT name FROM person WHERE id={{key1:C:ALNUMX}} }}*
Carsten  Rose's avatar
Carsten Rose committed
142

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

145
146
  * *{{ SELECT "Hello World"   }}* acts as *{{SELECT "Hello World"}}*
  * *{{ varname   }}* acts as *{{varname}}*
Carsten  Rose's avatar
Carsten Rose committed
147

148
149
150
* There are several stores, from where to retrieve the value. If a value is not found in one store, the next store is searched, and so on,
  until a value is found.
* 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
151
152
153
154
155
* If no value is found, the value is an <empty string>.

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

156
* URL (=GET) Parameter can be used in *forms* and *reports* as variables.
157
* If a value a parameter sanitize class, an exception is thrown.
Carsten  Rose's avatar
Carsten Rose committed
158
159
160
161

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

162
* All values in Store *C* (Client) and store *F* (Form) will be sanitized with one of three classes:
Carsten  Rose's avatar
Carsten Rose committed
163
164
165
166
167

  * **digit**: [0-9].-+
  * **alnumx**: [A-Za-z][0-9]@-_.,; /()
  * **all**: no sanitizing

168
169
* All :ref:`predefined-variable-names` have a specific default sanitize class. For these variables, it's not necessary
  to specify a sanitize class.
Carsten  Rose's avatar
Carsten Rose committed
170
* All other variables (Store: C, F) get by default the sanitize class 'digit'.
171
* A default sanitize class can be overwritten by individual definition: *{{a:C:all}}*
Carsten  Rose's avatar
Carsten Rose committed
172
173
174
175

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

176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
Only variables that are known in a specified store can be substituted.

 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 |Name |Description                                                                             | Content                                                                    |
 +=====+========================================================================================+============================================================================+
 | F   | Form: data not saved in database yet.                                                  | All native form elements. Recent values from the Browser.                  |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | S   | SIP: Client parameter 's' will indicate the current SIP, which will be loaded from the | sip, r (record_id), form                                                   |
 |     | SESSION repo to the SIP-Store.                                                         |                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | R   | Record - the record that is going to be edited. For new records: empty.                | All columns of the current record from the current table                   |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | 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   |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | D   | The *table.column* specified *default value*.                                          |                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | M   | The *table.column* specified *type*                                                    |                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | C   | Client: POST variable, if not found: GET variable                                      | Parameter sent from the Client (=Browser).                                 |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | T   | Typo3: a) Bodytext (ttcontent record), b) Typo3 internal varibles like fe_user_uid, ...| See Typo3 tt_content record configuration                                  |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | 0   | Value: 0, might be helpful if variable is empty but used in an SQL statement, which    | All possible keys                                                          |
 |     | might produce a SQL error otherwise if substituted with an empty string                |                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | Y   | System: a) Database credentials, b) helper vars for logging/debugging:                 |                                                                            |
 |     | SYSTEM_SQL_RAW ... SYSTEM_FORM_ELEMENT_COLUMN                                          |                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
204

205
* Default *<prio>*: *FSRD* - Form / SIP / Record / Table definition.
Carsten  Rose's avatar
Carsten Rose committed
206
207
* Hint: Preferable, parameter should be submitted by SIP, not by Client (=URL).

208
209
210
  * 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
211
212
213
214
215
216

.. _predefined-variable-names:

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

217
Store: *CLIENT* - C
Carsten  Rose's avatar
Carsten Rose committed
218
219
220
221
222
223
224
225
226
227
228
^^^^^^^^^^^^^^^^^^^

 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | Name          | Explanation                                                                                                                              |
 +===============+==========================================================================================================================================+
 | s             | =SIP                                                                                                                                     |
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | r             | record id. Typically stored in SIP, rarely specified on the URL                                                                          |
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | keySemId      | always current Semester Id                                                                                                               |
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
229
 | keySemIdUser  | *{{keySemIdUser}}*, may be changed by user                                                                                               |
Carsten  Rose's avatar
Carsten Rose committed
230
231
232
233
234
235
236
237
238
239
240
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | pageId        | current T3 page Id                                                                                                                       |
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | pageType      | T3 GET Parameter 'type'                                                                                                                  |
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | pageLanguage  | T3 GET Parameter 'L'                                                                                                                     |
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | HTTP_HOST     | current HTTP HOST                                                                                                                        |
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | REMOTE_ADDR   | Client IP address                                                                                                                        |
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
241
 | '$_SERVER[*]' | All other variables accessable by *$_SERVER[]*. Only the often used have a pre-defined sanitize class.                                   |
Carsten  Rose's avatar
Carsten Rose committed
242
243
244
245
246
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | form          | Unique name of current form                                                                                                              |
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | random        | random string with length of 32 chars, alphanum                                                                                          |
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
247
 | ANREDE        | *{{sex}}* == male >> Sehr geehrter Herr, *{{sex}}* == female  Sehr geehrte Frau                                                          |
Carsten  Rose's avatar
Carsten Rose committed
248
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+
249
 | EANREDE       | *{{sex}}* == male >> Dear Mr., *{{sex}}* == female >> Dear Mrs.                                                                          |
Carsten  Rose's avatar
Carsten Rose committed
250
251
 +---------------+------------------------------------------------------------------------------------------------------------------------------------------+

252
Store: *TYPO3* (Bodytext) - T
Carsten  Rose's avatar
Carsten Rose committed
253
254
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Carsten  Rose's avatar
Carsten Rose committed
255
256
257
258
 +---------------+-------------------------------------------------------------------+
 | Name          | Explanation                                                       |
 +===============+===================================================================+
 | form          | Formname defined in ttcontent record bodytext                     |
259
 |               |                                                                   |
260
261
 |               | * Fix. E.g. *form = person*                                       |
 |               | * via SIP. E.g. *form = {{form}}*                                 |
Carsten  Rose's avatar
Carsten Rose committed
262
 +---------------+-------------------------------------------------------------------+
263
 | debugShowStack| Any exception will show the call stack. E.g. *debugShowStack = 1* |
Carsten  Rose's avatar
Carsten Rose committed
264
 +---------------+-------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
265
266
267
268
 | debugLoad     | Debug Level for 'load', defined in ttcontent record bodytext      |
 +---------------+-------------------------------------------------------------------+
 | debugSave     | Debug Level for 'save', defined in ttcontent record bodytext      |
 +---------------+-------------------------------------------------------------------+
269
270
271
 | feUser        | Logged in Typo3 FE User                                           |
 +---------------+-------------------------------------------------------------------+
 | feUserUid     | Logged in Typo3 FE User uid                                       |
Carsten  Rose's avatar
Carsten Rose committed
272
 +---------------+-------------------------------------------------------------------+
273
 | feUserGroup   | FE groups of logged in Typo3 FE User                              |
Carsten  Rose's avatar
Carsten Rose committed
274
 +---------------+-------------------------------------------------------------------+
275
 | ttcontentUid  | Record id of current Typo3 content element                        |
Carsten  Rose's avatar
Carsten Rose committed
276
 +---------------+-------------------------------------------------------------------+
277
278
279
 | typo3PageId   | Record id of current Typo3 page                                   |
 +---------------+-------------------------------------------------------------------+

Carsten  Rose's avatar
Carsten Rose committed
280

281
Store: *FORM* - F
Carsten  Rose's avatar
Carsten Rose committed
282
283
284
285
286
287
288
289
290
291
^^^^^^^^^^^^^^^^^
* Represents the values in the form, typically before saving them.
* Used for:

  * Formelements who will be rerendered, after a parent element has been changed by the user.
  * Formelement actions, before saving the form.

 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | Name               | Explanation                                                                                                                                |
 +====================+============================================================================================================================================+
292
 | FormElement name   | Name of native formelement. To get, exactly and only, the specified form element (for 'p_id'): *{{p_id:F}}*                                |
Carsten  Rose's avatar
Carsten Rose committed
293
294
 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+

295
Store: *RECORD* - R
Carsten  Rose's avatar
Carsten Rose committed
296
297
298
299
^^^^^^^^^^^^^^^^^^^
 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | Name               | Explanation                                                                                                                                |
 +====================+============================================================================================================================================+
300
 | record column name | Name of a column of the primary table (as defined in the current form). To get, exactly and only, the specified form element: *{{p_id:R}}* |
Carsten  Rose's avatar
Carsten Rose committed
301
302
303
304
305
 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+

SQL
---

306
* The detection of an SQL command is case *insensitive*.
307
* Leading  whitespace will be skipped.
308
* The following commands are interpreted as SQL commands:
Carsten  Rose's avatar
Carsten Rose committed
309

310
311
312
313
314
  * SELECT
  * INSERT
  * UPDATE
  * DELETE
  * SHOW
Carsten  Rose's avatar
Carsten Rose committed
315

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

322
* Example::
Carsten  Rose's avatar
Carsten Rose committed
323

324
325
326
327
328
329
330
331
  {{SELECT id, name FROM Person}}
  {{SELECT id, name, IF({{fe_user}}=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={{fe_user}} }} }}

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

  *{{!SELECT ...}}*

332
  * This is only possible for the outermost SELECT.
333
334
335

Form: basic setup
-----------------
Carsten  Rose's avatar
Carsten Rose committed
336
337

+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
338
| Name                   | Type                                                     | Description                                                                             |
Carsten  Rose's avatar
Carsten Rose committed
339
340
341
342
343
+========================+==========================================================+=========================================================================================+
|id                      | int, autoincrement                                       | created by by MySQL                                                                     |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|name                    | string                                                   | unique and speaking name of the form. Form will be identified by this name              |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
344
|title                   | string                                                   | Title, shown on/above the form.                                                         |
Carsten  Rose's avatar
Carsten Rose committed
345
346
347
348
349
350
351
352
353
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|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                                                                            |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
354
|showButton              | set('new', 'delete')                                     | Default 'new,delete'. Displays button 'new' and 'delete'.                               |
Carsten  Rose's avatar
Carsten Rose committed
355
356
357
358
359
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|render                  | enum('plain','table', 'bootstrap')                       | Default bootstrap                                                                       |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|multiMode               | enum('none','horizontal','vertical')                     | Default 'none'                                                                          |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
360
|multiSql                | text                                                     | Optional. SQL Query which selects all records to edit.                                  |
Carsten  Rose's avatar
Carsten Rose committed
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|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                                                   | title: default number of 'bootstrap 12grid' columns                                     |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|bsInputColumns          | string                                                   | input: default number of 'bootstrap 12grid' columns                                     |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|bsNoteColumns           | string                                                   | note: default number of 'bootstrap 12grid' columns                                      |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
376
|parameter               | text                                                     | Misc additional parameters. See :ref:`form-parameter`                                   |
Carsten  Rose's avatar
Carsten Rose committed
377
378
379
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|deleted                 | string                                                   | 'yes'|'no'.                                                                             |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
380
|modified                | timestamp                                                | updated automatically through stored procedure                                          |
Carsten  Rose's avatar
Carsten Rose committed
381
382
383
384
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|created                 | datetime                                                 | set once through QFQ                                                                    |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+

385
386
387
388
389
390
391
392
393
394
Field: Form.showButton
^^^^^^^^^^^^^^^^^^^^^^

Display or hide the button 'new' and / or 'delete'.

* *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.
* *delete*: The simple form of deleting a record only deletes the record itself, not any child records.



395
.. _form-parameter:
Carsten  Rose's avatar
Carsten Rose committed
396

397
398
Field: Form.parameter
^^^^^^^^^^^^^^^^^^^^^
Carsten  Rose's avatar
Carsten Rose committed
399

400
* The following parameter are optional and can be configured in the *Form.parameter* field.
Carsten  Rose's avatar
Carsten Rose committed
401
402
403
404
405
406
407
408
409

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

410
411
* Example:

412
413
  * maxVisiblePill = 5
  * class = container-fluid
414
415
416
417
418
419
420
421
422

FormElements
------------
* Each *form* contains one or more *FormElement*.
* The *FormElements* are divided in three categories:
  
  * *native*
  * *container*
  * *action*
Carsten  Rose's avatar
Carsten Rose committed
423

424
* Ordering and grouping: Native Form-Elements and Container-Elements (both with feIdContainer=0) will be ordered by 'ord'.
Carsten  Rose's avatar
Carsten Rose committed
425
426
427
428
429
* Inside of a container, all nested elements will be displayed.

Class: Container
----------------

430
431
* Pills are containers for 'fieldset' and 'native' Form-Elements.
* Fieldsets are containers for 'native' Form-Elements
Carsten  Rose's avatar
Carsten Rose committed
432
433
434
435

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

436
* Native Formelements can be assigned to a fieldset.
Carsten  Rose's avatar
Carsten Rose committed
437
438
439
440
441
442
* name: technical name, used as HTML identifier.
* label: Shown title of the fieldset.

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

443
444
445
446
* Pill is synonymous for a tab. A pill looks like a tab.
* Pills are only available with mode render='bootstrap'.
* If there is at least one pill defined, every native Formelement needs to be assigned to a pill or to a fieldset.
* If there is at least one pill defined, every fieldset needs to be assigned to a pill.
Carsten  Rose's avatar
Carsten Rose committed
447
448
449
450
451

* Parameter:

  * FormElement.'''name''': technical name, used as HTML identifier.
  * FormElement.'''label''': Label shown on the corresponding pill button or inside the dropdown menu.
452
  * FormElement.'''type''': *pill*
Carsten  Rose's avatar
Carsten Rose committed
453
  * FormElement.'''feIdContainer''': 0  # Pill's can't be nested.
454
  * 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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473

Class: Native
-------------

+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
| Name         | Type                        | Description                                                                                       |
+==============+=============================+===================================================================================================+
| id           | int                         |                                                                                                   |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
| formId       | int                         |                                                                                                   |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|feIdContainer | int                         |                                                                                                   |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|enabled       | enum('yes'|'no')            |                                                                                                   |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|name          | string                      |                                                                                                   |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|label         | string                      | Label of formelement. Depending on layout model, left or on top of the formelement                |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
474
475
476
477
|mode          | enum('show', 'readonly',    | Default: show - *Show*: regular user input field. *Readonly* : user can't change any data.        |
|              | 'required',  'lock',        | *Important* : user manipulated data won't be saved. *Required* User has to specify a value.       |
|              | 'disabled' )                | Typically, an <empty string> represents 'no value'. *Lock* form element is read only and grayed   |
|              |                             | out, *Disabled*: form element is not visible                                                      |
Carsten  Rose's avatar
Carsten Rose committed
478
479
480
481
482
483
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|class         | enum('native', 'action',    | Details below.                                                                                    |
|              | 'container')                |                                                                                                   |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|type          | enum('checkbox', 'dateJQW', 'datetimeJQW', 'gridJQW', 'hidden', 'text', 'note', 'password', 'radio', 'select', 'subrecord',     |
|              | 'textarea', 'timeJQW', 'upload', 'fieldset', 'pill', 'before_load', 'before_save', 'before_insert', 'before_update',            |
484
|              | 'before_delete', 'after_load', 'after_save', 'after_insert', 'after_update', 'after_delete', 'feGroup', 'sendmail' ).           |
Carsten  Rose's avatar
Carsten Rose committed
485
486
487
488
489
490
491
492
493
494
495
496
497
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|checkType     | enum('min|max', 'pattern',  |                                                                                                   |
|              | 'number', 'email')          |                                                                                                   |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|checkPattern  | 'regexp'                    |if $check_type=='pattern': pattern to match                                                        |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|onChange      | string                      |list of 'form element names' of current form, separated by ', ', If one of the named form elements |
|              |                             | change, reload own data / status / mode                                                           |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|ord           | string                      |display order of form elements ('order' is a reserved keyword)                                     |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|tabindex      | string                      |HTML tabindex attribute                                                                            |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
498
499
|size          | string                      |Visible length of input element. Might be ommited, depending on the choosen form layout.           |
|              |                             |Format: <width>,<height> (in characters)                                                           |
Carsten  Rose's avatar
Carsten Rose committed
500
501
502
503
504
505
506
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|maxLength     | string                      |Maximum characters for input.                                                                      |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|note          | string                      |Note of formelement. Depending on layout model, right or below of the formelement                  |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|tooltip       | text                        |Display this text as tooltip on mouse over                                                         |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
507
|placeholder   | string                      |Text, displayed inside the input element in light grey                                             |
Carsten  Rose's avatar
Carsten Rose committed
508
509
510
511
512
513
514
515
516
517
518
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|clientJs      | text                        |Javascript called on 'on change' formelements                                                      |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|value         | text                        |Default value                                                                                      |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|sql1          | text                        |SQL query  ('sql' is a reserved keyword)                                                           |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|sql2          | text                        |second SQL query                                                                                   |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|parameter     | text                        |might contain misc parameter. Depends on the type of formelement.                                  |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
519
|feGroup       | string                      | Comma-separated list of Typo3 FE Group ID. NOT SURE IF THIS WILL BE IMPLEMENTED. Native           |
Carsten  Rose's avatar
Carsten Rose committed
520
521
522
523
524
525
|              |                             | 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 defintion      |
|              |                             | reference such FE-groups. Easy way of granting permission.                                        |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|deleted       | string                      |'yes'|'no'.                                                                                        |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
526
|modified      | timestamp                   |updated autmatically through stored procedure                                                      |
Carsten  Rose's avatar
Carsten Rose committed
527
528
529
530
531
532
533
534
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|created       | datetime                    |set once through QFQ                                                                               |
+--------------+-----------------------------+---------------------------------------------------------------------------------------------------+


+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
| Attribute        | checkbox | dateJQW | datetimeJQW |  gridJQW | hidden | input | note | password | radio | select | subrecord | textarea | timeJQW | upload |
+==================+==========+=========+=============+==========+========+=======+======+==========+=======+========+===========+==========+=========+========+
535
|id                |Internal id                                                                                                                                |
Carsten  Rose's avatar
Carsten Rose committed
536
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
537
|formId            |Form                                                                                                                                       |
Carsten  Rose's avatar
Carsten Rose committed
538
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
539
|containerId       |Assign the Formelement to user defined fieldSet or pill                                                                                    |
Carsten  Rose's avatar
Carsten Rose committed
540
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
541
|enabled           |Formelement is active or not                                                                                                               |
Carsten  Rose's avatar
Carsten Rose committed
542
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
543
|name              |Name of a column of the primary table. Formelements with a corresponding table will be saved automatically.                                |
Carsten  Rose's avatar
Carsten Rose committed
544
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
545
|label             |Label shown to the user.                                                                                                                   |
Carsten  Rose's avatar
Carsten Rose committed
546
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
547
|mode              |show, readonly, required, lock, disable.                                                                                                   |
Carsten  Rose's avatar
Carsten Rose committed
548
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
549
|class             |native                                                                                                                                     |
Carsten  Rose's avatar
Carsten Rose committed
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
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|type              | checkbox | dateJQW | datetimeJQW |  gridJQW | hidden | input | note | password | radio | select | subrecord | textarea | timeJQW | upload |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|checkType         |          |   -     |   -         |          |        |   -   |      |   -      |       |        |           |   -      |   -     |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|checkPattern      |          |   -     |   -         |          |        |   -   |      |   -      |       |        |           |   -      |   -     |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|onChange          |   -      |   -     |   -         |          |        |   -   |      |   -      |   -   |   -    |           |   -      |   -     |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|ord               |   -      |   -     |   -         |   -      |   -    |   -   |   -  |   -      |   -   |   -    |   -       |   -      |   -     |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|tabindex          |   -      |   -     |   -         |   -      |   -    |   -   |   -  |   -      |   -   |   -    |   -       |   -      |   -     |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|size              |   -  1   |         |             |          |        |   -   |      |   -      |   -  1|   -  2 |           |   -  1   |   -     |   -  ? |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|maxLength         |          |         |             |          |        |   -   |      |   -      |       |        |           |          |         |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|note              |   -      |   -     |   -         |          |        |   -   |   -  |   -      |   -   |   -    |   -       |   -      |   -     |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|tooltip           |   -      |   -     |   -         |          |        |   -   |      |   -      |   -   |   -    |           |   -      |   -     |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|placeholder       |          |   -     |   -         |          |        |   -   |      |          |       |        |           |   -      |   -     |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|clientJs          |          |   -     |   -         |   -      |        |   -   |      |   -      |   -   |   -    |           |   -      |   -     |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
|value             |   -      |   -     |   -         |   -      |   -    |   -   |   -  |   -      |   -   |   -    |           |   -      |   -     |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
577
|sql1              |?                                                                                                                                          |
Carsten  Rose's avatar
Carsten Rose committed
578
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
579
|sql2              |?                                                                                                                                          |
Carsten  Rose's avatar
Carsten Rose committed
580
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
581
|Additional attributes in Field 'parameter'. Typically in key=value format.                                                                                    |
Carsten  Rose's avatar
Carsten Rose committed
582
583
584
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
| type             | checkbox | dateJQW | datetimeJQW | gridJQW  | hidden | input | note | password | radio | select | subrecord | textarea | timeJQW | upload |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
585
| accept           |?                                                                                                                                          |
Carsten  Rose's avatar
Carsten Rose committed
586
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
587
| alt              |?                                                                                                                                          |
Carsten  Rose's avatar
Carsten Rose committed
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
| autocomplete     |          |   -     |   -         |          |        |   -   |      |          |       |        |           |   -      |   -     |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
| autofocus        |   -      |   -     |   -         |          |        |   -   |      |   -      |   -   |   -    |           |   -      |   -     |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
| checkBoxMode     |   -      |     -   |             |          |        |       |      |          |       |        |           |          |         |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
| checked          |   -      |         |             |          |        |   -   |      |          |   -   |        |           |          |         |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
| unchecked        |   -      |         |             |          |        |   -   |      |          |   -   |        |           |          |         |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
| label2           |   -      |         |             |          |        |       |      |          |   -   |        |           |          |         |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
| itemList         |   -      |         |             |          |        |       |      |          |   -   |   -    |           |          |         |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
| emptyItemAtStart |          |         |             |          |        |       |      |          |       |   -    |           |          |         |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
| emptyItemAtEnd   |          |         |             |          |        |       |      |          |       |   -    |           |          |         |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+
| accept           |          |         |             |          |        |       |      |          |       |        |           |          |         |   -  3 |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+----------+---------+--------+

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


Class: native
^^^^^^^^^^^^^

* All 'native' Formelements like 'input', 'checkbox', ...

Type: checkbox
^^^^^^^^^^^^^^

623
Checkboxes can be rendered in mode:
Carsten  Rose's avatar
Carsten Rose committed
624

625
* *single*:
Carsten  Rose's avatar
Carsten Rose committed
626

627
  * One column in a table corresponds to one checkbox.
628
  * The value for statuses *checked* and *unchecked* are free to choose.
629
630
  * 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
631

632
633
    * *checkBoxMode* = single (optional)
    * *checked* = <value> (optional, the value which represents 'checked')
Carsten  Rose's avatar
Carsten Rose committed
634

635
      * 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
636

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

639
      * 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
640

641
    * *label2* = <value>       (Text right beside checkbox) (optional)
Carsten  Rose's avatar
Carsten Rose committed
642
643


644
645
* *multi*:

646
  * One column in a table represents multiple checkboxes. This is typically useful for the column type *set*.
647
648
649
650
651
652
653
654
655
656
657
  * 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
    * *orientation*: vertical | horizontal (default), optional - the checkboxes are rendered horizontal or vertical.
    * *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
658
659
660
661
662
663
664
665
666
667
668
669

Type: date
^^^^^^^^^^

Type: datetime
^^^^^^^^^^^^^^^^^^^^

Type: hidden
^^^^^^^^^^^^^^^^^^^^

Type: input
^^^^^^^^^^^^^^^^^^^^
670

671
* General input for text and number.
Carsten  Rose's avatar
Carsten Rose committed
672
673
674
* size:

  * <number>:  width of input element in characters. Lineheight = 1.
675
  * <cols>,<rows>: input element = textarea, width=<cols>, height=<rows>
Carsten  Rose's avatar
Carsten Rose committed
676
677
678
679
680
681
682

Type: note
^^^^^^^^^^^^^^^^^^^^

Type: radio
^^^^^^^^^^^^^^^^^^^^

683
* Radio Buttons will be built from one of three sources:
Carsten  Rose's avatar
Carsten Rose committed
684

685
  * a) 'sql1': E.g. *{{!SELECT type AS label FROM car }}* or *{{!SELECT type AS label, typeNr AS id FROM car}}* or *{{!SHOW tables}}*.
Carsten  Rose's avatar
Carsten Rose committed
686
687
688

    * Resultset format 'named': column 'label' and optional a column 'id'.
    * Resultset format 'index':
689
690
691

      * One column in resultset >> first column represents *label*
      * Two or more columns in resultset >> first column represents *id* and second column represents *label*.
Carsten  Rose's avatar
Carsten Rose committed
692
693
694

  * b) FormElement.'''parameter''':

695
    * '''itemList''' attribute. E.g.: *itemList=red,blue,orange* or *itemList=1:red,2:blue:3:orange*
Carsten  Rose's avatar
Carsten Rose committed
696

697
  * c) Definition of the *enum* or *set* field (only labels, no ids are possible).
Carsten  Rose's avatar
Carsten Rose committed
698
699
700
701
702
703
704
705
706

* FormElement.'''parameter''':

  * '''emptyItemAtStart''': Existence of this item inserts an empty entry at the beginning of the selectlist.
  * '''emptyItemAtEnd''': Existence of this item inserts an empty entry at the end of the selectlist.

Type: select
^^^^^^^^^^^^^^^^^^^^

707
* Select lists will be built from one of three sources:
Carsten  Rose's avatar
Carsten Rose committed
708

709
  * a) 'sql1': E.g. *{{!SELECT type AS label FROM car }}* or *{{!SELECT type AS label, typeNr AS id FROM car}}* or *{{!SHOW tables}}*.
Carsten  Rose's avatar
Carsten Rose committed
710
711
712
713

    * Resultset format 'named': column 'label' and optional a column 'id'.
    * Resultset format 'index':

714
715
      * One column in resultset >> first column represents *label*
      * Two or more columns in resultset >> first column represents *id* and second column represents *label*.
Carsten  Rose's avatar
Carsten Rose committed
716
717
718

  * b) FormElement.'''parameter''':

719
    * '''itemList''' attribute. E.g.: *itemList=red,blue,orange* or *itemList=1:red,2:blue:3:orange*
Carsten  Rose's avatar
Carsten Rose committed
720

721
  * c) Definition of the *enum* or *set* field (only labels, no ids are possible).
Carsten  Rose's avatar
Carsten Rose committed
722
723
724
725

* FormElement.'''size''':

  * <empty>|0|1: Dropdown list.
726
  * >1: Select field with 'size' rows height. Multiple selection of items is possible.
Carsten  Rose's avatar
Carsten Rose committed
727
728
729
730
731
732
733
734
735

* FormElement.'''parameter''':

  * '''emptyItemAtStart''': Existence of this item inserts an empty entry at the beginning of the selectlist.
  * '''emptyItemAtEnd''': Existence of this item inserts an empty entry at the end of the selectlist.

Type: subrecord
^^^^^^^^^^^^^^^

736
737
738
739
740
741
742
743
'subrecord' will be rendered as HTML table.

* *parameter*

  * *detail*: e.g. *detail=id:gr_id,#{{a}}:p_id,#12:x_id*
  * *form*: Target form, e.g. *form=person*
  * *page*: Target page with detail form. If none specified, use the current page
  * *title*: Title displayed over the table.
Carsten  Rose's avatar
Carsten Rose committed
744

745
746
* *sql1*: SQL query to select records. E.g.::

747
   {{!SELECT a.id AS id, CONCAT(a.street, a.streetnumber) AS a, a.city AS b, a.zip AS c FROM adresse AS a}}
748

749
   # Notice the **exclamation mark** after '{{' - this is necessary to return an array of elements, instead of a single string.
750

751
  * Exactly one column 'id' has to exist; it specifies the primary record for the target form.
Carsten  Rose's avatar
Carsten Rose committed
752

753
* Columnname: *<title>[|<number>][|width=<number>][|nostrip][|icon][|url][|mailto]*
Carsten  Rose's avatar
Carsten Rose committed
754

755
756
757
758
759
760
761
  * *<number>*: any 'digit only' will be treated as '''width'''.
  * *width=<number>*: max. number of chars displayed per cell in the column.
  * *nostrip*: by default, html tags will be stripped off the cell content before rendering. This protects the table layout. 'nostrip' deactivates the cleaning to make links, images, ... possible.
  * *icon*: the cell value contains the name of an icon in *fileadmin/icons*. Empty cell values will omit an html image tag (=nothing renderd in the cell).
  * *mailto*: value will be rendered as a mailto link.
  * *url*: value will be rendered as a link.
  * *title=<text>* or '<none of the above>': column '''title'''.
Carsten  Rose's avatar
Carsten Rose committed
762
763
  * The parameters are position independet.
  * Examples::
764

765
766
       SELECT note1 AS 'Comment', note2 AS 'Comment\|50' , note3 AS 'title=Comment\|width=100\|nostrip', note4 AS '50\|Comment',
       'checked.png' AS 'Status\|icon', email AS 'mailto', CONCAT(homepage, '\|Homepage') AS 'url' ...
Carsten  Rose's avatar
Carsten Rose committed
767
768
769
770
771
772
773
774


Type: string
^^^^^^^^^^^^

Type: submit
^^^^^^^^^^^^

775
Typically not used. Useful if user wishes an explicit 'Submit' Button.
Carsten  Rose's avatar
Carsten Rose committed
776
777
778
779
780
781
782
783

Type: time
^^^^^^^^^^

Type: upload
^^^^^^^^^^^^

* See: https://www.w3.org/TR/html5/forms.html#file-upload-state-(type=file)
784
* parameter:accept: *image/*,video/*,audio/*,.doc,.docx,.pdf,<mime type>*
Carsten  Rose's avatar
Carsten Rose committed
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812

Class: Action
-------------

Type: before load
^^^^^^^^^^^^^^^^^

* Former: formallow
* Function: a) fire SQL, b) allow / deny access
* respects 'processRow'

Type: after load
^^^^^^^^^^^^^^^^

* Probably not implemented: no usecase.
* Function: fire SQL
* respects 'processRow'

Type: before save
^^^^^^^^^^^^^^^^^

* Former: lookup
* Function: a) fire SQL, b) allow / deny access
* respects 'processRow'

Type: after save
^^^^^^^^^^^^^^^^

813
* Maybe successor of *addnupdate*
Carsten  Rose's avatar
Carsten Rose committed
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
* Function: fire SQL
* respects 'processRow'

Type: before /after insert
^^^^^^^^^^^^^^^^^^^^^^^^^^

* Function: a) fire SQL, b) (before) allow / deny access
* respects 'processRow'

Type: before /after update
^^^^^^^^^^^^^^^^^^^^^^^^^^

* Function: a) fire SQL, b) (before) allow / deny access
* respects 'processRow'

Type: before / after delete
^^^^^^^^^^^^^^^^^^^^^^^^^^^

* Function: a) fire SQL, b) (before) allow / deny access
* respects 'processRow'

Type: addnupdate
^^^^^^^^^^^^^^^^

* Probably not implemented: no usecase. Probably replaced by after save | after insert. Depends on functionality of 'after ...'.

Type: sendmail
^^^^^^^^^^^^^^

* Send mail(s) on request.
* respects 'processRow'


Report
======


How to create a report
----------------------

854
To display a report on a given TYPO3 page, create a content element of type formreport (plugin) on that page.
Carsten  Rose's avatar
Carsten Rose committed
855
856

A simple example
857
^^^^^^^^^^^^^^^^
Carsten  Rose's avatar
Carsten Rose committed
858
859
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
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911

Assume that the database has a table person with columns first_name and last_name. To create a simple list of all persons, we can do the following:

10 Stands for a *root level* of the report (see section ?structure). 10.sql defines a SQL query for this specific level. When the query is executed it will return a result having one single column name containing first- and last name
separated by a space character.

The HTML output displayed on the page resulting from only this definition could look as follows:

::


    Marc MusterElton JohnSpeedy Gonzales

..



I.e. formreport will simply output the content of the SQL result row after row for each single level.

However, we can modify (wrap) the output by setting the values of various ?keys for each level: 10.rsep=<br/> for example tells formreport to seperate the rows of the result by a HTML-line break. The final result then is

::


    Marc Muster<br />Elton John<br />Speedy Conzales<br />

..



which gives us the desired simple list (we use linebreaks for simplicity here) when displayed by a browser:

::


    Marc Muster
    Elton John
    Speedy Conzales

..



Syntax
------

    All **root level queries** will be fired in the order specified by 'level' (Integer value).

    For **each** row of a query (this means *all* queries), all subqueries will be fired once.

    *   E.g. if the outer query selects 5 rows, and a nested query always select 3 rows, than the total number of rows are 5 x 3 = 15 rows.

    There is a set of **variables** that will get replace before the SQL-Query gets executed:

912
        Column values of the recent rows: {{<level>.<columnname>}}
Carsten  Rose's avatar
Carsten Rose committed
913

914
        Global variables: {{global.<name>}}
Carsten  Rose's avatar
Carsten Rose committed
915

916
        Sanitized URL (Post/Get) variables: {{url.<name>}}
Carsten  Rose's avatar
Carsten Rose committed
917

918
        Row index and total rows: {{<level>.line.count}} or {{<level>.line.total}}
Carsten  Rose's avatar
Carsten Rose committed
919

920
        'last_insert_id' and 'affected_rows': {{<level>.line.total}} (*total* have a different meaning, depending of the type of the SQL command)
Carsten  Rose's avatar
Carsten Rose committed
921
922
923
924
925
926
927
928
929
930
931

        See ?Variables for a full list of all available variables.

    Different types of SQL queries are possible: SELECT, INSERT, UPDATE, DELETE, SHOW

    Only SELECT and SHOW queries will fire subqueries.

*   Processing of the resulting rows and columns:

    *   In general, all columns of all rows will be printed out sequentially.

932
933
        On a per column base, printing of columns can be suppressed. This might be useful to select values which will be
        accessed later on in another query via the {{level.columnname}} variable. To suppress printing of a column, use a
Carsten  Rose's avatar
Carsten Rose committed
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
        underscore as column name prefix.

        Reserved column names have a special meaning and will be processed in a special way. See ?Processing of columns in the SQL result for details.

        There are extensive ways to ?wrap columns and rows automatically.

Structure
---------

A report can be divided into several levels. This can make report definitions more readable because it allows to split otherwise excessively long SQL queries. For example, if your SQL query on the root level selects a number of person
records from your person table, you can use the SQL query on the second level to look up the city where each person lives.

See the example below:

::


951
    10.sql = SELECT id AS person_id, CONCAT(first_name, " ", last_name, " ") AS name FROM person
Carsten  Rose's avatar
Carsten Rose committed
952
953
    10.sep = <br />

954
    10.10.sql = SELECT CONCAT(postal_code, " ", city) FROM address WHERE p_id = {{10.person_id}}
Carsten  Rose's avatar
Carsten Rose committed
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
    10.10.rbeg = (
    10.10.rend = )

..



This would result in

::


    Marc Muster (3004 Bern)
    Elton John (8008 Zürich)
    Speedy Conzales (3012 Bern)

..



975
Columns of the upper level result can be accessed via variables, eg. {{10.person_id}} will be replaced by the value in the person_id column.
Carsten  Rose's avatar
Carsten Rose committed
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000

+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|**Levels**   |A report is divided into levels. Example 1 has 3 levels **10**, **20.20**, **20.30.10**                                                                                                                                      |
+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|**Qualifier**|A level is divided into qualifiers **20.30.10** has 3 qualifiers **20**, **30**, **10**                                                                                                                                      |
+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|**Root       |Is a level with one qualifier. Example 1 has 2 root levels *10* and *20*.                                                                                                                                                    |
|levels**     |                                                                                                                                                                                                                             |
+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|**Sub        |Is a level with more than one qualifier. Example 1 has 2 sub levels **20.20** and **20.30.10**                                                                                                                               |
|levels**     |                                                                                                                                                                                                                             |
+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|**Child**    |The level **20** has one child **20.20**                                                                                                                                                                                     |
+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|**Parent**   |The level 20.20 has a parent **20**                                                                                                                                                                                          |
+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|**Example    |**10** and **20** is a root level and will be executed independently. **10** don't have a sub level. **20.20** will be executed as many times as **20** has row numbers. **20.30.10** won't be executed because there isn't  |
|explanation**|any **20.30** level                                                                                                                                                                                                          |
+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


Report Example 1:

::

For faster browsing, not all history is shown. View entire blame