Jump to content

Fieldtype Select External Option


Recommended Posts

last update

  • switched from Mysqli to PDO
  • all Inputfields available in all PW versions 2.5.0 and higher (Radios and Checkboxes incl.)
  • Filter added
  • Like 4
Link to post
Share on other sites

Awesome update!

I just played around with automatically detecting all available and compatible Inputfield types: https://github.com/adrianbj/FieldtypeSelectExtOption

It works great with all the standard ones as well as other 3rd party ones like InputfieldChosenSelect

I was hoping it might also with with Autocomplete and SelectMultipleTransfer but autocomplete doesn't have an AddOption method and InputfieldSelectMultipleTransfer doesn't style properly, but I haven't looked into fully to find out the issue.

I have restricted the Inputfieldtype options to exclude those which are a subclass of InputfieldPageListSelection (becaue these don't work at all), those that don't have an addOption method, and then specifically InputfieldSelectMultipleTransfer, although I'd like to figure out a better way of detecting the reason this one doesn't work so it could also match others than won't work.

If you want to take a look at my changes, please feel free to incorporate, or if you want, I can send you a PR. 

Perhaps it would be worthwhile adding a note under the Inputfield selector saying that there are no guarantees that all the Inputfields will work as expected and the user should test carefully.

  • Like 2
Link to post
Share on other sites

quick look
InputfieldPageListSelect and Autocomplete are subclasses of Inputfield and not InputfieldSelect. Maybe its good to restrict the selectable Inputfields to all subclasses of InputfieldSelect, which includes the method addOption() too. Furthermore render() method should be hookable.

Everything else is more on the side of Inputfield Developers. :)

Thanks again

  • Like 1
Link to post
Share on other sites

I took most parts of your code and implemented it. It works.
InputfieldSelectMultipleTransfer expects item-content class 'InputfieldSelectMultipleTransfer', which is not rendered. tested with InputfieldWrapper. It would be great if the developer could change this and make the module flexible like InputfieldChosenSelect. I like also install method in this one, which adds the module to InputfieldPage settings otherwise it should be done by hand.

Thanks a lot for your support.
 
 

  • Like 2
Link to post
Share on other sites
  • 1 month later...

Hi, I installed this module on 2.5.25 version and as soon as I tried to create a new field I got the following error. Any ideas?

Error: Using $this when not in object context (line 112 of /home/maloco15/public_html/site/modules/FieldtypeSelectExtOption/FieldtypeSelectExtOption.module)
This error message was shown because you are logged in as a Superuser. Error has been logged

  • Like 1
Link to post
Share on other sites
  • 4 weeks later...

With the API and SQL or a selector string I'd like to specify a subset of the records in the database table used by the field and set the field's selection to that set of records. How do I do that?

Link to post
Share on other sites

You don't need the API for that. There is a filter option under the details tab. With the filter you can create a WHERE clause. Example: Lets say you have a database table with an inttype column 'gender' (0=male, 1=female). You want only females as selectable options. Go to the Filter settings select 'gender' for column, the equal operator and 1 as value. Done.

Link to post
Share on other sites

Yes but I want to change the available options automatically depending on various conditions which change from time to time.

EDIT:

Maybe there's a way I can modify the module's filter method so I can change the filtering dynamically. Then when building a form I could setup the filter before calling getInputfield(Page $page, Field $field) and the user would see only those options.

Putting this at the top of the filter method is a good start:

		$attr = 'optionFilter_'.$field->name;
		if(!empty($page->$attr)){
			$field->filter_column = $page->$attr->filter_column;
			$field->filter_selector = $page->$attr->filter_selector;
			$field->filter_value = $page->$attr->filter_value;
		}
Link to post
Share on other sites

If I understand you right you would like to render the field via API and manipulate some field properties (filter_column, filter_selector and filter_value).
Following code should work. (not tested)

$fieldtype = $modules->get('FieldtypeSelectExtOption');
$field = $fields->get(123); // 123 is the id of the field you have assigned to your page template

// set your filter options 
$field->filter_column = 'id';
$field->filter_selector = '<';
$field->filter_value = 3;

$inputfield = $fieldtype->getInputfield($page, $field);
echo $inputfield->render();
Link to post
Share on other sites

Yes, that's pretty much what I did. At the time I thought I might like storing filter options as an attribute of the $page. We'll see.

This is working fine:

$fid = $fields->get($fieldname)->id;     //get the field id
$field = $fields->get($fid);    //this is what we need to set filter settings
(then like your example above)
 

Link to post
Share on other sites
  • 1 month later...

@kixe: I'm seeing a potential issue with this module. Using this in combination with InputfieldSelect everything else works, but the inputfield won't display the selected option as selected, so saving the page again I always end up with the first available option selected  :)

InputfieldSelect checks the string value of field to determine if current item should get 'selected="selected"', and since the string value will always be "SelectExtOption" (name of the class), this won't work at all. I've solved this locally by adding a __toString() method to the SelectExtOption class:

    public function __toString() {
	return (string) $this->value;
    }

Is there something I'm missing here? :)

For the record, using latest dev version of ProcessWire (2.6.9).

Link to post
Share on other sites

@teppo
I couldn't reproduce this using pw 2.6.10 and Modules Version 1.1.2.
The sleep value is always an integer. In the field settings you can only select integer columns with unique values to populate the option values of your selectfield.

Could you tell me some more details to reproduce your problem. Maybe an example of your database table (column settings) you took to populate the selectable options and field settings too? Thanks.

Link to post
Share on other sites

@kixe: I'll try to set up a clean test case and/or a screencast later, probably easier to explain that way.

To summarise, it looks like we're talking about different things here, since sleepValue() shouldn't have anything to do with my issue. The problem isn't saving broken/malformed values to database (which, to my best knowledge, is where sleepValue() steps in), it's about InputfieldSelect not being able to add "selected='selected'" to the selected option, and the field value reverting to the value of the first option available is simply a result of that :)

Link to post
Share on other sites
  • 1 month later...

I've got a small problem with this module. I created a new field in the backend with this new fieldtype, select a table and put the new field into the template. No problems. When I edit the page, I saw the values, I could select one or more and save the page. But the second time I want to edit the page, the choosen data won't be displayed as selected or choosen like in normal select fields. The choosen values stored correctly in the database, that's not the problem. Maybe someone got an idea to solve this? :)

Link to post
Share on other sites

welcome dsdb,
some values are selected but not all? in this case check if each value of the column you have choosen for your option values is unique. If not, some options will be overwritten by the preceding same option value.

If this doesn't help, could you please post a part or example of your source database table? and or a screenshot of your field? Which settings did you choose?

Link to post
Share on other sites

Hi kixe!

Here is the structure of my custom table:

CREATE TABLE IF NOT EXISTS `t_fsk` (
  `id_fsk` int(11) NOT NULL AUTO_INCREMENT,
  `f_fsk_value` int(11) NOT NULL,
  `f_fsk` varchar(200) NOT NULL,
  PRIMARY KEY (`id_fsk`)
) ENGINE=InnoDB  DEFAULT CHARSET=latin1 AUTO_INCREMENT=6 ;

I used the field "f_fsk_value" (values are; 1,2,3,4,5,6) as "option value" and the field "f_fsk" as "option label". My selection will stored correctly into

the database but when I try to edit the page a second time, the selection I made before isn't displayed. I tried the select and selectMulitple Option. Both of

them with the same result. May you have an idea to solve this problem?

  • Like 1
Link to post
Share on other sites

@dsdb
thanks for reporting this. It looks similar to teppos problem, which I couldn't reproduce in my surrounding. I don't have the time now. I will have a deeper look asap.
If there is anybody out there. Help is welcome. :)

Link to post
Share on other sites

Update to Version 1.1.3 (dev)
Download from github https://github.com/kixe/FieldtypeSelectExtOption/tree/dev

Changes

  • hook in Inputfield render() replaced by adding magic toString() method to SelectExtOption class (which helped teppo and dsdb) @Teppo Thanks! :)
  • filter() method is now hookable to define more complex SQL WHERE clauses.
  • whole usage description available in module settings.
  • from now all column values are populated as a property if the column is not named by a reserved word. Reserved words are: 'value','label','row' and 'data'.
$page->myfield->value
$page->myfield->label
$page->myfield->row // associative array of all values of the selected datatablerow
$page->myfield->columnname-1
$page->myfield->columnname-2 // ...

I tested the Module with PW 2.6.17. Please give me feedback if the module works in your surroundings.

  • Like 2
Link to post
Share on other sites

Thanks kixe for this awesome module. ^-^

I am new to ProcessWire. I am using this module to make a tagging system and I have a stupid question.

I have two templates, "news" and "news_detail". "news_detail" contains the Select External Option field named "tag" with some option tags which come from the input of other pages, while "news" page display all "news_detail" pages with the tags.

For some reasons I want to have the array of "tag" value.

$news = $pages->find("template=news_detail");
foreach($news as $n) {
  $tag = $n->tag; //echo this gives SelectExternalOption|SelectExternalOption|SelectExternalOption
  $arr = [];
  foreach($tags as $tag){
  $arr[] = $tag->row['data'];
  } 
...

I think it is not the correct way to do so. I tried 

$arr = $n->tag->row['data'];

But this outputs nothing. Any clean way to achieve that?

Link to post
Share on other sites

@starter welcome first!

$news = $pages->find("template=news_detail");
$arr = array();
foreach($news as $n) {
  $tags = $n->tag; // <- TYPO CORRECTED
  foreach($tags as $tag){
  $arr[] = $tag->row['data']; // will fill the array with each value of multiple value field of each page in page array
  } 
...

$news is an pageArray
$n is a single page of this array
$n->tag  is afield which returns a wireArray, because you choosed a multiple value field

//call a single value
$n->tag->first()->value
$n->tag->last()->value
$n->tag->eq(4)->value

or loop like you did. Maybe you prefer a multiple array (pages/ multivalues)?
 

Link to post
Share on other sites

Thanks kixe for kind helping!

Yes I want to obtain the array of the value of chosen options in a page.

I can then iterate the array for other matters easily like displaying them.

Calling single value is quite clear for me, but for calling multiple values I stuck, so I loop through them for getting single value one by one and merge them in an array. Any API for doing so directly? :)

Link to post
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 FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules Fluency is free, and now so is DeepL
      Since this module was first built DeepL has introduced free Developer accounts that allow anyone to start using Fluency at zero cost and beginning with the version 0.3.0 release Fluency now supports free DeepL accounts. As of June 2021 DeepL supports translation to 26 languages and continues to offer more!
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. Fluency can be used by users having roles given the fluency-translate permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

       
      Limitations:
      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Github issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Github page and file a bugfix ticket.
      Requirements:
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      The Module Is Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader).
      DeepL Developer Accounts
      In addition to paid Pro Developer accounts, DeepL now offers no-cost free accounts. Now all ProcessWire developers and users can use Fluency at no cost.
      Learn more about free and paid accounts by visiting the DeepL website. Sign up for a Developer account, get an API key, and start using Fluency today.
      Download & Feedback
      Download the latest version here
      https://github.com/SkyLundy/Fluency-Translation/archive/main.zip
      Github repository:
      https://github.com/SkyLundy/Fluency-Translation
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      https://github.com/SkyLundy/Fluency-Translation/issues
       
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • By monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      This is a simple module I made so a client could quickly grab a QR Code of the page's url in the admin.
      There's not much to it for now, but if need be you can output anything using a hook:
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $event->return = "Your custom text"; }) You can also output the QR code on your front-end by calling the field:
      echo $page->qr_code_field; The module uses the PHP library QR Code Generator by Kazuhiko Arase. When looking for a way to generate a QR Code in PW I came across @ryan's integration in his TFA module. I'm not very familiar with fieldtype/inputfield module development so I blindly followed @bernhard (great) tutorial and his BaseFieldtypeRuntime. At some point I'll take a deeper look to make a module on my own.
      Some ideas for improvements :
      add the ability to choose what to ouput : page's url / editUrl / file(s) / image(s) / ... allow to output multiple QR codes ?
    • By Chris Bennett
      https://github.com/chrisbennett-Bene/AdminThemeTweaker
      Inspired by @bernhard's excellent work on the new customisable LESS CSS getting rolled into the core soon, I thought I would offer up the module for beta testing, if it is of interest to anyone.

      It takes a different approach to admin styling, basically using the Cascade part of CSS to over-ride default UiKit values.
      Values are stored in ModuleConfig Module creates a separate AdminThemeTweaker Folder at root, so it can link to AdminThemeTweaker.php as CSS AdminThemeTweaker.php reads the module values, constructs the CSS variables then includes the CSS framework Can be switched on and off with a click. Uninstall removes everything, thanks to bernhard's wonderful remove dir & contents function.
      It won't touch your core. It won't care if stuff is upgraded. You won't need to compile anything and you don't need to touch CSS unless you want to.

      It won't do much at all apart from read some values from your module config, work out the right CSS variables to use (auto contrast based on selected backgrounds) and throw it on your screen.
      You can configure a lot of stuff, leave it as it comes (dark and curvy), change two main colors (background and content background) or delve deep to configure custom margins, height of mastheads, and all manner of silly stuff I never use.

      Have been developing it for somewhere around 2 years now. It has been (and will continue to be) constantly tweaked over that time, as I click on something and find something else to do.
      That said, it is pretty solid and has been in constant use as my sole Admin styling option for all of those 2 years.

      If nothing else, it would be great if it can provide any assistance to @bernhard or other contributor's who may be looking to solve some of the quirkier UiKit behavior.
      Has (in my opinion) more robust and predictable handling of hidden Inputfields, data-colwidths and showIf wrappers.
      I am very keen to help out with that stuff in any way I can, though LESS (and any css frameworks/tools basically) are not my go.
      I love CSS variables and banging-rocks-together, no-dependency CSS you can write with notepad.



       

    • By opalepatrick
      I see old posts saying that repeaters are not the way to go in Custom Process Modules. If that is the case, when using forms (as I am trying to do) how would one tackle things like repeat contact fields where there can be multiple requirements for contact details with different parameters? (Like point of contact, director, etc) or even telephone numbers that have different uses?
      Just for background I am creating a process module that allows me to create types of financial applications in the admin area (no need to publish any of this, pure admin) that require a lot of personal or company information.
      Maybe I am thinking about this incorrectly?
    • By HMCB
      I ran across a reference to IftRunner module. The post was 6 years ago. I cant find it in available modules. Has it been pulled?
×
×
  • Create New...