MultiColumnWizard

2021-01-16T16:02:23Z

Christian.Schmidt: /* Unterstützte Contao Eval-Optionen */

[[en:MultiSelectWizard]]
[[Category:Extensions]]
{{ExtInfo
| DevSite=http://www.men-at-work.de
| ExtVersion=3.0.0
| Version=2.10+
| ERLink=http://www.contao.org/erweiterungsliste/view/MultiColumnWizard.html
| TrackerLink=https://github.com/menatwork/MultiColumnWizard/issues
}}

Der MultiColumnWizard ist ein Widget zur Abbildung von mehreren Feldern ''gleichen'' und/oder ''unterschiedlichen'' Typs (''Inputtype'') in einem DCA-Element. Die einzelnen Felder des MCW werden im Backend spaltenweise geführt und sind als Gruppe zeilenweise erweiterbar. Die Anordnung entspricht einem multidimensionalen Array der Form ''array[Zeilen][Felder]'', das als serialisiertes Array in der Datenbank abgelegt wird. Das Widget ist quasi identisch zu [[MultiTextWizard]] oder [[MultiSelectWizard]]. Es erweitert die Funktionalitäten für beliebige Widgets.

=Aussehen=
Die Extension kann für jede Art von Inputtype verwendet werden, eine Mischung der einzelnen Typen ist kein Problem.
[[Datei:MultiColumnWizard.jpg|MultiColumnWizard|frame|center]]

=Verwendung=
Es gibt zwei Verwendungsmöglichkeiten. Entweder direkt mit der Angabe von "columnFields" im "eval"-Array oder mit einem Callback.

==Angabe mit columnFields==

<source lang="php">
$GLOBALS['TL_DCA']['tl_theme']['fields']['templateSelection'] = array
(
'label' => &$GLOBALS['TL_LANG']['tl_theme']['templateSelection'],
'exclude' => true,
'inputType' => 'multiColumnWizard',
'eval' => array
(
'columnFields' => array
(
'ts_client_os' => array
(
'label' => &$GLOBALS['TL_LANG']['tl_theme']['ts_client_os'],
'exclude' => true,
'inputType' => 'select',
'options' => array
(
'option1' => 'Option 1',
'option2' => 'Option 2',
),
'eval' => array('style' => 'width:250px', 'includeBlankOption'=>true, 'chosen'=>true)
),
'ts_client_browser' => array
(
'label' => &$GLOBALS['TL_LANG']['tl_theme']['ts_client_browser'],
'exclude' => true,
'inputType' => 'text',
'eval' => array('style'=>'width:180px')
),
'ts_client_mobile' => array
(
'label' => &$GLOBALS['TL_LANG']['tl_theme']['ts_client_mobile'],
'exclude' => true,
'inputType' => 'checkbox',
'eval' => array('style'=>'width:40px')

),
'ts_extension' => array
(
'label' => &$GLOBALS['TL_LANG']['tl_theme']['ts_extension'],
'inputType' => 'text',
'eval' => array('mandatory'=>true, 'style'=>'width:115px')
),
)
),
'sql' => "blob NULL"
);
</source>
Das ''''chosen'=>true''' im eval vom Select Feld (ts_client_os) ist für Contao 2.11 wichtig, da sonst die Anzeige nicht korrekt funktioniert. Für Contao 2.10 ist das nicht nötig, stört aber nicht und ist somit kompatibel für beide Versionen. Das SQL-Feld ist nur nötig, wenn es keine database.sql gibt.

==Angabe mit Callback==
<source lang="php">
$GLOBALS['TL_DCA']['tl_table']['fields']['anything'] = array
(
'label' => &$GLOBALS['TL_LANG']['tl_table']['anything'],
'exclude' => true,
'inputType' => 'multiColumnWizard',
'eval' => array('mandatory'=>true,'columnsCallback'=>array('Class', 'Method'))

);
</source>

Wobei natürlich der Return-Wert genau das selbe Array sein muss, wie bei der "columnFields"-Variante.

==Verfügbare MultiColumnWizard Eval-Optionen==

{| cellpadding="20" cellspacing="0"
|-
| '''Schlüssel''' || '''Wert''' || '''Beschreibung''' || '''Beispiel'''
|-
| columnPos || Gruppenname ''string'' || Gruppiert Felder und zeigt Sie untereinander an. ||
|-
| maxCount || Menge ''integer'' || Legt die maximale Anzahl an Felder fest, die angelegt werden dürfen. || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['mcwExample']['eval']['maxCount'] = 4;</source>
|-
| minCount || Menge ''integer'' || Legt die minimale Anzahl an Felder fest, die angelegt werden dürfen. || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['mcwExample']['eval']['minCount '] = 2;</source>
|-
| valign || Position ''string'' || Legt die vertikale Position der Zelle in der Tabelle fest. || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['mcwExample']['eval']['valign'] = 'top';</source>
|-
| buttonPos || Position ''string'' || Legt die vertikale Position der Zelle, in der sich die Buttons befinden, fest. || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['mcwExample']['eval']['buttonPos'] = 'bottom';</source>
|-
| buttons || Buttonnamen ''associative array'' || Legt fest, mit welchen Icons die Buttons "up", "down", "move", "new", "copy", "delete" dargestellt werden. Dabei ist der Buttonname der Schlüssel und der Pfad zum Icon der Wert. Wird ein Wert für einen Button explizit auf ''false'' gesetzt, so wird dieser versteckt. || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['mcwExample']['eval']['buttons'] = ['copy' => false, 'delete' => false, 'up' => 'myUpIcon.png'];</source>
|-
| hideButtons || Buttons ausblenden? ''boolean'' || Wird die Option ''hideButtons'' auf ''true'' gesetzt, werden keine Buttons angezeigt. || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['mcwExample']['eval']['hideButtons '] = true;</source>
|-
| disableSorting || Zeilen verschieben deaktivieren? ''boolean'' || Wird die Option ''disableSorting'' auf ''true'' gesetzt, lässt sich die Reihenfolge der Zeichen nicht ändern (die Buttons "up" und "down" bzw. "move" werden nicht angezeigt). || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['mcwExample']['eval']['disableSorting'] = true;</source>
|-
| dragAndDrop || Verschieben der Zeilen per "Drag and Drop" aktivieren? ''boolean'' || Wird die Option ''dragAndDrop'' auf ''true'' gesetzt, die Buttons "up" und "down" durch den Button "move" ersetzt). || <source lang="php">$GLOBALS['TL_DCA']['tl_example']['fields']['mcwExample']['eval']['dragAndDrop'] = true;</source>
|}

==Unterstützte Contao Eval-Optionen==
Diese Eval-Optionen werden für die "Kindwidgets" - oder besser "komponierten Widgets" - unterstützt.

{|
|-
| '''Schlüssel''' || '''Status'''
|-
| nospace || Unterstützt
|-
| multiple || Unterstützt
|-
| size || Unterstützt
|-
| rgxp || Unterstützt
|-
| style || Unterstützt
|-
| tl_class || Unterstützt
|-
| preserveTags || Unterstützt
|-
| allowHtml || Unterstützt
|-
| trailingSlash || Unterstützt
|-
| mandatory || Unterstützt
|-
| spaceToUnderscore || Unterstützt
|-
| includeBlankOption || Unterstützt
|-
| maxlength || Unterstützt
|-
| minlength || Unterstützt
|-
| chosen || Unterstützt
|-
| readonly || Unterstützt
|-
| minval || Unterstützt
|-
| maxval || Unterstützt
|-
| fieldType || Unterstützt
|-
| files || Unterstützt
|-
| filesOnly || Unterstützt
|-
| extensions || Unterstützt
|-
| rte || Unterstützt
|}

==Hinweise==
===options_callback===
Im Beispiel oben wird für das Select Feld ein Optionsliste direkt definiert über 'options'. Das geht auch über 'options_callback'. Im Gegensatz zum Core wird der Methode jedoch kein Datacontainer $dc übermittelt.

Beispiel für eine Liste abhängig von der Contao Version: 
<source lang="php">
'ts_client_os' => array
(
'label' => &$GLOBALS['TL_LANG']['tl_theme']['ts_client_os'],
'exclude' => true,
'inputType' => 'select',
'options_callback' => array('tl_theme', 'getOptions'),
'eval' => array('style' => 'width:250px', 'includeBlankOption'=>true, 'chosen'=>true)
),
</source>

Nun wie üblich im DCA die Klasse mit der Methode: 
<source lang="php">
class tl_theme extends Backend
{
/**
* Return options
* @return array
*/
public function getOptions()
{
$arrOptions = array(
'option1' => 'Option 1',
'option2' => 'Option 2',
'option3' => 'Option 3',
);
//option3 not in Contao 2.10
if (version_compare(VERSION, '2.11', '<'))
{
$arrOptions = array(
'option1' => 'Option 1',
'option2' => 'Option 2',
);
}
return $arrOptions;
}
}
</source>

Contao Community Documentation - Benutzerbeiträge [de]

MultiColumnWizard