Changeset 22510

Timestamp:

11/09/2012 07:38:54 PM (12 years ago)

Author:

ryan

Message:

WP_Image_Editor improvements.

• Make test() and supports_mime_type() static.
• Add required_methods argument to get_instance(). Allows requesting an implementation that has certain methods/capabilities.
• Whitespace cleanup

Props markoheijnen
see #6821

Location:

trunk

Files:

• wp-admin/includes/image-edit.php (modified) (1 diff)
• wp-includes/class-wp-image-editor-gd.php (modified) (2 diffs)
• wp-includes/class-wp-image-editor-imagick.php (modified) (2 diffs)
• wp-includes/class-wp-image-editor.php (modified) (7 diffs)

trunk/wp-admin/includes/image-edit.php

@@ -238 +238 @@
 /**
  * Saves Image to File
- * @TODO: Add mime_type support to WP_Image_Editor
  *
  * @param string $filename

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

@@ -29 +29 @@
      *
      * @since 3.5.0
-     * @access protected
+     * @access public
      *
      * @return boolean
      */
-    public function test() {
+    public static function test( $args = null ) {
         if ( ! extension_loaded('gd') || ! function_exists('gd_info') )
             return false;
@@ -100 +100 @@
      * @return boolean
      */
-    public function supports_mime_type( $mime_type ) {
+    public static function supports_mime_type( $mime_type ) {
         $allowed_mime_types = array( 'image/gif', 'image/png', 'image/jpeg' );
 

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

@@ -30 +30 @@
      *
      * @since 3.5.0
-     * @access protected
+     * @access public
      *
      * @return boolean
      */
-    public function test() {
+    public static function test( $args = null ) {
         if ( ! extension_loaded( 'imagick' ) )
             return false;
@@ -144 +144 @@
      * @return boolean
      */
-    public function supports_mime_type( $mime_type ) {
+    public static function supports_mime_type( $mime_type ) {
         if ( ! $mime_type )
             return false;

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

@@ -18 +18 @@
     protected $default_mime_type = 'image/jpeg';
     protected $quality = 90;
-    private static $implementation;
 
     protected function __construct( $filename ) {
@@ -31 +30 @@
      *
      * @param string $path Path to File to Load
+     * @param array $required_methods Methods to require in implementation
      * @return WP_Image_Editor|WP_Error|boolean
      */
-    public final static function get_instance( $path = null ) {
-        $implementation = apply_filters( 'image_editor_class', self::choose_implementation(), $path );
+    public final static function get_instance( $path = null, $required_methods = null ) {
+        $implementation = apply_filters( 'wp_image_editor_class', self::choose_implementation( $required_methods ), $path );
 
         if ( $implementation ) {
@@ -40 +40 @@
             $loaded = $editor->load();
 
-            if ( is_wp_error ( $loaded ) )
+            if ( is_wp_error( $loaded ) )
                 return $loaded;
 
@@ -55 +55 @@
      * @access private
      *
+     * @param $required_methods Array String array of all methods required for implementation returned.
+     *
      * @return string|bool Class name for the first editor that claims to support the request. False if no editor claims to support the request.
      */
-    private final static function choose_implementation() {
-
-        if ( null === self::$implementation ) {
-            $request_order = apply_filters( 'wp_editors', array( 'imagick', 'gd' ) );
-
-            // Loop over each editor on each request looking for one which will serve this request's needs
-            foreach ( $request_order as $editor ) {
-                $class = 'WP_Image_Editor_' . $editor;
-
-                // Check to see if this editor is a possibility, calls the editor statically
-                if ( ! call_user_func( array( $class, 'test' ) ) )
-                    continue;
-
-                self::$implementation = $class;
-                break;
-            }
-        }
-        return self::$implementation;
-    }
-
-    abstract public function test(); // returns bool
+    private final static function choose_implementation( $required_methods = null ) {
+        $request_order = apply_filters( 'wp_image_editors',
+            array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) );
+
+        if ( ! $required_methods )
+            $required_methods = apply_filters( 'wp_image_editor_default_methods',
+                array( 'resize', 'multi_resize', 'crop', 'rotate', 'flip', 'stream' ) );
+
+        // Loop over each editor on each request looking for one which will serve this request's needs
+        foreach ( $request_order as $editor ) {
+            // Check to see if this editor is a possibility, calls the editor statically
+            if ( ! call_user_func( array( $editor, 'test' ) ) )
+                continue;
+
+            // Make sure that all methods are supported by editor.
+            if ( array_diff( $required_methods, get_class_methods( $editor ) ) )
+                continue;
+
+            return $editor;
+        }
+        return false;
+    }
+
     abstract protected function load(); // returns bool|WP_Error
-    abstract public function supports_mime_type( $mime_type ); // returns bool
-    abstract public function resize( $max_w, $max_h, $crop = false );
-    abstract public function multi_resize( $sizes );
-    abstract public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false );
-    abstract public function rotate( $angle );
-    abstract public function flip( $horz, $vert );
     abstract public function save( $destfilename = null, $mime_type = null );
-    abstract public function stream( $mime_type = null );
+
+    /**
+     * Implement all of the below to support natively used functions:
+     *
+     * public function resize( $max_w, $max_h, $crop = false )
+     * public function multi_resize( $sizes )
+     * public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false )
+     * public function rotate( $angle )
+     * public function flip( $horz, $vert )
+     * public function stream( $mime_type = null )
+     */
+
+    /**
+     * Checks to see if current environment supports the editor chosen.
+     * Must be overridden in a sub-class.
+     *
+     * @since 3.5.0
+     * @access public
+     * @abstract
+     *
+     * @param $args array
+     * @return boolean
+     */
+    public static function test( $args = null ) {
+        return false;
+    }
+
+    /**
+     * Checks to see if editor supports mime-type specified
+     * Must be overridden in a sub-class.
+     *
+     * @since 3.5.0
+     * @access public
+     * @abstract
+     *
+     * @param string $mime_type
+     * @return boolean
+     */
+    public static function supports_mime_type( $mime_type ) {
+        return false;
+    }
 
     /**
@@ -259 +297 @@
         $result = call_user_func_array( $function, $arguments );
 
-        if( $result && $stream ) {
+        if ( $result && $stream ) {
             $contents = ob_get_contents();
 
             $fp = fopen( $dst_file, 'w' );
 
-            if( ! $fp )
+            if ( ! $fp )
                 return false;
 
@@ -271 +309 @@
         }
 
-        if( $stream ) {
+        if ( $stream ) {
             ob_end_clean();
         }
@@ -296 +334 @@
 
         foreach( $extensions as $_extension ) {
-            if( preg_match("/{$extension}/i", $_extension ) ) {
-                return $mime_types[ $_extension ];
+            if ( preg_match( "/{$extension}/i", $_extension ) ) {
+                return $mime_types[$_extension];
             }
         }