From 85731fc99b6d00689dd341713cef15b51d068363 Mon Sep 17 00:00:00 2001 From: Scott Taylor Date: Thu, 27 Mar 2014 20:40:17 +0000 Subject: [PATCH] In `multi_resize()` image editor methods, assert that `null` can only be passed for one of the arguments, not both. Add a lot more unit test assertions to ensure this. Props pbearne, DH-Shredder. Fixes #26823. Built from https://develop.svn.wordpress.org/trunk@27794 git-svn-id: http://core.svn.wordpress.org/trunk@27630 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/class-wp-image-editor-gd.php | 35 ++++++++++++++----- wp-includes/class-wp-image-editor-imagick.php | 33 ++++++++++++----- wp-includes/class-wp-image-editor.php | 10 ++++-- 3 files changed, 58 insertions(+), 20 deletions(-) diff --git a/wp-includes/class-wp-image-editor-gd.php b/wp-includes/class-wp-image-editor-gd.php index fdd5586866..303f5004c0 100644 --- a/wp-includes/class-wp-image-editor-gd.php +++ b/wp-includes/class-wp-image-editor-gd.php @@ -140,12 +140,16 @@ class WP_Image_Editor_GD extends WP_Image_Editor { * Resizes current image. * Wraps _resize, since _resize returns a GD Resource. * + * At minimum, either a height or width must be provided. + * If one of the two is set to null, the resize will + * maintain aspect ratio according to the provided dimension. + * * @since 3.5.0 * @access public * - * @param int $max_w - * @param int $max_h - * @param boolean $crop + * @param int|null $max_w Image width. + * @param int|null $max_h Image height. + * @param boolean $crop * @return boolean|WP_Error */ public function resize( $max_w, $max_h, $crop = false ) { @@ -192,24 +196,37 @@ class WP_Image_Editor_GD extends WP_Image_Editor { * @param array $sizes { * An array of image size arrays. Default sizes are 'small', 'medium', 'large'. * + * Either a height or width must be provided. + * If one of the two is set to null, the resize will + * maintain aspect ratio according to the provided dimension. + * * @type array $size { - * @type int $width Image width. - * @type int $height Image height. - * @type bool $crop Optional. Whether to crop the image. Default false. + * @type int ['width'] Optional. Image width. + * @type int ['height'] Optional. Image height. + * @type bool ['crop'] Optional. Whether to crop the image. Default false. * } * } - * @return array An array of resized images metadata by size. + * @return array An array of resized images' metadata by size. */ public function multi_resize( $sizes ) { $metadata = array(); $orig_size = $this->size; foreach ( $sizes as $size => $size_data ) { - if ( ! ( isset( $size_data['width'] ) && isset( $size_data['height'] ) ) ) + if ( ! isset( $size_data['width'] ) && ! isset( $size_data['height'] ) ) { continue; + } - if ( ! isset( $size_data['crop'] ) ) + if ( ! isset( $size_data['width'] ) ) { + $size_data['width'] = null; + } + if ( ! isset( $size_data['height'] ) ) { + $size_data['height'] = null; + } + + if ( ! isset( $size_data['crop'] ) ) { $size_data['crop'] = false; + } $image = $this->_resize( $size_data['width'], $size_data['height'], $size_data['crop'] ); diff --git a/wp-includes/class-wp-image-editor-imagick.php b/wp-includes/class-wp-image-editor-imagick.php index f3c9451ec3..4ebed4bae7 100644 --- a/wp-includes/class-wp-image-editor-imagick.php +++ b/wp-includes/class-wp-image-editor-imagick.php @@ -211,12 +211,16 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor { /** * Resizes current image. * + * At minimum, either a height or width must be provided. + * If one of the two is set to null, the resize will + * maintain aspect ratio according to the provided dimension. + * * @since 3.5.0 * @access public * - * @param int $max_w - * @param int $max_h - * @param boolean $crop + * @param int|null $max_w Image width. + * @param int|null $max_h Image height. + * @param boolean $crop * @return boolean|WP_Error */ public function resize( $max_w, $max_h, $crop = false ) { @@ -255,13 +259,17 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor { * @param array $sizes { * An array of image size arrays. Default sizes are 'small', 'medium', 'large'. * + * Either a height or width must be provided. + * If one of the two is set to null, the resize will + * maintain aspect ratio according to the provided dimension. + * * @type array $size { - * @type int $width Image width. - * @type int $height Image height. + * @type int ['width'] Optional. Image width. + * @type int ['height'] Optional. Image height. * @type bool $crop Optional. Whether to crop the image. Default false. * } * } - * @return array An array of resized images metadata by size. + * @return array An array of resized images' metadata by size. */ public function multi_resize( $sizes ) { $metadata = array(); @@ -272,11 +280,20 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor { if ( ! $this->image ) $this->image = $orig_image->getImage(); - if ( ! ( isset( $size_data['width'] ) && isset( $size_data['height'] ) ) ) + if ( ! isset( $size_data['width'] ) && ! isset( $size_data['height'] ) ) { continue; + } - if ( ! isset( $size_data['crop'] ) ) + if ( ! isset( $size_data['width'] ) ) { + $size_data['width'] = null; + } + if ( ! isset( $size_data['height'] ) ) { + $size_data['height'] = null; + } + + if ( ! isset( $size_data['crop'] ) ) { $size_data['crop'] = false; + } $resize_result = $this->resize( $size_data['width'], $size_data['height'], $size_data['crop'] ); diff --git a/wp-includes/class-wp-image-editor.php b/wp-includes/class-wp-image-editor.php index 7f6488f91f..5affba48c7 100644 --- a/wp-includes/class-wp-image-editor.php +++ b/wp-includes/class-wp-image-editor.php @@ -82,13 +82,17 @@ abstract class WP_Image_Editor { /** * Resizes current image. * + * At minimum, either a height or width must be provided. + * If one of the two is set to null, the resize will + * maintain aspect ratio according to the provided dimension. + * * @since 3.5.0 * @access public * @abstract * - * @param int $max_w - * @param int $max_h - * @param boolean $crop + * @param int|null $max_w Image width. + * @param int|null $max_h Image height. + * @param boolean $crop * @return boolean|WP_Error */ abstract public function resize( $max_w, $max_h, $crop = false );