]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/class-wp-image-editor-imagick.php
WordPress 4.3
[autoinstalls/wordpress.git] / wp-includes / class-wp-image-editor-imagick.php
index f3c9451ec3a312d6b22de6a1e9a2980a555b4654..bcfb576433d0b3426bed2a102aa3a90acf52e647 100644 (file)
  * @uses WP_Image_Editor Extends class
  */
 class WP_Image_Editor_Imagick extends WP_Image_Editor {
+       /**
+        * Imagick object.
+        *
+        * @access protected
+        * @var Imagick
+        */
+       protected $image;
 
-       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();
@@ -33,9 +38,12 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * method can be called statically.
         *
         * @since 3.5.0
+        *
+        * @static
         * @access public
         *
-        * @return boolean
+        * @param array $args
+        * @return bool
         */
        public static function test( $args = array() ) {
 
@@ -80,10 +88,12 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * Checks to see if editor supports the mime-type specified.
         *
         * @since 3.5.0
+        *
+        * @static
         * @access public
         *
         * @param string $mime_type
-        * @return boolean
+        * @return bool
         */
        public static function supports_mime_type( $mime_type ) {
                $imagick_extension = strtoupper( self::get_extension( $mime_type ) );
@@ -110,7 +120,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @since 3.5.0
         * @access protected
         *
-        * @return boolean|WP_Error True if loaded; WP_Error on failure.
+        * @return true|WP_Error True if loaded; WP_Error on failure.
         */
        public function load() {
                if ( $this->image instanceof Imagick )
@@ -126,7 +136,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                try {
                        $this->image = new Imagick( $this->file );
 
-                       if( ! $this->image->valid() )
+                       if ( ! $this->image->valid() )
                                return new WP_Error( 'invalid_image', __('File is not an image.'), $this->file);
 
                        // Select the first frame to handle animated images properly
@@ -140,10 +150,11 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                }
 
                $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( $this->quality );
+               return $this->set_quality();
        }
 
        /**
@@ -153,14 +164,14 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @access public
         *
         * @param int $quality Compression Quality. Range: [1,100]
-        * @return boolean|WP_Error True if set successfully; WP_Error on failure.
+        * @return true|WP_Error True if set successfully; WP_Error on failure.
         */
        public function set_quality( $quality = null ) {
                $quality_result = parent::set_quality( $quality );
                if ( is_wp_error( $quality_result ) ) {
                        return $quality_result;
                } else {
-                       $quality = $this->quality;
+                       $quality = $this->get_quality();
                }
 
                try {
@@ -187,6 +198,8 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         *
         * @param int $width
         * @param int $height
+        *
+        * @return true|WP_Error
         */
        protected function update_size( $width = null, $height = null ) {
                $size = null;
@@ -211,13 +224,17 @@ 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
-        * @return boolean|WP_Error
+        * @param  int|null $max_w Image width.
+        * @param  int|null $max_h Image height.
+        * @param  bool     $crop
+        * @return bool|WP_Error
         */
        public function resize( $max_w, $max_h, $crop = false ) {
                if ( ( $this->size['width'] == $max_w ) && ( $this->size['height'] == $max_h ) )
@@ -255,13 +272,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,15 +293,25 @@ 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['width'] ) ) {
+                               $size_data['width'] = null;
+                       }
+                       if ( ! isset( $size_data['height'] ) ) {
+                               $size_data['height'] = null;
+                       }
 
-                       if ( ! isset( $size_data['crop'] ) )
+                       if ( ! isset( $size_data['crop'] ) ) {
                                $size_data['crop'] = false;
+                       }
 
                        $resize_result = $this->resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
+                       $duplicate = ( ( $orig_size['width'] == $size_data['width'] ) && ( $orig_size['height'] == $size_data['height'] ) );
 
-                       if( ! is_wp_error( $resize_result ) ) {
+                       if ( ! is_wp_error( $resize_result ) && ! $duplicate ) {
                                $resized = $this->_save( $this->image );
 
                                $this->image->clear();
@@ -307,15 +338,14 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @since 3.5.0
         * @access public
         *
-        * @param string|int $src The source file or Attachment ID.
-        * @param int $src_x The start x position to crop from.
-        * @param int $src_y The start y position to crop from.
-        * @param int $src_w The width to crop.
-        * @param int $src_h The height to crop.
-        * @param int $dst_w Optional. The destination width.
-        * @param int $dst_h Optional. The destination height.
-        * @param boolean $src_abs Optional. If the source crop points are absolute.
-        * @return boolean|WP_Error
+        * @param int  $src_x The start x position to crop from.
+        * @param int  $src_y The start y position to crop from.
+        * @param int  $src_w The width to crop.
+        * @param int  $src_h The height to crop.
+        * @param int  $dst_w Optional. The destination width.
+        * @param int  $dst_h Optional. The destination height.
+        * @param bool $src_abs Optional. If the source crop points are absolute.
+        * @return bool|WP_Error
         */
        public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ) {
                if ( $src_abs ) {
@@ -352,7 +382,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @access public
         *
         * @param float $angle
-        * @return boolean|WP_Error
+        * @return true|WP_Error
         */
        public function rotate( $angle ) {
                /**
@@ -381,9 +411,9 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @since 3.5.0
         * @access public
         *
-        * @param boolean $horz Flip along Horizontal Axis
-        * @param boolean $vert Flip along Vertical Axis
-        * @returns boolean|WP_Error
+        * @param bool $horz Flip along Horizontal Axis
+        * @param bool $vert Flip along Vertical Axis
+        * @return true|WP_Error
         */
        public function flip( $horz, $vert ) {
                try {
@@ -427,6 +457,13 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                return $saved;
        }
 
+       /**
+        *
+        * @param Imagick $image
+        * @param string $filename
+        * @param string $mime_type
+        * @return array|WP_Error
+        */
        protected function _save( $image, $filename = null, $mime_type = null ) {
                list( $filename, $extension, $mime_type ) = $this->get_output_format( $filename, $mime_type );
 
@@ -469,7 +506,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @access public
         *
         * @param string $mime_type
-        * @return boolean|WP_Error
+        * @return true|WP_Error
         */
        public function stream( $mime_type = null ) {
                list( $filename, $extension, $mime_type ) = $this->get_output_format( null, $mime_type );