Jump to content
gebeer

Module ImageReference - Pick images from various sources

Recommended Posts

Hello all,

sharing my new module FieldtypeImageReference. It provides a configurable input field for choosing any type of image from selectable sources. Sources can be: 

  • a predefined folder in site/templates/
  • and/or a  page (and optionally its children)
  • and/or the page being edited
  • and/or any page on the site

CAUTION: this module is under development and not quite yet in a production-ready state. So please test it carefully.

UPDATE: the new version v2.0.0 introduces a breaking change due to renaming the module. If you have an older version already installed, you need to uninstall it and install the latest master version.

Module and full description can be found on github https://github.com/gebeer/FieldtypeImageReference
Install from URL: https://github.com/gebeer/FieldtypeImageReference/archive/master.zip

Read on for features and use cases.

Features

  • Images can be loaded from a folder inside site/templates/ or site/assets
  • Images in that folder can be uploaded and deleted from within the inputfield
  • Images can be loaded from other pages defined in the field settings
  • Images can be organized into categories. Child pages of the main 'image source page' serve as categories
  • mages can be loaded from any page on the site
  • From the API side, images can be manipulated like native ProcessWire images (resizing, cropping etc.), even the images from a folder
  • Image thumbnails are loaded into inputfield by ajax on demand
  • Source images on other pages can be edited from within this field.
  • Markup of SVG images can be rendered inline with `echo $image->svgcontent`
  • Image names are fully searchable through the API
$pages->find('fieldname.filename=xyz.png');
$pages->find('fieldname.filename%=xy.png');
  • 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 with links to help you edit those pages and remove references there before you can finally delete the image.
  • This field type can be used with marcrura's Settings Factory module to store images on settings pages, which was not possible with other image field types

When to use ?
If you want to 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 (e.g. icons, but not limited to that).
Other than the native ProcessWire images field, the images here are not stored per page. Only references to images that live on other pages or inside a folder 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)

Installation and setup instructions can be found on github.

Here's how the input field looks like in the page editor:

inputfield-in-editor.thumb.png.3d86af07fe9f4e67a50b385cf0e8803b.png

If you like to give it a try, I'm happy to hear your comments or suggestions for improvement. Install from URL: https://github.com/gebeer/FieldtypeImageReference/archive/master.zip

Eventually this will go in the module directory, too. But it needs some more testing before I submit it. So I'd really appreciate your assistance.

Thanks to all who contributed their feedback and suggestions which made this module what it is now.

 

  • Like 18
  • Thanks 1

Share this post


Link to post
Share on other sites
8 hours ago, gebeer said:

It can also be used to offer a choice of images that are used site-wide without having to upload them to individual pages.

Pretty cool, thanks for sharing!

Share this post


Link to post
Share on other sites

Thanks @gebeer - this looks really useful! I wonder whether it would be useful to have an "Upload Image" option so that site editors can easily add images to this global directory so they don't need to resort to FTP or engaging their developer to add new images. I suppose the alternative would be to create a "Global Images" page in the page tree and point this module to the /assets/files/xxxx/ directory for this page - maybe that's actually the better approach?

Anyway, I can definitely see using this quite often!

  • Like 3

Share this post


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

I suppose the alternative would be to create a "Global Images" page in the page tree and point this module to the /assets/files/xxxx/ directory for this page - maybe that's actually the better approach?

If @gebeer has time to add additional features to this module, I would vote for something like this, because it sounds simple enough. The simpler the better 🙂

Share this post


Link to post
Share on other sites
Just now, szabesz said:

If @gebeer has time to add additional features to this module, I would vote for something like this, because it sounds simple enough. The simpler the better 🙂

I just implemented it here:

image.png.4efb9b512f512c441c9269f9217208b9.png

The only changes I had to make to the module were to set the root path higher than the default site/templates/ so that I could point it to /site/assets/files/xxxx and it works brilliantly!

BTW, this is what the Global Images page looks like:

image.png.492f50134e968310fe5d66e9f4241251.png

  • Like 4

Share this post


Link to post
Share on other sites

@szabesz Actually I was thinking about making this change, too 🙂

@adrian Great job! Could you make a PR with your changes? I'd like to implement them.

This will also make the images instances of Pageimage and we get all image manipulation methods.

  • Like 1

Share this post


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

Great job! Could you make a PR with your changes? I'd like to implement them

I could, but I am not sure if you want to refine things a little more than my quick hack. I just replaced all instances of $this->config->paths->templates and $this->config->urls->templates with $this->config->paths->root and $this->config->urls->root 

I think perhaps it would be better to have an option in the field's settings to actually choose a page rather than manually /site/assets/files/xxxx - what do you think?

  • Like 1

Share this post


Link to post
Share on other sites
Just now, adrian said:

I think perhaps it would be better to have an option in the field's settings to actually choose a page rather than manually /site/assets/files/xxxx - what do you think?

Exactly the same thought came to my mind. Will implement this as an option.

  • Like 3

Share this post


Link to post
Share on other sites

I might be getting carried away, but I think it might also be nice to be able to select images from child pages of this page as well - I can see a use case for categorizing images and I think this would be a decent way of doing it. Perhaps the picker could even have a dropdown that lets you filter by child page (category). What do you think?

  • Like 1

Share this post


Link to post
Share on other sites

@adrian While I think that this is a good idea, I am not sure yet, if I want to go that far with this module. This would add additional complexity when installing and I wanted to keep it as simple as possible. This addition would make it kind of a "mini media manager" and I don't know how high the demand for it really would be since we have kongondo's excellent media manager already.

But if more people would like to have that option, I can implement it. Please vote.

Share this post


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

This would add additional complexity when installing

I was thinking this would be optional - I don't think anyone has to set this up - the module would scan these only if they exist.

Share this post


Link to post
Share on other sites

@adrian I'm with you here.

After contemplating some more, I think the page approach should be the only option, discarding the folder option in site/templates/. Since PW is all about pages, this makes more sense. Also editors can easily add/remove images as they see fit without having to use other tools like FTP clients. This also provides the manipulation methods from Pageimage class to all images.

What do you all think?

  • Like 2

Share this post


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

@adrian I'm with you here.

After contemplating some more, I think the page approach should be the only option, discarding the folder option in site/templates/. Since PW is all about pages, this makes more sense. Also editors can easily add/remove images as they see fit without having to use other tools like FTP clients. This also provides the manipulation methods from Pageimage class to all images.

What do you all think?

Makes sense to me 🙂

Share this post


Link to post
Share on other sites

What about adding the image description, width, height, and filesize to the tooltip and under the selected image?

  • Like 1

Share this post


Link to post
Share on other sites
17 minutes ago, adrian said:

What about adding the image description, width, height, and filesize to the tooltip and under the selected image?

can do 🙂

  • Like 2

Share this post


Link to post
Share on other sites
5 hours ago, gebeer said:

While I think that this is a good idea, I am not sure yet, if I want to go that far with this module. This would add additional complexity when installing and I wanted to keep it as simple as possible. This addition would make it kind of a "mini media manager" and I don't know how high the demand for it really would be since we have kongondo's excellent media manager already.

But if more people would like to have that option, I can implement it. Please vote.

@kongondo's Media Manager module offers a lot more than this module would offer even with the child pages feature, so as far as I can see it you are not working on something like that.

The suggested child pages feature would be welcome but if you stick to the one page only solution than that is great too.

  • Like 2

Share this post


Link to post
Share on other sites

@gebeer - I am sure you have already thought of this, but if you're changing to only support selecting a page (and its children), you could make use of  PW's API to load up the images in the picker field, rather than scanning the server folder directly. I don't think there is a reason not to change.

  • Like 1

Share this post


Link to post
Share on other sites
5 hours ago, adrian said:

you could make use of  PW's API to load up the images in the picker field, rather than scanning the server folder directly

Yes, I am using Pages and Pageimages to retrieve and list them. Everything is working fine so far. Doing some more fine tuning. Have to cater for cases where an image got deleted from the page that holds all images but is still referenced from my Fieldtype on a page. And things like that...

Can I make a fieldtype module autoload so that I can attach hooks to Pageimage and Pageimages from init() within my fieldtype? I tried, but it doesn't work.

  • Like 1

Share this post


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

Can I make a fieldtype module autoload so that I can attach hooks to Pageimage and Pageimages from init() within my fieldtype? I tried, but it doesn't work.

I don't think it's possible. Two comments in the core code:

"Fieldtype modules are not automatically loaded, they are only loaded when requested"

"Inputfields are not loaded until requested"

I think you might need to add a helper module for those hooks. I guess otherwise you would need to check for the presence of the pageimage from init(), rather than hooking which I think could also work fine.

  • Like 1

Share this post


Link to post
Share on other sites

Or maybe you are looking to hook into the image deletion process to prevent an image from being deleted if it is used by an ImagePicker field? If so, that sounds like a smart thing to have 🙂

  • Like 1

Share this post


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

Or maybe you are looking to hook into the image deletion process

This is what I'm trying to accomplish.

Also I want to add a new property to Pageimage that holds the svg markup for inlining. Even if I add my hook inside the formatValue() method, it is not executed. Still fiddling. Will find a solution, eventually...

  • Like 1

Share this post


Link to post
Share on other sites

@adrian @szabesz and everyone who followed this discussion. I opened a new thread for the Module FieldtypeImageFromPage which is the new module that evolves out of this one after the discussion. Had a happy weekend of module coding 😎. Please try the new module and let me know what you think. Cheers.

  • Like 2

Share this post


Link to post
Share on other sites

I just released v1.1.2 which has all the same features but removes dependency from MySQL >= 5.7.8 and fixes some minor issues. The module can now be used on any MySQL setup. You can update to or install from scratch the latest master version.

If you run into problems, please report here or open an issue on github. Thank you.

 

  • Like 6

Share this post


Link to post
Share on other sites

Just an idea: when you insert images into CKEditor with the pwimages plugin, you can choose an image from the page you are on but also from any other page of the site. Do you think this could be a useful feature for ImagePicker?

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 bernhard
      --- Please use RockFinder3 ---
    • By cosmicsafari
      Hi all,
      I have need to dynamically set InputFieldMultiSelect to  selected on page load based on the status of some items within a database table.
      However I keep running into issues when trying to do this via InputfieldSelect::setOptionAttributes()
      https://processwire.com/api/ref/inputfield-select/set-option-attributes/
      Going by the above it sounds like it should be pretty straight forward, and for certain values it seems to work but not when I wanted to set it to 'selected'.
      For example:
      $f->setOptionAttributes(1030,['foo' => 'test']); The above works as I would have wanted, in that it updates the option with the value 1030, to include the attribute foo="test"
      But the same code above edited to the following:
      $f->setOptionAttributes(1030,['selected' => 'selected']); Doesn't seem to do anything?
      I assume I'm missing something or trying to implement the 'selected' wrongly but I'm not sure how else I should approach this, any advice would be much appreciated.
       
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user 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, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
×
×
  • Create New...