sekFormTools.input.combobox

What is input.combobox?¶

Add a combobox to a form quickly and easily using this snippet.

Usage¶

Example for input.combobox using a value list:

[[input.combobox? &value_list=`[{ "value": "r", "label": "Red" }, { "value": "b", "label": "Blue" }]`]]

Example for input.combobox using an object:

[[input.combobox? &object=`[{"name": "sekftStates", "sortby": "state_name", "value": "state_abbr", "label": "state_name"}]`]]

Properties¶

object¶

The object property has several parts to quickly define combo box options from a modx table.

filter¶

The filter property has several parts to filter the data returned by the object property.

Examples¶

Some additional examples

Value List¶

The simplest way to create a quick combo box.

[[!input.combobox? &value_list=`[
{ "value": "101", "label": "Regular" },
{ "value": "102", "label": "Chocolate" },
{ "value": "103", "label": "Blueberry" },
{ "value": "104", "label": "Devil's Food"}
]`
]]

Object¶

Grabbing data by a table object is simple and straight forward. Using a json string, enter the name of the object, the optional sort by, and the table fields to use in the combo box options label and value.

[[!input.combobox?
    &object=`{"name": "sekftUSCities", "sortby": "city_name", "value": "city_name", "label": "city_name"}`
]]

You can even filter the data by using the filter option. Here we just want to grab all the cities with the state id of 62, which in this case is Kansas.

[[!input.combobox?
    &object=`{"name": "sekftUSCities", "sortby": "city_name", "value": "city_name", "label": "city_name"}`
    &filter=`{"field": "state_id", "value": "62"}`
]]

We can also filter the combo box using xpdo's powerful relational filters. Here we use the filter->name field to grab the states table. The field we filter on is the abbreviation, and the value we want to filter "KS". XPDO will then do the work by finding the relationship between the two tables ( the "id" of the states table and the "state_id" field of the city table ) and return the filtered list by state.

[[!input.combobox?
    &object=`{"name": "sekftUSCities", "sortby": "city_name", "value": "city_name", "label": "city_name"}`
    &filter=`{"name": "sekftStates", "field": "state_abbr", "value": "KS"}`
]]

The combo box can also be filter live using jquery. please view the Advanced Examples for more information.

Snippet¶

If more advanced filters are needed, a custom snippet can be called to fill the combo box.

[[!input.combobox? &snippet=`xpdo`]]

The snippet must must return a json array.

$items = $modx->getCollection('sekftStates');
$itemListArray = array();
foreach ($items as $item) {
    $itemArray = $item->toArray();
    $itemList = array();
    $itemList['value'] = $itemArray['id'];
    $itemList['label'] = $itemArray['state_name'];
    $itemListArray[] = $itemList;
}
return $modx->toJSON($itemListArray);

Similarly, a large list of values can be placed in an array within a snippet.

[[!input.combobox? &snippet=`array`]]

The snippet must must return a json array.

$itemListArray = array(
    array(
        'value' => '1',
        'label' => 'One'
    ),
    array(
        'value' => '2',
        'label' => 'Two'
    ),
    array(
        'value' => '3',
        'label' => 'Three'
    ),
    array(
        'value' => '4',
        'label' => 'Four'
    )
);
return $modx->toJSON($itemListArray);