Jump to content
horst

Page Image Manipulator 1

Recommended Posts

Wow, good find! ^-^

The ratio is stored as extended info for the image and not used further, so a very good find. (and a very stupid bug, info[2] holds the mimetype  :wacko: )

I will fix this with the next update.

Share this post


Link to post
Share on other sites

Hi Horst, I think I found one more.

PageImageManipulator.module, line 13: $this->optionNames is always NULL, because it doesn't get defined before (the class isn't even included at this point).

In consequence, param 2 and 3 are not working correctly as described here:

pimLoad

pimLoad($prefix, $param2=optional, $param3=optional)

  • param 1: $prefix - (string) = mandatory!
  • param 2: mixed, $forceRecreation or $options
  • param 3: mixed, $forceRecreation or $options

Share this post


Link to post
Share on other sites

Sorry, Horst, I don't want to be pesky, but how does this work:

PageImageManipulator.module, line 142:

if(!in_array(strtolower($outputFormat), array('gif','png','jpg'))) {
	$outputFormat = $p['extension'];
}
$outputFormat = strtolower($outputFormat);
if(empty($targetFilename)) {
	$targetFilename = $p['dirname'] .'/pim_'. $prefix .'_'. $p['filename'] .'.'. $outputFormat;
}

$outputFormat is always NULL, that's how it was defined in line 96.

As a result, $outputFormat is always set to the original extension the image has when it was uploaded. Assuming I'm doing a format conversion (png -> jpg), $targetFilename always points to the wrong extension (png instead of jpg), and this file is non-existant. Meaning: everytime all images are recreated, slowing down the page...

Share this post


Link to post
Share on other sites

titanium, please can you provide the code line for that with pimLoad?

At line 13 there is only comments. Also without need to test, param 2 definitely work, because I often use it to force recreation of a variations. So you cannot be right with this.

Your post regarding outputFormat, have you tested this or do you see this just by reading the code?

Share this post


Link to post
Share on other sites

titanium, please can you provide the code line for that with pimLoad?

Ah sorry, a "1" is missing. It's in line 113.

Regarding the "outputFormat" problem: I noticed that my page was very slow with PageImage Manipulator. I took a closer look and noticed that the image files were created once again every time the page was loaded. After that, I was on a bug hunt...

Share this post


Link to post
Share on other sites

Ok, your first post is wrong, because the second and third param is processed by the function.

But you are right with the post regarding outputFormat. The options passed as 2 or 3 param gets processsed but not assigned to $outputFormat if it is a key in options, and unfortunately $outputFormat overrides $options['outputFormat'] at the end of the function.

It is in the todo now. But as a quick workaround for you, you may completly bypass sending the $options together with pimLoad(). Insteed use it this way:

pimLoad('prefix'[, true | false])->setOptions($options)-> ... ->pimSave();

This works as expected. (I will rewrite the pimLoad to use this internally the same way)

Sorry for the inconvenience.

Share this post


Link to post
Share on other sites

updated to version 0.1.3

  • fixed a bug with ignoring outputFormat when send as $options with method pimLoad found by @titanium
  • added support for php versions with buggy GD-lib for sharpening and unsharpMask
  • added support for the coming module PageimageNamingScheme into pimVariations()
  • Like 2

Share this post


Link to post
Share on other sites

Are there any known limits with this module?

I'm trying to grayscale 10+ images on a single page using $image->first()->width(320)->pimLoad('bw')->grayscale()->pimSave()->url; and it ends up returning the first 9 images correctly, followed by this error:
Error: Maximum execution time of 30 seconds exceeded

This even occurs when the grayscaled images already exist, still getting a timeout. I've resorted to using file_exists() to check for the grayscaled images manually. If they don't it runs the code above, so with a few page refreshes atfer new image uploads I'm able to eventually have all the images converted.

Any suggestions?

Share this post


Link to post
Share on other sites

There are no limits with this module but with your max execution time for PHP.

add one line into your loop like here:

foreach($images as $image) {
    ini_set('max_execution_time', 30);  // this line resets the timer for max_execution_time with every loop.
    // following your code ...

EDIT:

It shouldn't take that long if images are already rendered. Please can you post your code of the loop here?

Edited by horst

Share this post


Link to post
Share on other sites

Sure thing:

<?php foreach ($page->children as $article) {
	$coverimage = $article->cover_image->first()->width(320);
	$bw = $coverimage->pimLoad('bw')->grayscale()->pimSave()->url;
	?>
	<a class="archive-item" href="<?php echo $article->url; ?>">
		<div class="archive-item-img"><img class="archive-item-img-overlay" src="<?php echo $bw; ?>"></div>
		<div class="archive-item-text-container"><div class="archive-item-text">
			<?php
			echo "<div class='archive-item-title'>".$article->title."</div>";
			echo "<div>".$article->contributor->title."</div>";
			?>
		</div></div>
	</a>
<?php } ?>

Share this post


Link to post
Share on other sites

Hhm, you are not looping through images but childpages. You may try to debug the times for the images rendering.

Also you can do the resize to 320 and grayconvert in one step.
 

<?php   
$timerstotal = array();

foreach ($page->children as $article) {
    ini_set('max_execution_time', 30);
    $timers = array();
    $timer = Debug::timer();
    $timers[] = Debug::timer($timer);  // start image rendering
    $bw = $article->cover_image->first()->pimLoad('bw320')->width(320)->grayscale()->pimSave();
    $timers[] = Debug::timer($timer);  // finished image rendering
?>
    <a class="archive-item" href="<?php echo $article->url; ?>">
        <div class="archive-item-img"><img class="archive-item-img-overlay" src="<?php echo $bw->url; ?>"></div>
        <div class="archive-item-text-container"><div class="archive-item-text">
        <?php
            echo "<div class='archive-item-title'>".$article->title."</div>";
            echo "<div>".$article->contributor->title."</div>";
        ?>
        </div></div>
    </a>
<?php 
    $timers[] = Debug::timer($timer);  // none image stuff finished
    $timerstotal[] = $timers;
} 

// output timers
echo "<pre>\n"; // or "<!-- \n" to output it as HTML comment 
var_dump($timerstotal);
echo "\n</pre>"; // or "\n-->\n";
?>

Share this post


Link to post
Share on other sites

Horst,

a very helpful module! Thank you. However, I miss a feature that would be helpful: 

cropFromCenter(width, height); 

- Resizing and cropping in the original aspect ratio 

The image is reduced first to the width or the height. If it does not fit into the new format, the image is automatically cropped from the middle of the image.

Regards,

David

Share this post


Link to post
Share on other sites

@David: this is already supported by the core ImageSizer. You can combine ImageSizer and PiM manipulations in any order you like:

$croppedVariation1 = $image->size($width, $height, array('cropping'=>true))->pimLoad('prefix')->grayscale()->pimSave();
$croppedVariation2 = $image->pimLoad('prefix')->grayscale()->pimSave()->size($width, $height);  // cropping is true by default in $config->imageSizerOptions in site/config.php

If this doesn't suite your needs, report back please.

  • Like 2

Share this post


Link to post
Share on other sites

@David: this is already supported by the core ImageSizer. You can combine ImageSizer and PiM manipulations in any order you like:

$croppedVariation1 = $image->size($width, $height, array('cropping'=>true))->pimLoad('prefix')->grayscale()->pimSave();
$croppedVariation2 = $image->pimLoad('prefix')->grayscale()->pimSave()->size($width, $height);  // cropping is true by default in $config->imageSizerOptions in site/config.php

If this doesn't suite your needs, report back please.

Ah damn. Sorry, my mistake. :)

  • Like 1

Share this post


Link to post
Share on other sites

Hhm, you are not looping through images but childpages. You may try to debug the times for the images rendering.

Also you can do the resize to 320 and grayconvert in one step.

<?php   
$timerstotal = array();

foreach ($page->children as $article) {
    ini_set('max_execution_time', 30);
    $timers = array();
    $timer = Debug::timer();
    $timers[] = Debug::timer($timer);  // start image rendering
    $bw = $article->cover_image->first()->pimLoad('bw320')->width(320)->grayscale()->pimSave();
    $timers[] = Debug::timer($timer);  // finished image rendering
?>
    <a class="archive-item" href="<?php echo $article->url; ?>">
        <div class="archive-item-img"><img class="archive-item-img-overlay" src="<?php echo $bw->url; ?>"></div>
        <div class="archive-item-text-container"><div class="archive-item-text">
        <?php
            echo "<div class='archive-item-title'>".$article->title."</div>";
            echo "<div>".$article->contributor->title."</div>";
        ?>
        </div></div>
    </a>
<?php 
    $timers[] = Debug::timer($timer);  // none image stuff finished
    $timerstotal[] = $timers;
} 

// output timers
echo "<pre>\n"; // or "<!-- \n" to output it as HTML comment 
var_dump($timerstotal);
echo "\n</pre>"; // or "\n-->\n";
?>

Thanks for this horst, if I have more than 9 items in the loop it never actually executes the code which outputs the timings.

Stripped it back to 9 items, this is the output:

array(9) {
  [0]=>
  array(3) {
    [0]=>
    string(6) "0.0001"
    [1]=>
    string(6) "0.0243"
    [2]=>
    string(6) "0.0280"
  }
  [1]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0150"
    [2]=>
    string(6) "0.0172"
  }
  [2]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0250"
    [2]=>
    string(6) "0.0267"
  }
  [3]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0484"
    [2]=>
    string(6) "0.0502"
  }
  [4]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.1159"
    [2]=>
    string(6) "0.1179"
  }
  [5]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.2891"
    [2]=>
    string(6) "0.2927"
  }
  [6]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.8478"
    [2]=>
    string(6) "0.8514"
  }
  [7]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "2.8584"
    [2]=>
    string(6) "2.8602"
  }
  [8]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(7) "10.3439"
    [2]=>
    string(7) "10.3459"
  }
}

Share this post


Link to post
Share on other sites

as you can see all image renderings are less than a second. Only number 7 = nearly 3 seconds and number 8 is more than 10 seconds!

It seems that this is a much to big image, maybe.

Also the ini_set('max_execution_time', 30); seems to be disabled / forbidden on your server.  :(

I would try to get this enabled. Can you ask your hoster about this? Also you can try to use set_time_limit(30) instead first, but I guess this will be disabled too. You should have a look to your phpinfo() under safe_mode and disabled functions.

Second point: do you really need that large images like under #8 that takes 10 seconds for rendering a 320 thumbnail? You can set a max dimension for width and height for the images-field under Setup -> Fields -> yourimagesfield -> Input -> Max Images Dimensions. This will render the uploaded image to these max dimensions (e.g. 1200 or 960 px or what ever you need) and takes this as source for all smaller sizes.

Also it looks that your images don't get cached? Do they get recreated every time you run that script? This is not the normal behave and sounds very strange if so. ??

Share this post


Link to post
Share on other sites

Hi horst, thanks for looking at this so quickly!

The last two images that are taking ~3s and ~10s, the originals are only 450 x 600px (25kb) and 536 x 712px (74kb). They're no bigger than any of the other images, actually quite small compared to some others. Seems strange that each image is taking progressively longer to render?

The process is also still taking this long even though the images aren't being recreated each time, they're all saved in the assets directory and aren't being overwritten as far as I can see.

EDIT: Is this looking like it's something to with my server configuration? This is all happening on my local XAMPP server.

Share this post


Link to post
Share on other sites

Yes, this is looking very weird. If it is on your local server, you can configure php.ini according to my suggestions above, (allowing set_time_limit(), etc). You need to check phpinfo().

Share this post


Link to post
Share on other sites

set_time_limit(300) did it. Could only load two more, but here's the output:

Last image took 158 seconds to render!

 

array(11) {
  [0]=>
  array(3) {
    [0]=>
    string(6) "0.0001"
    [1]=>
    string(6) "0.0880"
    [2]=>
    string(6) "0.0928"
  }
  [1]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0338"
    [2]=>
    string(6) "0.0357"
  }
  [2]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0454"
    [2]=>
    string(6) "0.0477"
  }
  [3]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0879"
    [2]=>
    string(6) "0.0898"
  }
  [4]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.1946"
    [2]=>
    string(6) "0.1964"
  }
  [5]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.4132"
    [2]=>
    string(6) "0.4180"
  }
  [6]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "1.1618"
    [2]=>
    string(6) "1.1657"
  }
  [7]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "3.4625"
    [2]=>
    string(6) "3.4644"
  }
  [8]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(7) "11.8296"
    [2]=>
    string(7) "11.8319"
  }
  [9]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(7) "43.1316"
    [2]=>
    string(7) "43.1335"
  }
  [10]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(8) "158.5707"
    [2]=>
    string(8) "158.5729"
  }
}

Share this post


Link to post
Share on other sites

hhm, but this is not the solution. There must be something completely wrong, because if the images once are rendered, it should only took 0.02 seconds for each image, regardless if it is the first or the 19. ??

Share this post


Link to post
Share on other sites

hi  @horst  :

i want to add a watermark for page image. and use this module then got an error:

Error: Call to a member function pimLoad() on a non-object 

this caused error:

 
$img = $page->images->first();

$wmi = $page->watermark->pimLoad('wmi')->colorize('red')->pimSave();

$imgsrc = $img->pimLoad('tw',true)->width(180)->grayscale()->watermarkLogo($wmi, 'southeast', 0)->pimSave();

echo "<img src='{$imgsrc->url}' /><br />";
 

i use this,its works well, i found the new image be created:

$img = $page->images->first();
$imgsrc = $img->pimLoad('myPrefix')->setOptions($options)->width(300)->pimSave();
echo "<img src='{$imgsrc->url}' /><br />";

Share this post


Link to post
Share on other sites

Hi @leoric,

I assume the error occures on the imagefield named watermark as you can use the pimLoad method with the field named images.

Here are a few questions:

  • Does your template / page have an imagefield with (exactly) that name?
  • Is this imagefield set to accept only a single image?
  • Like 1

Share this post


Link to post
Share on other sites

Hi @leoric,

I assume the error occures on the imagefield named watermark as you can use the pimLoad method with the field named images.

Here are a few questions:

  • Does your template / page have an imagefield with (exactly) that name?
  • Is this imagefield set to accept only a single image?

big help.

@horst, thank you!

Share this post


Link to post
Share on other sites

I was able to reproduce POWERFULHORSE's speed issue.

some images hang for 30-40 seconds on an operation after they have been successfully rendered once.  

PHP: 5.4

PW: 2.4

GD: 2.10 compatible

CODE:
 

foreach ( $albumimages as $albumimage ) 
{
//FAST
$imgSrc = $albumimage->size(1000,600,array('upscaling' => true,'cropping' => false,'quality' => 70))->url;
//Fast with some files, but killer slow with others
$imgSrc =$sized->pimLoad('watermarked')->watermarkText("Gail Gelburd", 20, 'SW', 5, 100, null)->pimSave()->url;
//... 
}

The PIM portion of this operation can hang the the page for many seconds, even after successful rendering of page it does not get any faster on subsequent  page loads.  I can Upload the offending images if that offers any clues as to what can be going on.  If I can offer any additional debug info that might give any helpful clues as to what is going on let me know. Thanks for a great module Horst. 

Share this post


Link to post
Share on other sites

Hi @neeks,
 
at first: I'm not really sure if you have the same effect as powerfulhorse has had, because he has used a loop through childpages and even has had large amount of processing times for cached images?! Doesn't make much sense, hhm?

second: especially the watermarkText method never was meant to be used in bulk rendering. It uses much cpu and memory for calling many memory image copy operations and also inspect images by histograms to autodetect the best used color for the text, etc. So that is a lot of work it does and that is time consuming, - sorry I haven't noted this in the first post here. It was meant for something like showing thumbnails without watermark text on a page and only watermark larger (single) images when requested. Also its text output can be a bit (or very) ugly!?! - If you want add the same text to all images, you should create and use a transparent png with a nice (and maybe smooth) text together with the watermarkLogo method instead.

third: you may use and inspect debug timers with your code. If there are no significant differences with images processed later (comparing to images processed first), everything seems to be ok. If you get significantly larger times only with later processed images in your loop, then this can be due to some (weird?) design in PHP? PiM uses the correct code to release and free memory (pointers) for all objetcs / instances, but the PHP interpreter internally only seems to set this objects to zero but do not really free the memory to the system site. Somewhere I have read about a discussion between the PHP Group and others and "the others" said that the PHP devs have said that it isn't necessary to release / free pointers because all pointers and handles will be released / freed at the end of every request, (because the complete php instance is closed / released then). I haven't investigated further on this, and maybe I have overlooked to release some objects. I will take a closer look to it when finding time for it. But don't expect it in the near future.

---

On the other hand do I use the watermarkLogo method within a loop on a gallery site where it sometimes create 100+ watermarked image variations [2] at first call of an album page without any drawbacks:

$gallery = "<div id='myGallery'>\n";
if(count($page->images)>0) {
    // display imageThumbs
    $num = -1;
    foreach($page->images as $image) {
[1]     set_time_limit(5);
        $imageName = pathinfo($image->name,PATHINFO_FILENAME);
        $imageDescription = strlen(trim($image->description))>0 ? ', ' . preg_replace('/[^0-9a-zA-ZöüäÖÜÄß -]/msi', '', trim($image->description)) : '';
        $num++;
[2]     $gallery .= "\t<a id='uid$num' rel='nofollow' title='{$imageName}{$imageDescription}' href='{$image->pimLoad('full',false)->watermarkLogo($wmPng)->pimSave()->url}'> </a>\n";
        ...
        ...
    }
}
$gallery .= "</div>\n";
set_time_limit(20);

All source images are max 1000 px and as you can see in the loop I use a time_limit of max 5 seconds [1] per loop.

  • Like 4

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
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-08-08
      2019-06-15
      2019-06-02
      2019-05-25
      If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By apeisa
      Update 31.7.2019: AdminBar is now maintained by @teppo. Modules directory entry has been updated, as well as the "grab the code" link below.
      ***
      Latest screencast: http://www.screencas...73-ab3ba1fea30c
      Grab the code: https://github.com/teppokoivula/AdminBar
      ***
      I put this Adminbar thingy (from here: http://processwire.c...topic,50.0.html) to modules section and to it's own topic.
      I recorded quick and messy screencast (really, my first screencast ever) to show what I have made so far. You can see it from here: http://www.screencas...18-1bc0d49841b4
      When the modal goes off, I click on the "dark side". I make it so fast on screencast, so it might seem a little bit confusing. Current way is, that you can edit, go back to see the site (without saving anything), continue editing and save. After that you still have the edit window, but if you click "dark side" after saving, then the whole page will be reloaded and you see new edits live.
      I am not sure if that is best way: there are some strengths in this thinking, but it is probably better that after saving there shouldn't be a possibility to continue editing. It might confuse because then if you make edits, click on dark side -> *page refresh* -> You lose your edits.
      ***
      When I get my "starting module" from Ryan, I will turn this into real module. Now I had to make some little tweaks to ProcessPageEdit.module (to keep modal after form submits). These probably won't hurt anything:
      if($this->redirectUrl) $this->session->redirect($this->redirectUrl); if(!empty($_GET['modal'])) $this->session->redirect("./?id={$this->page->id}&modal=true"); // NEW LINE else $this->session->redirect("./?id={$this->page->id}");   and...
      if(!empty($_GET['modal'])) { $form->attr('action', './?id=' . $this->id . '&modal=true'); } else { $form->attr('action', './?id=' . $this->id); // OLD LINE }  
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.54
      Composer: rockett/jumplinks
      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 nbcommunication
      I've spent the last while experimenting with srcset implementation - and PageimageSrcset is the result:
      PageimageSrcset
      Provides configurable srcset and sizes properties/methods for Pageimage.
      Overview
      The main purpose of this module is to make srcset implementation as simple as possible in your template code. It does not handle images rendered in CKEditor or similar fields.
      For an introduction to srcset and sizes, please read this Mozilla article about responsive images.
      Pageimage::srcset()
      // The property, which uses the set rules in the module configuration $srcset = $image->srcset; // A method call, using a set rules string // Delimiting with a newline (\n) would also work, but not as readable $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x"); // The same as above but using an indexed/sequential array $srcset = $image->srcset([ "320", "480", "640x480 768w", "1240", "2048 2x", ]); // The same as above but using an associative array // No rule checking is performed $srcset = $image->srcset([ "320w" => [320], "480w" => [480], "768w" => [640, 480], "1240w" => [1240], "2x" => [2048], ]); // Use the default set rules with portrait images generated for mobile/tablet devices $srcset = $image->srcset(true); // Return the srcset using all arguments $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x", [ "portrait" => "320, 640", ]); // The set rules above are a demonstration, not a recommendation! Image variations are only created for set rules which require a smaller image than the Pageimage itself. On large sites this may still result in a lot of images being generated. If you have limited storage, please use this module wisely.
      Portrait Mode
      In many situations, the ratio of the image does not need to change at different screen sizes. However, images that cover the entire viewport are an exception to this and are often the ones that benefit most from srcset implementation.
      The main problem with cover images is that they need to display landscape on desktop devices and portrait when this orientation is used on mobile and tablet devices.
      You can automatically generate portrait images by enabling portrait mode. It is recommended that you use this in combination with Pageimage::focus() so that the portrait variations retain the correct subject.
      The generated variations are HiDPI/Retina versions. Their height is determined by the portrait ratio (e.g. 9:16). Variations are always generated, regardless of whether the original image is smaller. Upscaling is disabled though, so you may find that some variations are actually smaller than they say they are in their filename.
      The sizes attribute should be used when portrait mode is enabled. Pageimage::sizes will return (orientation: portrait) and (max-width: {maxWidth}px) 50vw by default, which handles the use of these images for retina devices. The maximum width used in this rule is the largest set width.
      Pageimage::sizes()
      There is no option to configure default sizes because in most cases 100vw is all you need, and you do not need to output this anyway as it is inferred when using the srcset attribute. You can use the method for custom sizes though:
      // The property $sizes = $image->sizes; // Returns 100vw in most cases // Returns '(orientation: portrait) and (max-width: {maxWidth}px)50vw' if portrait mode enabled // A method call, using a mixture of integer widths and media query rules // Integer widths are treated as a min-width media query rule $sizes = $image->sizes([ 480 => 50, "(orientation: portrait) and (max-width: 640px)" => 100, 960 => 25, ]); // (min-width: 480px) 50vw, (orientation: portrait) and (max-width: 640px) 100vw, (min-width: 960px) 25vw // Determine widths by UIkit 'child-width' classes $sizes = $image->sizes([ "uk-child-width-1-2@s", "uk-child-width-1-3@l", ]); // (min-width: 640px) 50vw, (min-width: 1200px) 33.33vw // Determine widths by UIkit 'width' classes $sizes = $image->sizes([ "uk-width-1-2@m", "uk-width-1-3@xl", ]); // (min-width: 960px) 50vw, (min-width: 1600px) 33.33vw // Return the portrait size rule $sizes = $image->sizes(true); // (orientation: portrait) and (max-width: {maxWidth}px) 50vw // The arguments above are a demonstration, not a recommendation! Pageimage::render()
      This module extends the options available to this method with:
      srcset: When the module is installed, this will always be added, unless set to false. Any values in the formats described above can be passed. sizes: Only used if specified. Any values in the formats described above can be passed. uk-img: If passed, as either true or as a valid uk-img value, then this attribute will be added. The srcset attribute will also become data-srcset. Please refer to the API Reference for more information about this method.
      // Render an image using the default set rules echo $image->render(); // <img src='image.jpg' alt='' srcset='{default set rules}'> // Render an image using custom set rules echo $image->render(["srcset" => "480, 1240x640"]); // <img src='image.jpg' alt='' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w'> // Render an image using custom set rules and sizes // Also use the `markup` argument echo $image->render("<img class='image' src='{url}' alt='Image'>", [ "srcset" => "480, 1240", "sizes" => [1240 => 50], ]); // <img class='image' src='image.jpg' alt='Image' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 1240px) 50vw'> // Render an image using custom set rules and sizes // Enable uk-img echo $image->render([ "srcset" => "480, 1240", "sizes" => ["uk-child-width-1-2@m"], "uk-img" => true, ]); // <img src='image.jpg' alt='' data-uk-img data-srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 960px) 50vw'> // Render an image using portrait mode // Default rule sets used: 320, 640, 768, 1024, 1366, 1600 // Portrait widths used: 320, 640, 768 // Original image is 1000px wide // Not possible to use portrait mode and custom sets or portrait widths in render() // Sizes attribute automatically added echo $image->render(["srcset" => true]); // <img src='image.jpg' alt='' srcset='image.320x569-srcset-hidpi.jpg 320w, image.640x1138-srcset-hidpi.jpg 640w, image.768x1365-srcset-hidpi.jpg 768w, image.jpg 1024w' sizes='(orientation: portrait) and (max-width: 768px) 50vw'> Configuration
      To configure this module, go to Modules > Configure > PageimageSrcset.
      Set Rules
      These are the default set rules that will be used when none are specified, e.g. when calling the property: $image->srcset.
      Each set rule should be entered on a new line, in the format {width}x{height} {inherentwidth}w|{resolution}x.
      Not all arguments are required - you will probably find that specifying the width is sufficient for most cases. Here's a few examples of valid set rules and the sets they generate:
      Set Rule Set Generated Arguments Used 320 image.320x0-srcset.jpg 320w {width} 480x540 image.480x540-srcset.jpg 480w {width}x{height} 640x480 768w image.640x480-srcset.jpg 768w {width}x{height} {inherentwidth}w 2048 2x image.2048x0-srcset.jpg 2x {width} {resolution}x How you configure your rules is dependent on the needs of the site you are developing; there are no prescriptive rules that will meet the needs of most situations. This article gives a good overview of some of the things to consider.
      When you save your rules, a preview of the sets generated and an equivalent method call will be displayed to the right. Invalid rules will not be used, and you will be notified of this.
      Portrait Mode
      Set Widths
      A comma limited list of widths to create HiDPI/Retina portrait variations for.
      Crop Ratio
      The portrait ratio that should be used to crop the image. The default of 9:16 should be fine for most circumstances as this is the standard portrait ratio of most devices. However, you can specify something different if you want. If you add a landscape ratio, it will be switched to portrait when used.
      Any crops in the set rules ({width}x{height}) are ignored for portrait mode variations as this ratio is used instead.
      UIkit Widths
      If your website theme uses UIkit, you can pass an array of UIkit width classes to Pageimage::sizes to be converted to sizes. The values stored here are used to do this. If you have customised the breakpoints on your theme, you should also customise them here.
      Please note that only 1- widths are evaluated by Pageimage::sizes, e.g. uk-width-2-3 will not work.
      Remove Variations
      If checked, the image variations generated by this module are cleared on Submit. On large sites, this may take a while. It makes sense to run this after you have made changes to the set rules.
      Image Suffix
      You will see this field when Remove Variations is checked. The value is appended to the name of the images generated by this module and is used to identify variations. You should not encounter any issues with the default suffix, but if you find that it conflicts with any other functionality on your site, you can set a custom suffix instead.
      Debug Mode
      When this is enabled, a range of information is logged to pageimage-srcset.
      PageimageSrcsetDebug.js is also added to the <head> of your HTML pages. This will console.log a range of information about the images and nodes using srcset on your page after a window.onresize event is triggered. This can assist you in debugging your implementation.
      The browser will always use the highest resolution image it has loaded or has cached. You may need to disable browser caching to determine whether your set rules are working, and it makes sense to work from a small screen size and up. If you do it the other way, the browser is going to continue to use the higher resolution image it loaded first.
      UIkit Features
      This module implements some additional features that are tailored towards UIkit being used as the front-end theme framework, but this is not required to use the module.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. ProcessWire >= 3.0.123 is required to use this module.
×
×
  • Create New...