Jump to content
Soma

Images Manager (beta)

Recommended Posts

PW Images Manager (beta)

Just a weird little screencast trying to show how it works. (out of date a little, tags now use a textfield for easy copy/paste)

This module allows you to manage images from one central repository. You create a root page "/images/" where you can then add categories and images as pages. From there the new admin page created "ImagesManager" will show categories and images added in a ajax data table, from where you can see and search/filter all images, upload and create new categories and edit images too.

Every image will also show an image tag generated to copy into a textarea. This tag looks like this:

{image=/path/to/image/imagename/, width=200}
The width=100 is the thumbnail size used to output the image.

You can also have additional segment to contain classes:

{image=/path/to/image/imagename/, width=100, class=align_left}
Or you can enter the id directly:
{image=1033, width=100}
Once inserted into a textarea field it will get parsed when saved and loaded automaticly. It will store an abstract id tag in Database and convert it back to the image HTML tag. So after first save you'll see the image inserted in a Wysiwyg and be able to resize and place it as usual. Once it's inserted somewhere Images Manager will show a search link with the pages containing the image (you can configure the fields int the module setting). You can change the image or move it to a different category, it will still work and show the correct image. This also works with multi-language fields.

You can still also use the regular insert image dialog in TinyMCE and chose image from those pages. And it will start keeping track of those as well (they're the same after all).

You can use those central images pages also with page fields to reference them single or even whole categories, search them with API and do what you like.

Images Manager will also parse the page render on front-end and replace any found image tags with the HTML code. It will also look for a description on the image and output it as alt tag. If you want to have multi-language description you can add a `image_description` TextLanguage field to the image page template and have images parser use them.

Along with this module, you can also install the `PageListImageLabel` module to add thumbnails to the image pages in the tree.

To get it working you need to have the basic setup:

1. Create new `image` field with input setting to 1 max image

2. Create new `image` template and add `title` and the `image` field created before

3. Create a 'image-category' template with only title and allow the `image` template and `image-category` as child pages under family settings.

4. Create a `image-root` template with only the title field for the root of the images tree. Allow only `image-category` as child page under family settings.

5. Create the root page with the `image-root` under the home page as "/images/"

6. Done.

The structure of the image repository looks like this

/images/

/cagetory1/

/imagesxy/

/category2/

/image2/

/image3/

Now you can use the ImagesManager to add categories and images. But you can also still use the page tree to add new stuff as usual.

The root path, template names and fields are configurable in the module settings.

How to install the module:

- Download the contents of this repository and put the folder renamed as "ImagesManager" into your site/modules/ folder

- Login in to ProcessWire and got to Modules page and click "Check for new modules". You should see a note that the two new module were found. Install the "ImagesManager" module.

- A new admin page "ImagesManager" should appear in the top menu.

- You may configure the option on the module screen to suit your needs.

Download at github

https://github.com/somatonic/ImagesManager

Thanks and enjoy.

  • Like 31

Share this post


Link to post
Share on other sites

Amazing work Soma!!

Share this post


Link to post
Share on other sites

This looks really awesome, Soma! Thanks so much for this (and also for helping me in regards to my image management concerns post). I will definitely be giving this a run... er, once I break through this wall of trouble I'm having with learning PW. In any case, this looks like quite the thing that could help me.

Questions:

How many images can this manager handle comfortably, would you say? And is this something that's server intensive?

Also, is this something that you'd recommend for the general handling of all images, or just the ones that would be reused?

Share this post


Link to post
Share on other sites

Soma, this is awesome!

One minor suggestion: Instead of copying the image code by hand perhaps it is possible to copy it on click with Javascript?

One major improvement: Somehow connect the image manager to a standard image field, so you can also insert existing images to it and / or mix it with single ones. Like I suggested here: http://processwire.com/talk/topic/1188-image-inputfield-like-in-tinymce/#entry10701 I know that we would need a way of symlinking to other images than the ones in the assets/files folder. But you are creative ;-)

Great work!

  • Like 3

Share this post


Link to post
Share on other sites

Bravo! This'll open the flood gates to folk who expect this functionality in whatever CMS they use.

"Somehow connect the image manager to a standard image field" <- An uber image field

I rarely stick images into a wysiwyg editor and I have dreams where the standard image field can either accept an upload or link to another image on another page.

  • Like 4

Share this post


Link to post
Share on other sites

Marty, that is good dream to have (it would be superb feature).

Soma: you are a machine.

  • Like 4

Share this post


Link to post
Share on other sites

Thanks guys!

Yes there I see some room for improvements to select the tag and also show some infos of the image size.

It's impossible to have image field select from those images. It would require a new image fueldtype. But that's not something that has to be connected to ImagesManager but just a field you can select an image page. Thats the great thing about this approach.

But you can do it with a page field easily. I'm doing it. If you use PageListSelect you'll even see the image thumb. And it would also be possible to select multiple or even just categories. This is even better than a dedicated fieldtype.

  • Like 1

Share this post


Link to post
Share on other sites

WOW! Very, very interesting module, Soma!

Share this post


Link to post
Share on other sites

it's.. it's.. beautiful

^-^

Share this post


Link to post
Share on other sites

This looks really awesome, Soma! Thanks so much for this (and also for helping me in regards to my image management concerns post). I will definitely be giving this a run... er, once I break through this wall of trouble I'm having with learning PW. In any case, this looks like quite the thing that could help me.

Questions:

How many images can this manager handle comfortably, would you say? And is this something that's server intensive?

Also, is this something that you'd recommend for the general handling of all images, or just the ones that would be reused?

PW can handle x thousands of pages easily. Image Manager is using ajax based data table to list and search/filter those pages, so it scales infinitely. Also the abstraction of the images in texts uses page ID's searches, and this is pretty fast. So you could go as far as your server limit. It's not more intensive than PW itself. ImagesManager doesn't add a noticeable overhead.

You could use this for all images, but still also use the on page image field where it makes sense. However when sharing images and inserting those in Textareas, I think ImagesManager approach and its abstract feature is a big plus in handling those.

It's still alpha and it's possible some things may change on the way to a first RC. So it's not for use in production yet. 

  • Like 1

Share this post


Link to post
Share on other sites

Nice job Soma! Lots of good thinking here, and I like where you are going with the scalability. I look forward to seeing this in the modules directory. 

Share this post


Link to post
Share on other sites

I just pushed an update to 0.0.2 to github.

Some refactoring and some changes

- changed image tag syntax to use selector string syntax. This is easier to handle and I can use the PW selector class to read key=value easily.

Now supports:

{image=/path/, width=200, height=200, class=someclass, id=myimage, rel=album}
- improved image upload to use the image field settings for max size settings, also improved error handling there

- added some translations string

- changed data table some and added a input for the tag where when you click it will select the tag text automatic for easy copying.

- added modified date (sortable), also fixed some stuff with sortable of other cols

- added size col

- improved data table live search to search for also image description or image description field and title

Planned

- improve upload even more if/where possible

- add easy image delete function

- (Done) add textarea fields setting, to only insert "ImageManager" button to those specified

Any testing or help appreciated.

Thanks

  • Like 5

Share this post


Link to post
Share on other sites

Hey Soma, very cool Manager!
(it's not the first time I say this, but it can't be said to often :) )
 
I want to ask if it is possible and if you find it useful, to include an optional userdefined callback-function that gets invoked in the public function executeUpload() method at line 517. After successful upload and the new ImagePage is saved calling it for example like this:
 

if( ! empty($this->options['userCallbackUpload']) && function_exists($this->options['userCallbackUpload']) ) {
  ${$this->options['userCallbackUpload']}( $imagepage );
}

 
With this, users may have a simple way to extend imagesPageTemplate with some more fields (e.g. for Exif-data). Yes, actually they allready have this option to extend the template or provide an own, but it would only allow to do a manually populating of fields. With a userCallbackFunction it could be done automatically.
 
Is this not of interest for the ImagesManager himself?
You may read Exif-description and IPTC-description fields and populate automatically the ImageDescriptionField. (IPTC has higher priority as EXIF).
 
So, if a user uses IPTC-description the field is allready filled, if not, and Exif-Description is available, this is used.
Downside: If there is unwanted text populated, the user has to change it manually. But with nothing populated automatically the user allways has to do it all manually.
 
Maybe it could be an boolean option: 'Yes, do autopopulate the image description' or 'NO'  ?
 
 
EDIT: approved code for reading this I can provide, - as you've said elsewhere: i'm the 'metadata-man' :P

  • Like 1

Share this post


Link to post
Share on other sites

Hey Mr MetaData!

Yeah sure why not. Since it does add value and it's only optional I think this is good idea to add.

I just went ahead and added support for MetaData in my last commit. You could now add a field "image_exif" and get the EXIF data stored when uploading images. I made the method setMetaData(), which adds the meta data on page/image creation, hookable so you can do a hook on it to store additional data. Not sure if this a good idea but maybe nice to have.

v 0.0.3

  • fixed issue with images getting added twice to the assets folder (hope this is now ok)
  • removed the performance intense pages search for image tags (In my testinstall with 120k pages this result in many second waiting to load the data table.
  • and just output a link on all images to a PW search that will run a search.
  • added EXIF data support.

Let me know if that EXIF data reading is ok, or if it need a more sophisticated method.

You can hook the Meta Data method like this from a autoload module:

$this->addHookAfter("ImagesManager::setMetaData", $this, "hookMetaData");

public function hookMetaData(HookEvent $event){
    $page = $event->arguments[0]; // page that the image will be added
    $file = $event->arguments[1]; // path of file in temp upload folder
    // do whatever you like
    $page->yourfield = "I'm the Meta Man!"; // will be saved to page
}
  • Like 3

Share this post


Link to post
Share on other sites

...

Let me know if that EXIF data reading is ok, or if it need a more sophisticated method.

...

Exif reading is perfect!  :)

We can retrieve the data with

$myExifArray = wireDecodeJSON( $myImagePage->image_exif ); 

EDIT:  Your solution is very elegant. The user who wants to get Exifdata may only add a TextareaField to his image-Template!

---

But there is something with the Textfield not allright: post-1041-0-90412700-1366564393_thumb.jp

I use Firefox on Windows

Edited by horst

Share this post


Link to post
Share on other sites

Hi, it's me again.
 
It would be really nice if we can have a field for IPTC as well:

'imagesIPTCField' => 'image_iptc',

and if you can provide their fieldnames within the hookable method:

$this->setMetaData($imagepage, $this->upload_path . $file, $this->options['imagesEXIFField'], $this->options['imagesIPTCField']);
public function ___setMetaData(Page $page, $file, $fieldnameExif, $fieldnameIPTC) {

If you want to populate IPTC data too:

		// write iptc data if field exists on page
		if($page->template->fieldgroup->hasField($this->options['imagesIPTCField'])) {
			$tmp = getimagesize($file, $info);
			if(isset($info['APP13'])) {
				$iptc = iptcparse($info['APP13']);
				if($iptc) {
					$page->set($this->options['imagesIPTCField'], json_encode($iptc));
				}
			}
		}

Share this post


Link to post
Share on other sites

The hook does already allow you to do any additional custom field saving... Just add field you wish and populate it in the hook.

Thx I'll have a look. Forgot FF isnt consistent across OS. I think I know what it is.

Share this post


Link to post
Share on other sites

The hook does already allow you to do any additional custom field saving... Just add field you wish and populate it in the hook.

Thx I'll have a look. Forgot FF isnt consistent across OS. I think I know what it is.

Allright ^-^ , - but getting the ExifFieldname would be of great help if the user changes the default name: function ___setMetaData(Page $page, $file, $fieldnameExif)

Many thanks!

Share this post


Link to post
Share on other sites

You can already get the settings via the module options.

Share this post


Link to post
Share on other sites

You can already get the settings via the module options.

Yep (ich habs)  :) : $options = wire('modules')->getModuleConfigData(wire('modules')->get('ImagesManager'));

Share this post


Link to post
Share on other sites

Hmm, wire("modules")->get("ImagesManger")->options[key] should be enough :) The module sets the options array in the init.

But you can also get it when you hook setMetaData() with 

$event->object->options['imagesEXIFField']; 
  • Like 1

Share this post


Link to post
Share on other sites

willyc, nope. it's not in modules directory yet!

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 joshua
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The type has to be "optin" to get recognized by PrivacyWire, the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button> This module is still in development, but we already use it on several production websites.
      You find it here: PrivacyWire Git Repo
      Download as .zip
      I would love to hear your feedback 🙂
      CHANGELOG
      0.1.1 Debugging: fixed error during uninstall 0.1.0 Added new detection of async scripts for W3C Validation 0.0.6 CSS-Debugging for hiding unused buttons, added ProCache support for the JavaScript tag 0.0.5 Multi-language support included completely (also in TextFormatter). Added possibility to async load other assets (e.g. <img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">) 0.0.4 Added possibility to add an imprint link to the banner 0.0.3 Multi-language support for module config (still in development) 0.0.2 First release 0.0.1 Early development
    • By bernhard
      --- Please use RockFinder3 ---
    • 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...