Usage

How it works

The FormIt hooks¹ uses the following properties:

Hook Properties for FormIt2db

Property	Description	Default
allowFields	JSON-encoded array of form fields that are allowed to be saved in the xPDO object i.e. ["field_1", "field_2"]. Defaults to all fields allowed.	`[]`
arrayFields	JSON-encoded array of form fields that contains array data i.e. `["field_1", "field_2"]`	`[]`
arrayFormat	Format to transform form fields that contains array data (i.e. checkboxes) into.	csv
autoPackage	Use the autocreated xPDO Package²³.	0 (No)
classname	Class name of the xPDO object.	-
fieldname	xPDO fieldname the POST param is compared with – to update a row instead of creating a new one.	'paramname'
packagename	Package name of the xPDO package.	-
paramname	Requested POST param – to update a row instead of creating a new one.	-
prefix	Table prefix of the xPDO package.	MODX DB prefix
removeFields	JSON-encoded array of form fields not saved in the xPDO object i.e. `["field_1", "field_2"]`. Defaults to no fields removed.	`[]`
tablename	Table name of the MySQL table (only used if autoPackage is enabled).	-
where	JSON-encoded xPDO where clause – to update a row instead of creating a new one.	-

Hook Properties for db2FormIt

Property	Description	Default
arrayFields	JSON-encoded array of database fields that are transformed into arrays i.e. `["field_1", "field_2"]`.	`[]`
arrayFormat	Format to transform database fields that contains array data (i.e. checkboxes) into.	csv
autoPackage	Autocreate the xPDO Package with packagename and tablename².	0 (No)
classname	Class name of the xPDO object.	-
fieldname	xPDO fieldname the REQUEST param is compared with – to retreive an existing row.	'paramname'
ignoreFields	JSON-encoded array of database fields that are not retreived into FormIt i.e. `["field_1", "field_2"]`.	`[]`
notFoundRedirect	ID of the MODX resource the user is redirected to, if the requested row is not found.	-
packagename	Package name of the xPDO package.	-
paramname	Requested REQUEST param – to retreive an existing row.	-
prefix	Table prefix of the xPDO package.	MODX DB prefix
tablename	Table name of the MySQL table (only used if autoPackage is enabled).	-
where	JSON-encoded xPDO where clause – to retreive an existing row.	-

Security

FormIt2db/db2FormIt allows you to modify every database record in the MODX database, when you add the right packagename and classname properties. It is important to restrict the allowed database fields or add the removed database fields, so no unwanted entry field can't be changed. Also, it is important to show not unwanted database fields in the FormIt form. So please remove these fields with the ignoreFields property from the FormIt form.

Examples

FormIt call

The following FormIt call loads the record of the xPDO class MyPackageClass where the value in the id field is equal to the REQUEST parameter item and where the field value updated is equal to 0. The fields field_1, field_2, field_5 and field_6 are allowed to be saved into the database record. The fields field_1 and field_2 are not loaded into FormIt values. The fields field_3 and field_4 are not saved into the database record.

[[!FormIt?
&preHooks=`...,db2FormIt,...` 
&hooks=`...,FormIt2db,...`
&packagename=`mypackage` 
&classname=`MyPackageClass` 
&fieldname=`id`
&paramname=`item` 
&where=`{"updated:=":0}`
&allowFields=`["field_1", "field_2", "field_5", "field_6"]`
&removeFields=`["field_3", "field_4"]`
&ignoreFields=`["field_1", "field_2"]`
]]

Form code

<form action="[[~[[*id]]]]" method="post">
    <input type="hidden" name="item" value="[[!+fi.id]]"/>
    ...
</form>

The snippets base on the code in the following thread in the MODX forum. ↩
If the xPDO package is autocreated, the classname in the package is generated by MODX and could be different to a classname set by parameter. If you disable the autoPackage parameter later, please look which classname was generated and change the parameter to that value. ↩↩
Autocreating works only in MODX 2.x. It has to be rewritten for MODX 3.x. I don't have time for that. Maybe someone else would like to take it on. ↩