MultiSelectWizard
Aus Contao Community Documentation
Erweiterungs-Übersicht | |
---|---|
Name des Entwicklers | Yanick Witschi |
Entwickler Webseite | http://www.certo-net.ch |
Version der Erweiterung | 1.1.0 |
Kompatibilität mit Contao Version | 2.9.0 - 2.9.3 |
Kompatibilität mit TYPOlight Version | 2.7.0 - 2.8.4 |
Link zum Extension Repository | http://www.contao.org/erweiterungsliste/view/MultiSelectWizard.html |
Link zum Tracker | http://contao-forge.org/projects/multiselectwizard |
Dieses Widget ist dafür gedacht, mehrere Select-Inputs untereinander zu definieren.
Das Widget ist eigentlich das gleiche wie der MultiTextWizard, jedoch mit Dropdown-Feldern.
Inhaltsverzeichnis
Aussehen
Das Modul sieht haargenau gleich aus wie der ModuleWizard vom Contao-Core. Das Problem bei diesem Wizard ist nur, dass die Quellen alle hardgecodet sind und es deshalb für Drittentwickler unbrauchbar ist.
Verwendung
Es gibt zwei Verwendungsmöglichkeiten. Entweder direkt mit der Angabe von "columnsData" im "eval"-Array oder mit einem Callback.
Angabe mit columnsData
$GLOBALS['TL_DCA']['tl_table']['fields']['anything'] = array ( 'label' => &$GLOBALS['TL_LANG']['tl_table']['anything'], 'exclude' => true, 'inputType' => 'multiSelectWizard', 'eval' => array ( 'mandatory'=>true, 'columnsData'=> array ( 'columns' => array ( 'key' => 'language', 'label' => $GLOBALS['TL_LANG']['MSC']['mylanguagelabel'], 'source' => $this->getLanguages(), 'style' => 'width:200px' ), array ( 'key' => 'secondcolumn', 'label' => $GLOBALS['TL_LANG']['MSC']['secondcolumn'], 'source' => array ( 'option1' => $GLOBALS['TL_LANG']['MSC']['option1'], 'option2' => $GLOBALS['TL_LANG']['MSC']['option2'], 'option3' => $GLOBALS['TL_LANG']['MSC']['option3'] ), 'style' => 'width:100px' ), array ( 'key' => 'columnwithforeignkey', 'label' => $GLOBALS['TL_LANG']['MSC']['columnwithforeignkey'], 'source' => 'tl_table.column' ) ) ) );
Angabe mit Callback
$GLOBALS['TL_DCA']['tl_table']['fields']['anything'] = array ( 'label' => &$GLOBALS['TL_LANG']['tl_table']['anything'], 'exclude' => true, 'inputType' => 'multiSelectWizard', 'eval' => array('mandatory'=>true,'columnsCallback'=>array('Class', 'Method')) );
Wobei natürlich der Return-Wert genau das selbe Array sein muss, wie bei der "columnsData"-Variante.
Javascript-Fallback
Falls kein Javascript vorhanden ist, werden die Modifikationen (hinzufügen, löschen etc.) manuell ausgeführt. Viele Widgets führen dabei eine Datenbankoperation aus, was zwar in 99.9% aller Fälle korrekt ist, jedoch gibt es auch Ausnahmen, wie z.B. die Speicherung in der localconfig.php. Der MultiSelectWizard unterstützt sowohl die localconfig.php als auch eine beliebige Routine, welche per Callback definiert werden kann.
localconfig.php
'eval' => array('storeInLocalConfig'=>true)
Beliebige Routine
'eval' => array('storeCallback'=>array('MyClass','MyMethod'))
class MyClass extends Backend { public function MyMethod($objWidget) { } }
Helper Methoden
In der Erweiterung wurden auch Helper-Methoden eingebaut, die man verwenden kann.
getByKey
Die einfachere Methode ist mittels MultiSelectWizard::getByKey($strSerialized, $strKey)
. Einfach den serialisierten Wert aus der Datenbank plus den gewünschten Key mitgeben (im obigen Beispiel z.B. "language") und man bekommt ein aggregiertes Array mit allen Werten von dieser Spalte.
$arrLanguages = MultiSelectWizard::getByKey($obj->myField, 'language');
getFilteredByKey (AND Verknüpfung)
Die etwas kompliziertere Methode ist mit MultiSelectWizard::getFilteredByKey($strSerialized, $strKey, $arrAnotherKey)
. Der Anfang ist genau gleich: Man übergibt einen serialisierter Wert und Key. Dann kommt ein Array, mit dessen Hilfe man Return-Werte filtern kann.
Wenn man also alle Sprachen möchte, die in der "secondcolumn" den Wert "option2" haben, nutzt man die Methode wie folgt:
$arrLanguagesOption2 = MultiSelectWizard::getFilteredByKey($obj->myField, 'language', array('secondcolumn'=>'option2'));
Selbstverständlich kann man auch mehrere Filterangaben mitgeben. Einfach immer im Stil von "column_key" => "source_value". Als Rückgabe erhält man nur diejenigen Werte, die mit allen Filterparametern übereinstimmen.