Contao Community Documentation - Benutzerbeiträge [de]

Klasse Formular

2012-12-19T12:51:08Z

Ferni: /* Anwendungsbeispiel Filter */

[[Category:Dev HOWTOS]]
[[Category:Dev Snippets]]

'''Github:''' https://github.com/psi-4ward/Formular

= Beispiel =

Die Klasse ''Formular'' erstellt Formulare aus DCA-Arrays:

<source lang="php">
// Die DCA-Definition
$dca = array
(
'Kontaktdaten' => array
(
'label' => 'Ihre Kontaktdaten',
'inputType' => 'headline'
),
'vorname' => array
(
'label' => 'Vorname',
'inputType' => 'text',
'default' => 'vorname',
'eval' => array('mandatory'=>true,'helpmessage'=>'Ihr Vorname')
),
'nachname' => array
(
'label' => 'Nachname',
'inputType' => 'text',
'default' => 'nachname',
'eval' => array('mandatory'=>true,'helpmessage'=>'Ihr Nachname')
),
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('datepicker'=>$this->getDatePickerString(),'cleardefault'=>false)
),

'email' => array
(
'label' => 'E-Mail',
'inputType' => 'text',
'eval' => array('mandatory'=>true,'rgxp'=>'email')
),
'telefon' => array
(
'label' => 'Telefon',
'inputType' => 'text',
'eval' => array('mandatory'=>true)
),
'kategorie' => array
(
'label' => 'Kategorie',
'inputType' => 'checkbox',
'options' => array('Option1','Option2','Option3','Option4'),
'eval' => array('multiple' => true, 'mandatory' => true),
),
'bemerkung' => array
(
'label' => 'Bemerkung',
'inputType' => 'textarea',
'eval' => array('rte'=>'tinyMCE')
),
'submit' => array
(
'label' => 'speichern',
'inputType' => 'submit'
)
);

// Instantiirung mit der FormularID meinKontaktformular
$frm = new Formular('meinKontaktformular');

// Übergabe des DCA-Arrays
$frm->setDCA($dca);

// Konfiguration
$frm->setConfig('generateFormat','<div>%label %field %error </div>');
$frm->setConfig('attributes',array('tableless'=>true));

// Formular wurde abgeschickt und ist korrekt
if($frm->isSubmitted() && $frm->validate())
{
var_dump($frm->getData());
}

// Ausgabe des Formulars
echo $frm->parse();
</source>

=Konfiguration=

Es gibt einige Parameter um die Erstellung des Formulars zu beeinflussen.
Grundlegend muss zwischen '''parse()''' und '''generate()''' unterschieden werden, wobei parse() die Methode generate() impliziert.
Formular::parse() bettet den Output von generate() in das ''Template'' ein.

==Parameter==
Die Konfiguration der Klasse Formular kann über '''Formular::setConfig($param,$value)''' geändert werden.

* str '''formTemplate''': Wird das Formular über parse() gerendert wird dieses Template benutzt. Vorgabe: form
* str '''class''': Zusätzliche Klassenangabe
* str '''action''': action-Attribut des <form> Tags. Vorgabe: Environment->request
* str '''method''': method-Attribut des <form> Tags. Vorgabe: post
* str '''generateFormat''': String mit Platzhaltern welche für jedes Widget durch deren Elemente ersetzt werden. Vorgabe "%parse"
%parse Widget::parse()
%label Widget::generateLabel()
%field Widget::generate()
%error Widget::getErrorAsHTML()
%errorPlain Widget::getErrorAsString()
* array '''attributes''': Array mit Attributen für die Widget::parse() Methode. Z.B. array('tableless'=>true)

===Setzen von Default Werten===

Um bei Select, Radio, Checkbox -Feldern die Standardwerte vorzubelegen kann man sich dem Magical-Setter bedienen:

Beispiel:
<source lang="php">
$frm->kategorie = array('Option1','Option2');
</source>

===Anwendungsbeispiel Filter===

Will man einen mehrseitigen Filter mit der Klasse Formular erstellen und die Kriterien beim Blättern (Pagination) erhalten, kann man diese über get paramater (hinzugefügt über addToUrl()) wieder setzen:
<source lang="php">
$frm->kategorie = \Input::get('kategorie');
$frm->branche = \Input::get('branche');
$frm->bundesland = \Input::get('bundesland');
</source>

==Systemweite Konfiguration==
Die Formular-Klasse versucht Konfigurationsoptionen aus $GLOBALS['TL_FORM'] zu lesen.
<source lang="php">
$GLOBALS['TL_FORM'] = array
(
'class' =>'myFormular',
'generateFormat' => '<div class="formField">%label %error %field</div>',
'formTemplate' => 'myFormularTemplate'
)
</source>

=Interaktion mit Erweiterungen=

==cleardefault==

[http://www.contao.org/erweiterungsliste/view/cleardefault.de.html Cleardefault] löscht den Standardwert sobald das Textfeld den Fokus bekommt.
Ist die Erweiterung installiert werden alle Textfelder und Textareas mit diesem Verhalten versehen. Über das @eval@ Array kann es für ein
einzelnes Feld angepasst werden:

<source lang="php">
$dca = array(
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('cleardefault'=>false)
)
);
</source>
''' 'cleardefault'=>false''' deaktiviert das Löschen des Standardwertes für das Feld '''datum'''.

==helpmessage==

[http://www.contao.org/erweiterungsliste/view/helpmessage.de.html Helpmessage] blendet per Javascript Hilfsnachrichten für das Feld ein.
Die Nachricht wird im '''eval''' Array hinterlegt. Falls über die Klasse '''FormularTL_DCA''' eine Tabelle gerendert wird, werden die Hilfstexte aus den Contao-Sprachdateien der Tabelle übernommen.

<source lang="php">
$dca = array(
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('helpmessage'=>'Das Datum muss im Format DD.MM.YYYY sein')
)
);
</source>

==formcheck==

[http://www.contao.org/erweiterungsliste/view/formcheck.de.html Formcheck] validiert ein Formular per Javascript auf der Clientseite.
Falls die Erweiterung (ab Version 1.3!) installiert ist funktionierte diese ohne weitere Konfiguration.

Klasse Formular

2012-12-19T12:50:26Z

Ferni: /* Setzen von Default Werten */

[[Category:Dev HOWTOS]]
[[Category:Dev Snippets]]

'''Github:''' https://github.com/psi-4ward/Formular

= Beispiel =

Die Klasse ''Formular'' erstellt Formulare aus DCA-Arrays:

<source lang="php">
// Die DCA-Definition
$dca = array
(
'Kontaktdaten' => array
(
'label' => 'Ihre Kontaktdaten',
'inputType' => 'headline'
),
'vorname' => array
(
'label' => 'Vorname',
'inputType' => 'text',
'default' => 'vorname',
'eval' => array('mandatory'=>true,'helpmessage'=>'Ihr Vorname')
),
'nachname' => array
(
'label' => 'Nachname',
'inputType' => 'text',
'default' => 'nachname',
'eval' => array('mandatory'=>true,'helpmessage'=>'Ihr Nachname')
),
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('datepicker'=>$this->getDatePickerString(),'cleardefault'=>false)
),

'email' => array
(
'label' => 'E-Mail',
'inputType' => 'text',
'eval' => array('mandatory'=>true,'rgxp'=>'email')
),
'telefon' => array
(
'label' => 'Telefon',
'inputType' => 'text',
'eval' => array('mandatory'=>true)
),
'kategorie' => array
(
'label' => 'Kategorie',
'inputType' => 'checkbox',
'options' => array('Option1','Option2','Option3','Option4'),
'eval' => array('multiple' => true, 'mandatory' => true),
),
'bemerkung' => array
(
'label' => 'Bemerkung',
'inputType' => 'textarea',
'eval' => array('rte'=>'tinyMCE')
),
'submit' => array
(
'label' => 'speichern',
'inputType' => 'submit'
)
);

// Instantiirung mit der FormularID meinKontaktformular
$frm = new Formular('meinKontaktformular');

// Übergabe des DCA-Arrays
$frm->setDCA($dca);

// Konfiguration
$frm->setConfig('generateFormat','<div>%label %field %error </div>');
$frm->setConfig('attributes',array('tableless'=>true));

// Formular wurde abgeschickt und ist korrekt
if($frm->isSubmitted() && $frm->validate())
{
var_dump($frm->getData());
}

// Ausgabe des Formulars
echo $frm->parse();
</source>

=Konfiguration=

Es gibt einige Parameter um die Erstellung des Formulars zu beeinflussen.
Grundlegend muss zwischen '''parse()''' und '''generate()''' unterschieden werden, wobei parse() die Methode generate() impliziert.
Formular::parse() bettet den Output von generate() in das ''Template'' ein.

==Parameter==
Die Konfiguration der Klasse Formular kann über '''Formular::setConfig($param,$value)''' geändert werden.

* str '''formTemplate''': Wird das Formular über parse() gerendert wird dieses Template benutzt. Vorgabe: form
* str '''class''': Zusätzliche Klassenangabe
* str '''action''': action-Attribut des <form> Tags. Vorgabe: Environment->request
* str '''method''': method-Attribut des <form> Tags. Vorgabe: post
* str '''generateFormat''': String mit Platzhaltern welche für jedes Widget durch deren Elemente ersetzt werden. Vorgabe "%parse"
%parse Widget::parse()
%label Widget::generateLabel()
%field Widget::generate()
%error Widget::getErrorAsHTML()
%errorPlain Widget::getErrorAsString()
* array '''attributes''': Array mit Attributen für die Widget::parse() Methode. Z.B. array('tableless'=>true)

===Setzen von Default Werten===

Um bei Select, Radio, Checkbox -Feldern die Standardwerte vorzubelegen kann man sich dem Magical-Setter bedienen:

Beispiel:
<source lang="php">
$frm->kategorie = array('Option1','Option2');
</source>

===Anwendungsbeispiel Filter===

Will man einen mehrseitigen Filter mit der Klasse Formular erstellen und die Kriterien beim Blättern (Pagination) erhalten, kann man diese über get paramater (hinzugefügt über addToUrl()) wieder setzen:

$frm->kategorie = \Input::get('kategorie');
$frm->branche = \Input::get('branche');
$frm->bundesland = \Input::get('bundesland');

==Systemweite Konfiguration==
Die Formular-Klasse versucht Konfigurationsoptionen aus $GLOBALS['TL_FORM'] zu lesen.
<source lang="php">
$GLOBALS['TL_FORM'] = array
(
'class' =>'myFormular',
'generateFormat' => '<div class="formField">%label %error %field</div>',
'formTemplate' => 'myFormularTemplate'
)
</source>

=Interaktion mit Erweiterungen=

==cleardefault==

[http://www.contao.org/erweiterungsliste/view/cleardefault.de.html Cleardefault] löscht den Standardwert sobald das Textfeld den Fokus bekommt.
Ist die Erweiterung installiert werden alle Textfelder und Textareas mit diesem Verhalten versehen. Über das @eval@ Array kann es für ein
einzelnes Feld angepasst werden:

<source lang="php">
$dca = array(
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('cleardefault'=>false)
)
);
</source>
''' 'cleardefault'=>false''' deaktiviert das Löschen des Standardwertes für das Feld '''datum'''.

==helpmessage==

[http://www.contao.org/erweiterungsliste/view/helpmessage.de.html Helpmessage] blendet per Javascript Hilfsnachrichten für das Feld ein.
Die Nachricht wird im '''eval''' Array hinterlegt. Falls über die Klasse '''FormularTL_DCA''' eine Tabelle gerendert wird, werden die Hilfstexte aus den Contao-Sprachdateien der Tabelle übernommen.

<source lang="php">
$dca = array(
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('helpmessage'=>'Das Datum muss im Format DD.MM.YYYY sein')
)
);
</source>

==formcheck==

[http://www.contao.org/erweiterungsliste/view/formcheck.de.html Formcheck] validiert ein Formular per Javascript auf der Clientseite.
Falls die Erweiterung (ab Version 1.3!) installiert ist funktionierte diese ohne weitere Konfiguration.

Klasse Formular

2012-12-10T13:08:17Z

Ferni: /* Parameter */

[[Category:Dev HOWTOS]]
[[Category:Dev Snippets]]

'''Github:''' https://github.com/psi-4ward/Formular

= Beispiel =

Die Klasse ''Formular'' erstellt Formulare aus DCA-Arrays:

<source lang="php">
// Die DCA-Definition
$dca = array
(
'Kontaktdaten' => array
(
'label' => 'Ihre Kontaktdaten',
'inputType' => 'headline'
),
'vorname' => array
(
'label' => 'Vorname',
'inputType' => 'text',
'default' => 'vorname',
'eval' => array('mandatory'=>true,'helpmessage'=>'Ihr Vorname')
),
'nachname' => array
(
'label' => 'Nachname',
'inputType' => 'text',
'default' => 'nachname',
'eval' => array('mandatory'=>true,'helpmessage'=>'Ihr Nachname')
),
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('datepicker'=>$this->getDatePickerString(),'cleardefault'=>false)
),

'email' => array
(
'label' => 'E-Mail',
'inputType' => 'text',
'eval' => array('mandatory'=>true,'rgxp'=>'email')
),
'telefon' => array
(
'label' => 'Telefon',
'inputType' => 'text',
'eval' => array('mandatory'=>true)
),
'kategorie' => array
(
'label' => 'Kategorie',
'inputType' => 'checkbox',
'options' => array('Option1','Option2','Option3','Option4'),
'eval' => array('multiple' => true, 'mandatory' => true),
),
'bemerkung' => array
(
'label' => 'Bemerkung',
'inputType' => 'textarea',
'eval' => array('rte'=>'tinyMCE')
),
'submit' => array
(
'label' => 'speichern',
'inputType' => 'submit'
)
);

// Instantiirung mit der FormularID meinKontaktformular
$frm = new Formular('meinKontaktformular');

// Übergabe des DCA-Arrays
$frm->setDCA($dca);

// Konfiguration
$frm->setConfig('generateFormat','<div>%label %field %error </div>');
$frm->setConfig('attributes',array('tableless'=>true));

// Formular wurde abgeschickt und ist korrekt
if($frm->isSubmitted() && $frm->validate())
{
var_dump($frm->getData());
}

// Ausgabe des Formulars
echo $frm->parse();
</source>

=Konfiguration=

Es gibt einige Parameter um die Erstellung des Formulars zu beeinflussen.
Grundlegend muss zwischen '''parse()''' und '''generate()''' unterschieden werden, wobei parse() die Methode generate() impliziert.
Formular::parse() bettet den Output von generate() in das ''Template'' ein.

==Parameter==
Die Konfiguration der Klasse Formular kann über '''Formular::setConfig($param,$value)''' geändert werden.

* str '''formTemplate''': Wird das Formular über parse() gerendert wird dieses Template benutzt. Vorgabe: form
* str '''class''': Zusätzliche Klassenangabe
* str '''action''': action-Attribut des <form> Tags. Vorgabe: Environment->request
* str '''method''': method-Attribut des <form> Tags. Vorgabe: post
* str '''generateFormat''': String mit Platzhaltern welche für jedes Widget durch deren Elemente ersetzt werden. Vorgabe "%parse"
%parse Widget::parse()
%label Widget::generateLabel()
%field Widget::generate()
%error Widget::getErrorAsHTML()
%errorPlain Widget::getErrorAsString()
* array '''attributes''': Array mit Attributen für die Widget::parse() Methode. Z.B. array('tableless'=>true)

===Setzen von Default Werten===

Um bei Select, Radio, Checkbox -Feldern die Standardwerte vorzubelegen kann man sich dem Magical-Setter bedienen:

Beispiel:
<source lang="php">
$frm->kategorie = array('Option1','Option2');
</source>

==Systemweite Konfiguration==
Die Formular-Klasse versucht Konfigurationsoptionen aus $GLOBALS['TL_FORM'] zu lesen.
<source lang="php">
$GLOBALS['TL_FORM'] = array
(
'class' =>'myFormular',
'generateFormat' => '<div class="formField">%label %error %field</div>',
'formTemplate' => 'myFormularTemplate'
)
</source>

=Interaktion mit Erweiterungen=

==cleardefault==

[http://www.contao.org/erweiterungsliste/view/cleardefault.de.html Cleardefault] löscht den Standardwert sobald das Textfeld den Fokus bekommt.
Ist die Erweiterung installiert werden alle Textfelder und Textareas mit diesem Verhalten versehen. Über das @eval@ Array kann es für ein
einzelnes Feld angepasst werden:

<source lang="php">
$dca = array(
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('cleardefault'=>false)
)
);
</source>
''' 'cleardefault'=>false''' deaktiviert das Löschen des Standardwertes für das Feld '''datum'''.

==helpmessage==

[http://www.contao.org/erweiterungsliste/view/helpmessage.de.html Helpmessage] blendet per Javascript Hilfsnachrichten für das Feld ein.
Die Nachricht wird im '''eval''' Array hinterlegt. Falls über die Klasse '''FormularTL_DCA''' eine Tabelle gerendert wird, werden die Hilfstexte aus den Contao-Sprachdateien der Tabelle übernommen.

<source lang="php">
$dca = array(
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('helpmessage'=>'Das Datum muss im Format DD.MM.YYYY sein')
)
);
</source>

==formcheck==

[http://www.contao.org/erweiterungsliste/view/formcheck.de.html Formcheck] validiert ein Formular per Javascript auf der Clientseite.
Falls die Erweiterung (ab Version 1.3!) installiert ist funktionierte diese ohne weitere Konfiguration.

Klasse Formular

2012-12-10T13:02:47Z

Ferni: /* Beispiel */

[[Category:Dev HOWTOS]]
[[Category:Dev Snippets]]

'''Github:''' https://github.com/psi-4ward/Formular

= Beispiel =

Die Klasse ''Formular'' erstellt Formulare aus DCA-Arrays:

<source lang="php">
// Die DCA-Definition
$dca = array
(
'Kontaktdaten' => array
(
'label' => 'Ihre Kontaktdaten',
'inputType' => 'headline'
),
'vorname' => array
(
'label' => 'Vorname',
'inputType' => 'text',
'default' => 'vorname',
'eval' => array('mandatory'=>true,'helpmessage'=>'Ihr Vorname')
),
'nachname' => array
(
'label' => 'Nachname',
'inputType' => 'text',
'default' => 'nachname',
'eval' => array('mandatory'=>true,'helpmessage'=>'Ihr Nachname')
),
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('datepicker'=>$this->getDatePickerString(),'cleardefault'=>false)
),

'email' => array
(
'label' => 'E-Mail',
'inputType' => 'text',
'eval' => array('mandatory'=>true,'rgxp'=>'email')
),
'telefon' => array
(
'label' => 'Telefon',
'inputType' => 'text',
'eval' => array('mandatory'=>true)
),
'kategorie' => array
(
'label' => 'Kategorie',
'inputType' => 'checkbox',
'options' => array('Option1','Option2','Option3','Option4'),
'eval' => array('multiple' => true, 'mandatory' => true),
),
'bemerkung' => array
(
'label' => 'Bemerkung',
'inputType' => 'textarea',
'eval' => array('rte'=>'tinyMCE')
),
'submit' => array
(
'label' => 'speichern',
'inputType' => 'submit'
)
);

// Instantiirung mit der FormularID meinKontaktformular
$frm = new Formular('meinKontaktformular');

// Übergabe des DCA-Arrays
$frm->setDCA($dca);

// Konfiguration
$frm->setConfig('generateFormat','<div>%label %field %error </div>');
$frm->setConfig('attributes',array('tableless'=>true));

// Formular wurde abgeschickt und ist korrekt
if($frm->isSubmitted() && $frm->validate())
{
var_dump($frm->getData());
}

// Ausgabe des Formulars
echo $frm->parse();
</source>

=Konfiguration=

Es gibt einige Parameter um die Erstellung des Formulars zu beeinflussen.
Grundlegend muss zwischen '''parse()''' und '''generate()''' unterschieden werden, wobei parse() die Methode generate() impliziert.
Formular::parse() bettet den Output von generate() in das ''Template'' ein.

==Parameter==
Die Konfiguration der Klasse Formular kann über '''Formular::setConfig($param,$value)''' geändert werden.

* str '''formTemplate''': Wird das Formular über parse() gerendert wird dieses Template benutzt. Vorgabe: form
* str '''class''': Zusätzliche Klassenangabe
* str '''action''': action-Attribut des <form> Tags. Vorgabe: Environment->request
* str '''method''': method-Attribut des <form> Tags. Vorgabe: post
* str '''generateFormat''': String mit Platzhaltern welche für jedes Widget durch deren Elemente ersetzt werden. Vorgabe "%parse"
%parse Widget::parse()
%label Widget::generateLabel()
%field Widget::generate()
%error Widget::getErrorAsHTML()
%errorPlain Widget::getErrorAsString()
* array '''attributes''': Array mit Attributen für die Widget::parse() Methode. Z.B. array('tableless'=>true)

==Systemweite Konfiguration==
Die Formular-Klasse versucht Konfigurationsoptionen aus $GLOBALS['TL_FORM'] zu lesen.
<source lang="php">
$GLOBALS['TL_FORM'] = array
(
'class' =>'myFormular',
'generateFormat' => '<div class="formField">%label %error %field</div>',
'formTemplate' => 'myFormularTemplate'
)
</source>

=Interaktion mit Erweiterungen=

==cleardefault==

[http://www.contao.org/erweiterungsliste/view/cleardefault.de.html Cleardefault] löscht den Standardwert sobald das Textfeld den Fokus bekommt.
Ist die Erweiterung installiert werden alle Textfelder und Textareas mit diesem Verhalten versehen. Über das @eval@ Array kann es für ein
einzelnes Feld angepasst werden:

<source lang="php">
$dca = array(
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('cleardefault'=>false)
)
);
</source>
''' 'cleardefault'=>false''' deaktiviert das Löschen des Standardwertes für das Feld '''datum'''.

==helpmessage==

[http://www.contao.org/erweiterungsliste/view/helpmessage.de.html Helpmessage] blendet per Javascript Hilfsnachrichten für das Feld ein.
Die Nachricht wird im '''eval''' Array hinterlegt. Falls über die Klasse '''FormularTL_DCA''' eine Tabelle gerendert wird, werden die Hilfstexte aus den Contao-Sprachdateien der Tabelle übernommen.

<source lang="php">
$dca = array(
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('helpmessage'=>'Das Datum muss im Format DD.MM.YYYY sein')
)
);
</source>

==formcheck==

[http://www.contao.org/erweiterungsliste/view/formcheck.de.html Formcheck] validiert ein Formular per Javascript auf der Clientseite.
Falls die Erweiterung (ab Version 1.3!) installiert ist funktionierte diese ohne weitere Konfiguration.

Klasse Formular

2012-12-10T13:01:39Z

Ferni:

[[Category:Dev HOWTOS]]
[[Category:Dev Snippets]]

'''Github:''' https://github.com/psi-4ward/Formular

= Beispiel =

Die Klasse ''Formular'' erstellt Formulare aus DCA-Arrays:

<source lang="php">
// Die DCA-Definition
$dca = array
(
'Kontaktdaten' => array
(
'label' => 'Ihre Kontaktdaten',
'inputType' => 'headline'
),
'vorname' => array
(
'label' => 'Vorname',
'inputType' => 'text',
'default' => 'vorname',
'eval' => array('mandatory'=>true,'helpmessage'=>'Ihr Vorname')
),
'nachname' => array
(
'label' => 'Nachname',
'inputType' => 'text',
'default' => 'nachname',
'eval' => array('mandatory'=>true,'helpmessage'=>'Ihr Nachname')
),
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('datepicker'=>$this->getDatePickerString(),'cleardefault'=>false)
),

'email' => array
(
'label' => 'E-Mail',
'inputType' => 'text',
'eval' => array('mandatory'=>true,'rgxp'=>'email')
),
'telefon' => array
(
'label' => 'Telefon',
'inputType' => 'text',
'eval' => array('mandatory'=>true)
),
'kategorie' => array
(
'label' => 'Kategorie',
'inputType' => 'checkbox',
'options' => array('Option1','Option2','Option3','Option4'),
'eval' => array('multiple' => true, 'mandatory' => true),
),
'bemerkung' => array
(
'label' => 'Bemerkung',
'inputType' => 'textarea',
'eval' => array('rte'=>'tinyMCE')
),
'submit' => array
(
'label' => 'speichern',
'inputType' => 'submit'
)
);

// Instantiirung mit der FormularID meinKontaktformular
$frm = new Formular('meinKontaktformular');

// Übergabe des DCA-Arrays
$frm->setDCA($dca);

// Konfiguration
$frm->setConfig('generateFormat','<div>%label %field %error </div>');
$frm->setConfig('attributes',array('tableless'=>true));

// Formular wurde abgeschickt und ist korrekt
if($frm->isSubmitted() && $frm->validate())
{
var_dump($frm->getData());
}

// Ausgabe des Formulars
echo $frm->parse();
</source>

=Konfiguration=

Es gibt einige Parameter um die Erstellung des Formulars zu beeinflussen.
Grundlegend muss zwischen '''parse()''' und '''generate()''' unterschieden werden, wobei parse() die Methode generate() impliziert.
Formular::parse() bettet den Output von generate() in das ''Template'' ein.

==Parameter==
Die Konfiguration der Klasse Formular kann über '''Formular::setConfig($param,$value)''' geändert werden.

* str '''formTemplate''': Wird das Formular über parse() gerendert wird dieses Template benutzt. Vorgabe: form
* str '''class''': Zusätzliche Klassenangabe
* str '''action''': action-Attribut des <form> Tags. Vorgabe: Environment->request
* str '''method''': method-Attribut des <form> Tags. Vorgabe: post
* str '''generateFormat''': String mit Platzhaltern welche für jedes Widget durch deren Elemente ersetzt werden. Vorgabe "%parse"
%parse Widget::parse()
%label Widget::generateLabel()
%field Widget::generate()
%error Widget::getErrorAsHTML()
%errorPlain Widget::getErrorAsString()
* array '''attributes''': Array mit Attributen für die Widget::parse() Methode. Z.B. array('tableless'=>true)

==Systemweite Konfiguration==
Die Formular-Klasse versucht Konfigurationsoptionen aus $GLOBALS['TL_FORM'] zu lesen.
<source lang="php">
$GLOBALS['TL_FORM'] = array
(
'class' =>'myFormular',
'generateFormat' => '<div class="formField">%label %error %field</div>',
'formTemplate' => 'myFormularTemplate'
)
</source>

=Interaktion mit Erweiterungen=

==cleardefault==

[http://www.contao.org/erweiterungsliste/view/cleardefault.de.html Cleardefault] löscht den Standardwert sobald das Textfeld den Fokus bekommt.
Ist die Erweiterung installiert werden alle Textfelder und Textareas mit diesem Verhalten versehen. Über das @eval@ Array kann es für ein
einzelnes Feld angepasst werden:

<source lang="php">
$dca = array(
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('cleardefault'=>false)
)
);
</source>
''' 'cleardefault'=>false''' deaktiviert das Löschen des Standardwertes für das Feld '''datum'''.

==helpmessage==

[http://www.contao.org/erweiterungsliste/view/helpmessage.de.html Helpmessage] blendet per Javascript Hilfsnachrichten für das Feld ein.
Die Nachricht wird im '''eval''' Array hinterlegt. Falls über die Klasse '''FormularTL_DCA''' eine Tabelle gerendert wird, werden die Hilfstexte aus den Contao-Sprachdateien der Tabelle übernommen.

<source lang="php">
$dca = array(
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('helpmessage'=>'Das Datum muss im Format DD.MM.YYYY sein')
)
);
</source>

==formcheck==

[http://www.contao.org/erweiterungsliste/view/formcheck.de.html Formcheck] validiert ein Formular per Javascript auf der Clientseite.
Falls die Erweiterung (ab Version 1.3!) installiert ist funktionierte diese ohne weitere Konfiguration.

Klasse Formular

2012-12-10T12:56:12Z

Ferni: /* Beispiel */

[[Category:Dev HOWTOS]]
[[Category:Dev Snippets]]

'''Github:''' https://github.com/psi-4ward/Formular

= Beispiel =

Die Klasse ''Formular'' erstellt Formulare aus DCA-Arrays:

<source lang="php">
// Die DCA-Definition
$dca = array
(
'Kontaktdaten' => array
(
'label' => 'Ihre Kontaktdaten',
'inputType' => 'headline'
),
'vorname' => array
(
'label' => 'Vorname',
'inputType' => 'text',
'default' => 'vorname',
'eval' => array('mandatory'=>true,'helpmessage'=>'Ihr Vorname')
),
'nachname' => array
(
'label' => 'Nachname',
'inputType' => 'text',
'default' => 'nachname',
'eval' => array('mandatory'=>true,'helpmessage'=>'Ihr Nachname')
),
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('datepicker'=>$this->getDatePickerString(),'cleardefault'=>false)
),

'email' => array
(
'label' => 'E-Mail',
'inputType' => 'text',
'eval' => array('mandatory'=>true,'rgxp'=>'email')
),
'telefon' => array
(
'label' => 'Telefon',
'inputType' => 'text',
'eval' => array('mandatory'=>true)
),
'kategorie' => array
(
'label' => 'Kategorie',
'inputType' => 'checkbox',
'value' => array('Option1', 'Option3'), // Setzt Option1 & 3 auf checked
'options' => array('Option1','Option2','Option3','Option4'),
'eval' => array('multiple' => true, 'mandatory' => true),
),
'bemerkung' => array
(
'label' => 'Bemerkung',
'inputType' => 'textarea',
'eval' => array('rte'=>'tinyMCE')
),
'submit' => array
(
'label' => 'speichern',
'inputType' => 'submit'
)
);

// Instantiirung mit der FormularID meinKontaktformular
$frm = new Formular('meinKontaktformular');

// Übergabe des DCA-Arrays
$frm->setDCA($dca);

// Konfiguration
$frm->setConfig('generateFormat','<div>%label %field %error </div>');
$frm->setConfig('attributes',array('tableless'=>true));

// Formular wurde abgeschickt und ist korrekt
if($frm->isSubmitted() && $frm->validate())
{
var_dump($frm->getData());
}

// Ausgabe des Formulars
echo $frm->parse();
</source>

=Konfiguration=

Es gibt einige Parameter um die Erstellung des Formulars zu beeinflussen.
Grundlegend muss zwischen '''parse()''' und '''generate()''' unterschieden werden, wobei parse() die Methode generate() impliziert.
Formular::parse() bettet den Output von generate() in das ''Template'' ein.

==Parameter==
Die Konfiguration der Klasse Formular kann über '''Formular::setConfig($param,$value)''' geändert werden.

* str '''formTemplate''': Wird das Formular über parse() gerendert wird dieses Template benutzt. Vorgabe: form
* str '''class''': Zusätzliche Klassenangabe
* str '''action''': action-Attribut des <form> Tags. Vorgabe: Environment->request
* str '''method''': method-Attribut des <form> Tags. Vorgabe: post
* str '''generateFormat''': String mit Platzhaltern welche für jedes Widget durch deren Elemente ersetzt werden. Vorgabe "%parse"
%parse Widget::parse()
%label Widget::generateLabel()
%field Widget::generate()
%error Widget::getErrorAsHTML()
%errorPlain Widget::getErrorAsString()
* array '''attributes''': Array mit Attributen für die Widget::parse() Methode. Z.B. array('tableless'=>true)

==Systemweite Konfiguration==
Die Formular-Klasse versucht Konfigurationsoptionen aus $GLOBALS['TL_FORM'] zu lesen.
<source lang="php">
$GLOBALS['TL_FORM'] = array
(
'class' =>'myFormular',
'generateFormat' => '<div class="formField">%label %error %field</div>',
'formTemplate' => 'myFormularTemplate'
)
</source>

=Interaktion mit Erweiterungen=

==cleardefault==

[http://www.contao.org/erweiterungsliste/view/cleardefault.de.html Cleardefault] löscht den Standardwert sobald das Textfeld den Fokus bekommt.
Ist die Erweiterung installiert werden alle Textfelder und Textareas mit diesem Verhalten versehen. Über das @eval@ Array kann es für ein
einzelnes Feld angepasst werden:

<source lang="php">
$dca = array(
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('cleardefault'=>false)
)
);
</source>
''' 'cleardefault'=>false''' deaktiviert das Löschen des Standardwertes für das Feld '''datum'''.

==helpmessage==

[http://www.contao.org/erweiterungsliste/view/helpmessage.de.html Helpmessage] blendet per Javascript Hilfsnachrichten für das Feld ein.
Die Nachricht wird im '''eval''' Array hinterlegt. Falls über die Klasse '''FormularTL_DCA''' eine Tabelle gerendert wird, werden die Hilfstexte aus den Contao-Sprachdateien der Tabelle übernommen.

<source lang="php">
$dca = array(
'datum' => array
(
'label' => 'Datum',
'inputType' => 'text',
'default' => date('d.m.Y'),
'eval' => array('helpmessage'=>'Das Datum muss im Format DD.MM.YYYY sein')
)
);
</source>

==formcheck==

[http://www.contao.org/erweiterungsliste/view/formcheck.de.html Formcheck] validiert ein Formular per Javascript auf der Clientseite.
Falls die Erweiterung (ab Version 1.3!) installiert ist funktionierte diese ohne weitere Konfiguration.