Jump to content

Fieldtype Select External Option


Recommended Posts

Get the last version:

From the first view a simple select dropdown Fieldtype. But what is different?
Rather than the option field in the modul settings you will find some setting fields to define a source (datatable or field) from where you can pull the options (value and label).

I found this very useful when I had to put 250 options in a select field (which I provide in frontend too) and needed this connected and congruent to another more complex table. So now I can make changes in the main table and the select field will take over these changes.

You can define the following in the settings:

  • datatable
  • tablecolumn for (value) should be integer
  • tablecolumn for (label)
  • dependance (value or label)
  • order ascending or descending

Here we go:
(updated 10.03.15 Version 1.0.2 with Multiselect Option)
(updated 11.03.15 Version 1.0.3 with Select Inputfields in Settings)

Edited by kixe
added links to github and modules directory
  • Like 7
Link to comment
Share on other sites

Very cool - definitely has some similarities with: https://processwire.com/talk/topic/8803-module-fieldtypeselectrelation/ but the ability to draw from any type of DB table is super cool and really flexible - I love it and can see several uses for it already :)

Any thoughts of making it support ASM multiselect?

This could then replace http://modules.processwire.com/modules/fieldtype-templates/ and https://processwire.com/talk/topic/9167-create-a-field-for-selecting-fields/?p=88679

  • Like 2
Link to comment
Share on other sites

Awesome to have the multi options.

A couple of things. 

  • Instances of page_id should be pages_id
  • Are the defaults supposed to work if not entered? They don't seem to - even if I change $value = 'page_id' to $value = 'pages_id' in the getExtOptions function, it still gives me "Column doesn't exist in table"
  • With this new version I am getting "TemplateFile: SQLSTATE[42S22]: Column not found: 1054 Unknown column 'sort' in 'order clause'
Link to comment
Share on other sites


Thanks for this...

Do you have the project somewhere on Github?

Just an observation: In your $db query, Although you are properly escaping and sanitizing values, maybe you should consider using prepared statements too?

  • Like 1
Link to comment
Share on other sites

Thanks for your help.

  • Yes it should be 'pages_id'. Anyway it was ment more like a placeholder. Maybe I will leave it out.
  • Yes in general the defaults should work. :)  I will check this.
  • It was a bit tricky to prevent from SQL Error exception, but I solved this with checking against an array of column names.
    And this beautiful API: $this->db->getTables()
  • You receive this SQL Error maybe if you didn't deleted the field where you have set the fieldtype. Since the module extends FieldtypeMulti the DatabaseSchema has changed. You should solve this by creating a new field. Tell me if it is working then.

thanks for your post.

  • Like 1
Link to comment
Share on other sites

Aah...how could I miss that :-), thanks.

As for prepared statements, here's a couple of posts. 




You can also grep 'prepare' in core files to see how Ryan does it. You can also have a look in my Matrix module.

Link to comment
Share on other sites

You receive this SQL Error maybe if you didn't deleted the field where you have set the fieldtype. Since the module extends FieldtypeMulti the DatabaseSchema has changed. You should solve this by creating a new field. Tell me if it is working then.


That fixed it!


Everything seems to be working again now - just a pesky notice:

Notice: Object of class WireArray could not be converted to int in /site/modules/FieldtypeSelectExtOption/FieldtypeSelectExtOption.module on line 105

Link to comment
Share on other sites

Awesome enhancements - this is very cool!

Still getting one notice:

Notice: Undefined variable: v in /site/modules/FieldtypeSelectExtOption/FieldtypeSelectExtOption.module on line 109

Can I make one suggestion - if the option label field is blank, could the label use the value field?

PS Is there any reason for the "type (int)" part of this description "Choose a column of type (int)." ? Why can't I use a text field? I am guessing it is just suggestion, and while it is generally a good idea, there are often reasons this is not convenient.

Link to comment
Share on other sites


many thanks for your interest and help. I pushed Version 1.0.4 on github and a readme.md too. Should work stable now.

your remarks

  • I forgot to define an array. Its done.
  • Your suggestion:
    I disabled a preselection but field defaults of 'Option Value' and 'Option Table' are for both the first column of the selected table even if nothing is selected.
  • Yes there is a reason. The Class extends FieldtypeMulti. In the Database Schema of FieldtypeMulti values are defined as type (int). I don't want to change this. One of the intention I had when I started was to store the values as slim as possible. Now it is easy to create any database table with more than 2 columns to process the input in the way you want it. No need to run in problems by changing the database schema.
Link to comment
Share on other sites

Now another new notice:

Notice: Undefined index: option_table in /site/modules/FieldtypeSelectExtOption/FieldtypeSelectExtOption.module on line 145

You really need to turn on debug mode, or at least check your php error log :)

I see why you went with integers for the value - it makes sense to stay with the schema of FieldtypeMulti - I hadn't thought of that. But when using a non-PW DB table, when outputting the label of the selected value on the front end of your website, how are you going to get the value you want to display? This will require an SQL query to retrieve, right? For some devs this is no problem, but for others it may be too technical. Do you think you could include a method for rendering the label on the front end, based on the stored value?

I am thinking that you should be able to do:

echo $page->selectextoption;

and get the label of the selected value, rather than the stored value. What do you think?

Link to comment
Share on other sites

Stupid me. I turned on debug mode in wire instead of site folder. :P

For my use it is enough because I need only a unique ID for further processing. But in general you are completely right. There should be an api variable to get both value and label from external tables. I will try to solve this.

Access tables depending to PW is easy. For example if you choose 'templates' as source table the API is like:


Returns a string if InputfieldSelect in use and array for InputfieldAsmSelect and InputfieldSelectMultiple.

  • Like 1
Link to comment
Share on other sites

Yep - I see that it totally works with PW tables. Thanks for looking into an option for non PW tables.

I am actually wondering if you might be able to do something like:


and be able to return the value from any field (column) for the row that contains the selected integer ID value? This could work with both PW and non PW tables. Some examples of what you could return with this.

PW fields table:

$page->selectextoption->id = 1
$page->selectextoption->name = title
$page->selectextoption->label = Title
$page->selectextoption->flags = 13

a non PW table (maybe a list of country codes):

$page->selectextoption->num_code = 276
$page->selectextoption->iso3 = DEU
$page->selectextoption->name = Germany

I think this would be much more powerful than just returning the value and label fields.

I think it might also be nice to be able to magically return the selected value and label without knowing what the fields are, so:

$page->selectextoption = 1
$page->selectextoption->selectedLabel = Title (assuming the field I chose for the label was the title field)

Of course you can't use "Label" in this last example because "Label" is a field name in some PW tables, hence my use of "selectedLabel", but there might be a better option. Does that make sense?

Thanks for your hard work on this - it's going to be very useful!

  • Like 1
Link to comment
Share on other sites

Ups, this looks strange  $page->selectextoption returns always the fields value (string or array in case of InputfieldAsmSelect and InputfieldSelectMultiple). I cannot follow. ???

I found another solution to access all values of all columns of the source table depending on the field value ($page->selectextoption) label included.

Use the following API

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

// will find the first or only field of type SelectExtOption in your page

// will find a specific field of type SelectExtOption in your page, useful if more than one field of same type in template

// will find a specific field of type SelectExtOption in a page found by selector string

// will find the first or only field of type SelectExtOption in a page found by selector string

Output will be an Array with the stored value like ($page->selectextoption) as key and whole information about the row in the databasetable belonging to this value.

Field Settings

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

Selected Values in Frontend

  • 'admin'
  • 'user'


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)

Does this help? It is working already. I will check a little bit and than upload to github.

New Version on github.

Edited by kixe
Link to comment
Share on other sites

Hey kixe - thanks for making progress on this. Maybe my example was confusing? When I wrote: $page->selectextoption, the "selectextoption" in my example is the name of my field.

I am not sure how your new code works, and I don't have much time today, but perhaps you can get some ideas from:

https://github.com/somatonic/FieldtypeDimension/blob/master/FieldtypeDimension.module or https://github.com/adrianbj/FieldtypePhone/blob/master/FieldtypePhone.module

or ProFields Table if you have access to it.

Then again it's early here and I need to get back to work so maybe I am not sure exactly how your new setup works.

Link to comment
Share on other sites

For single values ok, but what do you recommend in case of multiple values? Like this?

$page->selectextoption->3->id = 1
$page->selectextoption->3->name = title
$page->selectextoption->3->label = Title
$page->selectextoption->3->flags = 13

$page->selectextoption->29->id = 1
$page->selectextoption->29->name = title
$page->selectextoption->29->label = Title
$page->selectextoption->29->flags = 13

For now I prefer this

$data = $modules->get('FieldtypeSelectExtOption')->row(null,'id=245');

$data['29']['country'] = Germany
Link to comment
Share on other sites

I think I am maybe confused, but shouldn't it behave like other PW muilti fieldtypes. That is, you should be able to do:

foreach ($page->selectextoption as $selectedoption) {
    echo $selectedoption->id //returns 1
    echo $selectedoption->name // returns title



I don't really understand why you need to look up $data['29']. I am assuming 29 is the integer that has been stored and is what $page->selectextoption would currently return if using a single select field. In the case of a single one you would just return the corresponding db fields as properties of the field, like my example a couple of posts above. If it's a multi-select field, then it should return an array of results that you can foreach through or grab a specific index (first, eq, last).

Am I missing something?

Link to comment
Share on other sites

Adrian, thanks a lot for your interest and your comments.

$page->selectextoption = 1
$page->selectextoption->selectedLabel = Title (assuming the field I chose for the label was the title field)

I was a little bit confused about that. If selectextoption is a instance of WireData or any Helper Class how could this work?

Thanks for the hints with FieldtypeDimension and FieldtypePhone.
I find it a bit tricky to instantiate class objects with flexible properties. I will try. I am thinking about the following, depending on your recommendation.

// selectextoption is the name of our field

$page->selectextoption // returns WireData Object
$page->selectextoption->value // returns the stored integer value
$page->selectextoption->label // returns the label value

// to prevent a conflict between 'label' and a column in the datatable named 'label'
$page->selectextoption->data // returns array(columnname => rowvalue) of the datatable
// or better a class
$page->selectextoption->data->columnname // whereas columnname presents the name of any column in the datatable

What do you think?
I will put a dev branch on github for further development. But weekend first ...

Link to comment
Share on other sites

pushed Version 1.0.6 on github dev-branch.
Works now with the API Adrian recommended:

for single values
//selected value (int)
// selected label
// associative array with column => value of depending datatable row

muliple values can be called with WireArray API

To prevent conflicts with datatable column names like 'data' I decided to access the values via $page->myfield->row['data'] instead of $page->myfield->data. 'data' is an reserved property of  the WireData object.

Please check out and comment. Thanks

  • Like 3
Link to comment
Share on other sites

This is getting cooler and cooler :)

A few more comments / suggestions.

In ASM Select mode, everything seems to be working fine, but I am getting this notice:

Warning: Invalid argument supplied for foreach() in //site/modules/FieldtypeSelectExtOption/FieldtypeSelectExtOption.module on line 312

You should probable change your DB queries to use PDO and prepared statements. Here is a note from Ryan (https://processwire.com/talk/topic/3768-processwire-dev-branch/?p=36787) - at some point  procedural mysqli functions will no longer be supported - I am not sure when, but better to be ahead of things (I know there lots of modules out there that need updating).

The $page->myfield->row['land'] approach seems to work just fine. It's a shame it won't work as $page->myfield->land, but I as you mentioned, I guess the issue is $page->myfield->data, which would be a common requirement.

I haven't time to investigate right now to see if I can find a workaround, but I don't think it really matters - what you have is easy to use and an awesome way to access data from all sorts of DB tables - brilliant!

  • Like 3
Link to comment
Share on other sites

Unfortunately this latest version results in nothing being saved for the field value, no matter whether I use single, multiple, or ASM :(

Some more new thoughts:

  • I think you need that note back that mentions that you need to save the page to populate the options dropdowns.
  • I'd love to see checkboxes and radio buttons added as Inputfieldtype options.

Thanks again for working on this!

Link to comment
Share on other sites

Adrian, thanks for your remarks and help to push this forward.

  • It doesn't work in the latest devs. It works until 2.5.16. not later! No problem with master 2.5.3. There are changes in InputfieldSelect.module where I hook in.
    The new setAttribute() method converts object values to string. I try to get a solution. Maybe Ryan should check this too.
    Edit 20-03-15: added PW Version Switcher to enable hook for older versions on dev branch.
  • I thought about adding a Javascript which will save the page after the datatable is selected. Maybe a note is enough for now.
  • I put this on the list. List is getting longer.... Hey you gave me a lot of homework. :P
Edited by kixe
  • Like 1
Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Similar Content

    • By Sebi
      AppApiFile adds the /file endpoint to the AppApi routes definition. Makes it possible to query files via the api. 
      This module relies on the base module AppApi, which must be installed before AppApiFile can do its work.
      You can access all files that are uploaded at any ProcessWire page. Call api/file/route/in/pagetree?file=test.jpg to access a page via its route in the page tree. Alternatively you can call api/file/4242?file=test.jpg (e.g.,) to access a page by its id. The module will make sure that the page is accessible by the active user.
      The GET-param "file" defines the basename of the file which you want to get.
      The following GET-params (optional) can be used to manipulate an image:
      width height maxwidth maxheight cropX cropY Use GET-Param format=base64 to receive the file in base64 format.
    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.

      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

    • By tcnet
      Session Viewer is a module for ProcessWire to list session files and display session data. This module is helpful to display the session data of a specific session or to kick out a logged in user by simply delete his session file. After installation the module is available in the Setup menu.

      The following conditions must be met for the module to work properly:
      Session files
      Session data must be stored in session files, which is the default way in ProcessWire. Sessions stored in the database are not supported by this module. The path to the directory where the session files are stored must be declared in the ProcessWire configuration which is by default: site/assets/sessions.
      Serialize handler
      In order to transform session data easier back to a PHP array, the session data is stored serialized. PHP offers a way to declare a custom serialize handler. This module supports only the default serialize handlers: php, php_binary and php_serialize. WDDX was dropped in PHP 7.4.0 and is therefore not supported by this module as well as any other custom serialize handler. Which serialize handler is actually used you can find out in the module configuration which is available under Modules=>Configure=>SessionViewer.

      Session data
      The session data can be displayed in two different ways. PHP's default output for arrays print_r() or by default for this module nice_r() offered on github: https://github.com/uuf6429/nice_r. There is a setting in the module configuration if someone prefers print_r(). Apart from the better handling and overview of the folded session data the output of nice_r() looks indeed nicer.

      ProcessWire module directory
  • Create New...