Docs update: API $config->imageSizerOptions missing key "sharpening"

[esszett]

Setting imageSizerOptions in config.php as written in the API-docs is generating a PHP Notice: "Undefined index: sharpening in .../www/wire/core/Pageimage.php:512"

Expected behavior

Docs should mention key "sharpening"

Optional: Suggestion for a possible fix

Add "sharpening" and possible values "soft, …" to API docs

Setup/Environment

• ProcessWire version: 3.0.62
• PHP version: 7.0

[Toutouwai]

You don't say exactly how you are setting the imageSizerOptions in /site/config.php, but be aware that for config settings that are arrays (as imageSizerOptions is) you must merge your settings with the default settings.

So for instance you cannot do this:

$config->imageSizerOptions['upscaling'] = false;

But must instead do:

$config->imageSizerOptions = array_merge($config->imageSizerOptions, ['upscaling' => false]);

[esszett]

I guess it's my mistake: I did in config.php

$config->imageSizerOptions = array(
 'upscaling' => false,
 'cropping' => false,
 'quality' => 90
);

Thank you for pointing towards array_merge() – I did miss that.

[Toutouwai]

Thank you for pointing towards array_merge() – I did miss that.

I don't think it's documented anywhere - it's just what I've found from personal experience. You would think you would be able to set individual array values by key but for some reason it doesn't work.

[Toutouwai]

And you are right in that if the API docs are going to state the defaults then they should be the complete defaults. I think you should reopen this issue so the API docs get updated.

[ryancramerdesign]

You can also do this for any array property when you just want to set one part of it: $config->imageSizerOptions('upscaling', false);

[ryancramerdesign]

There are now just too many imageSizerOptions to fit within the phpdoc in that class, so I've updated the note to say "see /wire/config.php for all options and defaults".

[netcarver]

@esszett Hello there. Could you close this issue if it is resolved to your satisfaction, otherwise post a reply so we know to keep it open and on the radar. Thank you!