adrian

Page Field Select Creator

Recommended Posts

This module provides a way to rapidly generate Page fields and the required templates and pages for use as a drop down select (or any other Page field type).

This module will let you create a full page field setup in literally a few seconds  :)

To use, run Page Field Select Creator from the Setup Menu

  • Enter a Field Title, eg: Room Types
  • Select Options - These will become the child pages that will populate the page field select options. There are two different options.
     
    Option 1. TITLE FIELD ONLY - enter one option per line, eg:
     
    Single
    Double
    Suite
     
     
    Option 2. MULTIPLE FIELDS - the first line is used for the field names and the first field must be 'Title'. Subsequent lines are the values for the fields, eg:
     
    Title, Number of Beds, Number of People, Kitchen Facilities
    Single, 1, 1, Fridge Only
    Double, 2, 2, Fridge Only
    Suite, 3, 6, Full Kitchen
     
  • Choose the parent where the page tree of options will be created, eg a hidden "Options" parent page
  • Select a "Deference in API as" option depending on your needs
  • Choose the input field type
  • Check whether "Allow new pages to be created from field?" should be enabled.

As an example, if you entered "Room Types" as the field title, you would end up with all of the following automatically created:

  • a fully configured page field called: room_types
  • MULTIPLE FIELDS OPTION - 3 additional fields - number_of_beds, number_of_people, kitchen
  • a parent template called: room_types
  • a child template called: room_types_items (with either just a title field, or with the 3 additional fields as well)
  • a parent page called: Room Types
  • a series of child pages named and titled based on the per line entries in the Select Options textarea

The templates are configured such that the "room_types_items" child template can only have the main "room_types" template as a parent, and vice versa.

Then all you have to do is add the newly created page field to any template you want and you're ready to go!
 
You can grab it from:
 
Modules directory: http://mods.pw/5R
Github: https://github.com/adrianbj/ProcessPageFieldSelectCreator

I'd appreciate some feedback on whether others would find this useful, and if you agree with the default way the template structure and family settings are being configured. Then I'll add to the modules directory.

post-985-0-49927700-1379441662_thumb.png

  • Like 18

Share this post


Link to post
Share on other sites

This is great Adrian, extremely handy!

As this is a more advantaged tool I was thinking of:

Select a template to use as child page ( with more fields in a template )

Say you select a child template with the fields: title, type & year.

Then at Select Options:

BMW, m3, 1987

Mazda, 323, 1986

VW, Golf, 2012

---

Even without this it's a real time saver !!!

  • Like 1

Share this post


Link to post
Share on other sites

Greetings,
Excellent concept! I just experimented with it briefly this morning. Will use it more later...

One of the most common newcomer misunderstandings about ProcssWire is the "missing" dropdown field. Your module gets us closer to using the depth of ProcessWire pages as selects while being easier to set up.

Thanks for doing this!

Matthew

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for the positive feedback everyone. 

Matthew - that was definitely part of my reasoning for creating this. There are a few times I have wanted to set up a page field, but have gone with hani's fieldtype Select module to save time. I still think there are times when his module is more appropriate, but now I think I won't be making the decision because of the time/hassle of creating a page field setup. It is also why I chose to put "Select" in the name of the module - hopefully it will help newcomers find it more easily.

Martijn - I like where you are headed with those ideas. I think rather than selecting an existing child template (which I think is what you are suggesting), how about I allow the Select Options field to also handle multiple fields if entered? I might take a stab at that and see how it goes - stay tuned!

  • Like 3

Share this post


Link to post
Share on other sites

<adrian>how about I allow the Select Options field to also handle multiple fields if entered? I might take a stab at that and see how it goes - stay tuned!</adrian>

I didn't thought about that, but thats even better, thumbs up !

Share this post


Link to post
Share on other sites
Hi everyone.

The new functionality based on Martijn's suggestions for creating the select options with multiple fields is ready. I have updated the code on Github and modified the instructions in the first post above.

Please test and let me know how it goes for you and whether there are any improvements I could make.

  • Like 4

Share this post


Link to post
Share on other sites

Adrian, thanks for the update! If possible, it would have been nice to have a before (original version) and after this update text and screenshots (I know could potentially lead to a long thread and not practical with every update). It helps to compare, follow progress, etc. Not a big deal though... ;)

Share this post


Link to post
Share on other sites

Adrian I think you broke something in your latest commit.

In the option with multiple fields

The pagefield, doesn't store the Parent Page.

ps, I'm smiling while using this Module  :) 

(aside: People have to take care they're not creating a Hani amount of fields )

  • Like 1

Share this post


Link to post
Share on other sites

Works ! 

$field->notes at Select Options contain a lot of text. Maybe move the to $field->desc.

And use the $field->notes to echo out all compatible text based fields.

ps, your implementation of my suggestion is way better then how I thought about it.

Share this post


Link to post
Share on other sites

Glad to hear it's working again!

I don't mind moving the examples for the Select Options field to the desc, but I am actually not sure what you mean by:

"echo out all compatible text based fields"

Do you mean all existing text fields from the entire site? I am not sure what would make them compatible or not.

Remember that any new specified fields are created on the fly and added to the child template's fieldgroup - there is no need to have those fields already defined.

Sorry, I think I am just not understanding what you mean :)

Share this post


Link to post
Share on other sites

<adrian>Do you mean all existing text fields from the entire site? I am not sure what would make them compatible or not</adrian>

Yep that is what I meant.

Reuse of existing fields makes sense, so it would be nice to see a list of all fields that extends from FieldtypeText. ( all compatible I think )

Share this post


Link to post
Share on other sites

Good point - v4 is now available and includes a list of available text fields that can be used instead of automatically creating new ones if appropriate.

  • Like 1

Share this post


Link to post
Share on other sites

Wil test tomorrow, thanks for all your effort!

Did the testings this morning... simply love it.

Thanks for bringing in my ideas !

Edited by Martijn Geerts
  • Like 1

Share this post


Link to post
Share on other sites

Hey, no worries - I was going to be working on another new module today, but may as well get this one perfected first :)

What exactly do you think it needs and how do you see it working? I have played around with multi languages in PW a little, but since I don't really have a need, I am still not terribly literate with it yet.

Am I correct in assuming that you wouldn't really need multi-language versions of the title of the Parent page? I am thinking you'd only need them for all fields of the child pages?

So, would having separate "Select Options" textarea fields for each installed language cover everything needed?

It would be great if you could detail out how you think it would work best so I don't go down a confusing path!

Sorry for being an ignorant English speaker :)

PS Go grab v6 from Github - some restructuring of the form - layout and instructions, fixing of a bug if the field already existed, and more friendly error reporting in general.

Edited by adrian
  • Like 1

Share this post


Link to post
Share on other sites

All strings can be translated in PW.

It is as easy as. $this->_("provide your english here") or __("provide your english here") instead of "provide your english here"

Then If someone needs to translate your module the translatable strings are in there. 

  1. The translator should go to /Setup/Languages/ 
  2. Then to the language, say Dutch.
  3. There fill in the path of your module
  4. ProcessWire will detect all __('translatable strings') & $this->_('translatable strings') and present the translator with inputs.
  5. Then The translator can type in "vertaalbare tekst" go to the next, etc. translate them all.
  6. Save... Done

$field->description = __("Fringilla Sollicitudin Consectetur"); or $field->description = _$this->_("Fringilla Sollicitudin Consectetur");

To make it more fancy, use the sprintf or printf

printf(__("Created %d pages."), $count);


example

protected function buildForm1() {
  $f = $this->modules->get("InputfieldText");
  $f->name = 'fieldTitle';
  $f->label = __('Field Title');
  $f->required = true;
  $f->description = __("The title of the page field to be created.");
  $f->notes = __("Use capitals, spaces etc.");
  $form->add($f);
  .....
}
  • Like 2

Share this post


Link to post
Share on other sites

Ok, now I understand - I wasn't thinking about making the module's form translatable. I thought you meant having the option for creating the selectable child pages have multi-language fields.

Thanks a lot for the detailed example - I'll take care of it now and hopefully you can let me know if I have missed anything. Should/can the name of the module itself be translatable?

Share this post


Link to post
Share on other sites

Just a little note to the translations:

If you're in a class context (extending Wire), the way to translate strings is like this: 

$this->_('Your string to translate');

Whereas in templates, there's the following syntax to use:

__('Translate me baby');

Great module :)

  • Like 1

Share this post


Link to post
Share on other sites

OK, v7 now has translations support!

Wanze - thanks for the translation info. I had just finished when your message came through. Everything seems to be working fine. Maybe you could take a look for me and let me know if I need to change any of them.

One other question for you guys - wasn't quite sure the best way to handle multiline description fields. In the case of the "Select Options" field, I think I may have made the translation more complicated than it really needs to be. Perhaps it would be better to put all in one translatable field and require the translator to include these as required. Trouble is that the title and description on the translation page don't get formatted, so it is hard to see what the intended layout actually is. Do you have any advice?

Anything I missed?

Share this post


Link to post
Share on other sites

Hey guys,

I have been playing around trying to better understand multi-language stuff and it seems to me that along with the module translation that I just set up, it would also make sense to be able to automatically fill in the alternate language(s) for the fields of the sub-pages - in my example, the values for: Title, Number of Beds, Number of People, Kitchen Facilities.

So, if you had three languages installed you'd be given three "Select Options" fields, one for each language. Based on my standard example, you'd fill out something like this:

English

Title, Number of Beds, Number of People, Kitchen Facilities

Single, 1, 1, Fridge Only

Double, 2, 2, Fridge Only

Suite, 3, 6, Full Kitchen

Dutch

Titel, aantal bedden, aantal personen, ingerichte keuken

Alleenstaand, 1, 1, Koelkast Alleen
Dubbel, 2, 2, Alleen Koelkast

Vervolg, 3, 6, volledige keuken

German

Titel, Anzahl der Betten, Anzahl von Menschen, Küchen

Einzel, 1, 1, Kühlschrank Nur

Doppel, 2, 2, Kühlschrank Nur

Weiterführung, 3, 6, komplett ausgestattete Küche

Would this be useful, or is this not how you guys handle things for the content pages for a Page field.

PS Excuse the dodgy google translations - no offense intended :)

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 BitPoet
      As threatened in the Pub sub forum in the "What are you currently building?" thread, I've toyed around with Collabora CODE and built file editing capabilities for office documents (Libre-/OpenOffice formats and MS Office as well as a few really old file types) into a PW module.
      If you are running OwnCloud or NextCloud, you'll perhaps be familiar with the Collabora app for this purpose.
      LoolEditor
      Edit office files directly in ProcessWire
      Edit your docx, odt, pptx, xlsx or whatever office files you have stored in your file fields directly from ProcessWire's page editor. Upload, click the edit icon, make your changes and save. Can be enabled per field, even in template context.
      Currently supports opening and saving of office documents. Locking functionality is in development.
      See the README on GitHub for installation instructions. You should be reasonably experienced with configuring HTTPS and running docker images to get things set up quickly.
      Pull requests are welcome!
      Here is a short demonstration:

    • By Robin S
      An Images field allows you to:
      Rename images by clicking the filename in the edit panel or in list view. Replace images, keeping metadata and filename (when possible) by dropping a new image on the thumbnail in the edit panel. Introduced here. But neither of these things is possible in File fields, which prompted this module. The way that files are renamed or replaced in this module is not as slick as in the Images field but it gets the job done. The most time-consuming part was dealing with the UI differences of the core admin themes. @tpr, gives me even more respect for the work that must go into AdminOnSteroids.
      Most of the code to support the rename/replace features is already present in InputfieldFile - there is just no UI for it currently. So hopefully that means these features will be offered in the core soon and this module can become obsolete.
       
      Files Rename Replace
      Allows files to be renamed or replaced in Page Edit.

      Usage
      Install the Files Rename Replace module.
      If you want to limit the module to certain roles only, select the roles in the module config. If no roles are selected then any role may rename/replace files.
      In Page Edit, click "Rename/Replace" for a file...
      Rename
      Use the text input to edit the existing name (excluding file extension).
      Replace
      Use the "Replace with" select to choose a replacement file from the same field. On page save the file will be replaced with the file you selected. Metadata (description, tags) will be retained, and the filename also if the file extensions are the same.
      Tip: newly uploaded files will appear in the "Replace with" select after the page has been saved.
       
      https://github.com/Toutouwai/FilesRenameReplace
      http://modules.processwire.com/modules/files-rename-replace/
    • By d'Hinnisdaël
      So I decided to wade into module development and created a wrapper module around ImageOptim, a service that compresses and optimizes images in the cloud. ImageOptim currently handles JPG, PNG and GIF files and, depending on the settings you use, shaves off between 15% and 60% in filesize. Great for bandwidth and great for users, especially on mobile.
      This module handles the part of uploading images to ImageOptim via their official API, downloading the optimized version and storing it alongside the original image.
       

       
      Download & Info
      GitHub / Module directory / Readme / Usage
       
      Why ImageOptim?
      There are other image optimization services out there, some of them free, that have outstanding ProcessWire modules. A few things make ImageOptim the best tool for most of my customers: It's not free, i.e. it will probably be around for a while and offers support. However, it's cheaper than some of the bigger competitors like Cloudinary. And it does PNG compression better than any of the free services out there, especially those with alpha channels.
       
      Installation
      Install the module like any other ProcessWire module, by either copying the folder into your modules folder or installing it via the admin. See above for downloads links on GitHub and in the module directory.
       
      Requirements
      To be able to upload images to the service, allow_url_fopen must be set on the server. The module will abort installation if that's not the case.
      I have only tested the module on ProcessWire 3.x installations. I don't see why it shouldn't work in 2.x, if anyone wants to try it out and report back.
       
      ImageOptim account
      To compress images, you first need to sign up for an ImageOptim account. They offer free trials to try the service.
       
      Usage (manual optimization)
      Images can be optimized by calling the optimize() method on any image. You can pass an options array to set ImageOptim API parameters.
      $image->size(800,600)->optimize()->url $image->optimize(['quality' => 'low', 'dpr' => 2]) // Set quality to low and enable hi-dpi mode
      Automatic optimization
      The module also has an automatic mode that optimizes all image variations after resizing. This is the recommended way to use this module since it leaves the original image uncompressed, but optimizes all derivative images.
      $image->size(800,600)->url // nothing to do here; image is optimized automatically
      To change compression setting for single images, you can pass an options array along with the standard ImageResizer options. Passing false disables optimization.
      $image->size(800, 600, ['optimize' => 'medium']) $image->size(800, 600, ['optimize' => ['quality' => 'low', 'dpr' => 2]]) $image->size(800, 600, ['optimize' => false])
      For detailed usage instructions and all API parameters, see the usage instructions on GitHub.
       
      Filenames
      Optimized images will be suffixed, e.g. image.jpg becomes image.optim.jpg. You can configure the suffix in the module settings.
       
      Roadmap
      Asynchronous processing. Not really high on the list. Image variations need to be created anyway, so waiting a few seconds longer on first load is preferable to adding complexity to achieve async optimization. Optimize image variations created by other modules. CroppableImage comes to mind. I don't use any of these, so if somebody wants to help out and submit a pull request — all for it! Add a dedicated page in the setup menu with a dashboard and detailed statistics. ImageOptim's API is very barebones for now, so not sure if that's feasible or even necessary.
      Stability
      I've been using this module on production sites for some time now, without hiccups. If you do notice oddities, feel free to comment here or investigate and submit PRs.
    • By daniels
      General
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      It can update / create a subscriber in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe users to different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns You can find it here: https://github.com/danielstieber/SubscribeToMailchimp
      Let me know what you think and if I should add it to the Modules Directory.
      Setup
      Log into your Mailchimp account and go to  Profile > Extras > API Keys. If you don't have an API Key, create a new one. Copy your API Key and paste it in the module settings (Processwire > Modules > Site > SubscribeToMailchimp). Back in Mailchimp, go to the list, where you want your new subscribers. Go to Settings > List name and defaults. Copy the List ID an paste it in to the module settings.
      Usage
      To use the module, you need to load it into your template:
      $mc = $modules->get("SubscribeToMailchimp"); Now you can pass an email address to the module and it will try to edit (if the user exists) or create a new subscriber in your list.
      $mc->subscribe('john.doe@example.com'); You can also pass a data array, to add additional info.
      $mc->subscribe('john.doe@example.com', ['FNAME' => 'John', 'LNAME' => 'Doe']); You can even choose an alternative list, if you don't want this subscriber in your default list.
      $mc->subscribe('john.doe@example.com', ['FNAME' => 'John', 'LNAME' => 'Doe'], 'abcdef1356'); // Subscribe to List ID abcdef1356  
      Important Notes
      This module does not do any data validation. Use a sever-sided validation like Valitron Make sure that you have set up your fields in your Mailchimp list. You can do it at Settings > List fields and *|MERGE|* tags Example
      Example usage after a form is submitted on your page:
      // ... validation of form data $mc = $modules->get("SubscribeToMailchimp"); $email = $input->post->email; $subscriber = [ 'FNAME' => $input->post->firstname, 'LNAME' => $input->post->lastname, ]; $mc->subscribe($email, $subscriber);  
      Troubleshooting
      In case of trouble check your ProcessWire warning logs.
      I can't see the subscriber in the list
      If you have enabled double opt-in (it is enabled by default) you will not see the subscriber, until he confirmed the subscription in the email sent by Mailchimp
      I get an error in my ProccessWire warning logs
      Check if you have the right List ID and API Key. Check if you pass fields, that exist in your list. Check if you pass a valid email address. Go to Mailchimps Error Glossary for more Information
      How To Install
      Download the zip file at Github or clone directly the repo into your site/modules If you downloaded the zip file, extract it in your sites/modules directory. You might have to change the folders name to 'SubscribeToMailchimp'. Goto the modules admin page, click on refresh and install it  
    • By PWaddict
      Module for hiding pages for non-superusers.
      Download
      HidePages
      Requirements
      ProcessWire 3.x Changelog
      1.0.1 (31 March 2018)
      Module renamed to prevent confusion 1.0.0 (30 March 2018)
      Initial release