PrevNew ProcessWire modules directory
There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new. More
This week we’ll take a brief look at a powerful new ProFields module for ProcessWire that’s just around the corner—the Combo field.
In last week's forum post about ProcessWire 3.0.169, I briefly mentioned the new ProFields Combo field that's in development and coming soon (likely this month). Like many of the ProFields, it includes 2 parts: “FieldtypeCombo” and “InputfieldCombo”. Unlike other ProFields, the Inputfield part can be used independently of the Fieldtype. Meaning it can be used in FormBuilder forms or any other ProcessWire form.
While the Combo field does have some crossover with other ProFields, it’s also something very different that I think will fill a common need. I’m particularly excited about it because I think it really rounds out the ProFields set of modules nicely, and it’s the one ProFields module that I anticipate using the most out of all of them.
One field, any number of combinations
The word “Combo” in this case refers to “Combination”. A Combo field lets you have a combination of different fields within it. But unlike other ProFields modules, or other solutions in ProcessWire, the fields in your Combo don’t use other ProcessWire fields, and it doesn’t use other ProcessWire pages. So a single Combo field can have as many other fields in it as you want, but it’s still just 1 field in ProcessWire, and it consumes no more resources that 1 field in ProcessWire, making it especially efficient.
A simple Combo example
If you are still wondering just what a Combo field is and how it works, I think the best way to explore that is with a simple example. Let’s say that we want to have a field named mailing_address that contains the combination of fields necessary to hold each of the following pieces of information independently:
- first name
- last name
- street address
- city
- state or province
- zip or postal code
- country
The above would be comprised of a combination of text, select, and/or Page reference fields/inputs. Without the Combo field, we would need to create fields in ProcessWire for each of those aspects of a mailing address, and then add them to a template (perhaps also in a Fieldset). This is fine of course, no problem. But the goal of ProFields is to reduce the quantity of fields necessary to accomplish a particular task, so we prefer fewer fields when possible. The Combo field really takes that goal to the next level.
Here’s how our new mailing_address field looks in the Page editor:
Familiar and straightforward API
As you might guess, in our template file, we can simply refer to any of the fields as properties of the mailing_address field, like this (using first_name as an example):
echo $page->mailing_address->first_name;If you want to search for "Frank" in the mailing_address.first_name field across all pages, you can do so like this:
$results = $pages->find("mailing_address.first_name=Frank");Or if you want to search for the word "Frank" in all mailing_address fields, you can do so like this:
$results = $pages->find("mailing_address~=Frank");Basically, if you’ve used ProcessWire for anything else, then you already know how to use a Combo field from the coding side. But the Combo field makes it particularly straightforward and without compromise.
Easy to create and manage
Defining a Combo field is really simple. Below are a couple screenshots of how it looks in the field editor (Setup > Fields > mailing_address):
The selectable type options that you see in the screenshot above are Inputfield modules. The above are just what happens to be installed on a core installation without any 3rd party modules (other than the Combo field), but you can install other types to use with Combo fields too.
Fast and efficient storage
When it comes to storage in the database, the Combo field is also unique. It stores data in individual DB columns like the ProFields Table field, but also keeps a combined index, making it possible to perform text matching searches on all data in a Combo field at once. This makes it fast and efficient for searches, whether a granular search on a single property, or a wide search on all properties.
I’m aiming to have the Combo field ready for release in the ProFields support/upgrades board by the end of the year, which is this month. I should have more information about the Combo field in the next couple of weeks as well. But if you have any questions, feel free to ask anytime. Thanks for reading, have a great weekend, and enjoy the latest ProcessWire Weekly!
Comments
NextProcessWire 3.0.170 core updates
Happy New Year! Today I’ve bumped the version on the dev branch to 3.0.170, and it’s quite a lot of updates. This post covers most of them. In this post, there’s also a question for you: what would you like to see in ProcessWire in 2021? More
Joshua
- 2 years ago
- 22
★★★★★Wow, thank you Ryan!
That looks fantastic and very useful.
Can’t wait to give it a try!
Reply
Marc
Hi Ryan, this is great! Already have some use cases for exactly this :)
One question: Is there also an API (as always) for creating/editing/deleting those fields via API?
Rock on!
Marc
Reply
Ryan
Getting and setting (creating, modifying, deleting) field values in a Combo field is pretty much the same as for any other field, and saving them is just a matter of saving the page that they are on. Like with most fields, you'll want the page's output formatting to be turned off before modifying stuff and saving the page.
Reply
Sheldon
- 2 years ago
- 13
★★★★★Heh, this seems like the perfect response to the thread I posted in the ProFields subforum a few weeks ago - this looks particularly useful in a lot of areas though!
My question is - if I have several integer fields, would I be able to do something like below in order to filter pages? If so, this is super powerful.
$pages->find(combo_number >= $target_number)
Reply
ryan
You could do this: $pages->find('combo_field.number_subfield>=123');
Reply
Sergey
Hi, Ryan!
Can you post a screenshot of the db table with combo field data?
Reply
ryan
The DB schema part of it is still very much in development, so more work to be done before that part is final.
Reply
thetuningspoon
Looks very promising! If the fields are based on Inputfield modules only, how does the database table know how to store the data for each type?
Reply
Jonathan
Thanks. But I dont get what the difference to the page fieldset is. Any help?
Reply
MrSnoozles
You can create as many fields as you want. Under the hood (in the database) just one field is created. This is way more efficient if you're working with a lot of fields.
Reply
HMCB
- 2 years ago
- 11
★★★★★Genius. You are an artisan. Thanks Ryan.
Reply
MrSnoozles
- 2 years ago
- 00
★★★★★Highly anticipated. It really fills a gap in the ecosystem. I've been using the excellent Mystique module so far when I needed to create a lot of fields. Looking forward to see how this changes the workflow.
Will it be possible to use the individual fields in page selectors?
Reply
ryan
Yes, this is possible to query the individual fields in selectors just like with other fields in PW. Though Combo also goes a little further with this than others I've built so far (see API section in this post).
Reply