WordPress 4.3
[autoinstalls/wordpress.git] / wp-includes / class-wp-image-editor-imagick.php
index a70bebdaebdacf0e29441f694185ad7eddd2c705..bcfb576433d0b3426bed2a102aa3a90acf52e647 100644 (file)
  */
 class WP_Image_Editor_Imagick extends WP_Image_Editor {
        /**
+        * Imagick object.
+        *
+        * @access protected
         * @var Imagick
         */
-       protected $image; // Imagick Object
+       protected $image;
 
        public function __destruct() {
                if ( $this->image instanceof Imagick ) {
@@ -35,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() ) {
 
@@ -82,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 ) );
@@ -112,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 )
@@ -128,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
@@ -156,7 +164,7 @@ 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 );
@@ -225,8 +233,8 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         *
         * @param  int|null $max_w Image width.
         * @param  int|null $max_h Image height.
-        * @param  boolean  $crop
-        * @return boolean|WP_Error
+        * @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 ) )
@@ -330,14 +338,14 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @since 3.5.0
         * @access public
         *
-        * @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 ) {
@@ -374,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 ) {
                /**
@@ -403,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 {
@@ -449,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 );
 
@@ -491,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 );