Technical Documentation

ID Category Req. Element Action
5 array yes $zz_conf Main configuration variables. To be set in table scripts or central configuration file. Most variables will have a reasonable default.
237 string no $zz_conf['access'] deprecated, use $zz['access'] instead

Relations: $zz['access']; FORM; LIST

243 string: filename no $zz_conf['action_dir'] Directory where included scripts from $zz['extra_action'] reside

Relations: $zz['extra_action']; ACTION

236 mixed no $zz_conf['add'] Add or do not add data. Can be an array to allow adding of records whith specific values already set. Format: - `type`: Title, as in Add new ... - `field_name`: field_name for which value will already be set when adding a new record - `value`: value to field_name which will be set - `title`: title-attribute to explain add link further - `explanation`: (optional) will be written behind the link

Relations: FORM; LIST

346 boolean no $zz_conf['add_link'] add new record link will be shown (true) or not (false); normally this needs not to be set, because it's the same as $zz_conf['add']

Relations: LIST; OUTPUT

775 boolean no $zz_conf['always_show_empty_detail_record'] show always empty detail record if min_records is set to 0

Relations: subtable

284 array no $zz_conf['breadcrumbs']

Relations: OUTPUT; brick_forms()

783 boolean no $zz_conf['cancel_link'] shows/hides cancel link
874 boolean no $zz_conf['character_set_db_multiple'] if db uses multiple character sets (latin1, utf8 etc.), this variable should be set to true to get correct character set from database/script config for fields

Relations: $zz_conf['character_set']

45 string no $zz_conf['character_set'] Character encoding which is used to serve pages, convert text to filenames and more.

Relations: GLOBAL

795 boolean no $zz_conf['check_referential_integrity'] bool; if set to true, will check referential integrity with relations table (useful for tables who do not support referential integrity like MyISAM)

Relations: $zz_conf['relations_table']

776 boolean no $zz_conf['copy'] allows to copy a record (add new record with the data of the old record as a basis)
250 resource no $zz_conf['db_connection'] resource of MySQL connection (open connection will be used, therefore this value can be set to true as well)

Relations: GLOBAL

876 string: SQL yes $zz_conf['db_name_local'] local (development) database name for website

Relations: $zz_setting['local_access']; $zz_conf['db_name']

251 string yes $zz_conf['db_name'] database name

Relations: GLOBAL

287 boolean no $zz_conf['debug_time'] Logs the processing time that was used by certain functions into the zzform error handling

Relations: debug.inc.php; OUTPUT

91 boolean no $zz_conf['debug'] Turns debugging in zzform on or off; debugging mode, shows several debugging outputs directly in the html output

Relations: debug.inc.php; OUTPUT

903 string no $zz_conf['decimal_point'] Decimal point for numbers, depending on language
826 array no $zz_conf['default_language_for'] for not existing language files, use a different default than 'en'

Relations: $zz_conf['language']

213 boolean no $zz_conf['delete'] delete records possible or not

Relations: FORM; LIST

219 array no $zz_conf['details'] Creates a column "details" next to the column "action"; links to detail records with foreign key. A link will be constructed from each values but you can influence that with 'details_url' and 'details_base'

Relations: FORM; LIST

231 array no $zz_conf['details_base'] array, corresponding to details, does not make use of details as first part of details_url but this field instead

Relations: FORM; LIST

233 boolean no $zz_conf['details_referer'] add referer to details link

Relations: FORM; LIST

800 array no $zz_conf['details_sql']
232 string: HTML no $zz_conf['details_target'] target window for details link

Relations: FORM; LIST

220 array: path no $zz_conf['details_url'] what url to follow for detail records, may be array e. g. array('field1' => 'fieldname_bla', 'string1' => '/', 'field2' => 'fieldname_blubb') etc.

Relations: FORM; LIST

516 string: filename no $zz_conf['dir_custom'] Directory for customized scripts, i. e. db.inc.php, translation scripts

Relations: GLOBAL

517 string: filename no $zz_conf['dir_inc'] Directory for zzform include scripts

Relations: GLOBAL

115 string: filename no $zz_conf['dir'] Directory in which zzform resides in

Relations: $zz_setting['inc']; zzform_multi(); GLOBAL

285 boolean no $zz_conf['dont_show_title_as_breadcrumb'] Title of zzform document won't be shown as part of the breadcrumbs

Relations: $zz_conf['breadcrumbs']; brick_forms(); GLOBAL

851 boolean no $zz_conf['dont_show_total_records'] if set to true, »n total records« will not be shown below list
248 string no $zz_conf['error_handling'] what to do with errors, possible values: `output` | `mail` | `save_mail` | `mail_summary`

Relations: GLOBAL

528 string: filename no $zz_conf['error_log']['error'] path to error_log, default from php.ini

Relations: GLOBAL

529 string: filename no $zz_conf['error_log']['notice'] path to error_log for E_USER_NOTICE, default from php.ini

Relations: GLOBAL

530 string: filename no $zz_conf['error_log']['warning'] path to error_log for E_USER_WARNING, default from php.ini

Relations: GLOBAL

246 string no $zz_conf['error_mail_from'] mailaddress where errrors come from

Relations: GLOBAL

279 mixed no $zz_conf['error_mail_level'] When to mail an error to the admin.

Relations: GLOBAL

245 string no $zz_conf['error_mail_to'] E-Mail address where errors go to. Multiple addresses must be separated by a comma

Relations: GLOBAL

531 integer no $zz_conf['log_errors_max_len']

Relations: GLOBAL

532 boolean no $zz_conf['log_errors']

Relations: GLOBAL

760 boolean no $zz_conf['error_log_post'] Logs $_POST variables on error

Relations: $zz_conf['log_errors']

814 string no $zz_conf['error_mail_parameters'] parameters for sending error mails

Relations: $zz_conf['error_mail_from']

1005 string no $zz_conf['export_csv_delimiter'] delimiter between columns of CSV export
1004 string no $zz_conf['export_csv_enclosure'] character that encloses strings in CSV export
1003 boolean no $zz_conf['export_csv_no_head'] do not export titles as first line in CSV
1006 array no $zz_conf['export_csv_replace'] list of characters that should be replaced when exporting to CSV
252 mixed no $zz_conf['export'] if sql result might be exported (link for export will appear at the end of the page)

Relations: export.inc.php; OUTPUT

897 array no $zz_conf['footer_record']
900 string: HTML no $zz_conf['footer_record']['delete'] HTML text for output after a successful delete directly below the record
898 string: HTML no $zz_conf['footer_record']['insert'] HTML text for output after a successful insert directly below the record
899 string: HTML no $zz_conf['footer_record']['update'] HTML text for output after a successful update directly below the record
239 string: HTML no $zz_conf['footer_text'] Textblock at the end of div id zzform

Relations: $zz['explanation']; OUTPUT

116 string: filename no $zz_conf['form_scripts'] where form scripts reside

Relations: zzbrick_tables/; $zz_setting['inc']; GLOBAL

269 string no $zz_conf['format']['markdown']['link'] Link to markdown help page; similarly use ['format'][$format]['link'] for other formats

Relations: FORM

725 boolean no $zz_conf['generate_output'] allows to not call some functions which are only needed to generate HTML output in case this is not needed
808 array no $zz_conf['geo'] settings of the geo-module
809 integer no $zz_conf['geo']['rounding'] rounding of geographical coordinates
812 string: HTML no $zz_conf['geo']['spacer'] Symbol that separates degrees, minutes, seconds and hemisphere in degree display
925 function no $zz_conf['geocoding_function'] Function to use for geocoding an address; gets array $address as input, utf8 encoded data, * string 'country' * string 'locality' * string 'postal_code' (optional) * string 'street_name' (optional) * string 'street_number' (optional) should return Array * double 'longitude' * double 'latitude' * string 'postal_code' if not set, function from zzwrap library will be used

Relations: geo.inc.php

778 string: HTML no $zz_conf['group_html_table']

Relations: $zz['fields'][n]['group_in_list']

600 string: function no $zz_conf['hash_password'] Name of PHP function to encrypt fields of type 'password' or 'password_change'; possible values are `md5`, `sha1`, `phpass`

Relations: password; password_change

838 integer no $zz_conf['hash_cost_log2'] if `phpass` is used as hash function, this is the number of iterations how often a hash function will be used
839 boolean no $zz_conf['hash_portable'] if `phpass` is used as password hash function, this value indicates whether the hash should be portable to older versions
837 string: filename no $zz_conf['hash_script'] filename of script with hash function if it's not a standard php function

Relations: $zz_conf['hash_password']

881 string: HTML no $zz_conf['heading_prefix'] Sets a prefix for each table, e. g. a hierarchical path (breadcrumb) for the heading (string will be prepended with a space)

Relations: $zz['title']

862 boolean no $zz_conf['html_autofocus'] set HTML attribute autofocus to first input field/first input field in added subrecord
214 array no $zz_conf['if']

Relations: FORM; LIST

921 array no $zz_conf['import_file_order_by_extension'] List of filetypes in order of importance, if more than one filetype is imported at the same time.

Relations: zzform_multi()

117 string: field yes $zz_conf['language'] Language code ISO 639-1 Language of zzform. English is the default language. For each language, you have to provide a file `$zz_conf['dir_inc']/text-[iso language code].inc.php`

Relations: GLOBAL

843 integer no $zz_conf['limit_all_max'] Maximum count of records which should be displayed on one page (if there are more records, 'all'-Link will be hidden)

Relations: $zz_conf['limit']

226 integer no $zz_conf['limit'] display only limited amount of records per page, add links to browse through all records on several pages; false: show all records no matter how many

Relations: LIST

728 string no $zz_conf['limit_display'] display links to pages with page numbers or entries (begin-end of no. of records)
227 integer no $zz_conf['limit_show_range'] range in which links to records around current selection will be shown

Relations: LIST

221 string no $zz_conf['list_display'] format of list display, defaults to `table`, other possibilities include `ul`

Relations: LIST

256 boolean no $zz_conf['logging'] logging of INSERT UPDATE DELETE enabled?

Relations: ACTION

257 boolean no $zz_conf['logging_id'] logging of record_id enabled?

Relations: ACTION

258 string: field no $zz_conf['logging_table'] table where logging will be written into

Relations: ACTION

791 string no $zz_conf['mail_subject_prefix'] Prefix, will be prepended to all mail subjects
534 integer no $zz_conf['max_detail_records'] max 20 detail records, might be expanded later on

Relations: FORM

259 integer no $zz_conf['max_select_val_len'] maximum length of values in select

Relations: FORM; LIST

260 integer no $zz_conf['max_select'] configures the maximum entries in a select-dialog, if there are more entries, an empty input field will be provided

Relations: FORM

949 boolean no $zz_conf['merge'] If true, allows to merge existing records
535 integer no $zz_conf['min_detail_records'] min 0 detail records, might be expanded later on

Relations: FORM

951 boolean no $zz_conf['multi_delete'] If true, allows to delete multiple records at once
950 boolean no $zz_conf['multi_edit'] If true, allows to edit multiple records at once
536 boolean no $zz_conf['multi'] signals zzform that script will be rerun several times, so certain initialization steps need only to be completed once

Relations: GLOBAL

740 string no $zz_conf['nice_tablename'][TAB]
852 boolean no $zz_conf['no_add_above']

Relations: $zz_conf['add']

907 boolean no $zz_conf['no_ok'] Show/hide OK button below form
816 string no $zz_conf['password_salt'] salt for password generation

Relations: $zz_conf['hash_password']

797 string: filename no $zz_conf['pdflib_path'] string; path to pdf library

Relations: $zz_conf['export']

12 string: SQL no $zz_conf['prefix'] Prefix for all table names in a database [default ''], table_prefix like zz_ (will be removed in error output)

Relations: GLOBAL

247 string: HTML no $zz_conf['project'] project name, used sparely

Relations: GLOBAL

771 boolean no $zz_conf['redirect_on_change'] Redirect after successful database operation or not (to avoid POST again after update)
861 boolean no $zz_conf['redirect_to_referer_zero_records'] redirects to referer webpage instead of same webpage in case form would return 0 records
261 array no $zz_conf['redirect']

Relations: GLOBAL

264 string no $zz_conf['redirect']['successful_delete'] redirect to this URL (local, starting with / or full qualified URI) when this event occurs

Relations: GLOBAL

263 string no $zz_conf['redirect']['successful_insert'] redirect to this URL (local, starting with / or full qualified URI) when this event occurs

Relations: GLOBAL

262 string no $zz_conf['redirect']['successful_update'] redirect to this URL (local, starting with / or full qualified URI) when this event occurs

Relations: GLOBAL

234 string no $zz_conf['referer'] referer which links back to previous page

Relations: GLOBAL

51 string: field yes $zz_conf['relations_table'] Table for relations for relational integrity

Relations: GLOBAL

104 string: filename no $zz_conf['root'] root directory of website

Relations: GLOBAL

223 mixed no $zz_conf['search'] Search records possible or not: \ as first string in search query will be removed (escapes reserved symbols) > greater than ... (should be used with scope set) < lesser than ... (should be used with scope set) [nothing] LIKE %...% (true or bottom: below list, top = above list, both = below and above list)

Relations: OUTPUT

845 boolean no $zz_conf['search_form_always'] normally, search form will not be shown if there are less records than will be shown on a page. if set to true, search form will be shown even if there are less records than set to limit
121 boolean no $zz_conf['show_list_while_edit']

Relations: LIST

228 boolean no $zz_conf['show_list'] display list of records in database

Relations: LIST

229 boolean no $zz_conf['show_output'] ECHO output or keep it in $zz['output'] for later use (e. g. zzform_all will use this)

Relations: zzform_all(); OUTPUT

717 string no $zz_conf['sync_concat_unique'] concat string for unique fields, might be changed if neccessary if ambiguous to unique IDs with strings
818 array no $zz_conf['text'] extra (translated) text
819 array no $zz_conf['text'][lang] text in this language (lang, two-letter ISO code); if -- is used as language code, all text will be replaced by this text or its translation
904 string no $zz_conf['thousands_separator'] Thousands separator for numbers, depending on language
512 boolean no $zz_conf['translations_of_fields'] shall zzform and zzwrap save and read translate database field content in central database tables?

Relations: translations.inc.php

514 string: filename no $zz_conf['translations_script']

Relations: $zz_conf['translations_of_fields']; translations.inc.php

513 string no $zz_conf['translations_table']

Relations: $zz_conf['translations_of_fields']; translations.inc.php

965 boolean no $zz_conf['upload_imagick_options_no_defaults'][extension] ignore imagemagick defaults for options from filetypes.cfg for this extension

Relations: $zz_conf UPLOAD

230 array no $zz_conf['url_self'] own url or target url

Relations: GLOBAL

244 string no $zz_conf['user'] user name, used for logging and errors

Relations: ACTION

825 boolean no $zz_conf['valid_request'] if access = add_only or edit_only and record was saved successfully, valid_request shows whether combination of zzaction and hash is correct
224 boolean no $zz_conf['view'] view records, this will only be enabled if edit records is turned off

Relations: FORM; LIST

Export (CSV Excel)

119 records total