Changeset 28879

Timestamp:

06/28/2014 03:49:55 AM (10 years ago)

Author:

wonderboymusic

Message:

Add ->get_quality() method to WP_Image_Editor class.

Adds unit tests.

Props markoheijnen.
Fixes #28154.

Location:

trunk

Files:

• src/wp-includes/class-wp-image-editor-gd.php (modified) (3 diffs)
• src/wp-includes/class-wp-image-editor-imagick.php (modified) (2 diffs)
• src/wp-includes/class-wp-image-editor.php (modified) (3 diffs)
• tests/phpunit/tests/image/editor.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-image-editor-gd.php

@@ -115 +115 @@
         $this->mime_type = $size['mime'];
 
-        return $this->set_quality( $this->quality );
+        return true;
     }
 
@@ -395 +395 @@
         }
         elseif ( 'image/jpeg' == $mime_type ) {
-            if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, $this->quality ) ) )
+            if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, $this->get_quality() ) ) )
                 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
         }
@@ -443 +443 @@
             default:
                 header( 'Content-Type: image/jpeg' );
-                return imagejpeg( $this->image, null, $this->quality );
+                return imagejpeg( $this->image, null, $this->get_quality() );
         }
     }

trunk/src/wp-includes/class-wp-image-editor-imagick.php

@@ -144 +144 @@
                 return $updated_size;
 
-        return $this->set_quality( $this->quality );
+        return true;
     }
 
@@ -161 +161 @@
             return $quality_result;
         } else {
-            $quality = $this->quality;
+            $quality = $this->get_quality();
         }
 

trunk/src/wp-includes/class-wp-image-editor.php

@@ -17 +17 @@
     protected $mime_type = null;
     protected $default_mime_type = 'image/jpeg';
-    protected $quality = 90;
+    protected $quality = false;
+    protected $default_quality = 90;
 
     /**
@@ -204 +205 @@
 
     /**
+     * Gets the Image Compression quality on a 1-100% scale.
+     *
+     * @since 4.0.0
+     * @access public
+     *
+     * @return int $quality Compression Quality. Range: [1,100]
+     */
+    public function get_quality() {
+        if ( ! $this->quality ) {
+            /**
+             * Filter the default image compression quality setting.
+             *
+             * @since 3.5.0
+             *
+             * @param int    $quality   Quality level between 1 (low) and 100 (high).
+             * @param string $mime_type Image mime type.
+             */
+            $quality = apply_filters( 'wp_editor_set_quality', $this->default_quality, $this->mime_type );
+
+            if ( 'image/jpeg' == $this->mime_type ) {
+                /**
+                 * Filter the JPEG compression quality for backward-compatibility.
+                 *
+                 * The filter is evaluated under two contexts: 'image_resize', and 'edit_image',
+                 * (when a JPEG image is saved to file).
+                 *
+                 * @since 2.5.0
+                 *
+                 * @param int    $quality Quality level between 0 (low) and 100 (high) of the JPEG.
+                 * @param string $context Context of the filter.
+                 */
+                $quality = apply_filters( 'jpeg_quality', $quality, 'image_resize' );
+
+                if ( ! $this->set_quality( $quality ) ) {
+                    $this->quality = $this->default_quality;
+                }
+            }
+        }
+
+        return $this->quality;
+    }
+
+    /**
      * Sets Image Compression quality on a 1-100% scale.
      *
@@ -213 +257 @@
      */
     public function set_quality( $quality = null ) {
-        if ( $quality == null ) {
-            $quality = $this->quality;
-        }
-
-        /**
-         * Filter the default image compression quality setting.
-         *
-         * @since 3.5.0
-         *
-         * @param int    $quality   Quality level between 1 (low) and 100 (high).
-         * @param string $mime_type Image mime type.
-         */
-        $quality = apply_filters( 'wp_editor_set_quality', $quality, $this->mime_type );
-
-        if ( 'image/jpeg' == $this->mime_type ) {
-            /**
-             * Filter the JPEG compression quality for backward-compatibility.
-             *
-             * The filter is evaluated under two contexts: 'image_resize', and 'edit_image',
-             * (when a JPEG image is saved to file).
-             *
-             * @since 2.5.0
-             *
-             * @param int    $quality Quality level between 0 (low) and 100 (high) of the JPEG.
-             * @param string $context Context of the filter.
-             */
-            $quality = apply_filters( 'jpeg_quality', $quality, 'image_resize' );
-
-            // Allow 0, but squash to 1 due to identical images in GD, and for backwards compatibility.
-            if ( $quality == 0 ) {
-                $quality = 1;
-            }
-        }
-
-        if ( ( $quality >= 1 ) && ( $quality <= 100 ) ){
+        // Allow 0, but squash to 1 due to identical images in GD, and for backwards compatibility.
+        if ( $quality == 0 ) {
+            $quality = 1;
+        }
+
+        if ( ( $quality >= 1 ) && ( $quality <= 100 ) ) {
             $this->quality = $quality;
             return true;

trunk/tests/phpunit/tests/image/editor.php

@@ -53 +53 @@
         $editor = wp_get_image_editor( DIR_TESTDATA . '/images/canola.jpg' );
 
-        // Make quality readable
-        $property = new ReflectionProperty( $editor, 'quality' );
-        $property->setAccessible( true );
-
         // Ensure set_quality works
         $this->assertTrue( $editor->set_quality( 75 ) );
-        $this->assertEquals( 75, $property->getValue( $editor ) );
+        $this->assertEquals( 75, $editor->get_quality() );
 
         // Ensure the quality filter works
@@ -65 +61 @@
         add_filter( 'wp_editor_set_quality', $func );
         $this->assertTrue( $editor->set_quality( 75 ) );
-        $this->assertEquals( 100, $property->getValue( $editor ) );
+        $this->assertEquals( 75, $editor->get_quality() );
 
         // Clean up