Jump to content

Page Image Manipulator | API for 1 & 2


Recommended Posts

Hi Horst,

pim2 v0.2.9 running on PW 2.8.62 overwrites the original image instead of making a variation.

I'm using the canvas method

<img src="<? echo $image->pim2Load('pim')->setQuality(90)->setOutputFormat('png')->canvas(240,160)->pimSave()->httpUrl; ?>">



Is this thread abandoned??

Edited by JFn
no reaction
Link to comment
Share on other sites

  • 2 months later...

Good day, @horst!

Was messing with an old site of mine. I did not even remember I used pim2 on this one. And getting to use this powerful tool once again was a pleasure. Thank you for your work!

I had to make a overblurred version of an image for a background. So I used smooth(255) about a 10 times in a row. That did the trick, but the code looks kind of ugly. Am I missing some shortcut way to do it in a more beautiful manner?

Link to comment
Share on other sites

Hi @Ivan Gretsky, thanks for the nice words.

To make an image overblurred, there is only the "blur" and the "smooth" functions. But maybe you can experiment with using "pixelate" before "smooth"?

pixelate(2) or pixelate(3) and then smooth(255), (regarding your desription, maybe 2-3 times smooth(255))

Or isn't that what you are asking for?

  • Like 1
Link to comment
Share on other sites

  • 1 year later...

@Jonathan Lahijani Hmm, there is no fast fix possible ATM. BUT you may use this code, passing the options array as second param to pim2Load, what works as expected:

$image1->pim2Load('i1')->setOptions(['outputFormat'=>'jpg'])->pimSave(); // FAILES (with outputFormat, all other settings work as expected)
$image2->pim2Load('i2', ['outputFormat'=>'jpg'])->pimSave();  // works!!

Summary: all option settings work in both ways, BUT changing the outputFormat only works correctly when passed as options argument into pim2Load().

(I think it needs a massive rewrite to fix that properly, for that I have no time atm 😞)

Link to comment
Share on other sites

  • 4 weeks later...

There are serious issues with this module running PW 3.0.123+. Didn't have time to debug properly, but on different sites the pim2load didn't work anymore.

Two different examples that didn't work anymore:

I ended up disabling the module and using core image manipulations (except for the grayscale... it looks much better in color anyway 😎)

Link to comment
Share on other sites

  • 2 months later...

@JFn I cannot confirm this. I tested with different newer PW versions up to 3.0.131. Everything is working as expected and like with older PW versions.

Only thing from your examples that did not work, is to use the ->setOutputFormat(). How to handle this, please read my post directly above yours.


Link to comment
Share on other sites

  • 2 months later...

Just a heads up, I'm getting this warning on PHP 7.3.6 :

Warning: "continue" targeting switch is equivalent to "break". Did you mean to use "continue 2"? in /home/zzzzzz/dev/site/assets/cache/FileCompiler/site/modules/PageImageManipulator/ImageManipulator02.class.php on line 525 


Link to comment
Share on other sites

10 hours ago, Macrura said:

On a separate topic – is there anyway to set the color of watermark text?

Sorry, no. The current text watermark method analyzes the images and decides between white, gray and black in a automated way. The reason behind that is, you can apply text to any images without knowing which colors it includes.

  • Like 1
Link to comment
Share on other sites

  • 4 months later...

I am using this module (v0.2.9) to generate low quality previews for use with lazysizes js using following code

$imgLow = $img->pim2Load('lowq', true)->setOptions(['quality' => 20])->pixelate(3)->smooth(255)->pimSave();

This is working fine but I quite frequently get a warning:

PHP Warning: rename(/home/m1698/Sites/processwire/site/assets/files/14172/p1010866_geschnitten-1.780x0-pim2-lowq.jpg.tmp,/home/m1698/Sites/processwire/site/assets/files/14172/p1010866_geschnitten-1.780x0-pim2-lowq.jpg): No such file or directory in /home/m1698/Sites/processwire/site/assets/cache/FileCompiler/site/modules/PageImageManipulator/ImageManipulator02.class.php:715

It seems that the warning is thrown by rename() because it is being executed on a non existing file ($dest). Somehow $dest must have been deleted.

But strange enough, the renamed file exists. So the rename operation seems to have been run successfully.

Any idea what might be causing this?

Link to comment
Share on other sites

  • 2 months later...

Thank you for this great module.

In the log I find multiple of these exceptions:

Error when trying to resize watermarkLogo to fit to the MemoryImage. (in /site/assets/cache/FileCompiler/site/modules/PageImageManipulator/ImageManipulator02.class.php line 1986)

My guess is that some of the images that I am trying to resize are too large (but I am not sure).

Any suggestion how to fix this, so I can avoid fatal exceptions?


Link to comment
Share on other sites

1 hour ago, eydun said:

My guess is that some of the images that I am trying to resize are too large (but I am not sure).

Some infos may help. How are the dimensions of the images (orig images and the watermark image) How much is the dedicated memory for PHP on your server / account?

Link to comment
Share on other sites

ProcessWire 3.0.98
Pageimage Manipulator 2    0.2.9

Some files(?) put pim2 in endless loop . Loop in ImageManipulator02.class.php :

        public function __construct($entryItem=null, $options=array(), $bypassOperations=false) {

            // version check module == class
            $m = wire('modules')->get('PageImageManipulator02')->getModuleInfo();
            $m = preg_replace('/(\d)(?=\d)/', '$1.', str_pad("{$m['version']}", 3, "0", STR_PAD_LEFT));
            $c = preg_replace('/(\d)(?=\d)/', '$1.', str_pad("{$this->version}", 3, "0", STR_PAD_LEFT));
            if(!version_compare($m, $c, '=')) {
                throw new WireException("The versions of Module PageImageManipulator02 ($m) and it dependency classfile ImageManipulator02 ($c) are inconsist

            $this->bypassOperations = true===$bypassOperations ? true : false;
            // validate PageImage, FileImage, MemoryImage

            if($entryItem instanceof Pageimage) {

                $this->pageimage = $entryItem;
                $this->entryItem = 'page';
                $this->filename = $entryItem->filename;
                $this->isOriginal = $entryItem->original===NULL ? true : false;

                if(!$this->isOriginal) {
                    // traversing up 'til reaching root reference
                    $this->originalImage = $entryItem->original;
                    while(null !== $this->originalImage->original) {
					// !!!!!!!!!!!! ENDLESS LOOP HERE !!!!!!!!!!!!!!!!!!!!!!!
                        $reference = $this->originalImage->original;
                        $this->originalImage = $reference;


  • Like 2
Link to comment
Share on other sites

Thanks for the replies.

I use PW 3.0.148 and PIM2 0.2.9.

Here is my code:

$imgWidth = 255;
$imgHeight = 312;
$imgPadding = 5;

$image->pim2Load($product->title)->setOutputFormat('png')->canvas($imgWidth, $imgHeight, array(255, 255, 255, 0) ,'center', $imgPadding)->pimSave();

Actually @ak1001 suggestion of a endless loop, sounds more plausible than it is caused by a too large image.

I use a function to selected random images to display, so currently I do not know which source-images are causing the exception.

Link to comment
Share on other sites

Investigating further, in my case problem i think with some file names.  For example one page with three images break down on image named 30x30.jpg. I think processwire thinks that it is a variation image forewer.

mysql> select pages_id, data, sort from field_tovarimages where pages_id = 9771;
| pages_id | data         | sort |
|     9771 | 30_belyi.jpg |    0 |
|     9771 | 19480.jpg    |    1 |
|     9771 | 30x30.jpg    |    2 |
3 rows in set (0.00 sec)

So in  pim 

$this->originalImage == $this->originalImage->original

and it makes loop ?

  • Like 1
Link to comment
Share on other sites

So,  public function ___isVariation in class Pageimage have a regexp 

$re1 = '/^'  ..
   '(\d+)x(\d+)' .>    // 50x50 
   '([pd]\d+x\d+|[a-z]{1,2})?' . <>// nw or p30x40 or d30x40
   '(?:-([-_a-z0-9]+))?' .   // -suffix1 or -suffix1-suffix2, etc.
   '\.' . $this->ext() . <>  // .jpg

that will match names like 30x30.jpg and always says this is a variation image. And this will cause the pim go in endless loop. Don't know is there some consequnces for processwire, seems only pim react abnormally.

I will rename all images for now, and will ask users to not use such type names, but some prevention methods must be used i think

  • Like 1
Link to comment
Share on other sites

Hi @ak1001, many thanks for your investigations.

Please can you provide me with some informations, so that I can test it locally here, and try to update the ___isVariation stuff to fit with recent PW versions?

(When pim was build, we don't have had imge-rendering-engines and the image structures as it is today. We only have had the imagesizer.php and the pageimage.php, where I copy pasted that method from.) 

Which version of PW are you using:

Do you use Pim1 or Pim2:

Which module version of Pim:

What is the exact full URL of the image(s) in question:



Link to comment
Share on other sites

On 2/11/2020 at 2:54 PM, horst said:

Hi @ak1001, many thanks for your investigations.

Please can you provide me with some informations

Hi @horst
ProcessWire 3.0.98
Pageimage Manipulator 2    0.2.9

exact urls something like site/assets/files/9771/30x30.jpg
pim image : site/assets/files/9771/30x30.-pim2-wm3.jpg

Also i was lazy to rename images so i just count loops in PageImageManipulator02.class.php


		// Construct & Destruct the ImageManipulator02 for a single image
        public function __construct($entryItem=null, $options=array(), $bypassOperations=false) {


                if(!$this->isOriginal) {
                    // traversing up 'til reaching root reference
                    $this->originalImage = $entryItem->original;
                    $countloop = 0;
                    while(null !== $this->originalImage->original) {
                        $reference = $this->originalImage->original;
                        $this->originalImage = $reference;
                        if($countloop > 5) {
                            error_log("---- ImageManipulator02 loop!  ".__LINE__);
                            error_log("---- loop filename= ".$this->filename .", ".__LINE__);


  • Like 1
Link to comment
Share on other sites

  • 4 months later...

Hi! I just found a problem adding a watermar when 2 different images have the same name but the extensions are jpg and jpeg the result is only one image.

I fixed it commenting lines 554 to 556 on ImageManipulator02.class.php file.

Eg: "photo1.jpg" and "photo1.jpeg"

foreach ($images as $img){
     $img->pim2Load("wtmd", true)->height(480)->watermarkLogo($watermark, $position = 'center', $padding = 2)->pimSave()->httpUrl;
} // The result is photo1.jpg


  • Like 1
Link to comment
Share on other sites

Hello @horst me again with problems. Tried to enable webp support and get this error:


"Error when trying to save the MemoryImage: we have no Targetfilename!
In /site/assets/cache/FileCompiler/site/modules/PageImageManipulator/ImageManipulator02.class.php line 674"

I'm using your implementation with the Strategy 1 from this post:

Everything works until I need to create the image with the watermark.

The code for the watermark is:

$image_url = $prop->images->eq(0)->pim2Load("wtm",true)->height(480)->watermarkLogo($watermark, $position='center', $padding=2) ->pimSave()->url;

Thank you!

Link to comment
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 monollonom
      Github: https://github.com/romaincazier/PageMjmlToHtml
      Modules directory: https://processwire.com/modules/page-mjml-to-html/
      A module allowing you to write your Processwire template using MJML and get a converted HTML output using MJML API.
      This is considered to be in alpha and as such needs some testing before being used in production!

      Created by Mailjet, MJML is a markup language making it a breeze to create newsletters displayed consistently across all email clients.
      Write your template using MJML combined with Processwire’s API and this module will automatically convert your code into a working newsletter thanks to their free-to-use Rest API.
      For this module to work you will need to get an API key and paste it in the module’s configuration.
      Once your credentials are validated, select the template(s) in which you’re using the MJML syntax, save and go visualize your page(s) to see if everything’s good. You will either get error/warning messages or your email properly formatted and ready-to-go.
      From there you can copy/paste the raw generated code in an external mailing service or distribute your newsletter using ProMailer.
      The MJML output is cached to avoid repetitive API calls Not cached if there are errors/warnings Cleared if the page is saved Cleared if the template file has been modified A simple (dumb?) code viewer highlights lines with errors/warnings A button is added to quickly copy the raw code of the generated newsletter Not added if the page is rendered outside of a PageView Only visible to users with the page’s edit permission A shortcut is also added under “View” in the edit page to open the raw code in a new tab Multi-languages support
      The code viewer is only shown to superusers. If there’s an error the page will display:
      Only its title for guests Its title and a message inviting to contact the administrator for editors If you are using the markup regions output strategy, it might be best to not append files to preserve your MJML markup before calling the MJML API. This option is available in the module’s settings.
    • By Marco Ro
      Hi guys!
      I'm a bit anxious because this is the first module I present! (beta modulo) But I will finally be able to share something with the community too! :)
      This is a BETA version of the PayPal payment system called: PayPal Commerce Platform.
      It is an advanced system (Business Pro account is needed) that brings various benefits in terms of fees and above all integrates direct payment with credit/debit cards. 
      The module integrates with Padloper 0.0.2, which is the current installation I'm using.
      This system integrates the classic PayPal buy button, the alternative or local payment method and the new payment system: credit/debit cards that doesn't go through the PayPal account. It is a Stripe-style payment, it connects directly with the bank and integrates 3D security validation.
      I say that it is a BETA because this module currently only works with Sandbox account, to put it live you need to change API url manually (manually for the moment).
      Because this module is not ready for live:
      I would like to have your opinion on how I built the module (is the first one I do). I don't want to share something that is not fish but I need a comparison with someone more experienced than me, for be sure that this is the best way to code the module.
      If you want to try this I created a git, you will find all the instructions for installation and correct operation. (Git has a MIT licensed)
      https://github.com/MarcooRo/processwire-PayPal-Commerce-Platform I hope I did something that you guys can like :)
    • By monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      A simple fieldtype generating a QR Code from the public URL of the page, and more.
      Using the PHP library QR Code Generator by Kazuhiko Arase.

      In the field’s Details tab you can change between .gif or .svg formats. If you select .svg you will have the option to directly output the markup instead of a base64 image. SVG is the default.
      You can also change what is used to generate the QR code and even have several sources. The accepted sources (separated by a comma) are: httpUrl, editUrl, or the name of any text/URL/file/image field.
      If LanguageSupport is installed the compatible sources (httpUrl, text field, ...) will return as many QR codes as there are languages. Note however that when outputting on the front-end, only the languages visible to the user will be generated.
      Unformatted value
      When using $page->getUnformatted("qrcode_field") it returns an array with the following structure:
      [ [ "label" => string, // label used in the admin "qr" => string, // the qrcode image "source" => string, // the source, as defined in the configuration "text" => string // and the text used to generate the qrcode ], ... ] Formatted value
      The formatted value is an <img>/<svg> (or several right next to each other). There is no other markup.
      Should you need the same markup as in the admin you could use:
      $field = $fields->get("qrcode_field"); $field->type->markupValue($page, $field, $page->getUnformatted("qrcode_field")); But it’s a bit cumbersome, plus you need to import the FieldtypeQRCode's css/js. Best is to make your own markup using the unformatted value.
      Static QR code generator
      You can call FieldtypeQRCode::generateQRCode to generate any QR code you want. Its arguments are:
      string $text bool $svg Generate the QR code as svg instead of gif ? (default=true) bool $markup If svg, output its markup instead of a base64 ? (default=false) Hooks
      Please have a look at the source code for more details about the hookable functions.
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $page = $event->arguments("page"); $event->return = $page->title; // or could be: $event->return = "Your custom text"; }) $wire->addHookAfter("FieldtypeQRCode::generateQRCodes", function($event) { $qrcodes = $event->return; // keep everything except the QR codes generated from editUrl foreach($qrcodes as $key => &$qrcode) { if($qrcode["source"] === "editUrl") { unset($qrcodes[$key]); } } unset($qrcode); $event->return = $qrcodes; })
    • By Sebi
      AppApiFile adds the /file endpoint to the AppApi routes definition. Makes it possible to query files via the api. 
      This module relies on the base module AppApi, which must be installed before AppApiFile can do its work.
      You can access all files that are uploaded at any ProcessWire page. Call api/file/route/in/pagetree?file=test.jpg to access a page via its route in the page tree. Alternatively you can call api/file/4242?file=test.jpg (e.g.,) to access a page by its id. The module will make sure that the page is accessible by the active user.
      The GET-param "file" defines the basename of the file which you want to get.
      The following GET-params (optional) can be used to manipulate an image:
      width height maxwidth maxheight cropX cropY Use GET-Param format=base64 to receive the file in base64 format.
    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
  • Create New...