Jump to content

Fieldtype Select External Option


Recommended Posts

If you use latest dev https://github.com/kixe/FieldtypeSelectExtOption/tree/dev you could use the following code (since version 1.1.3)

$news = $pages->find("template=news_detail");
$arr = [];
foreach($news as $n) {
  echo $n->tag; // returns a string with all values separated by pipe, example: '45|67|89|22'
  $arr = array_merge($arr,explode('|',$n->tag));
} 

or (since version 1.1.5)

$news = $pages->find("template=news_detail");
$arr = [];
foreach($news as $n) $arr = array_merge($arr,$n->tag->getKeys());
var_dump(array_unique($arr));

// or
foreach($news as $n) var_dump($n->tag->each('yourPropertyOfSelectExtOption'));
// all table columns are provided as property except those named with reserved words
foreach($news as $n) var_dump($n->tag->each('row'));

or simpler

$news = $pages->find("template=news_detail");
var_dump($selected->each('tag.label')); // return multiple array of each label of field 'tag' of each page in the PageArray
Edited by kixe
  • Like 1
Link to post
Share on other sites
  • 3 weeks later...

I'm using 1.1.5 on PW 2.6.19 and the table is setup, the selector appears on the page edit form, I can chose "Bob" from the list, save the page and see the data in the database. What I can't do is make the selection via API. Let's say we're using id numbers and usernames and that Bob is #3. I should be able to do $page->myfield = 3 shouldn't I?

Thanks.

Link to post
Share on other sites

Your example works only with echo.

echo $page->myfield; // return the string value, in your case '3'
$page->myfield->value; // return (int)3
$page->myfield->label; // return (string)'Bob';

any value of another column of you table is accessible too with
$page->myfield->columnname;
Link to post
Share on other sites

I'm not trying to access the data from the external table.

I'm trying to build new pages (or update existing ones) using the API.

Doing things manually from the admin's page editor...

"the selector appears on the page edit form, I can chose "Bob" from the list"

I need to be able to do that via the API, so that when somebody views the page, "Bob" will already be selected.

Link to post
Share on other sites

How to set a fieldvalue via API:

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

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

/* this works for both, but will replace existing values */
$page->of(false);
$page->myfield = array(3,7,9); // in case of single select only 1 item in array
$page->save('myfield');
  • Like 1
Link to post
Share on other sites
  • 11 months later...

Can you provide an example of the filter function? Here's my field being born:

      $f = new Field();
      $f->type = wire('modules')->get('FieldtypeSelectExtOption');
      $f->set("name", "iu_template")->set("label", "Template");
      $f->option_table = "templates";
      $f->option_value = "id"; $f->option_label = "name";
      $f->filter('id not in (2,3,4,5)');
      $f->set("required",1);
      $f->set("tags", "-impupd")->set("columnWidth",50)->save();

 

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

@cjx2240 Welcome to the forums. The Module pulls selectable Inputfields from InputfieldPage module. Go to the module settings of InputfieldPage and add the Inputfieldtypes you want to have available in Fieldtype SelectExtOption.

Link to post
Share on other sites
1 hour ago, kixe said:

@cjx2240 Welcome to the forums. The Module pulls selectable Inputfields from InputfieldPage module. Go to the module settings of InputfieldPage and add the Inputfieldtypes you want to have available in Fieldtype SelectExtOption.

Thanks for the reply, so am I missing something? See attached.

I appreciate the module doesn't claim to be 3.x compatible but it's just so close!

select_ext_1.png

select_ext_2.png

  • Like 1
Link to post
Share on other sites

I made an update 4 month ago to solve this. Unfortunately it hasn't been changed on github, but it is marked as changed in my desktop tool. Don't know why. Anyway I will make an update today. I have the module running under 3.0.39 without problems.

Please update to 1.2.1

Edited by kixe
Fixed
  • Like 2
Link to post
Share on other sites
  • 1 month later...

Hello @kixe

I have installed your module (latest version) on ProcessWire 3.0.36. However, when I create a new field using the FieldtypeSelectExtOption, ProcessWire tries to load the field edition page for the new field (e.g. http://www.mydomain.com/cms/setup/field/edit?id=111), but fails to do so a few seconds of waiting. In Google Chrome I get "ERR_CONNECTION_RESET". I'm not seeing any error(s) (regarding this) logged in ProcessWire's error log and I have $config->debug set to true. I should clarify that the script is not reaching max_execution_time. Apparently what happens is that, somehow, the connection with the page is reset.

This is the first time a ProcessWire module behaves this way for me. Do you have any ideas as to what may be happening?

Link to post
Share on other sites

@efiguerola

Sorry for the late answer. I cannot reproduce this error. This is a Chrome specific error message, which could be related to firewall settings or other security settings on your machine. Since there is no Error logged in the system, everything is working as it should.
Could you please try out with other browsers: Firefox, IE or Safari. What happens there?
Did you make any settings, or does this happen immediately after creation of the field?

Link to post
Share on other sites

@kixe Hi, I gave you the Chrome error code just because it is the one I personally use, but I get the same kind of behavior in other browsers as well, it is not a browser thing.

I didn't get to make any settings because the error happens immediately after creation of the field.

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

Here is a brief reference to the last updates:

  • Value Preselection
    Since version 1.2.3 it is possible to pre-select a value if the field is required.
  • Language Labels
    In a multilanguage environment, as of version 1.2.4, it is possible to assign a special column to each installed language in the database table to pull the option labels  from. Of course with fallback to the default language.
  • 0 allowed as value
    Since version 1.2.5 int 0 is an allowed value
Link to post
Share on other sites

If Language Support is installed but no additional languages created then there is a PHP error:

PHP Warning: Division by zero in ...\FieldtypeSelectExtOption.module:504

Probably not something that happens very often.

  • Like 2
Link to post
Share on other sites
On 2.3.2017 at 9:30 AM, Robin S said:

If Language Support is installed but no additional languages created then there is a PHP error:


PHP Warning: Division by zero in ...\FieldtypeSelectExtOption.module:504

Probably not something that happens very often.


@Robin S
I fixed this and other stuff you mentioned in this post:

It was a bit more complicated than I expected, since PW really doesn't provide '0' as value in a SelectFieldtype.

  • Like 2
Link to post
Share on other sites

Pushed another update with new function added which allows to modify the option labels via hook.

Scenario: You want to provide a select drop down for image fields stored in another page as described in this post

In the next step we want to provide labels pulled from the description field (default language in multilanguage environment) instead from the data field providing ugly file names. How can we achieve that?

The description is stored as a json string. We need to extract the label from it. To do so choose 'description' as option label and put the following hook in your /site/ready.php

$this->addHookAfter('FieldtypeSelectExtOption::label', function ($e) {
    $array = json_decode($e->return, true);
    $e->return = $array[0]; // image description in default language
});


Function label() always provides the default lable, the option value, the page to which the field is assigned and the specific field that uses the field type to facilitate customizations.
Default return is the unmodified label pulled from the database column.
ATTENTION: Arguments changed since Version 1.3.5

// Version >= 1.3.5
$this->addHookAfter('FieldtypeSelectExtOption::label', function ($e) {
	$optionLabel = $e->arguments[0];
	$optionValue = $e->arguments[1];
	$page = $e->arguments[2];
	$field = $e->arguments[3];
});

 

Edited by kixe
modified arguments for label()
  • Like 3
Link to post
Share on other sites
19 hours ago, kixe said:

The description is stored as a json string.

In a single-language site the description is just a plain string, so a user would want to modify the hook accordingly.

I like this new feature allowing the select option label to be determined in a hook, but I wonder if choosing a single column in the field config makes the hookable method too limited. For example, in the case of using the description column as a label for an images select, having the label fall back to the sort integer if an image has no description is worse than having the image filename. Is there a way to conditionally grab a different column value from the row inside the label hook? So you could for example get the "data" (filename) column if the description column is empty.

Not sure if it's practical but I think it would be cool if there was a hookable method that receives an argument of all the row columns as an array lets you return both the option value and label.

  • Like 1
Link to post
Share on other sites
On 5.3.2017 at 3:29 AM, Robin S said:

Not sure if it's practical but I think it would be cool if there was a hookable method that receives an argument of all the row columns as an array lets you return both the option value and label.

@Robin S

Thanks for pointing this out. I agree and changed the 3d argument. It receives now the row related to the value.

ATTENTION: Since Module version 1.3.5 you have access to all row columns as described here

wire()->addHookAfter('FieldtypeSelectExtOption::label', null, function ($e) {
    $optionLabel = $e->arguments[0];
    $optionValue = $e->arguments[1];
    $page = $e->arguments[2];
    $field = $e->arguments[3];
    $row = $e->object->row($field->name, "id=$page->id");
});

 

/**
 * select field for images in a multilanguage environment
 * label pulled from image description in default language with fallback to filename
 */
$this->addHookAfter('FieldtypeSelectExtOption::label', function ($e) {
    $array = json_decode($e->return, true);
    $page = $e->arguments[2];
    $field = $e->arguments[3];
    $row = $e->object->row($field->name, "id=$page->id");
    $e->return = $array[0]? $e->return = $array[0]: $row['data'];
});

 

 

Edited by kixe
modified arguments for label()
  • Like 1
Link to post
Share on other sites
  • 1 year later...

Can someone clarify for me if the external DB is read each time an instance of this field is used or is the external DB used only during initial creation and filling of the values and those values/labels are stored in PW? 

thank you

Link to post
Share on other sites

If you use an external DB to generate the select field the DB is queried to generate the field and also if you access the value via Api.
Depending on your setup (single/ mutliple) the returned value is either an object of class SelectExtOption or a WireArray of  SelectExtOption items. This module does not 'import' anything.

The value reference is of type integer and stored in the PW Database.

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...