*/
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 ) {
* 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() ) {
// First, test Imagick's extension and classes.
- if ( ! extension_loaded( 'imagick' ) || ! class_exists( 'Imagick' ) || ! class_exists( 'ImagickPixel' ) )
+ if ( ! extension_loaded( 'imagick' ) || ! class_exists( 'Imagick', false ) || ! class_exists( 'ImagickPixel', false ) )
return false;
if ( version_compare( phpversion( 'imagick' ), '2.2.0', '<' ) )
* 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 ) );
* @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 )
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
* @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 );
$size = $this->image->getImageGeometry();
}
catch ( Exception $e ) {
- return new WP_Error( 'invalid_image', __('Could not read image size'), $this->file );
+ return new WP_Error( 'invalid_image', __( 'Could not read image size.' ), $this->file );
}
}
*
* @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 ) )
* @access public
*
* @param array $sizes {
- * An array of image size arrays. Default sizes are 'small', 'medium', 'large'.
+ * An array of image size arrays. Default sizes are 'small', 'medium', 'medium_large', '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'] Optional. Image width.
- * @type int ['height'] Optional. Image height.
+ * Array of height, width values, and whether to crop.
+ *
+ * @type int $width Image width. Optional if `$height` is specified.
+ * @type int $height Image height. Optional if `$width` is specified.
* @type bool $crop Optional. Whether to crop the image. Default false.
* }
* }
* @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 ) {
* @access public
*
* @param float $angle
- * @return boolean|WP_Error
+ * @return true|WP_Error
*/
public function rotate( $angle ) {
/**
* @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 {
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 );
* @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 );
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff