CroppableImage

[Peter Knight]

is it possible to select the cropped images from my CKeditor image select popup?

That's a great question and actually, would be very useful.

Without using Croppable Image, Ryan introduced a 'native' image crop recently which will allow you to save a version of an image. You can most likely drop that version into CK editor.

It's one of the latter Dev versions I believe.

[horst]

CroppableImages and its mother "Thumbnails" are not intended for use in RTEs. But since PW version 2.5.19 Ryan has introduced cropping, rotating, cloning of images in RTEs. It isn't fully implemented yet, (or I must have missed some updates ), but is still very good working already.

see: https://processwire.com/blog/posts/new-image-editing-features-2.5.19/

[Neeks]

I have tried the new dev branch, with all the crop and sizing magic. It's pretty flexible, and fast, and easy for some one who knows how to edit images. The concern I'm getting from my client is they don't trust their editors to size their images correctly, to remember the pixel dimensions for a medium sized portrait for example. (anything can be fixed with enough training though) My client however wants their editors to be able to select from a few preset sizes of images that they can drop into the content area: landscape, portrait, banner, etc. It seems like the new dev-branch of processwire could be rigged to work with some preset sizes, but thats that all requires a level of javascript which is not my strong point. CroppableImages on the other hand seems to have 95% of everything I need just does not have the ability to select the images from the RTE. The new image features in the dev branch also do not let you select images that have already been sized in the image fields. I think allowing users to select the different sizes  of an image would be beneficial for both CroppableImage and the new image management tools created by Ryan. I'll take a crack at it, and see what happens.

[KentBrockman]

Hi Horst,

I checked the filenames your module creates. My original filename was "testslide.jpg", which was saved as "testslide.-sliderbild.jpg". That looks a little weird to me.

In line 194 of FieldtypeCroppableImage.module I found:

$basename = basename($img->basename, '.' . $img->ext) . ".-$suffix" . "." . $img->ext;

Is there any thought behind the ".-" part of the filename? 

What do you think of cleaning the basename to an alpanumeric string, plus dots and symbols?

A quick and dirty way how I'd save the filename:

$basename = preg_replace('/[^a-z0-9\.]+/', '-', strtolower(basename($img->basename, '.' . $img->ext))) . ".$suffix" . "." . $img->ext;

Thank you.

[Peter Knight]

Your explanation makes no sense to me actually ...

Ok, my fault.

Basically, the docs say a Crop can be called as follows:

<img src='{$preview->Images->first->getCrop('Blog_Preview_Thumb')->url}'>

but in the case below, the first image doesn't have a Crop applied and the page throws an error.

So I have to instruct my editors that in a series of images / array of images, the image with the Crop needs to be first in the list.

[Soma]

Actually you don't have to crop an image. It just will make a default cropped image.

[Neeks]

I managed to get cropped images working in CKeditor. Here is the code, in case any one is interested in such a hack. If you know a better way to do this, let em know. It would be cool to dynamically get this list of crop settings (thumb, portrait, etc) from the croppedImage field, but, all in all, this seems to work surprisingly well. 

Using the latest dev branch of processwire: 2.5.27

Copy:  /wire/modules/Process/ProcessPageEditImageSelect/ to /site/modules/ProcessPageEditImageSelect/

Made these changes:

//CHANGES TO ALLOWS IMAGE SIZES FROM CROP IMAGE IN RTE
$acceptedCropImageSets = ['thumb','portrait','landscape','thumb'];
foreach($images as $image){
	list($imgBase,$ext) = explode(".", $image->basename); 
	foreach($acceptedCropImageSets as $set)
	{
		$cropedImagePath = wire('config')->paths->files."{$page->id}/{$imgBase}.-{$set}.{$ext}";
		if(file_exists($cropedImagePath))
		{
			$images->add($cropedImagePath);
		}
	}
	$cropImagesGlobSearch = wire('config')->paths->files."{$page->id}/{$imgBase}.-thumb.{$ext}";
}
//CROP IMAGE CHANGES - END

foreach($images as $image) {
	$numImages++;
	$key = $page->id . ',' . $image->basename;  // page_id,basename for repeater support
	$allImages[$key] = $image; 
}

[horst]

$basename = basename($img->basename, '.' . $img->ext) . ".-$suffix" . "." . $img->ext;

Is there any thought behind the ".-" part of the filename?

Hi Kent,

yes indeed, there were some thoughts behind this.

The naming scheme for images in PW core has changed somewhere between PW 2.4 and 2.5, but finally and fully functional it is implemented since 2.5.11, if I remember right. The naming scheme is:

// original image name looks like
basename . ext

// all variation descriptions are appended to basename, introduced by a . (dot)
basename . {variation description} . ext

// variation descriptions start with sizes, if present
basename . {WxH} . ext
basename . 0x100 . ext
basename . 80x80 . ext

// sizes can be followed by cropsettings, if present
basename . {WxH}{cropsetting} . ext
basename . 80x80p30x40 . ext
basename . 80x80nw . ext

// resized variations also can have suffixes, introduced by a - (minus sign)
basename . 80x80 - soft . ext
basename . 80x80 - medium . ext
basename . 80x80 - strong . ext
basename . 80x80nw - soft . ext

// variations also can have ONLY suffixes, without a resize part
basename . - suffix . ext

The goal with this was and is: the core pageimage class only should (be able to) handle the cleaning of variations, regardless if variations were created by the core imagesizer or by any third party image module. And the authors of third party image modules should not be made responsible for that. The only thing they have to do is to follow the naming scheme.

There are also possibilities that image variations are passed through a chain of manipulations from different modules, e.g. Cropimage -> coresizer || pia -> pim, what results in a much more weird looking filename. But there never will be an image variation stay orphaned when an original image gets deleted. This is even valid if you have variations created by third party modules where the module is uninstalled already!

So, if you have suggestions to the naming scheme, please first do a check if the above requirements can be fullfilled with them.

(see: https://github.com/ryancramerdesign/ProcessWire/blob/dev/wire/core/Pageimage.php#L607)

[Neeks]

i'm trying to get a list of valid crop images for the current page so that when I encode some pages in JSON using the JsonPages module the images will have the cropImage image URL's associated with the JSON payload as well as the standard image URL.  

//from the JsonPages module
include('../CroppableImage/classes/CroppableImageCropSettings.class');
$cropSettings = new CroppableImageCropSettings();
$cropSettings->getCropSettingsForTemplate($page->template);
print_r($cropSettings);

result: 

CroppableImageCropSettings Object
(
    [items] => Array
        (
        )

    [names] => Array
        (
        )

    [invalidLines] => Array
        (
        )

    [templateNames] => Array
        (
        )

    [duplicates] => Array
        (
        )

)

My test has a CroppableImage field, with a single thumbnail crop variation.  

It could also be nice to build a function into the $image or the module for getting field names, what do you think?. 

UPDATE:

I got it working this way, by modifying the fieldType for CropImage .

$this->addHook('Pageimage::getCropSettings', $this, 'getCropSettings');

//....

public function getCropSettings(HookEvent $event) {
    $inputFieldInstance = $this->_getInputFieldInstance($event);
    $cropSettings = new CroppableImageCropSettings($inputFieldInstance->cropSetting);           
    $settings =  $cropSettings->getCropSettingsForTemplate($event->object->page->template);
    $event->return = $settings;
    return true;
}
//...
$settings = $image->getGropSettings();

Is this a good place to put this function?

update again: 
A function returns all the cropImages with the crop name would probably the must useful to other people.
$images = $image->getcrops();? //returns all the crop image variations "portrait, landscape, etc." and add a variable to the image object. $image->cropname...or something like that. If that feature would be good, ill be happy to submit it to the project. I have not worked on any open source projects before, so forgive me if I'm being awkward in how i'm going about trying to contribute, and communicate about it. 
 

[Peter Knight]

In 2.6, one of my Croppable image fields won't accept any updates to it's Crop Settings.

Services-Feature,500,300,services-detail

Updating either the name or the allowed template above has no effect. I downloaded the error log and enabled debug mode and there's no explanation.

is this a known bug with 2.6?

[videokid]

Hi,

I remember I had something similar, therefore I changed everything to lower-case, that did the trick [for me anyway].

I have a 2.6 running with Croppable Image without a problem.

[Peter Knight]

I remember I had something similar, therefore I changed everything to lower-case, that did the trick [for me anyway].

I have a 2.6 running with Croppable Image without a problem.

Ah, thanks. Forgot about that one

[horst]

update again: 

A function returns all the cropImages with the crop name would probably the must useful to other people.

$images = $image->getcrops();? //returns all the crop image variations "portrait, landscape, etc." and add a variable to the image object. $image->cropname...or something like that. If that feature would be good, ill be happy to submit it to the project. I have not worked on any open source projects before, so forgive me if I'm being awkward in how i'm going about trying to contribute, and communicate about it. 

The first part of your idea is practicable, the second one not. At least I don't want to add properties to pageimage from a croppableimage cropsettimgs field. For example if someone calls his thumb "crop", it collides with existing pageimage property from new core. Also it has potential that properties from (other) third party modules collides with those properties. I'm not 100% sure, but tend more to no then yes.

Best way to contributing is to send pull requests to Github.

[Can]

Just to let you know, I noticed that the # Variations link, which Ryan introduced a short while ago is missing with CroppableImage module.

I mean the link which show up in the images field list view after the name and size of the image. When clicked it shows all available variations.

Or is there a reason for the link not to be present?

Cheers

[Marty Walker]

I'm having a slight issue on the lastest PW build 2.6.13. I can create a crop but it won't display on the front end.

[bora]

I'm having a slight issue on the lastest PW build 2.6.13. I can create a crop but it won't display on the front end.

The same here with 2.6.15 build. $image->getCrop('productcover')  returns null even with the cropped images on the frontend. 

Name and settings for the field is productcover,988,741

[bora]

Hello again,

I tracked down the problem on dev branch. Not sure if this is normal or something related to another module but this fixed the frontend problem.

I realized that $inputFieldInstance check on the FieldtypeCroppableImage > getCrop  always returns null on frontend with the multiple image field.

I checked and changed the _getInputFieldInstance method as below. Only change is the $image->pagefile === $pagefiles check part.

I also sent a pull request from github. I hope it's the right fix.

public function _getInputFieldInstance(HookEvent $event) {

        $field = null; // where we'll keep the field we're looking for
        $image = $event->object;
        $page = $image->page;
        $action = $event->arguments[0];

        // find all fields of type FieldtypeImage that are part of the page we're using
        // or regular image fields with InputfieldImage inputfield assigned
        $imageFields = array();
        foreach($page->fields as $f) {
            if ($f->type instanceof FieldtypeCroppableImage || ($f->inputfieldClass && $f->inputfieldClass == 'InputfieldCroppableImage')) {
                $imageFields[] = $f;
            }
        }


        // loop through to find the one we're looking for
        foreach($imageFields as $imageField) {

            // good to get unformatted in case it's a single image field,
            // because it'll still be an array rather than 1 image
            $pagefiles = $page->getUnformatted($imageField->name);          // TODO: name to lowercase 

            $pagefilesFirst = $image->pagefiles->first();


            // if the image's pagefiles property matches the one with the
            // field we're looking at, we have a match. save in $field
            foreach($pagefiles as $pageImageFile) {
                if($pagefilesFirst === $pageImageFile) {

                $field = $imageField->getInputfield($page);
                break;
                }
            }

            //This is commented, not working on dev branch 2.6.15
            /*
            if ($image->pagefiles === $pagefiles) {
                $field = $imageField->getInputfield($page);
                break;
            }
            */
        }

        if ($field) {
            //$event->return = $out;
            return $field;
        }

        return null;
    }

[bernhard]

It fully respects settings for upscaling. If upscaling is set to false, you cannot select rectangles smaller than the crop setting.

where do i define these settings?

[bora]

where do i define these settings?

in your sites config.php you can set them like below.

$config->imageSizerOptions = array(
    'upscaling' => true, // upscale if necessary to reach target size?
    'cropping' => true, // crop if necessary to reach target size?
    'autoRotation' => true, // automatically correct orientation?
    'sharpening' => 'none', // sharpening: none | soft | medium | strong
    'quality' => 100, // quality: 1-100 where higher is better but bigger
    'hidpiQuality' => 60, // Same as above quality setting, but specific to hidpi images
    'defaultGamma' => -1, // defaultGamma: 0.5 to 4.0 or -1 to disable gamma correction (default=2.0)
);

[bernhard]

hi bora, thanks for your answer. so i can only set those settings globally? is there no way to set upscaling for "crop1" to true whereas upscaling for "crop2" would be set to false?

[bora]

hi bora, thanks for your answer. so i can only set those settings globally? is there no way to set upscaling for "crop1" to true whereas upscaling for "crop2" would be set to false?

As stated in the doc, you can use it when viewing but like:

$image = $page->images->first()->getCrop('portrait', "height=400, sharpening=medium, quality=85");

Not sure if it will be sufficient for your needs.

[bernhard]

thanks. unfortunately not...

for example if you want to have a crop "slider" it would be great to NOT allow upscaling as it would lead to bad quality images on your site's frontpage slideshow. but you could have for example a "facebook" crop that automatically creates a facebook image that will fill up maximum size of your facebook posting. can't think of a better example at the moment. maybe i'll switch it globally to false in my case

[bora]

thanks. unfortunately not...

for example if you want to have a crop "slider" it would be great to NOT allow upscaling as it would lead to bad quality images on your site's frontpage slideshow. but you could have for example a "facebook" crop that automatically creates a facebook image that will fill up maximum size of your facebook posting. can't think of a better example at the moment. maybe i'll switch it globally to false in my case

Yes, I think setting upscaling to false by default is a good idea and whenever necessary you can do it by css anyway.

[mr-fan]

Have a problem with this module...since i'm switched from local to life server...

PW 2.6.19 all uptodate

No default crop is created...this is really not that good since i can't really uninstall it or switch image handling.. don't have a clue where to start debug or change something on this....

help is very appreciated regards mr-fan

[mr-fan]

If i tell the user to create a crop manually that this fit exactly his needs all works...but it don't create default crops.