DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

General attributes¶

Property	Data type	Default	Plus	Mvc
addEdit	Boolean	0	Yes	No
addEditIfAdmin	Boolean	0	Yes	No
addEditIfNull	Boolean	0	Yes	No
addLeftIfNotNull	String		Yes	No
addLeftIfNull	String		Yes	No
addNewIcon	Boolean	0	Yes	No
addRighIfNotNull	String		Yes	No
addRighIfNull	String		Yes	No
alias	Field name		Yes	No
classLabel	String		Yes	Yes
classValue	String		Yes	Yes
cutIf / showIf	String		Yes	Yes
cutIfNull	Boolean	0	Yes	Yes
cutLabel	Boolean	0	Yes	Yes
edit	Boolean	1	Yes	Yes
editAdminPlus	Boolean	0	Yes	No
func	String		Yes	No
funcAddLeftIfNotNull	String		Yes	No
funcAddLeftIfNull	String		Yes	No
funcAddRightIfNotNull	String		Yes	No
funcAddRightIfNull	String		Yes	No
fusion	{begin, end}		Yes	Yes
label	String		Yes	Yes
mail	Boolean	0	Yes	No
mailAlways	Boolean	0	Yes	No
mailAuto	Boolean	0	Yes	No
onLabel	Boolean	0	Yes	No
orderLinkInTitle	Boolean	0	Yes	Yes
orderLinkInTitleSetup	String	:link:	Yes	Yes
query	SQL statements		Yes	No
queryOnValue	String		Yes	No
queryForEach	Field name		Yes	No
renderReqValue	Boolean	0	Yes	No
reqValue	SQL SELECT statement		Yes	No
showIf	String		Yes	Yes
setExtendLink	Table name		Yes	No
stdWrapItem	stdWrap		Yes	No
stdWrapValue	stdWrap		Yes	No
styleLabel	String		Yes	Yes
styleValue	String		Yes	Yes
tsObject	cObject		Yes	No
tsProperties	String		Yes	No
value	String		Yes	Yes
verifier	String		Yes	No
verifierMessage	String		Yes	No
verifierParam	String		Yes	No
verifierSetWarning	Boolean	0	Yes	No
wrapItem	Wrap		Yes	Yes

addEdit¶

Property

addEdit

Data type

Boolean

Description

When the field is used in an "Update form" view, it will add an input element for update that can be used with the marker ###field_name_Edit### where "field_name" is the name of the field.

See also the help for Form views (showAllItemTemplate) to see how to use markers ###field[field_name, label]###.

Default

0

addEditIfAdmin¶

Property

addEditIfAdmin

Data type

Boolean

Description

Same as addEdit but the element will be added only if the user has the input right for the plugin.

Default

0

addEditIfNull¶

Property

addEditIfNull

Data type

Boolean

Description

Same as addEdit but the element will be added only if the field is null.

Default

0

addLeftIfNotNull¶

Property

addLeftIfNotNull

Data type

String

Description

String will be added to the left if the field value is not null.

Default

0

addLeftIfNull¶

Property

addLeftIfNull

Data type

String

Description

String will be added to the left if the field value is null.

addNewIcon¶

Property

addNewIcon

Data type

Boolean

Description

A new icon, will be displayed in front of the field during the number of days given by the int number.

addRighIfNotNull¶

Property

addRighIfNotNull

Data type

String

Description

String will be added to the right if the field value is not null.

addRighIfNull¶

Property

addRighIfNull

Data type

String

Description

String will be added to the right if the field value is null.

alias¶

Property

alias

Data type

Field name

Description

The displayed value will be provided by the fieldname value for the current record.

classLabel¶

Property

classLabel

Data type

String

Description

The default class "label" associated with the label of the displayed value will be replaced by the string.

classValue¶

Property

classValue

Data type

String

Description

The default class "value" associated with the displayed value will be replaced by the string.

cutIf / showIf¶

Property

cutIf / showIf

Data type

String

Description

The string can be:

fieldName=valueCuts / shows the field if current value of the field is equal to the given value. The markers ###user### or ###cruser### (same as user but should be used if a new record is created) will be replaced by the user id. Use EMPTY for the value to test an empty field.
fieldName!=valueCuts / shows the field if current value of the field is not equal to the given value. Same markers as above can be used.
###usergroup=group_name###The field is cut / shown if the group “group_name” is a valid group for the current user.
###usergroup!=group_name###The field is cut / shown if the group “group_name” is not a valid group for the current user.
###group=group_name###The field is cut / shown if the group “group_name” is a valid group for the current record. It checks the usergroup field in the local table if any.
###group!=group_name###The field is cut / shown if the group “group_name” is not a valid group for the current record. It checks the usergroup field in the local table if any.

Logical connectors & and | can be used between expression. However no parentheses are allowed.

cutIfNull¶

Property

cutIfNull

Data type

Boolean

Description

Cut the field if it is empty.

Default

0

cutLabel¶

Property

cutLabel

Data type

Boolean

Description

Cuts the label associated with the field.

Default

0

edit¶

Property

edit

Data type

Boolean

Description

Makes the field not editable in an input form.

Default

1 in Edit views

editAdminPlus¶

Property

editAdminPlus

Data type

Boolean

Description

Makes the field editable in an input form, if the user has the "Admin+" right. To be an "Admin" user, his/her TSConfig must contain a line as follows:

extKey_Admin=value where “extKey” is the extension key and value is one of the possible value of the "Input Admin Field" defined in the flexform associated with the extension.
The user becomes an "Admin+" user, if his/her TSConfig contains a line as follows:

extKey_Admin=value+

Default: 0

func¶

Property

func

Data type

String

Description

See Functions.

funcAddLeftIfNotNull¶

Property

funcAddLeftIfNotNull

Data type

String

Description

String will be added to the left if the result of the applied function, defined by "func=function_name;" property, is not null.

funcAddLeftIfNull¶

Property

funcAddLeftIfNull

Data type

String

Description

String will be added to the left if the result of the applied function, defined by "func=function_name;" property, is null.

funcAddRightIfNotNull¶

Property

funcAddRightIfNotNull

Data type

String

Description

String will be added to the right if the result of the applied function, defined by "func=function_name;" property, is not null.

funcAddRightIfNull¶

Property

funcAddRightIfNull

Data type

String

Description

String will be added to the right if the result of the applied function, defined by "func=function_name;" property, is null.

fusion¶

Property

fusion

Data type

{begin, end}

Description

fusion = begin;

Starts the fusion of the fields, that is the following fields will be displayed on the same line.

fusion = end;

Ends the fusion of the fields, that is the following field will be displayed on the next line.

label¶

Property

label

Data type

String

Description

The displayed label will be provided by the string.

mail¶

Property

mail

Data type

Boolean

Description

A mail will be associated with the field.

If the field is a checkbox, it is used as a flag to verify is the mail has to be sent. Mail information are the following and can be used as properties:

fieldForCheckMail=field_name; The mail will be sent if the value of the fieldname for the current row is not null.
mailIfFieldSetTo=string; The mail will be sent if the value of the fieldname for the current row was previously null or zero and is set to the given string value. If the string is a comma- separated list of values, the mail is sent is the value of the fieldname for the current row belongs to this list (only in SAV Library Plus).
mailSender=string; mail of the sender. Marker ###user_email### will be replaced by the user email.
mailReceiver=string; mail of the person who will receive the mail and process the information.
mailReceiverFromField=field_name; The field_name contains the mail of the person who will receive the mail and process the information.
mailReceiverFromQuery=MySQL_Query; The receiver is obtained from a select query with an alias "value" that will used to retrieve the receiver. Example:
```
SELECT email AS value FROM fe_users WHERE ...
```
mailSubject=string; subject of the mail. Markers ###fieldname### are allowed and will be replaced by their current value.
mailMessage=string, mail message. Markers ###fieldname### are allowed and will be replaced by their current value.
mailcc=string; if set the string is used as Cc: for the mail.
mailccFromField=field_name; The field_name contains the mail of the person who will receive the mail in carbon copy.
mailReceiverFromQuery=MySQL_Query; The receiver is obtained from a select query with an alias "value" that will used to retrieve the carbon copy information.
mailMessageLanguage=string; This parameter will force the language for the message to the value of the string.
mailMessageLanguageFromField=fieldname; This parameter will force the language for the message to the value of the field (for example a selector box).

Localization by means of the file locallang.xml can be used with $$$tag$$$ which will be replaced by its value according to the configuration language.

Default

0

mailAlways¶

Property

mailAlways

Data type

Boolean

Description

The mail property must be set (mail = 1;) when using this property.

The mail is always sent when saving. Mail information are the following:

mailSender=string; mail of the sender. Marker ###user_email### will be replaced by the user email.
mailReceiver=string; mail of the person who will receive the mail and process the information.
mailReceiverFromField=field_name; The field_name contains the mail of the person who will receive the mail and process the information.
mailReceiverFromQuery=MySQL_Query; The receiver is obtained from a select query with an alias "value" that will used to retreive the receiver. Example:
```
SELECT email AS value FROM fe_users WHERE ...
```
mailSubject=string; subject of the mail. Markers ###fieldname### are allowed and will be replaced by their current value.
mailMessage=string, mail message. Markers ###fieldname### are allowed and will be replaced by their current value.
mailcc=string; if set the string is used as Cc: for the mail.
mailccFromField=field_name; The field_name contains the mail of the person who will receive the mail in carbon copy.
mailReceiverFromQuery=MySQL_Query; The receiver is obtained from a select query with an alias "value" that will used to retrieve the carbon copy information.

Localization by means of the file locallang.xml can be used with $$$tag$$$ which will be replaced by its value according to the configuration language.

mailMessageLanguage=string; This parameter will force the language for the message to the value of the string.
mailMessageLanguageFromField=fieldname; This parameter will force the language for the message to the value of the field (for example a selector box).

Default

0

mailAuto¶

Property

mailAuto

Data type

Boolean

Description

The mail property must be set (mail = 1;) when using this property.

The mail is sent when saving, if the field is not empty and if one field in the form is changed. Mail information are the following:

mailSender=string; mail of the sender. The marker ###user_email### will be replaced by the user email.
mailReceiver=string; mail of the person who will receive the mail and process the information.
mailReceiverFromField=field_name; The field_name contains the mail of the person who will receive the mail and process the information.
mailReceiverFromQuery=MySQL_Query; The receiver is obtained from a select query with an alias "value" that will used to retreive the receiver. Example:

SELECT email AS value FROM fe_users WHERE ...

mailSubject=string; subject of the mail. Markers ###fieldname### are allowed and will be replaced by their current value.
mailMessage=string, mail message. Markers ###fieldname### are allowed and will be replaced by their current value.
mailcc=string; if set the string is used as Cc: for the mail.
mailccFromField=field_name; The field_name contains the mail of the person who will receive the mail in carbon copy.
mailReceiverFromQuery=MySQL_Query; The receiver is obtained from a select query with an alias "value" that will used to retrieve the carbon copy information.

Localization by means of the file locallang.xml can be used with $$$tag$$$ which will be replaced by its value according to the onfiguration language.

mailMessageLanguage=string; This parameter will force the language for the message to the value of the string.
mailMessageLanguageFromField=fieldname; This parameter will force the language for the message to the value of the field (for example a selector box).

Default

0

onLabel¶

Property

onLabel

Data type

Boolean

Description

The value will be displayed in place of the label. Not so useful since the label can be cut.

Default

0

orderLinkInTitle¶

Property

orderLinkInTitle

Data type

Boolean

Description

If this property is set, it makes it possible to generate a hyperlink in the title bar of the "list view". The hyperlink is associated with the field if the marker ###fieldname### is used in the "Title bar" section. Order clauses have to be defined in the "Where Tags" section of the "Query Form".

Use the two followings “Where Tags”:

Name: fieldname+
WHERE Clause:
ORDER BY Clause: tablename.fieldname
Name: fieldname-
WHERE Clause:
ORDER BY Clause: tablename.fieldname DESC

Note: orderLink can be also directly added in the title bar without any reference to a field. The syntax is:

###link(Default)[whereTagName1(,whereTageName2)]###

If the optional part “Default” is used, by default the whereTagName1 is assumed when the extension is launched.

The optional whereTagName2 can be used to set a toggle link with two different behaviours.

Default

0

orderLinkInTitleSetup¶

Property

orderLinkInTitleSetup

Data type

String

Description

This property controls the display of the link when “orderLinkInTitle” is set. The format is “param1:param2:param3” where “param1” to “param3” can take the following values:

value: the field value is displayed,
link: the field value is displayed with a link which toggles the sort,
asc: an icon is displayed with a link to make an ascending sort,
desc: an icon is displayed with a link to make a descending sort,
ascdesc: two icons are displayed with separate links to make an ascending or descending sort.
if there is no value, nothing is displayed.

Default

:link:

query¶

Property

query

Data type

SQL statements

Description

The query will be executed once the input form data have been saved. Therefore, it can only be used with "input" or "update" views.

Important

Because any query may be executed, for security reason, this property can only be used if an admin user has checked the field “Allow the use of the “query” property” in the advanced folder of the flexform.

It may be useful, for example, to update a specific table when the current data are saved. Several queries can be used in the SQL statements. Each query must be separated using ";".

Special markers can be used in the statement:

###uid### will be replaced by the current record uid.
###CURRENT_PID### will be replaced by the current page uid.
###STORAGE_PID### will be replaced by the storage page uid.
###user### will be replaced by the user id.
###value### will be replaced by the current value for the field.

queryOnValue¶

Property

queryOnValue

Data type

String

Description

The query, as defined above, will be executed if the current field value is equal to the right hand side string.

queryForEach¶

Property

queryForEach

Data type

Field name

Description

If the field is a true MM relation, the query, as defined above, will be executed for all the record in the relation.

The special marker ###field_name###, where "field_name" is the field where the relation is defined, can be used to identify the record. It will be replaced by the uid of the associated record.

renderReqValue¶

Property

renderReqValue

Data type

Boolean

Description

Rendering is applied to the value provided by the "reqValue" attribute according to the type of the field.

Default

0

reqValue¶

Property

reqValue

Data type

SQL SELECT statement

Description

SQL SELECT statement must have an alias "value" which will be used as the value to display.

Special markers can be used in the statement :

###uid### will be replaced by the current record uid.
###uidMainTable### will be replaced by the uid of the reccord in the main table.
###user### will be replaced by the user id.
###row[field_name]### where field_name is the name of a field in the current record, will be replaced by its current value.

The following example returns the name of the user who has created the current record, assuming that tx_mytable is the local table:

reqValue= SELECT name AS value
FROM fe_users
WHERE uid=(SELECT cruser_id FROM tx_mytable WHERE uid=###uid###);

setExtendLink¶

Property

setExtendLink

Data type

Table name

Description

The table name will be left-joined to existing tables.

showIf¶

Property

showIf

Data type

String

Description

See cutIf / showIf.

stdWrapItem¶

Property

stdWrapItem

Data type

stdWrap

Description

It defines a conventional TypoScript stdWrap property. You can add here full TS syntax.

Important

Do not forget that the configuration field is ended by a semi-column, therefore if you need a semi-column in your TS write it ";".

stdWrapValue¶

Property

stdWrapValue

Data type

stdWrap

Description

It defines a conventional TypoScript stdWrap property. You can add here full TS syntax.

Important

Do not forget that the configuration field is ended by a semi-column, therefore if you need a semi-column in your TS write it ";".

styleLabel¶

Property

styleLabel

Data type

String

Description

The string will be added as a style attribute associated with the label of the displayed value.

styleValue¶

Property

styleValue

Data type

String

Description

The string will be added as a style attribute associated with the displayed value.

tsObject¶

Property

tsObject

Data type

cObject

Description

It defines a TS content object (e.g. TEXT)

tsProperties¶

Property

tsProperties

Data type

String

Description

It defines the properties of the TS cObject.

Important

Do not forget that the configuration field is ended by a semi-column, therefore if you need a semi-column in your TS write it “;”.

value¶

Property

value

Data type

String

Description

It defines directly the value for the field.

verifier¶

Property

verifier

Data type

String

Description

Verifiers can be used to check if a field satisfy a constraint. Each field can have one verifier. Each verifier is associated with a parameter.

The verifier name can be:

isValidPattern
isValidLength
isValidInterval
isValidQuery

verifierMessage¶

Property

verifierMessage

Data type

String

Description

It replaces the default message.

Localization by means of the file locallang.xml can be used with $$$tag$$$ which will be replaced by its value according to the configuration language.

The marker $$$label[fieldName]$$$ will be replaced by the fieldName title according to the localization.

verifierParam¶

Property

verifierParam

Data type

String

Description

The string can be:

a regular expression for the verifier "isValidPattern". For example /^[A-Za-z0-9_]*$/ will allow any input which contains letters, numbers or underline characters.
an integer value for the verifier "isValidLength".
an interval [a, b] where a and b are integers for the verifier "isValidInterval".
a SELECT query for "isValidQuery". The marker ###value### in the query will be replaced by the value of the field. The marker ###uid### will be replaced by the uid of the current record.

verifierSetWarning¶

Property

verifierSetWarning

Data type

Boolean

Description

If set an error detected by the verifier becomes a warning. In that case, the field content is written in the database (which is not the case for errors) and a message is displayed.

Default

0

wrapItem¶

Property

wrapItem

Data type

Wrap

Description

The string will be used to wrap the item. The syntax in the same as in TypoScript.

Localization by means of the file locallang.xml can be used with $$$tag$$$ which will be replaced by its value according to the configuration language.

The marker $$$label[fieldName]$$$ will be replaced by the fieldName title according to the localization.