Jump to content
gebeer

FieldtypeImageFromPage pick an image from various sources

Recommended Posts

EDIT: all development and discussion of this module has been moved to Module FieldtypeImagePicker which now contains all features of this module and more. This module will not be maintained any further. The information below remains for pure historical reasons.

I am happy to present my new fieldtype FieldtypeImageFromPage. It is made up of 2 modules:

Fieldtype Image Reference From Another Page is a Fieldtype that stores a reference to a single image from another page. The image can be selected with the associated Inputfield.
Inputfield Select Image From Page is an Inputfield to select a single image from images on a predefined page and it's children.
And there also is a helper module that takes care of cleanup tasks.

This module evolved out of a discussion about my other Module FieldtypeImagePicker.  It caters for use cases where a set of images is being reused multiple times across a site. With this fieldtype these images can be administered through a chosen page. All images uploaded to that page will be available in the inputfield.

When to use ?

Let editors choose an image from a set of images that is being used site-wide. Ideal for images that are being re-used across the site.
Suited for images that are used on multiple pages throughout the site (e.g. icons).
Other than the native ProcessWire images field, the images here are not stored per page. Only references to images on another page are stored. This has several advantages:

  • one central place to organize images
  • when images change, you only have to update them in one place. All references will be updated, too. (Provided the name of the image that has changed stays the same)

Features

  • Images can be manipulated like native ProcessWire images (resizing, cropping etc.)
  • Image names are fully searchable through the API
  • Accidental image deletion is prevented. When you want to delete an image from one of the pages that hold your site-wide images, the module searches all pages that use that image. If any page contains a reference to the image you are trying to delete, deletion will be prevented. You will get an error message to help you edit those pages and remove references there before you can finally delete the image.

How to install and setup

  1. Download and install this module like any other modules in ProcessWire
  2. Create a page in the page tree that will hold your images. This page's template must have an images field
  3. Upload some images to the page you created in step 2
  4. Create a new field. As type choose 'Image Reference From Another Page'. Save the field.
  5. In 'Details' Tab of the field choose the page you created in step 2
  6. Click Save button
  7. Choose the images field name for the field that holds your images (on page template from step 2)
  8. Click Save button again
  9. Choose whether you want to include child pages of page from step 2 to supply images
  10. Add the field to any template
  11. You are now ready to use the field

View of the inputfield on the page edit screen:
inputfield-in-editor.thumb.png.100bda7a6a16b9e6ee9a099f3f0b2ce2.png

View of the field settings
field-settings.thumb.png.6846178c9562cee896e177b9fbe95bee.png

The module can be installed from this github repo. Some more info in the README there, too.

In my tests it was fairly stable. After receiving your valued feedback, I will eventually add it to the modules directory.

My ideas for further improvement:
- add ajax loading of thumbnails

Happy to hear your feedback!

 

Edited by gebeer
move features to other module
  • Like 15

Share this post


Link to post
Share on other sites

Thanks for your work and sharing the module, much appreciated! I have just installed it, but stopped at this stage as my current use-case is: I would like to use it as a "page header" image picker. What I would like to do is this (at least theoretically):

  • I want to add two image fields to the template of the Home page . One for "header image normal", and another one for "header image tall". So the home should be used for storing these site-wide images.
  • 'Image Reference From Another Page' should be either added to the home template itself and to all of the templates of top level pages, so that the user can pick one image to be used as the header of that page.
  • However, because I use Home as the source of images, I do not want the module to search for images under its child pages.

I guess the above outlined setup should be ok, but before spending time on trying it out, could you please confirm that it is a working setup or not?

Share this post


Link to post
Share on other sites

This is exactly what I was looking for. Sorry for the dumb question....

  1. How do I actually install this into processwire for it to recognize?
  2. and what would be the exact name of the module?

Share this post


Link to post
Share on other sites

@szabesz ATM there is no option to choose whether child pages of the "image holder page" (home in your case) should be included or not. This would be a necessary option in your use case. Otherwise the inputfield would list all children of home as sources for images.
Couldn't you just use another page as source for the images and than create the 2 fields "header image normal" and "header image tall" as fields with my fieldtype and assign them to all top level pages' templates?
Anyways, sounds like an option to exclude child pages would be good. Think, I'm going to add this to the next release.

  • Like 1

Share this post


Link to post
Share on other sites
1 minute ago, gebeer said:

Couldn't you just use another page as source for the images

Sure I could, however normally I use the template of the home for site-wide settings, which is a simple but working solution. The home page is rarely edited by my clients so in this sense it is a perfect fit for rarely edited site-wide settings or – in this use-case – as storage for such images.

3 minutes ago, gebeer said:

Anyways, sounds like an option to exclude child pages would be good. Think, I'm going to add this to the next release.

Thank you in advance! I'm going to wait for that, I'm not in a hurry.

Share this post


Link to post
Share on other sites
6 minutes ago, shogun said:
  • How do I actually install this into processwire for it to recognize?
  • and what would be the exact name of the module?

You can install this module from URL. Have a read here how to do this.

In the 'Add Module from URL section' of the Module install page, paste this URL that points to the zip download from my github repo: https://github.com/gebeer/FieldtypeImageFromPage/archive/master.zip

No need for the module name.

Share this post


Link to post
Share on other sites

I got it working. It's cool. The only thing I noticed after installing, creating the default photo page, adding my photos and then creating the field and adding that field to a page.

The first time you arrive on a page that uses the new field, I got this error. It went away once I attached an image from the photos page, but I assume it would be more user friendly if there wasn't an error on the initial load before a

 

Screen Shot 2019-12-08 at 10.08.02 AM.png

  • Like 1

Share this post


Link to post
Share on other sites

Also would be cool if it allowed you to choose multiple images from the page so you can create a gallery from the stored global images.

  • Like 2

Share this post


Link to post
Share on other sites
6 minutes ago, shogun said:

The first time you arrive on a page that uses the new field, I got this error

Thanks for spotting this. Will be fixed for the next release soon.

4 minutes ago, shogun said:

Also would be cool if it allowed you to choose multiple images from the page so you can create a gallery from the stored global images.

This is not planned, as of yet, sorry. But if more people like to have that feature, I will eventually add it.

Share this post


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

Thank you in advance! I'm going to wait for that,

No need to wait any longer 😎 Option for including child pages is added and live on github in the new master v0.0.2 .

EDIT: It's the v0.0.3, getting late here

  • Thanks 1

Share this post


Link to post
Share on other sites
23 minutes ago, shogun said:

The first time you arrive on a page that uses the new field, I got this error

That error is fixed on the latest release. To install it,  download a new module zip from github and replace all the files inside the module folder with files from the zip.

Share this post


Link to post
Share on other sites
22 minutes ago, gebeer said:

This is not planned, as of yet, sorry. But if more people like to have that feature, I will eventually add it.

Let's put the current state of the module to some "stress test" first for some time. After that, I happy to support "multiple images" request 🙂

20 minutes ago, gebeer said:

No need to wait any longer 😎 Option for including child pages is added and live on github in the new master v0.0.2 .

I'm gonna upgrade, thanks!

Edited by szabesz
typo

Share this post


Link to post
Share on other sites

Looks brilliant @gebeer

A couple of minor things:

1) The "Include child pages of above page as source for images?" checkbox doesn't show as checked when it is actually checked. Typically the way to handle this is with a ternary conditional to set the checked attribute to "checked" if the value is "1", eg: 

$f->attr('checked', $data['enabled'] == '1' ? 'checked' : '');

2) I didn't get an error message when deleting one of the source images. I actually wonder if you can hook into this and prevent deletion completely (unless the image is removed from being selected by this field.

  • Like 2

Share this post


Link to post
Share on other sites
28 minutes ago, gebeer said:

Use the v0.0.3 version

Thanks, I have updated the module, and set up two image fields for the Home's template. Afterwards, I created an "Image Reference From Another Page" inputfield, however, in "Chose a page to get images from" any page is selectable except for Home. Any idea why is that so?

Share this post


Link to post
Share on other sites

New version v0.0.4 released https://github.com/gebeer/FieldtypeImageFromPage

12 hours ago, adrian said:

checkbox doesn't show as checked when it is actually checked

Is now fixed

12 hours ago, adrian said:

I didn't get an error message when deleting one of the source images. I actually wonder if you can hook into this and prevent deletion completely (unless the image is removed from being selected by this field

Implemented this. Also think it is better to prevent deletion of images as long as they still are referenced from other pages. In this case now a detailed error message is displayed which contains a list of pages that have references to the image, with edit links for those pages. Following the edit links (they open in new tab) shows only the relevant field to be edited on that page. Not sure this works in repeater contexts, though. Will have to test.

 

12 hours ago, szabesz said:

any page is selectable except for Home

Sorry for that, it was late last night. It is now fixed.

 

  • Thanks 1

Share this post


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

Implemented this. Also think it is better to prevent deletion of images as long as they still are referenced from other pages. In this case now a detailed error message is displayed which contains a list of pages that have references to the image, with edit links for those pages.

Works great - thank you! This is going to be such a useful module 🙂

  • Like 2

Share this post


Link to post
Share on other sites

@adrian Yes, pretty useful 😎

I tested this in repeater matrix context and it works, even the deletion prevention.
Only thing which is not so nice: when you have this field inside a repeater, the edit links to the pages that contain the image references are pointing to the repeater pages, not to the pages containing the repeater field. Do you think this could boggle editors? They normally never see the repeater pages in the system.

Share this post


Link to post
Share on other sites
3 minutes ago, gebeer said:

Do you think this could boggle editors

Yeah, being out of context like this will be confusing I think. Could you try the getForPage() method to find the page that the repeater item is on and link to that instead?

  • Like 1

Share this post


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

Yeah, being out of context like this will be confusing I think. Could you try the getForPage() method to find the page that the repeater item is on and link to that instead?

Will do that. Also think it is better. Only have to find a way how to open the respective repeater field on that page and ideally scroll to it. There should be a built in way to do this. I remember having read sth about it but can't recall where it was.

Share this post


Link to post
Share on other sites

Hi @gebeer,

nice module, thx for sharing! Just tested it and everything worked flawlessly. 2 suggestions for improvements:

  1. When no image is selected the gallery could be opened by default (I guess that is what one would like to do in that case: Choose an image)
  2. Maybe there could be a link to the page that holds the images so if one wanted to upload a new image they could just click the link, upload the image and save the page. If your inputfield updated its content after that process it would even be better, but not necessary in the first step, I think.
  • Like 1

Share this post


Link to post
Share on other sites
11 hours ago, bernhard said:

nice module, thx for sharing! Just tested it and everything worked flawlessly

Thanks for testing.

11 hours ago, bernhard said:

When no image is selected the gallery could be opened by default (I guess that is what one would like to do in that case: Choose an image)

I have this behavior in my other module that allows to pick images from a single folder. But now that there is an option to also choose images from child pages, it would make the inputfield grow too high. Also if there are many images. I will implement ajax loading for the thumbnails on open and think that is better, especially for cases with many images or child pages or when the field is used inside repeaters.

 

11 hours ago, bernhard said:

Maybe there could be a link to the page that holds the images

Good idea! Will add this. Maybe open in modal window and refresh thumbnails on close. Will be easy to implement once the ajax thumbnail loading is there.

9 hours ago, gmclelland said:

Maybe this? https://processwire.com/blog/posts/pw-3.0.145/  See the Inputfield Javascript API

Thanks for the link. That would be one option but only works for installs which are up to date on the PW version. Repeater fields also open automatically if they have an error attached to them. That is another option. But implementation is quite complex. Still experimenting with this feature.

  • Like 1

Share this post


Link to post
Share on other sites

Updated to v0.0.5 on github

New features:

  • optional Ajax loading of thumbnails. Especially useful when field is used inside repeaters or has many images.
  • edit link right next to the thumbnails for the page that supplies the images. When clicked, the images field that holds the images will be loaded in a modal window. After making changes to the images and saving, the thumbnails are dynamically reloaded

Side note: while working on these, I discovered that you cannot assign custom attributes to InputfieldMarkup and InputfieldWrapper (both inherit from Inputfield class) with $field->attr('data-sth', 'value'). $field->setAttribute() also doesn't work. Anyone else also experienced this? Is it deliberate or a bug?

  • Like 4

Share this post


Link to post
Share on other sites
30 minutes ago, gebeer said:

Side note: while working on these, I discovered that you cannot assign custom attributes to InputfieldMarkup and InputfieldWrapper (both inherit from Inputfield class) with $field->attr('data-sth', 'value'). $field->setAttribute() also doesn't work. Anyone else also experienced this? Is it deliberate or a bug?

Not sure, but is this what you are looking for? https://processwire.com/api/ref/inputfield/wrap-attr/

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • 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-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 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 (alpha version only available via GitHub) 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 ----
       
    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Robin S
      This module is inspired by and similar to the Template Stubs module. The author of that module has not been active in the PW community for several years now and parts of the code for that module didn't make sense to me, so I decided to create my own module. Auto Template Stubs has only been tested with PhpStorm because that is the IDE that I use.
      Auto Template Stubs
      Automatically creates stub files for templates when fields or fieldgroups are saved.
      Stub files are useful if you are using an IDE (e.g. PhpStorm) that provides code assistance - the stub files let the IDE know what fields exist in each template and what data type each field returns. Depending on your IDE's features you get benefits such as code completion for field names as you type, type inference, inspection, documentation, etc.
      Installation
      Install the Auto Template Stubs module.
      Configuration
      You can change the class name prefix setting in the module config if you like. It's good to use a class name prefix because it reduces the chance that the class name will clash with an existing class name.
      The directory path used to store the stub files is configurable.
      There is a checkbox to manually trigger the regeneration of all stub files if needed.
      Usage
      Add a line near the top of each of your template files to tell your IDE what stub class name to associate with the $page variable within the template file. For example, with the default class name prefix you would add the following line at the top of the home.php template file:
      /** @var tpl_home $page */ Now enjoy code completion, etc, in your IDE.

      Adding data types for non-core Fieldtype modules
      The module includes the data types returned by all the core Fieldtype modules. If you want to add data types returned by one or more non-core Fieldtype modules then you can hook the AutoTemplateStubs::getReturnTypes() method. For example, in /site/ready.php:
      // Add data types for some non-core Fieldtype modules $wire->addHookAfter('AutoTemplateStubs::getReturnTypes', function(HookEvent $event) { $extra_types = [ 'FieldtypeDecimal' => 'string', 'FieldtypeLeafletMapMarker' => 'LeafletMapMarker', 'FieldtypeRepeaterMatrix' => 'RepeaterMatrixPageArray', 'FieldtypeTable' => 'TableRows', ]; $event->return = $event->return + $extra_types; }); Credits
      Inspired by and much credit to the Template Stubs module by mindplay.dk.
       
      https://github.com/Toutouwai/AutoTemplateStubs
      https://modules.processwire.com/modules/auto-template-stubs/
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.60
      Composer: rockett/jumplinks
      ⚠️ NOTICE: 1.5.60 is an important security patch-release for an XSS vulnerability discovered by @phlp. It's HIGHLY RECOMMENDED that all Jumplinks users update to the latest version as soon as possible.
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! 🙂
    • By Robin S
      Add Image URLs
      Allows images/files to be added to Image/File fields by pasting URLs.

      Usage
      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image and file fields. Use the button to show a textarea where URLs may be pasted, one per line. Images/files are added when the page is saved.
       
      https://github.com/Toutouwai/AddImageUrls
      https://modules.processwire.com/modules/add-image-urls/
×
×
  • Create New...