You are here: The Zugzwang Project > Technical Documentation

Technical Documentation

Selection Teilbaum:: $ops; $page; $zz; $zz_conf; $zz_conf INTERNAL; $zz_conf UPLOAD; $zz_error; $zz_page; $zz_setting; $zz_sql; $zz_tab; $zz_var; WEBSERVER_DIRECTORY; zz_constants; zz_fieldtypes; zz_states; zzbrick; zzform; zzwrap; – all –

ID	Category	Req.	Element	Action
11	string: field	yes	$zz['fields'][n]['field_name'] Database field name; required, if field value shall be shown or changed in the output. Not all fields of a table have to be defined, the undefined fields will be ignored by the script. Relations: $zz['fields'][n]	Show
172	string: field	no	$zz['fields'][n]['fields'][n]['detail_key'] inserts in field id_field from different detail_record	Show
429	string: field	no	$zz['fields'][n]['foreign_key_field_name'] Normally, zzform uses maintable.id_field as WHERE maintable.id_field = id_value for subtables. This variable allows to set a different key_field_name, e. g. if you use table aliases Relations: subtable	Show
546	string: field	no	$zz['fields'][n]['group'] allows to group records select via HTML optgroup-element Relations: select	Show
614	string: field	no	$zz['fields'][n]['id_field_name'] In some cases, for whatever reason the first field in an SQL query is not the id_field_name of a query. This variable can be set to solve this problem. Should be used as well if id_field_name is ambiguous and table name has to be prepended Relations: $zz['fields'][n]['sql']; select	Show
418	string: field	no	$zz['fields'][n]['key_field_name'] if where is used and where-key-name is different from key name in sql-query; field name differs from foreign_key, e. g. mother_org_id instead of org_id For list view of a subtable, key_field_name has to be used if the fieldname of the foreign_key differs from the fieldname of the ID field of the main record. Table `persons` normally as something like `person_id` as PRIMARY_KEY, table `address` has `person_id` as a foreign key. if for some reason the field in table `address` is called e. g. `primary_address_id`, you have to set this parameter to `address_id` Relations: select; foreign_key	Show
417	string: field	no	$zz['fields'][n]['show_hierarchy'] shows hierarchy in selects, value must be set to corresponding SQL field name Relations: select	Show
188	string: field	no	$zz['fields'][n]['table_name'] Alias if more subtables are included (used for search only, AFAIK) Relations: subtable	Show
854	string: field	no	$zz['fields'][n]['text_field'] similar to display_field, this key must be set to a field name from the SQL query which contains the textual representation of the corresponding spatial field Relations: geo_point	Show
779	string: filename	no	$zz['fields'][n]['set_folder'] path of folder, files in this folder will be presented for selection (no subfolders), names of chosen files will be saved in database. Relations: select	Show
35	string: function	no	$zz['fields'][n]['format'] Formats in form view text content of field with this markup language (e. g. Markdown), function of the same name must lie inside zzform-folder Relations: text; memo	Show
399	string: function	no	$zz['fields'][n]['function'] function which will be called to change input value `function($vars, $field_name);` $vars = POST vars of fields defined in an array in $zz['fields'][n]['fields'] $field_name = $zz['fields'][n]['field_name'] Relations: hidden	Show
425	string: function	no	$zz['fields'][n]['list_format'] function which will be used to format text for display, e. g. markdown \| textile, in list part; might be array if you want to use several functions Relations: $zz['fields'][n]['format']; text; memo	Show
906	string: function	no	$zz['fields'][n]['list_function'] Name of function that will be called from field type 'list_function' for display in list Relations: list_function	Show
709	string: function	no	$zz['fields'][n]['post_validation'] Function that will be called with field value and field name as parameters directly after validation of a field; returned values will be saved in 'extra' to let other records access values later Relations: $zz['fields'][n]['detail_value']	Show
909	string: function	no	$zz['fields'][n]['subselect']['list_field_format'] Formats each single field (e. g. binary represenations of IP addresses to strings) with list_field_format function (opposed to list_format which formats the full string). Might be array as well, then key is field_name Relations: $zz['fields'][n]['subselect']['list_format']	Show
171	string: function	no	$zz['fields'][n]['subselect']['list_format'] Relations: $zz['fields'][n]['list_format']	Show
813	string: function	no	$zz['fields'][n]['upload_func'] string; name of a function to format upload values (the only way to handle arrays) Relations: $zz['fields'][n]['upload_field']	Show
975	string: function	no	$zz['fields'][n][format_0'] function to format fields from sql query Relations: $zz['fields'][n]['sql']; select	Show
199	string: HTML	no	$zz['fields'][n]['class_add'] class name that will be shown if a subrecord will be added Relations: subtable	Show

348 records total