enmi-conf.org: comparison wp/wp-includes/class-wp-image-editor.php

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 	protected $file = null;
 	protected $size = null;
 	protected $mime_type = null;
 	protected $default_mime_type = 'image/jpeg';
 	protected $quality = false;
-	protected $default_quality = 90;
+	protected $default_quality = 82;
 	/**
 	 * Each instance handles a single file.
+	 *
+	 * @param string $file Path to the file to load.
 	 */
 	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
+	 *
+	 * @static
 	 * @abstract
 	 *
 	 * @param array $args
-	 * @return boolean
+	 * @return bool
 	 */
 	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
+	 *
+	 * @static
 	 * @abstract
 	 *
 	 * @param string $mime_type
-	 * @return boolean
+	 * @return bool
 	 */
 	public static function supports_mime_type( $mime_type ) {
 		return false;
 	}
 	/**
 	 * Loads image from $this->file into editor.
 	 *
 	 * @since 3.5.0
-	 * @access protected
+	 * @abstract
-	 * @abstract
+	 *
-	 *
+	 * @return bool|WP_Error True if loaded; WP_Error on failure.
-	 * @return boolean|WP_Error True if loaded; WP_Error on failure.
 	 */
 	abstract public function load();
 	/**
 	 * Saves current image to file.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 * @abstract
 	 *
 	 * @param string $destfilename
 	 * @param string $mime_type
 	 * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
 	 * 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
 	 * @abstract
 	 *
 	 * @param  int|null $max_w Image width.
 	 * @param  int|null $max_h Image height.
-	 * @param  boolean  $crop
+	 * @param  bool     $crop
-	 * @return boolean|WP_Error
+	 * @return bool|WP_Error
 	 */
 	abstract public function resize( $max_w, $max_h, $crop = false );
 	/**
 	 * Resize multiple images from a single source.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 * @abstract
 	 *
 	 * @param array $sizes {
 	 *     An array of image size arrays. Default sizes are 'small', 'medium', 'large'.
 	 *
 	/**
 	 * Crops Image.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 * @abstract
 	 *
 	 * @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.
+	 * @param bool $src_abs Optional. If the source crop points are absolute.
-	 * @return boolean|WP_Error
+	 * @return bool|WP_Error
 	 */
 	abstract public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false );
 	/**
 	 * Rotates current image counter-clockwise by $angle.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 * @abstract
 	 *
 	 * @param float $angle
-	 * @return boolean|WP_Error
+	 * @return bool|WP_Error
 	 */
 	abstract public function rotate( $angle );
 	/**
 	 * Flips current image.
 	 *
 	 * @since 3.5.0
-	 * @access public
+	 * @abstract
-	 * @abstract
+	 *
-	 *
+	 * @param bool $horz Flip along Horizontal Axis
-	 * @param boolean $horz Flip along Horizontal Axis
+	 * @param bool $vert Flip along Vertical Axis
-	 * @param boolean $vert Flip along Vertical Axis
+	 * @return bool|WP_Error
-	 * @return boolean|WP_Error
 	 */
 	abstract public function flip( $horz, $vert );
 	/**
 	 * Streams current image to browser.
 	 *
 	 * @since 3.5.0
-	 * @access public
+	 * @abstract
-	 * @abstract
+	 *
-	 *
+	 * @param string $mime_type The mime type of the image.
-	 * @param string $mime_type
+	 * @return bool|WP_Error True on success, WP_Error object or false on failure.
-	 * @return boolean|WP_Error
 	 */
 	abstract public function stream( $mime_type = null );
 	/**
 	 * Gets dimensions of image.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 *
 	 * @return array {'width'=>int, 'height'=>int}
 	 */
 	public function get_size() {
 		return $this->size;
 	/**
 	 * Sets current image size.
 	 *
 	 * @since 3.5.0
-	 * @access protected
 	 *
 	 * @param int $width
 	 * @param int $height
 	 * @return true
 	 */
 	/**
 	 * Gets the Image Compression quality on a 1-100% scale.
 	 *
 	 * @since 4.0.0
-	 * @access public
 	 *
 	 * @return int $quality Compression Quality. Range: [1,100]
 	 */
 	public function get_quality() {
 		if ( ! $this->quality ) {
 	/**
 	 * Sets Image Compression quality on a 1-100% scale.
 	 *
 	 * @since 3.5.0
-	 * @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 ) {
 		if ( null === $quality ) {
 			/**
-			 * Filter the default image compression quality setting.
+			 * Filters the default image compression quality setting.
 			 *
 			 * Applies only during initial editor instantiation, or when set_quality() is run
 			 * manually without the `$quality` argument.
 			 *
 			 * set_quality() has priority over the filter.
 			 */
 			$quality = apply_filters( 'wp_editor_set_quality', $this->default_quality, $this->mime_type );
 			if ( 'image/jpeg' == $this->mime_type ) {
 				/**
-				 * Filter the JPEG compression quality for backward-compatibility.
+				 * Filters the JPEG compression quality for backward-compatibility.
 				 *
 				 * Applies only during initial editor instantiation, or when set_quality() is run
 				 * manually without the `$quality` argument.
 				 *
 				 * set_quality() has priority over the filter.
 			if ( $quality < 0 || $quality > 100 ) {
 				$quality = $this->default_quality;
 			}
 		}
-		// Allow 0, but squash to 1 due to identical images in GD, and for backwards compatibility.
+		// Allow 0, but squash to 1 due to identical images in GD, and for backward compatibility.
 		if ( 0 === $quality ) {
 			$quality = 1;
 		}
 		if ( ( $quality >= 1 ) && ( $quality <= 100 ) ) {
 	 * Will default to $this->default_mime_type if requested is not supported.
 	 *
 	 * Provides corrected filename only if filename is provided.
 	 *
 	 * @since 3.5.0
-	 * @access protected
 	 *
 	 * @param string $filename
 	 * @param string $mime_type
 	 * @return array { filename|null, extension, mime-type }
 	 */
 		// Double-check that the mime-type selected is supported by the editor.
 		// If not, choose a default instead.
 		if ( ! $this->supports_mime_type( $mime_type ) ) {
 			/**
-			 * Filter default mime type prior to getting the file extension.
+			 * Filters default mime type prior to getting the file extension.
 			 *
 			 * @see wp_get_mime_types()
 			 *
 			 * @since 3.5.0
 			 *
 			$mime_type = apply_filters( 'image_editor_default_mime_type', $this->default_mime_type );
 			$new_ext = $this->get_extension( $mime_type );
 		}
 		if ( $filename ) {
-			$ext = '';
+			$dir = pathinfo( $filename, PATHINFO_DIRNAME );
-			$info = pathinfo( $filename );
+			$ext = pathinfo( $filename, PATHINFO_EXTENSION );
-			$dir  = $info['dirname'];
-			if( isset( $info['extension'] ) )
-				$ext = $info['extension'];
 			$filename = trailingslashit( $dir ) . wp_basename( $filename, ".$ext" ) . ".{$new_ext}";
 		}
 		return array( $filename, $new_ext, $mime_type );
 	/**
 	 * Builds an output filename based on current file, and adding proper suffix
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 *
 	 * @param string $suffix
 	 * @param string $dest_path
 	 * @param string $extension
 	 * @return string filename
 	public function generate_filename( $suffix = null, $dest_path = null, $extension = null ) {
 		// $suffix will be appended to the destination filename, just before the extension
 		if ( ! $suffix )
 			$suffix = $this->get_suffix();
-		$info = pathinfo( $this->file );
+		$dir  = pathinfo( $this->file, PATHINFO_DIRNAME );
-		$dir  = $info['dirname'];
+		$ext  = pathinfo( $this->file, PATHINFO_EXTENSION );
-		$ext  = $info['extension'];
 		$name = wp_basename( $this->file, ".$ext" );
 		$new_ext = strtolower( $extension ? $extension : $ext );
 		if ( ! is_null( $dest_path ) && $_dest_path = realpath( $dest_path ) )
 	/**
 	 * Builds and returns proper suffix for file based on height and width.
 	 *
 	 * @since 3.5.0
-	 * @access public
 	 *
 	 * @return false|string suffix
 	 */
 	public function get_suffix() {
 		if ( ! $this->get_size() )
 	/**
 	 * Either calls editor's save function or handles file as a stream.
 	 *
 	 * @since 3.5.0
-	 * @access protected
 	 *
 	 * @param string|stream $filename
 	 * @param callable $function
 	 * @param array $arguments
-	 * @return boolean
+	 * @return bool
 	 */
 	protected function make_image( $filename, $function, $arguments ) {
 		if ( $stream = wp_is_stream( $filename ) ) {
 			ob_start();
 		} else {
 	/**
 	 * Returns first matched mime-type from extension,
 	 * as mapped from wp_get_mime_types()
 	 *
 	 * @since 3.5.0
-	 * @access protected
+	 *
+	 * @static
 	 *
 	 * @param string $extension
-	 * @return string|boolean
+	 * @return string|false
 	 */
 	protected static function get_mime_type( $extension = null ) {
 		if ( ! $extension )
 			return false;
 		$mime_types = wp_get_mime_types();
 		$extensions = array_keys( $mime_types );
-		foreach( $extensions as $_extension ) {
+		foreach ( $extensions as $_extension ) {
 			if ( preg_match( "/{$extension}/i", $_extension ) ) {
 				return $mime_types[$_extension];
 			}
 		}
 	/**
 	 * Returns first matched extension from Mime-type,
 	 * as mapped from wp_get_mime_types()
 	 *
 	 * @since 3.5.0
-	 * @access protected
+	 *
+	 * @static
 	 *
 	 * @param string $mime_type
-	 * @return string|boolean
+	 * @return string|false
 	 */
 	protected static function get_extension( $mime_type = null ) {
 		$extensions = explode( '|', array_search( $mime_type, wp_get_mime_types() ) );
 		if ( empty( $extensions[0] ) )

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9