FieldtypeSelectExtOption by kixe

Fieldtype which generates the options for a Select Inputfield from any table of any (accessible) database. Define the source table, columns (to pull value & label) and the preferred Inputfieldtype (Select, Radios, Checkboxes SelectMultiple or ASMSelect) in field settings. Access to all values in the corresponding row of the source table via API. Frontend safe.

FIELDTYPE SELECT EXTERNAL OPTION

Fieldtype which generates the options for a Select Inputfield from any MYSQL table in any (accessible) database. Define the source table, columns (to pull value & label) and the preferred Inputfieldtype (Select, Radios, Checkboxes SelectMultiple or ASMSelect) in field settings. Access to all values in the corresponding row of the source table via API.

Create a new field


  • Step 1: Create a new field select fieldtype SelectExtOption.
  • Step 2: Define options under tab Details
  • Step 3: Save. Done!

Settings


Screenshot

Inputfieldtype

Fieldtype SelectExtOption is compatible with the following Inputfieldtypes. You maybe need to adapt InputfieldPage to make all the options available.

  • InputfieldSelect
  • InputfieldRadios
  • InputfieldCheckboxes
  • InputfieldSelectMultiple
  • InputfieldAsmSelect
  • InputfieldToggle

Note:
- InputfieldToggle requires always a value.
- InputfieldAsmSelect selections are sortable.
- 3d party modules maybe supported too.
Read more ...

Source Table

Choose any datatable in the database including those which are not depending to Processwire. required.

Option Value

Select a column of the source datatable to get the value for the option tag.
Only Integer types allowed. (This Class extends FieldtypeMulti which stores values as int(11).)
Default column or column if not selected is always the first column of the table.
<option value="Option Value" > ...

*note: Option will overwrite the preceding option with same value while generating the select. Unique values recommended.*

Option Label

Select a column of the source datatable to get the label for the option tag.
<option>Option Label</option>
All types allowed. Default label or label if not selected same as Option Value.

Filter

Small Filter to limit the options if needed. Adds a WHERE condition to the SELECT statement which pulls the options from the datatable. Function filter() is hookable.

Order by Label

Options are ordered by Option Label. Select to order by any other column.

Order Descending

Order is Ascending by default. Check to switch to Descending


API


Return field value

$page->[fieldname]

By default you get the value. A value from another column can be selected in the field settings.

$page->[fieldname]->[property]

All column values are populated as a property (columnname) except values of columns named with reserved words ('label', 'value', 'row', 'options' and 'data').


/**
 * single values (InputfieldSelect)
 * @return SelectExtOption Object (extended WireData Object)
 *
 **/

$page->myfield->value
$page->myfield->label
$page->myfield->row // assoc array (columnname => value) of all values of the selected datatablerow
$page->myfield->options // assoc array (value => label) of all selectable options
$page->myfield->columnname-1
$page->myfield->columnname-2 // ...

/**
 * muliple values (InputfiedSelectMultiple, InputfieldAsmSelect)
 * @return WireArray Object with SelectExtOption elements for each single value like above
 *
 **/

// Usage Examples
$page->myfield->last()->row['land'] // value of column 'land' of last selected item
$page->myfield->first()->row['id']
$page->myfield->eq(3)->value // integer value of 4th item in array of selected items
$page->myfield->each('pages_id') // array of value of column 'pages\_id' of each item

note: to get the value of a column named by reserved word use the row property, like $page->myfield->row['data']

Set a field value via API


/* Inputfieldtype Select */
$page->of(false);
$page->myfield->value = 3;
$page->save('myfield');


/* Inputfieldtype SelectMultiple (add a single value) */
$v = new SelectExtOption;
$v->value = 3;
$page->of(false);
$page->myfield->add($v);
$page->save('myfield');


/* Inputfieldtype Select/SelectMultiple. Will replace existing values */
$page->of(false);
$page->myfield = array(3,7,9); // Example Values
$page->save('myfield');

note: trying to set a not existing value will be ignored

Public module functions options() and row()


// call the module
$getdata = $modules->get('FieldtypeSelectExtOption');

// return array of all possible value/ label pairs version >= 1.1.6
$getdata->options('selector'); // selector = field-name, field-id or field-instance

// find value(s) of the first or only field of type SelectExtOption in current page
$getdata->row();

// find value(s) of a specific field of type SelectExtOption in current page, useful if more than one of same type
$getdata->row('myfield');

// find value(s) of a specific field of type SelectExtOption in a page found by selector string
$getdata->row('myfield','selectorstring');

// find value(s) of the first or only field of type SelectExtOption in a page found by selector string
$getdata->row(null,'selectorstring');

Function row() will return a MultipleArray with the stored value(s) as key.

Example

Field Settings

  • Inputfieldtype = 'InputfieldAsmSelect'
  • Source Table = 'pages'
  • Option Value = 'id'
  • Option Label = 'name'

Selected Values in Frontend

  • 'admin'
  • 'user'

Code

$getdata = $modules->get('FieldtypeSelectExtOption');
$getdata->row();

Output


array (size=2)
  2 =>
    array (size=10)
      'id' => string '2' (length=1)
      'parent_id' => string '1' (length=1)
      'templates_id' => string '2' (length=1)
      'name' => string 'admin' (length=5)
      'status' => string '1035' (length=4)
      'modified' => string '2015-01-29 06:37:43' (length=19)
      'modified_users_id' => string '41' (length=2)
      'created' => string '0000-00-00 00:00:00' (length=19)
      'created_users_id' => string '2' (length=1)
      'sort' => string '15' (length=2)
  29 =>
    array (size=10)
      'id' => string '29' (length=2)
      'parent_id' => string '28' (length=2)
      'templates_id' => string '2' (length=1)
      'name' => string 'users' (length=5)
      'status' => string '29' (length=2)
      'modified' => string '2011-04-05 00:39:08' (length=19)
      'modified_users_id' => string '41' (length=2)
      'created' => string '2011-03-19 19:15:29' (length=19)
      'created_users_id' => string '2' (length=1)
      'sort' => string '0' (length=1)

Developers Note


3d party Inputfieldtypes are supported too, if they are subclasses of InputfieldSelect. Furthermore they should be added in settings of InputfieldPage module. No guarantees that these Inputfieldtypes will work as expected.
Please test carefully.
Working example: InputfieldChosenSelect.

InputfieldSelectMultipleTransfer will be supported after removing the '>' in the selector string of javascript file. (Line 3 and 19 InputfieldSelectMultipleTransfer.js)


License


GNU-GPLv3

Author


kixe (Christoph Thelen)

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #384
    In the 384th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new module called Session Allow, and highlight a new site of the week. Read on!
    Weekly.pw / 18 September 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK