Jump to content
justb3a

Module: FieldtypeSelectRelation

Recommended Posts

I'm not quite sure if this is worth to be a module. But I needed it...

This Fieldtype creates a select list (drop down) in relation to another field (you can restrict the list by setting up certain templates and / or pages).

Installation:

1. Clone the module and place FieldtypeSelectRelation in your site/modules/ directory. 

git clone https://github.com/justonestep/processwire-fieldtypeselectrelation.git your/path/site/modules/FieldtypeSelectRelation

(or get it from the module page)

2. Login to ProcessWire admin and click Modules. 

3. Click "Check for new modules".

4. Click "install" next to the new FieldtypeSelectRelation module. 

Usage:

After installation, you'll have a new "Select" fieldtype that will allow you to define the items you'd like in the drop down depending on another field.

  • Create a new field and assign type SelectRelation
  • Click on the Details tab, there you find different fields to create your select list
  • Field: required, choose another field you created before from which the select list should be populated
  • Repeater: optional, if the field you chose is included in a repeater, select the repeater here
  • Template(s): optional, restrict your result by setting certain template(s)
  • Page(s): optional, restrict your result by setting certain page(s)
  • Unique Values: optional, check this field if you want to avoid duplicate values 
    (If you enable this, the string value will be saved instead of the ID. You will not be able to reference via ID.)
  • Including not only visible pages: optional, include all hidden and unpublished pages and pages that user doesn't have access to view
  • Multiple Output: optional, multiple selection (using ASMSelect)

Unique Values Disabled

If this field is not enabled the key is the pages_id and the value is the value from the other field.

<select id="Inputfield_chosen_fruit" name="chosen_fruit">
  <option value=""></option>
  <option selected="selected" value="1026">Strawberry</option>
  <option value="1030">Apple</option>
  <option value="1031">Banana</option>
  <option value="1032">Lemon</option>
</select>

Note:

If you change the value of a field the value changes too. If you deleted a value the value now is empty and multilingualism works like a charm.

Accessing the value:

// single select
echo $pages->get((int)$page->chosen_color)->color;

// multiple select
foreach ($page->chosen_color as $p) {
  echo $pages->get((int)$p)->color;
}

`chosen_fruit` and `chosen_color` are of the type SelectRelation.  

`title` is the page title and `color` a simple input field (TextLanguage for example).

In `chosen_fruit` the selected field is `title`.

And in `chosen_color` the selected field is `color`.

Unique Values Enabled

If this field is checked the key as well as the value are the value from the other field.

<select id="Inputfield_chosen_color" name="chosen_color">
  <option value=""></option>
  <option value="red">red</option>
  <option value="green">green</option>
  <option selected="selected" value="yellow">yellow</option>
</select>

If you don't check this box you might have duplicate colors (because there is more than one fruit which has a yellow color for example).  

BUT if you change the value of an field, your already chosen value stays the same, because there isn't a relation via ID.

Access such a field like you are used to:

// single select
echo reset($page->chosen_color);

// multiple select
foreach ($page->chosen_color as $p) {
  echo $p;
}

TL;DR:

I tried to save a comma separated list for duplicate values .It works until you change anything. For example, if you have two times the color yellow a key of the kind '1034,1036' may get saved. Now assume you change a basic color (the banana turns brown :D), the selected value is now empty because a key like '1034,1036' doesn't exist anymore. And in the frontend you may get a wrong output. 

  • Like 14

Share this post


Link to post
Share on other sites

I added two config options:

  • Including not only visible pages: optional, include all hidden and unpublished pages and pages that user doesn't have access to view
  • Multiple Output: optional, multiple selection (using ASMSelect)

Field settings:

field-settings.png

Select Lists:

(settings above -> first one)

fields.png

  • Like 5

Share this post


Link to post
Share on other sites

Thanks for this - I think it will come in very handy. Just a quick note though - looks like you did a find/replace just before submitting, because there are several instances of "FieldField" instead of just "Field", eg. $chooseFieldField and instanceof FieldFieldtypeRepeater - this is preventing your attempts for excluding a bunch of field types from the list of available fields.

PS I'd love to see support for Profields Table subfields :)

Share this post


Link to post
Share on other sites

Not sure I understand this module? Is this for creating relation between two page fields? When I select Europe, then in next field I can choose countries from Europe?

That is already supported in core. But there seems to be much more in this module than just that. Maybe I should just try this :)

  • Like 2

Share this post


Link to post
Share on other sites

I was a little confused at first too and thought it might work to generate dynamic/conditional dropdowns like you are describing with the Europe countries example - actually that is a field type that I think would be nice - I have been thinking about it the last couple of days actually :)

What this relation fieldtype does is create a dropdown field that lists the entries for the selected field from all the matched templates/pages. The option value is the ID of the page that has the entry. Clear as mud right :) Maybe you just need to try it :)

  • Like 2

Share this post


Link to post
Share on other sites

Adrian, no need for custom field for that. Just set parent=page.otherpagefield as selector value for your page field.

And thanks for the explanation, I got it!

Nope, I mean this: parent=page.manufacturer kind values for page fields "define selector to find pages". They create ajaxified UI for field relations.

  • Like 3

Share this post


Link to post
Share on other sites
Adrian, no need for custom field for that. Just set parent=page.otherpagefield as selector value for your page field. 

Wow - how did I miss (or maybe forget about) this - thanks :) That works perfectly!

PS Sorry for hijacking your thread here @justb3a

Share this post


Link to post
Share on other sites

Adrian no problem  :)  Indeed I appreciate this, it's always good to learn more and to get some feedback. I just started my second ProcessWire project and there is so much more to discover...

I tried to use the Page Fieldtype (parent=page.otherpagefield) but I got a complete different output. The point is that I don't want to get a whole page object, I need a plain value in order to receive this value using the ServicePages API. Unfortunately my use case is quite complex and you need a lot of background knowledge so I had to find another example.

Use case: Categorize Posts/Pages

"The common way": Create a single page for each category. Add a Page Inputfield, set up the parent page / template and you get a select list of categories (pages). Fine.

"My way": Create just one page to hold all categories in a repeater. Add a SelectRelation Inputfield, set up field=category, repeater=r_categories. Then you get "the same" list. If you need more than just the title (or any other field) you should use the Page Inputfield for sure.  

The difference is that you don't select a page, you select a field value depending on a page. I guess this should also work for Profield Table subfields but I didn't test it.

  • Like 3

Share this post


Link to post
Share on other sites

@JoZ3: I'm not quite sure whether I understood your request right. You want to select an image to be the cover?

If so I would suggest using tags. Activate the `use tags?` checkbox in image settings and enter the tag "cover" (or something else) for the specific image.

post-2759-0-52140500-1424683153_thumb.jp

In your template you can pick this image using the following code (adapted to your needs / field names, ..):

page.images.getTag('cover');
  • Like 2

Share this post


Link to post
Share on other sites

@justb3a I think what @JoZ3 might mean is can this field be used to select an image from a multiple image field and use it on another page? For example (I think) he wants to use an image from a field on a product page on the home page but the image he wants is (fro example) the fifth one down in a field.

  • Like 1

Share this post


Link to post
Share on other sites

This works great for what I'm working on! Is there a way to limit populating the select from a field within a repeater from just the parent page?

Share this post


Link to post
Share on other sites

Did you try to add only the parent page in the Pages select field?

Share this post


Link to post
Share on other sites

I did, but there are multiple parent pages with multiple child pages. The select is in the child and I'd like to dynamically populate the select with data from a repeater from the parent.

so:

_ parent1 (with repeater)

_ _ child1 (get from parent 1)

_ _ child2 (get from parent 1)

_ parent2 (with repeater)

_ _ child1 (get from parent 2)

_ _ child2 (get from parent 2)

_ _ child3 (get from parent 2)

I tried editing the module by adding an option to the choosepagesfield with $page->parent but I just ended up breaking it :P

Share this post


Link to post
Share on other sites

not tested, add in function getInputfield after line 153

// later: check before if this is enabled in field settings
if (!empty($page->parent_id)) {
  $selector[] = 'has_parent=' . $page->parent_id;
}

Please let me know if this works. I'll then add a checkbox in field settings and the depending check as well.

Share this post


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 MoritzLost
      TrelloWire
      This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.
      Features
      All the things the module can do for you without any custom code: Create a new card on Trello whenever a page is added or published (you can select applicable templates). Configure the target board, target list, name and description for new cards. Add default labels and checklists to the card. Update the card whenever the page is updated (optional). When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable). You can extend this through hooks in many ways: Modifiy when and how cards are created. Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello. Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly. Feedback & Future Plans
      Let me know what you think! In particular:
      If you find any bugs report them here or on Github, I'll try to fix them. This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it! The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular). I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case! Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂 Links
      Repository on Github Complete module documentation (getting started, configuration & API documentation) [Module directory pending approval] Module configuration

    • By MoritzLost
      Process Cache Control
      This module provides a simple solution to clearing all your cache layers at once, and an extensible interface to perform various cache-related actions.
      The simple motivation behind this module was that I was tired of manually clearing caches in several places after deploying a change on a live site. The basic purpose of this module is a simple Clear all caches link in the Setup menu which clears out all caches, no matter where they hide. You can customize what exactly the module does through it's configuration menu:
      Expire or delete all cache entries in the database, or selectively clear caches by namespace ($cache API) Clear the the template render cache. Clear out specific folders inside your site's cache directory (/site/assets/cache) Clear the ProCache page render cache (if your site is using ProCache) Refresh version strings for static assets to bust client-side browser caches (this requires some setup, see the full documentation for details). This is the basic function of the module. However, you can also add different cache management action through the API and execute them through the module's interface. For this advanced usage, the module provides:
      An interface to see all available cache actions and execute them. A system log and logging output on the module page to see verify what the module is doing. A CacheControlTools class with utility functions to clear out different caches. An API to add cache actions, execute them programmatically and even modify the default action. Permission management, allowing you granular control over which user roles can execute which actions. The complete documentation can be found in the module's README.
      Plans for improvements
      If there is some interest in this, I plan to expand this to a more general cache management solution. I particular, I would like to add additional cache actions. Some ideas that came to mind:
      Warming up the template render cache for publicly accessible pages. Removing all active user sessions. Let me know if you have more suggestions!
      Links
      https://github.com/MoritzLost/ProcessCacheControl ProcessCacheControl in the Module directory CHANGELOG in the repository Screenshots


    • By Macrura
      PrevNextTabs Module
      Github: https://github.com/outflux3/PrevNextTabs
      Processwire helper modules for adding page navigation within the editor.
      Overview
      This is a very simple module that adds Previous and Next links inline with the tabs on the page editor. Hovering over the tab shows the title of the previous or next page (using the admin's built in jqueryUI tooltips.)
      Usage
      This module is typically used during development where you or your editors need to traverse through pages for the purpose of proofing, flagging and/or commenting. Rather than returning to the page tree or lister, they can navigate with these links.
      Warnings
      If you are using PW version 2.6.1 or later, the system will prevent you from leaving the page if you have unsaved edits.
      For earlier versions, to avoid accidentally losing changes made to a page that might occur if a user accidentally clicks on one of these, make sure to have the Form Save Reminder module installed.
      http://modules.processwire.com/modules/prev-next-tabs/
    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
×
×
  • Create New...