]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/class-wp-image-editor-imagick.php
WordPress 4.1.1-scripts
[autoinstalls/wordpress.git] / wp-includes / class-wp-image-editor-imagick.php
index 2e1bebc994afcee056a2301c2d63aad7176d9e33..843b85c541076983ca21f65c938c60929acbb5bc 100644 (file)
  * @uses WP_Image_Editor Extends class
  */
 class WP_Image_Editor_Imagick extends WP_Image_Editor {
  * @uses WP_Image_Editor Extends class
  */
 class WP_Image_Editor_Imagick extends WP_Image_Editor {
+       /**
+        * @var Imagick
+        */
+       protected $image; // Imagick Object
 
 
-       protected $image = null; // Imagick Object
-
-       function __destruct() {
+       public function __destruct() {
                if ( $this->image instanceof Imagick ) {
                        // we don't need the original in memory anymore
                        $this->image->clear();
                if ( $this->image instanceof Imagick ) {
                        // we don't need the original in memory anymore
                        $this->image->clear();
@@ -119,6 +121,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
                        return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
 
                if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
                        return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
 
+               /** This filter is documented in wp-includes/class-wp-image-editor-imagick.php */
                // Even though Imagick uses less PHP memory than GD, set higher limit for users that have low PHP.ini limits
                @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
 
                // Even though Imagick uses less PHP memory than GD, set higher limit for users that have low PHP.ini limits
                @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
 
@@ -139,8 +142,9 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                }
 
                $updated_size = $this->update_size();
                }
 
                $updated_size = $this->update_size();
-               if ( is_wp_error( $updated_size ) )
-                               return $updated_size;
+               if ( is_wp_error( $updated_size ) ) {
+                       return $updated_size;
+               }
 
                return $this->set_quality();
        }
 
                return $this->set_quality();
        }
@@ -152,15 +156,19 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @access public
         *
         * @param int $quality Compression Quality. Range: [1,100]
         * @access public
         *
         * @param int $quality Compression Quality. Range: [1,100]
-        * @return boolean|WP_Error
+        * @return boolean|WP_Error True if set successfully; WP_Error on failure.
         */
        public function set_quality( $quality = null ) {
         */
        public function set_quality( $quality = null ) {
-               if ( !$quality )
-                       $quality = $this->quality;
+               $quality_result = parent::set_quality( $quality );
+               if ( is_wp_error( $quality_result ) ) {
+                       return $quality_result;
+               } else {
+                       $quality = $this->get_quality();
+               }
 
                try {
 
                try {
-                       if( 'image/jpeg' == $this->mime_type ) {
-                               $this->image->setImageCompressionQuality( apply_filters( 'jpeg_quality', $quality, 'image_resize' ) );
+                       if ( 'image/jpeg' == $this->mime_type ) {
+                               $this->image->setImageCompressionQuality( $quality );
                                $this->image->setImageCompression( imagick::COMPRESSION_JPEG );
                        }
                        else {
                                $this->image->setImageCompression( imagick::COMPRESSION_JPEG );
                        }
                        else {
@@ -171,7 +179,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                        return new WP_Error( 'image_quality_error', $e->getMessage() );
                }
 
                        return new WP_Error( 'image_quality_error', $e->getMessage() );
                }
 
-               return parent::set_quality( $quality );
+               return true;
        }
 
        /**
        }
 
        /**
@@ -206,12 +214,16 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
        /**
         * Resizes current image.
         *
        /**
         * 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
         *
         * @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 ) {
         * @return boolean|WP_Error
         */
        public function resize( $max_w, $max_h, $crop = false ) {
@@ -250,13 +262,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'.
         *
         * @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 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.
         *     }
         * }
         *         @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();
         */
        public function multi_resize( $sizes ) {
                $metadata = array();
@@ -267,11 +283,20 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                        if ( ! $this->image )
                                $this->image = $orig_image->getImage();
 
                        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;
                                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;
                                $size_data['crop'] = false;
+                       }
 
                        $resize_result = $this->resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
 
 
                        $resize_result = $this->resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
 
@@ -447,11 +472,12 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
                @ chmod( $filename, $perms );
 
                $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
                @ chmod( $filename, $perms );
 
+               /** This filter is documented in wp-includes/class-wp-image-editor-gd.php */
                return array(
                return array(
-                       'path' => $filename,
-                       'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
-                       'width' => $this->size['width'],
-                       'height' => $this->size['height'],
+                       'path'      => $filename,
+                       'file'      => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
+                       'width'     => $this->size['width'],
+                       'height'    => $this->size['height'],
                        'mime-type' => $mime_type,
                );
        }
                        'mime-type' => $mime_type,
                );
        }