Login / Status
developer.Resource
Home . Documentation . Document Library . Extension Manuals
Sponsors
hosted by punkt.deTYPO3 and Open Source MagazineAOE Media

1.6. Reference

plugin.tx_logicalform_pi1 properties: TS configuration.

General Settings

Property:

Data type:

Description:

Default:

templateFile

string

The template file for the form

Example:

plugin.tx_logicalform_pi1 {
  templateFile = typo3conf/ext/logical_form/ \    pi1/template.html

}

typo3conf/ext/logical_form/pi1/template.html

code

string

The marker for the form subpart in the template file

Example:

plugin.tx_logicalform_pi1 {
  code = FORM

}

FORM

key_prod

int

You need this key for encrypting input values.Integer values will be multiplied with key_prod.

See also the reference "input.send_keyed" on page 23.

Example:

plugin.tx_logicalform_pi1 {
  key_prod = 4523

}

123

error.wrap

string

The wrap for an error message in the form.

The message will be displayed, if a field is required but the value of this field is an empty string.

Example:

plugin.tx_logicalform_pi1.error {
  wrap = <dd><div style="font-weight:bold; \    font-size:small;color:red;">|</div></dd>

}

<div style="font-weight:bold;font-size:small;color:red;">|</div>

required.wrap

string

The wrap for the line required in the form.The required line will be displayed, if there is any field which is required.

Example:

plugin.tx_logicalform_pi1.required {
  wrap = <dd><div style="font-size:small; \    padding-top:2em;">|</div></dd>

}

<div style="font-size:small;padding-top:2em;">|</div>

date

string

Output format for a timestamp.

A timestamp is used in a report mail.

plugin.tx_logicalform_pi1{
  date = Y-m-d H:i:s

}

Y-m-d H:i:s

Captcha

Property:

Data type:

Description:

Default:

captcha

deprecated

Please use captcha.extkey (see below)

captcha.extkey.captcha

captcha.extkey.sr_freecap

boolean

If you want use captcha or sr_freecap, you have to activate it with a 1 (true)

You have to install the extension captcha or sr_freecap of course.

Example:

plugin.tx_logicalform_pi1 {
  captcha.extkey.captcha = 1

}

0

captcha.wrap.error

string

Example:

plugin.tx_logicalform_pi1 {
  captcha.wrap.error =              <div class="my-error-wrap">|</div>

}

<div style="font-weight:bold;font-size:small;color:red;">|</div>

Workflow and Pids

Property:

Data type:

Description:

Default:

debug

boolean

Debug mode of the logical form.

Maybe you will get a helpful hint.

If you like to debug problems with mails, please see mail.debug below.

Example:

plugin.tx_logicalform_pi1 {
  debug = 1

}

0

workflow

string

failure_page,

form

The workflow of the logical form.

failure_page: In case of a failure the visitor will be guided   to a failure page. You have to configure the setup value pids.failure!

form: In case of a failure there will be an error message   in the form.

Example:

plugin.tx_logicalform_pi1 {
  workflow = failure_page

}

failure_page

pids.failure

pids.success

integer

The ids of the pages with the failure and success message.

You have to configure the value pids.success in every case!

You have to configure the value pids.failure, if your workflow (see above) is failure_page (this is the default mode).

Example:

plugin.tx_logicalform_pi1.pids {
  failure = 417
  success = 418

}

General Field Settings

Settings for all field in the extension logical_form

Property:

Data type:

Description:

Default:

fields.[field_name].[field_type]

array

[field_type]:

input

textarea

radio

checkbox

select

Create a field

Example for a select field:

plugin.tx_logicalform_pi1.fields.country.select {
  ...

}

Example for an input field:

plugin.tx_logicalform_pi1.fields.city.input {
  ...

}

See tables below

country.select,

city.input

fields.[field_name].[field_type].required

boolean

If the field is required the extension won't accept an empty value

The field name will be completed with an asterisk.

The last line in the form will be an information, that required fields have to be completed.

Example:

plugin.tx_logicalform_pi1.fields.country.select {
  required = 1

}

fields.[field_name].[field_type].failure.x

string

Value, which shouldn't be accepted

Example:

plugin.tx_logicalform_pi1.fields.country.select {
  failure.0 = Switzerland
  failure.1 = USA

}

fields.[field_name].[field_type].default

string

Default value of a field

Example:

plugin.tx_logicalform_pi1.fields.city.input {
  default = Berlin

}

Settings for an Input Field

Property:

Data type:

Description:

Default:

fields.[field_name].input.size

integer

Html length of the input field

Example:

plugin.tx_logicalform_pi1.fields.city.input {
  size = 30

}

fields.[field_name].input.maxlength

integer

Allowed length of the value in the input field

Example:

plugin.tx_logicalform_pi1.fields.city.input {
  maxlength = 60

}

fields.[field_name].input.mail

boolean

If set the value of the input field have to be a valid mail address m(e.g. with an @). Otherwise there will be an error message

Example:

plugin.tx_logicalform_pi1.fields.email.input {
  mail = 1

}

0

fields.[field_name].input.int

boolean

If set the value of the input field have to be an integer. Otherwise there will be an error message

Example:

plugin.tx_logicalform_pi1.fields.email.input {
  int = 1

}

0

fields.[field_name].input.send_keyed

boolean

If set, this value will bey keyed in mails.

Example output in a mail:

- Sended value: 12345678

- Displayed value: ########

Output in the report mail:

- if input.int = 1 then there will be displayed: 1518518394/123

  (value * key_prod, keyprod is the value after the slash)  key_prod: see General Settings key_prod.

- without input.int there will be displayed 87654321/rev

Example:

plugin.tx_logicalform_pi1.fields.account_no.input {
  send_keyed = 1

}

You can configure the output for the client mail (see the below)

0

fields.[field_name].input.send_keyed.start

int

Start point of the mask in the client mail.

Example for start value 3:

- Sended value: 12345678

- Displayed value: 123#####

Example:

plugin.tx_logicalform_pi1.fields.account_no.input {
  send_keyed.start = 3

}

0

fields.[field_name].input.send_keyed.symbol

char

You can set the symbol, with which values will be substituted in the client mail

Example:

plugin.tx_logicalform_pi1.fields.account_no.input {
  send_keyed.symbol = *

}

#

Settings for a Textarea

Property:

Data type:

Description:

Default:

fields.[field_name].texarea.cols

integer

Html cols of the texarea

Example:

plugin.tx_logicalform_pi1.fields.note.texarea {
  cols = 30

}

fields.[field_name].texarea.rows

integer

Html rows of the texarea

Example:

plugin.tx_logicalform_pi1.fields.note.texarea {
  rows = 5

}

Settings for a Radio Button

Property:

Data type:

Description:

Default:

fields.[field_name].radio.value.x

string

Option field of a radio button

Example:

plugin.tx_logicalform_pi1.fields.sexus.radio {
  value.0 = male
  value.1 = female

}

fields.[field_name].radio.br

boolean

If set, then there will be a <br />-tag between the option fields

Example:

plugin.tx_logicalform_pi1.fields.sexus {
  br = 1

}

Settings for a Checkbox

Property:

Data type:

Description:

Default:

fields.[field_name].checkbox.value.x

string

Option field of a checkbox

Example:

plugin.tx_logicalform_pi1.fields.profile.checkbox {
  value.0 = sport
  value.1 = culture
  value.2 = vacation

}

Settings for a Selectbox

Property:

Data type:

Description:

Default:

fields.[field_name].select.size

integer

Amount of the displayed items in the option list

Example:

plugin.tx_logicalform_pi1.fields.country.select {
  size = 5

}

fields.[field_name].select.value.x

string

Option value of a selectbox

Example:

plugin.tx_logicalform_pi1.fields.country.select {
  value.0 = 
  value.1 = Germany
  value.2 = Spain
  value.3 = Switzerland
  value.4 = USA

}

fields.[field_name].select.multiple

boolean

Enable the multiple choice of a selectbox

Example:

plugin.tx_logicalform_pi1.fields.country.select {
  multiple = 1

}

General Mail Settings

Property:

Data type:

Description:

Default:

mail.from

string

The sender of the mail, which will send in cases of failure and success to the provider of the website and others

Example:

plugin.tx_logicalform_pi1.mail {
  from = webmaster@my-client.com

}

webmaster@my-client.com

mail.debug

boolean

If set there is a output in Html

Example:

plugin.tx_logicalform_pi1.mail {
  debug = 1

}

0

mail.charset

string

The charset for the mail

Example:

plugin.tx_logicalform_pi1.mail {
  charset = UTF-8

}

iso-8859-15

Mail Settings for a Report Mail

Property:

Data type:

Description:

Default:

mail.report

boolean, array

Activating a report mail (you have to configure the report array).

Example:

plugin.tx_logicalform_pi1.mail {
  report = 1

}

0

mail.report.from.mail,

mail.report.from.name

strings

Sender of the report mail

Example:

plugin.tx_logicalform_pi1.mail.report {
  from.mail = webmaster@my-domain.com
  from.name = Typo3 Logical Form Report

}

mail.report.to.x

string

Receiver of the report mail

Example:

plugin.tx_logicalform_pi1.mail.report {
  to.0 = webmaster@my-domain.com
  to.1 = henry@statistics.com

}

mail.report.signature.x

string

Signature of the report mail

Example:

plugin.tx_logicalform_pi1.mail.report {
  signature.0 = My company
  signature.1 = My name
  signature.2 = webmaster@my-domain.com

}

Mail Settings for the Client Mail

Property:

Data type:

Description:

Default:

mail.client

boolean, array

Activating a mail to the client, the visitor, who filled up the values in the form (you have to configure the mail client array).

Example:

plugin.tx_logicalform_pi1.mail {
  client = 1

}

0

mail.client.from.mail,

mail.client.from.name

strings

Sender of the report mail

Example:

plugin.tx_logicalform_pi1.mail.client {
  from.mail = name@my.provider.com
  from.name = My provider company

}

mail.client.bcc

string

Comma separated list of mail addresses for a blind copy

Example:

plugin.tx_logicalform_pi1.mail.client {
  bcc = name@my.provider.com, \          webmaster@my-domain.com

}

mail.client.field

string

The name of the field in the form, which contained the mail address of the visitor (see the mail tutorial on page 16)

Example:

plugin.tx_logicalform_pi1.mail.client {
  field = mail

}

mail.client.body

string

The name of the field for mail subject and mail message in the language configuration (see the mail tutorial on page 16)

Example:

plugin.tx_logicalform_pi1.mail.client {
  body = mailclient

}

mail.client.signature.x

string

Signature of the report mail

Example:

plugin.tx_logicalform_pi1.mail.client {
  signature.0 = My provider company
  signature.1 = My provider name
  signature.2 = name@my-provider.com

}

Language and translation

There are translations for some words and phrases in the file

  1. pi1/locallang.xml

especially for

  1. error_mail: "There is a mistake in your mail address ###MAIL###”

  2. error_not_accepted: "The system doesn't accept this value!”

  3. error_not_accepted_checkbox "The system doesn't accept one of the values!”

  4. "error_not_accepted_select: "The system doesn't accept one of the values!”

  5. legend: "Logical Form”

  6. mail_report_subject: "Logical Form Report”

  7. mail_report_text: A text with markers.

If you want to change the values,

  1. you can edit locallang.xml (but maybe you will get trouble in case of updating the extension)

  2. or edit the array “_Local_Lang” (recommended).

If you want to edit the array “_LOCAL_LANG” please take a look in the tutorial “How to configure language for fields and values” on page 15.