Skip to content

Document legacy and clarify bestfit parameters for Imagick::resizeImage #5056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lacatoire wants to merge 8 commits into
base: master
Choose a base branch
from
+95 −2
Open

Document legacy and clarify bestfit parameters for Imagick::resizeImage #5056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f3a4bcb
Document legacy and clarify bestfit parameters for Imagick::resizeImage
lacatoire Dec 23, 2025
f1fef45
Update reference/imagick/imagick/resizeimage.xml
lacatoire Jan 6, 2026
372dbcf
Update reference/imagick/imagick/resizeimage.xml
lacatoire Jan 6, 2026
7d4c6e1
Document legacy parameter for Imagick resize and scaling methods
lacatoire Jan 6, 2026
de3b00b
build error
lacatoire Jan 6, 2026
69c528a
add changelog
lacatoire Jan 6, 2026
5d577cd
add order
lacatoire Jan 6, 2026
8aa9e8a
Merge branch 'master' into imagick/resizeimage-legacy-doc
lacatoire Jan 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion reference/imagick/imagick/adaptiveresizeimage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,19 @@
<term><parameter>bestfit</parameter></term>
<listitem>
<para>
Whether to fit the image inside a bounding box.
Whether to fit the image within the given dimensions while preserving
the aspect ratio.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>legacy</parameter></term>
<listitem>
<para>
Optional <type>bool</type> parameter.
If set to true, the calculations are done with the small rounding bug
that existed in Imagick before 3.4.0. If set to false, the calculations
should produce the same results as the ImageMagick command-line tools.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -94,6 +106,12 @@
Pass zero as either parameter for proportional scaling.
</entry>
</row>
<row>
<entry>PECL imagick 3.4.0</entry>
<entry>
Added the <parameter>legacy</parameter> parameter.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
Expand Down
34 changes: 34 additions & 0 deletions reference/imagick/imagick/cropthumbnailimage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,17 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>legacy</parameter></term>
<listitem>
<para>
Optional <type>bool</type> parameter.
If set to true, the calculations are done with the small rounding bug
that existed in Imagick before 3.4.0. If set to false, the calculations
should produce the same results as the ImageMagick command-line tools.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>

Expand All @@ -57,6 +68,29 @@
&imagick.imagick.throws;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL imagick 3.4.0</entry>
<entry>
Added the <parameter>legacy</parameter> parameter.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>

</refentry>

Expand Down
22 changes: 21 additions & 1 deletion reference/imagick/imagick/resizeimage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,21 @@
<term><parameter>bestfit</parameter></term>
<listitem>
<para>
Optional fit parameter.
Optional <type>bool</type> parameter.
If set to true, the image is resized to fit within the given dimensions
while preserving the aspect ratio.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><parameter>legacy</parameter></term>
<listitem>
<para>
Optional <type>bool</type> parameter.
If set to true, the calculations are done with the small rounding bug that existed in
Imagick before 3.4.0. If set to false, the calculations should produce the same results
as the ImageMagick command-line tools.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -98,6 +112,12 @@
Pass zero as either parameter for proportional scaling.
</entry>
</row>
<row>
<entry>PECL imagick 3.4.0</entry>
<entry>
Added the <parameter>legacy</parameter> parameter.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
Expand Down
21 changes: 21 additions & 0 deletions reference/imagick/imagick/scaleimage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,35 @@
<term><parameter>columns</parameter></term>
<listitem>
<para>
The number of columns in the scaled image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rows</parameter></term>
<listitem>
<para>
The number of rows in the scaled image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>bestfit</parameter></term>
<listitem>
<para>
Whether to fit the image within the given dimensions while preserving
the aspect ratio.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>legacy</parameter></term>
<listitem>
<para>
Optional <type>bool</type> parameter.
If set to true, the calculations are done with the small rounding bug
that existed in Imagick before 3.4.0. If set to false, the calculations
should produce the same results as the ImageMagick command-line tools.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -84,6 +99,12 @@
Pass zero as either parameter for proportional scaling.
</entry>
</row>
<row>
<entry>PECL imagick 3.4.0</entry>
<entry>
Added the <parameter>legacy</parameter> parameter.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
Expand Down