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

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 totoff
      Dear all,
      tomorrow I'll have to introduce some editors on how to upload and edit images in image fields in Processwire. The site in question is quite image rich and I've spent some time to serve the appropriate images via scrcset already cropped for different screen sizes.
      However, the backend offers a lot of possibilities to manipulate images and most of them I'm not familiar with because as a developer I've never spent much thinking on what all the features might be good for … Yet I'm concerned that my editors work on images in the backend may interfere with my optimization strategies in the templates.
      Is there a general rule of thumb what content editors should do or not do with images in order not to break srcset strategies etc.? Maybe there is already a source of information you could point me to?
      Your recommendations are much appreciated!
    • By totoff
      Dear all,
      I'm upgrading an older side with the new custom fields for images feature as of 3.0.142. My image field is set to "Automatic" and holds a bunch of images together with their respective description on each page. New custom fields include "caption" among others and to make my live easier I I'm trying to populate "caption" with the value from the (default) description field. But unfortunately I can't seem to find out how to save the newly set values. This is my code:
      <?php foreach (page()->images as $image) { $image->set('caption', $image->description); bd($image->caption); echo files()->render("markup/views/view-card-image-fancybox.php", array('image'=>$image)); } ?> <?php $page->save(); bd($page->save()); ?> This sets the value as intended (see screenshot) but doesn't save it permanently to the database. What am I doing wrong?
      Thanks!
       

    • By jploch
      Hey folks,
      for a module (a pagebuilder based on PageTable) I need to save some settings as JSON. The values are saved for each page table item (a pw page). It's working well, but I am looking for ways to improve the structure I have. As I'm not that experienced with JSON, maybe someone more experienced can take a look and tell me if my approach is good practice. 

      My goal is to make all the items accessible by page id, without looping over them (using objects instead of arrays):
      // access from template with pw page var $jsonObject->items->{$page}->cssClass; Her is an example of my JSON structure:
      { "items": { "3252": { "id": "3252", "cssClass": "pgrid-main", "breakpoints": { "base": { "css": { "grid-column-end": "auto", "grid-row-end": "auto", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "60px", "padding-right": "60px", "padding-top": "60px", "padding-bottom": "60px", "background-color": "rgb(255, 255, 255)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3686": { "id": "3686", "cssClass": "test_global", "breakpoints": { "base": { "css": { "grid-column-end": "-1", "grid-row-end": "span 1", "grid-column-start": "1", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3687": { "id": "3687", "cssClass": "block_editor-3687", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3696": { "id": "3696", "cssClass": "block_editor-3696", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } } }, "breakpointActive": "base", "breakpointActiveSize": "@media (min-width: 576px)" }  
    • By dalibor
      I'm using hook for retrieving data from image metadata (IPTC) after image upload and filling them to some fields. When I choose server-side image resize, everything works well. But when I use client-side resize (which si much faster and client comfortable  - it uses PWImageResizer.js) image metadata are lost during resizing - I have downloaded the file after resize and checked for EXIF, IPTC etc. and they are not present.  Using PW 3.0.165. Tried to look into PWImageResizer.js but uhh it's too javascreepy to me:) 
    • By jploch
      Fieldtype Page Table Grid
      This is a sneak preview of a side project I've been working on for quite some time now. A lot of work and thought has gone into this, so I will most likely release this as a commercial module at some point in the near future. 

      As a designer (and developer) I get the appeal of a WYSIWYG editor. After playing around with some WYSIWYG page builder tools, I always felt something was wrong about them. So I decided to build my own PW version based on PageTable.

      Here is a small demo (using AdminThemeCanvas, but its working with other admin themes as well) :
      There is also a complete website that I built for a friend of mine using this module and some custom blocks.
      Concept
      This fieldtype shares a lot of features with PageTableExtended: it's also an extension of PageTable and renders the block templates in the backend and frontend (native PW templates and fields). You can also add your own css via module settings.
      The difference is, this fieldtype also gives you the ability to rearrange and resize elements in a visual way as well as enable inline editing for text, ckeditor and file fields. Similar (and promising) attempts have been made, but I wanted something based on native CSS grid instead of a CSS framework...so I built my own version. Most CSS frameworks are based on flexbox, which is great for layouting elements horizontally. With CSS grid, you can place elements horizontally and vertically, allowing for layouts that were not previously possible with CSS. Similar to webflow, this fieldtype uses javascript (in the backend) to let you manipulate CSS grid in a visual way to design fully responsive websites (or parts of them). It should still be possible to include a CSS framework if you like (just add the classes to your block markup and include the CSS via module settings).
      The CSS grid layout manipulations are saved in a single field as a JSON array and used to generate a dynamic stylesheet that you simply include in your main template (no inline styles). The styles are saved within the breakpoint you select and cascade down to smaller breakpoints. That means you can specify just the basic breakpoint and adjust other breakpoints if needed. The exception is the mobile breakpoint which will display everything in one column as a default (you can change the layout here too).
      The fieldtype also comes with an optional style panel to manipulate some additional CSS properties directly on the page. You can customize the panel or disable it completely from the module settings (and just use a CSS file that you include via module settings). The style panel is based on inputfields (nothing is saved to the database). This means that you just have to install the module and all fields are available to all blocks automatically (this can be customized). It also has the benefit that your installation is not flooded with fields; this module only installs one field.
      Don't want to give your customer all that power? Design features can be disabled for certain roles. The grid editor role can just edit the content and use the inline editing feature to edit content quickly. You can then also grant access individually to the style panel, resize or drag functionality.
      Features
      Blocks are just pages Blocks are defined by native PW templates and fields Manipulate CSS grid in a visual way to design fully responsive websites (or parts of them) Design features can be disabled for certain roles Inline editing of text, ckeditor and file fields The layout is 100% CSS grid (very small css file size) Simply drag and resize to manipulate grid items directly inside the backend Manipulate grid columns and rows directly on the page (use any number of columns you want) All style manipulations are saved as JSON and used to generate a dynamic stylesheet that you just include in your main template (no inline styles) Nested groups/grids (child pages of nested blocks are created under group parent) Global blocks work with page reference field (changes on one page, changes all blocks on all pages) Manual and auto placement of grid items Define custom icons for your blocks via native template settings (template -> advanced -> icon) Option to load lazysizes in the backend to enable lazy loading of assets with class lazyload Works with all default and ui-kit based admin themes If you have any questions or feedback, let me know.
×
×
  • Create New...