Changeset 22817 for trunk/wp-includes/class-wp-image-editor.php

Timestamp:

11/22/2012 09:52:16 AM (14 years ago)

Author:

nacin

Message:

WP_Image_Editor: the last stand.

• Have wp_get_image_editor() rather than WP_Image_Editor::get_instance(). Having static factory methods would be less confusing if there weren't also static methods tied to individual editor implementations.
• Lazy-load the WP_Image_Editor base class and editor implementations.
• Have WP_Image_Editor_GD::supports_mime_type() actually check which types it supports.
• Deprecate gd_edit_image_support() in favor of wp_image_editor_supports().

props DH-Shredder, scribu, markoheijnen. fixes #22356. see #6821.

File:

• trunk/wp-includes/class-wp-image-editor.php (modified) (6 diffs)

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

@@ -8 +8 @@
 
 /**
- * Base WordPress Image Editor class for which Editor implementations extend
+ * Base image editor class from which implementations extend
  *
  * @since 3.5.0
@@ -15 +15 @@
         protected $file = null;
         protected $size = null;
-        protected $mime_type  = null;
+        protected $mime_type = null;
         protected $default_mime_type = 'image/jpeg';
         protected $quality = 90;
 
-        protected function __construct( $filename ) {
-                $this->file = $filename;
-        }
-
-        /**
-         * Returns a WP_Image_Editor instance and loads file into it.
-         *
-         * @since 3.5.0
-         * @access public
-         *
-         * @param string $path Path to File to Load
-         * @param array $required_methods Methods to require in implementation
-         * @return WP_Image_Editor|WP_Error
-         */
-        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 ) {
-                        $editor = new $implementation( $path );
-                        $loaded = $editor->load();
-
-                        if ( is_wp_error( $loaded ) )
-                                return $loaded;
-
-                        return $editor;
-                }
-
-                return new WP_Error( 'no_editor', __('No editor could be selected') );
-        }
-
-        /**
-         * Tests which editors are capable of supporting the request.
-         *
-         * @since 3.5.0
-         * @access private
-         *
-         * @param array $required_methods 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( $required_methods = null ) {
-                $request_order = apply_filters( 'wp_image_editors',
-                        array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) );
-
-                if ( ! $required_methods )
-                        $required_methods = array();
-
-                // 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;
-                }
+        /**
+         * Each instance handles a single file.
+         */
+        public function __construct( $file ) {
+                $this->file = $file;
+        }
+
+        /**
+         * 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 array $args
+         * @return boolean
+         */
+        public static function test( $args = array() ) {
                 return false;
         }
 
         /**
+         * Checks to see if editor supports the 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;
+        }
+
+        /**
          * Loads image from $this->file into editor.
          *
@@ -89 +65 @@
          * @return boolean|WP_Error True if loaded; WP_Error on failure.
          */
-        abstract protected function load();
+        abstract public function load();
 
         /**
@@ -169 +145 @@
          * @abstract
          *
-         * @param boolean $horz Horizonal Flip
+         * @param boolean $horz Horizontal Flip
          * @param boolean $vert Vertical Flip
          * @return boolean|WP_Error
@@ -186 +162 @@
          */
         abstract 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 array $args
-         * @return boolean
-         */
-        public static function test( $args = null ) {
-                return false;
-        }
-
-        /**
-         * Checks to see if editor supports the 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;
-        }
 
         /**
@@ -452 +398 @@
         }
 }
+