Plugin Updates

This commit is contained in:
Tony Volpe
2024-03-19 15:33:31 +00:00
parent ff5b56dc44
commit 3a70a6e4bf
317 changed files with 8178 additions and 2933 deletions

View File

@@ -113,7 +113,7 @@ class File {
return new \WP_Error(
'not_exists',
sprintf(
/* translators: %s is a file path. */
/* translators: %s is a file path. */
__( 'The file %s does not seem to exist.', 'imagify' ),
'<code>' . esc_html( $this->filesystem->make_path_relative( $this->path ) ) . '</code>'
)
@@ -124,7 +124,7 @@ class File {
return new \WP_Error(
'not_a_file',
sprintf(
/* translators: %s is a file path. */
/* translators: %s is a file path. */
__( 'This does not seem to be a file: %s.', 'imagify' ),
'<code>' . esc_html( $this->filesystem->make_path_relative( $this->path ) ) . '</code>'
)
@@ -135,7 +135,7 @@ class File {
return new \WP_Error(
'not_writable',
sprintf(
/* translators: %s is a file path. */
/* translators: %s is a file path. */
__( 'The file %s does not seem to be writable.', 'imagify' ),
'<code>' . esc_html( $this->filesystem->make_path_relative( $this->path ) ) . '</code>'
)
@@ -148,7 +148,7 @@ class File {
return new \WP_Error(
'folder_not_writable',
sprintf(
/* translators: %s is a file path. */
/* translators: %s is a file path. */
__( 'The folder %s does not seem to be writable.', 'imagify' ),
'<code>' . esc_html( $this->filesystem->make_path_relative( $parent_folder ) ) . '</code>'
)
@@ -197,7 +197,7 @@ class File {
return new \WP_Error(
'not_an_image',
sprintf(
/* translators: %s is a file path. */
/* translators: %s is a file path. */
__( 'The file %s does not seem to be an image, and cannot be resized.', 'imagify' ),
'<code>' . esc_html( $this->filesystem->make_path_relative( $this->path ) ) . '</code>'
)
@@ -321,7 +321,7 @@ class File {
return new \WP_Error(
'not_an_image',
sprintf(
/* translators: %s is a file path. */
/* translators: %s is a file path. */
__( 'The file %s does not seem to be an image, and cannot be resized.', 'imagify' ),
'<code>' . esc_html( $this->filesystem->make_path_relative( $this->path ) ) . '</code>'
)
@@ -423,6 +423,22 @@ class File {
) );
}
// Check if a '-scaled' version of the image exists.
$scaled_path = preg_replace( '/(\.)([^\.]+)$/', '-scaled.$2', $backup_source );
if ( $this->filesystem->exists( $scaled_path ) ) {
// Create a backup path for the scaled image.
$scaled_backup_path = preg_replace( '/(\.)([^\.]+)$/', '-scaled.$2', $backup_path );
// Copy the '-scaled' version to the backup.
$this->filesystem->copy( $scaled_path, $scaled_backup_path, $overwrite, FS_CHMOD_FILE );
if ( ! $this->filesystem->exists( $scaled_backup_path ) ) {
return new \WP_Error( 'backup_doesnt_exist', __( 'The file could not be saved.', 'imagify' ), array(
'file_path' => $this->filesystem->make_path_relative( $scaled_path ),
'backup_path' => $this->filesystem->make_path_relative( $scaled_backup_path ),
) );
}
}
return true;
}
@@ -438,7 +454,7 @@ class File {
* @type bool $backup False to prevent backup. True to follow the user's setting. A backup can't be forced.
* @type string $backup_path If a backup must be done, this is the path to use. Default is the backup path used for the WP Media Library.
* @type int $optimization_level The optimization level (2=ultra, 1=aggressive, 0=normal).
* @type string $convert Set to 'webp' to convert the image to WebP.
* @type string $convert Set to 'webp' to convert the image to WebP, 'avif' to convert image to AVIF.
* @type string $context The context.
* @type int $original_size The file size, sent to the API.
* }
@@ -474,7 +490,7 @@ class File {
*
* @param string $path Absolute path to the media file.
* @param array $args Arguments passed to the method.
*/
*/
do_action( 'imagify_before_optimize_file', $this->path, $args );
/**
@@ -485,7 +501,7 @@ class File {
*
* @param string $path Absolute path to the image file.
* @param bool $backup True if a backup will be make.
*/
*/
do_action_deprecated( 'before_do_imagify', [ $this->path, $args['backup'] ], '1.9', 'imagify_before_optimize_file' );
if ( $args['backup'] ) {
@@ -509,6 +525,7 @@ class File {
if ( $args['convert'] ) {
$data['convert'] = $args['convert'];
$format = $args['convert'];
}
$response = upload_imagify_image( [
@@ -534,8 +551,12 @@ class File {
$args['convert'] = '';
}
if ( 'webp' === $args['convert'] ) {
$destination_path = $this->get_path_to_webp();
$formats = [
'webp',
'avif',
];
if ( in_array( $args['convert'], $formats, true ) ) {
$destination_path = $this->get_path_to_nextgen( $args['convert'] );
$this->path = $destination_path;
$this->file_type = null;
$this->editor = null;
@@ -557,7 +578,7 @@ class File {
*
* @param string $path Absolute path to the image file.
* @param bool $backup True if a backup has been made.
*/
*/
do_action_deprecated( 'after_do_imagify', [ $this->path, $args['backup'] ], '1.9', 'imagify_before_optimize_file' );
/**
@@ -568,7 +589,7 @@ class File {
*
* @param string $path Absolute path to the media file.
* @param array $args Arguments passed to the method.
*/
*/
do_action( 'imagify_after_optimize_file', $this->path, $args );
return $response;
@@ -603,7 +624,7 @@ class File {
$this->editor = new \WP_Error(
'image_editor',
sprintf(
/* translators: %1$s is an error message, %2$s is a "More info?" link. */
/* translators: %1$s is an error message, %2$s is a "More info?" link. */
__( 'No php extensions are available to edit images on the server. ImageMagick or GD is required. The internal error is: %1$s. %2$s', 'imagify' ),
$this->editor->get_error_message(),
'<a href="' . esc_url( imagify_get_external_url( 'documentation-imagick-gd' ) ) . '" target="_blank">' . __( 'More info?', 'imagify' ) . '</a>'
@@ -765,6 +786,26 @@ class File {
return imagify_path_to_webp( $this->path );
}
/**
* Replace the file extension by its next-gen format extension.
*
* @since 2.2
*
* @param string $format the format we are targeting.
* @return string|bool The file path on success. False if not an image or on failure.
*/
public function get_path_to_nextgen( string $format ) {
if ( ! $this->is_image() ) {
return false;
}
if ( $this->is_webp() || $this->is_avif() ) {
return false;
}
return imagify_path_to_nextgen( $this->path, $format );
}
/**
* Tell if the file is a WebP image.
* Rejects "path/to/.webp" files.
@@ -778,6 +819,18 @@ class File {
return preg_match( '@(?!^|/|\\\)\.webp$@i', $this->path );
}
/**
* Tell if the file is an AVIF image.
* Rejects "path/to/.avif" files.
*
* @since 2.2
*
* @return bool
*/
public function is_avif() {
return preg_match( '@(?!^|/|\\\)\.avif$@i', $this->path );
}
/**
* Get the file mime type + file extension.
*

View File

@@ -1,31 +1,35 @@
<?php
declare(strict_types=1);
namespace Imagify\Optimization\Process;
defined( 'ABSPATH' ) || die( 'Cheatin uh?' );
use WP_Error;
/**
* Fallback class to optimize medias.
*
* @since 1.9
* @author Grégory Viguier
*/
class Noop implements ProcessInterface {
/**
* The suffix used in the thumbnail size name.
*
* @var string
* @since 1.9
* @author Grégory Viguier
* @var string
* @since 1.9
*/
const WEBP_SUFFIX = '@imagify-webp';
/**
* The suffix used in the thumbnail size name.
*
* @var string
* @since 2.2
*/
const AVIF_SUFFIX = '@imagify-avif';
/**
* The suffix used in file name to create a temporary copy of the full size.
*
* @var string
* @since 1.9
* @author Grégory Viguier
* @var string
* @since 1.9
*/
const TMP_SUFFIX = '@imagify-tmp';
@@ -33,9 +37,8 @@ class Noop implements ProcessInterface {
* Used for the name of the transient telling if a media is locked.
* %1$s is the context, %2$s is the media ID.
*
* @var string
* @since 1.9
* @author Grégory Viguier
* @var string
* @since 1.9
*/
const LOCK_NAME = 'imagify_%1$s_%2$s_process_locked';
@@ -43,11 +46,10 @@ class Noop implements ProcessInterface {
* Tell if the given entry can be accepted in the constructor.
* For example it can include `is_numeric( $id )` if the constructor accepts integers.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param mixed $id Whatever.
*
* @param mixed $id Whatever.
* @return bool
*/
public static function constructor_accepts( $id ) {
@@ -57,9 +59,7 @@ class Noop implements ProcessInterface {
/**
* Get the data instance.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return DataInterface|false
*/
@@ -70,9 +70,7 @@ class Noop implements ProcessInterface {
/**
* Get the media instance.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return MediaInterface|false
*/
@@ -83,9 +81,7 @@ class Noop implements ProcessInterface {
/**
* Get the File instance.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return File|false
*/
@@ -96,9 +92,7 @@ class Noop implements ProcessInterface {
/**
* Tell if the current media is valid.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return bool
*/
@@ -109,106 +103,87 @@ class Noop implements ProcessInterface {
/**
* Tell if the current user is allowed to operate Imagify in this context.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param string $describer Capacity describer. See \Imagify\Context\ContextInterface->get_capacity() for possible values. Can also be a "real" user capacity.
*
* @param string $describer Capacity describer. See \Imagify\Context\ContextInterface->get_capacity() for possible values. Can also be a "real" user capacity.
* @return bool
*/
public function current_user_can( $describer ) {
return false;
}
/** ----------------------------------------------------------------------------------------- */
/** OPTIMIZATION ============================================================================ */
/** ----------------------------------------------------------------------------------------- */
/**
* Optimize a media files by pushing tasks into the queue.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
*
* @return bool|WP_Error True if successfully launched. A WP_Error instance on failure.
*/
public function optimize( $optimization_level = null ) {
return new \WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
return new WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
}
/**
* Re-optimize a media files with a different level.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
*
* @return bool|WP_Error True if successfully launched. A WP_Error instance on failure.
*/
public function reoptimize( $optimization_level = null ) {
return new \WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
return new WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
}
/**
* Optimize several file sizes by pushing tasks into the queue.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param array $sizes An array of media sizes (strings). Use "full" for the size of the main file.
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
* @param array $sizes An array of media sizes (strings). Use "full" for the size of the main file.
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
*
* @return bool|WP_Error True if successfully launched. A WP_Error instance on failure.
*/
public function optimize_sizes( $sizes, $optimization_level = null ) {
return new \WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
return new WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
}
/**
* Optimize one file with Imagify directly.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param string $size The media size.
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
* @return array|WP_Error The optimization data. A \WP_Error instance on failure.
* @param string $size The media size.
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
*
* @return array|WP_Error The optimization data. A WP_Error instance on failure.
*/
public function optimize_size( $size, $optimization_level = null ) {
return new \WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
return new WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
}
/**
* Restore the media files from the backup file.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return bool|WP_Error True on success. A \WP_Error instance on failure.
* @return bool|WP_Error True on success. A WP_Error instance on failure.
*/
public function restore() {
return new \WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
return new WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
}
/** ----------------------------------------------------------------------------------------- */
/** MISSING THUMBNAILS ====================================================================== */
/** ----------------------------------------------------------------------------------------- */
/**
* Get the sizes for this media that have not get through optimization.
* No sizes are returned if the file is not optimized, has no backup, or is not an image.
* The 'full' size os never returned.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return array|WP_Error {
* A WP_Error object on failure.
@@ -229,45 +204,30 @@ class Noop implements ProcessInterface {
/**
* Optimize missing thumbnail sizes.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
* @return bool|WP_Error True if successfully launched. A WP_Error instance on failure.
*/
public function optimize_missing_thumbnails() {
return new \WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
return new WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
}
/** ----------------------------------------------------------------------------------------- */
/** BACKUP FILE ============================================================================= */
/** ----------------------------------------------------------------------------------------- */
/**
* Delete the backup file.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*/
public function delete_backup() {}
/** ----------------------------------------------------------------------------------------- */
/** RESIZE FILE ============================================================================= */
/** ----------------------------------------------------------------------------------------- */
/**
* Maybe resize an image.
*
* @since 1.9
* @access protected
* @author Grégory Viguier
* @since 1.9
*
* @param string $size The size name.
* @param File $file A File instance.
* @return array|WP_Error A \WP_Error instance on failure, an array on success as follow: {
* @param string $size The size name.
* @param File $file A File instance.
*
* @return array|WP_Error A WP_Error instance on failure, an array on success as follow: {
* @type bool $resized True when the image has been resized.
* @type bool $backuped True when the image has been backuped.
* @type int $file_size The file size in bytes.
@@ -281,58 +241,47 @@ class Noop implements ProcessInterface {
];
}
/** ----------------------------------------------------------------------------------------- */
/** WEBP ==================================================================================== */
/** ----------------------------------------------------------------------------------------- */
/**
* Generate WebP images if they are missing.
* Generate Nextgen images if they are missing.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
* @return bool|WP_Error True if successfully launched. A WP_Error instance on failure.
*/
public function generate_webp_versions() {
return new \WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
public function generate_nextgen_versions() {
return new WP_Error( 'invalid_media', __( 'This media is not valid.', 'imagify' ) );
}
/**
* Delete the WebP images.
* Delete the next gen format images.
* This doesn't delete the related optimization data.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 2.2
*
* @param bool $keep_full Set to true to keep the full size.
* @return bool|WP_Error True on success. A WP_Error object on failure.
*/
public function delete_webp_files() {}
/**
* Tell if a thumbnail size is an "Imagify WebP" size.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @param string $size_name The size name.
* @return string|bool The unsuffixed name of the size if WebP. False if not WebP.
*/
public function is_size_webp( $size_name ) {
public function delete_nextgen_files( $keep_full = false ) {
return false;
}
/** ----------------------------------------------------------------------------------------- */
/** PROCESS STATUS ========================================================================== */
/** ----------------------------------------------------------------------------------------- */
/**
* Tell if a thumbnail size is an "Imagify Next-Gen" size.
*
* @since 2.2
*
* @param string $size_name The size name.
*
* @return string|bool The unsuffixed name of the size if Next-Gen. False if not a Next-Gen.
*/
public function is_size_next_gen( $size_name ) {
return false;
}
/**
* Tell if a process is running for this media.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return bool
*/
@@ -343,34 +292,24 @@ class Noop implements ProcessInterface {
/**
* Set the running status to "running" for a period of time.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*/
public function lock() {}
/**
* Delete the running status.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*/
public function unlock() {}
/** ----------------------------------------------------------------------------------------- */
/** DATA ==================================================================================== */
/** ----------------------------------------------------------------------------------------- */
/**
* Tell if a size already has optimization data.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param string $size The size name.
*
* @param string $size The size name.
* @return bool
*/
public function size_has_optimization_data( $size ) {
@@ -380,13 +319,12 @@ class Noop implements ProcessInterface {
/**
* Update the optimization data for a size.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param object $response The API response.
* @param string $size The size name.
* @param int $level The optimization level (0=normal, 1=aggressive, 2=ultra).
*
* @param object $response The API response.
* @param string $size The size name.
* @param int $level The optimization level (0=normal, 1=aggressive, 2=ultra).
* @return array {
* The optimization data.
*

View File

@@ -1,13 +1,12 @@
<?php
namespace Imagify\Optimization\Process;
declare(strict_types=1);
defined( 'ABSPATH' ) || die( 'Cheatin uh?' );
namespace Imagify\Optimization\Process;
/**
* Interface to use to optimize medias.
*
* @since 1.9
* @author Grégory Viguier
* @since 1.9
*/
interface ProcessInterface {
@@ -15,11 +14,10 @@ interface ProcessInterface {
* Tell if the given entry can be accepted in the constructor.
* For example it can include `is_numeric( $id )` if the constructor accepts integers.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param mixed $id Whatever.
*
* @param mixed $id Whatever.
* @return bool
*/
public static function constructor_accepts( $id );
@@ -27,9 +25,7 @@ interface ProcessInterface {
/**
* Get the data instance.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return DataInterface|false
*/
@@ -38,9 +34,7 @@ interface ProcessInterface {
/**
* Get the media instance.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return MediaInterface|false
*/
@@ -49,9 +43,7 @@ interface ProcessInterface {
/**
* Get the File instance of the original file.
*
* @since 1.9.8
* @access public
* @author Grégory Viguier
* @since 1.9.8
*
* @return File|false
*/
@@ -60,9 +52,7 @@ interface ProcessInterface {
/**
* Get the File instance of the full size file.
*
* @since 1.9.8
* @access public
* @author Grégory Viguier
* @since 1.9.8
*
* @return File|false
*/
@@ -71,9 +61,7 @@ interface ProcessInterface {
/**
* Tell if the current media is valid.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return bool
*/
@@ -82,94 +70,75 @@ interface ProcessInterface {
/**
* Tell if the current user is allowed to operate Imagify in this context.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param string $describer Capacity describer. See \Imagify\Context\ContextInterface->get_capacity() for possible values. Can also be a "real" user capacity.
*
* @param string $describer Capacity describer. See \Imagify\Context\ContextInterface->get_capacity() for possible values. Can also be a "real" user capacity.
* @return bool
*/
public function current_user_can( $describer );
/** ----------------------------------------------------------------------------------------- */
/** OPTIMIZATION ============================================================================ */
/** ----------------------------------------------------------------------------------------- */
/**
* Optimize a media files by pushing tasks into the queue.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
*
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
*/
public function optimize( $optimization_level = null );
/**
* Re-optimize a media files with a different level.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
*
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
*/
public function reoptimize( $optimization_level = null );
/**
* Optimize several file sizes by pushing tasks into the queue.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param array $sizes An array of media sizes (strings). Use "full" for the size of the main file.
* @param array $sizes An array of media sizes (strings). Use "full" for the size of the main file.
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
*
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
*/
public function optimize_sizes( $sizes, $optimization_level = null );
/**
* Optimize one file with Imagify directly.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param string $size The media size.
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
* @return array|WP_Error The optimization data. A \WP_Error instance on failure.
* @param string $size The media size.
* @param int $optimization_level The optimization level (0=normal, 1=aggressive, 2=ultra).
*
* @return array|WP_Error The optimization data. A \WP_Error instance on failure.
*/
public function optimize_size( $size, $optimization_level = null );
/**
* Restore the media files from the backup file.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return bool|WP_Error True on success. A \WP_Error instance on failure.
*/
public function restore();
/** ----------------------------------------------------------------------------------------- */
/** MISSING THUMBNAILS ====================================================================== */
/** ----------------------------------------------------------------------------------------- */
/**
* Get the sizes for this media that have not get through optimization.
* No sizes are returned if the file is not optimized, has no backup, or is not an image.
* The 'full' size os never returned.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return array|WP_Error {
* A WP_Error object on failure.
@@ -188,42 +157,27 @@ interface ProcessInterface {
/**
* Optimize missing thumbnail sizes.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
*/
public function optimize_missing_thumbnails();
/** ----------------------------------------------------------------------------------------- */
/** BACKUP FILE ============================================================================= */
/** ----------------------------------------------------------------------------------------- */
/**
* Delete the backup file.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*/
public function delete_backup();
/** ----------------------------------------------------------------------------------------- */
/** RESIZE FILE ============================================================================= */
/** ----------------------------------------------------------------------------------------- */
/**
* Maybe resize an image.
*
* @since 1.9
* @access protected
* @author Grégory Viguier
* @since 1.9
*
* @param string $size The size name.
* @param File $file A File instance.
*
* @param string $size The size name.
* @param File $file A File instance.
* @return array|WP_Error A \WP_Error instance on failure, an array on success as follow: {
* @type bool $resized True when the image has been resized.
* @type bool $backuped True when the image has been backuped.
@@ -232,77 +186,58 @@ interface ProcessInterface {
*/
public function maybe_resize( $size, $file );
/** ----------------------------------------------------------------------------------------- */
/** WEBP ==================================================================================== */
/** ----------------------------------------------------------------------------------------- */
/**
* Generate WebP images if they are missing.
* Generate next-gen images if they are missing.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return bool|WP_Error True if successfully launched. A \WP_Error instance on failure.
*/
public function generate_webp_versions();
public function generate_nextgen_versions();
/**
* Delete the WebP images.
* Delete the next gen format images.
* This doesn't delete the related optimization data.
*
* @since 1.9
* @since 1.9.6 Return WP_Error or true.
* @access public
* @author Grégory Viguier
* @since 2.2
*
* @param bool $keep_full Set to true to keep the full size.
* @return bool|\WP_Error True on success. A \WP_Error object on failure.
* @param bool $keep_full Set to true to keep the full size.
*
* @return bool|WP_Error True on success. A \WP_Error object on failure.
*/
public function delete_webp_files( $keep_full = false );
public function delete_nextgen_files( $keep_full = false );
/**
* Tell if a thumbnail size is an "Imagify WebP" size.
* Tell if a thumbnail size is an "Imagify Next-Gen" size.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 2.2
*
* @param string $size_name The size name.
* @return string|bool The unsuffixed name of the size if WebP. False if not WebP.
* @param string $size_name The size name.
*
* @return string|bool The unsuffixed name of the size if next-gen. False if not next-gen.
*/
public function is_size_webp( $size_name );
public function is_size_next_gen( $size_name );
/**
* Tell if the media has all WebP versions.
* Tell if the media has all next-gen versions.
*
* @return bool
*/
public function is_full_webp();
public function is_full_next_gen();
/**
* Tell if the media has WebP versions.
* Tell if the media has a next-gen format.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 2.2
*
* @return bool
*/
public function has_webp();
/** ----------------------------------------------------------------------------------------- */
/** PROCESS STATUS ========================================================================== */
/** ----------------------------------------------------------------------------------------- */
public function has_next_gen();
/**
* Tell if a process is running for this media.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @return bool
*/
@@ -311,34 +246,24 @@ interface ProcessInterface {
/**
* Set the running status to "running" for a period of time.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*/
public function lock();
/**
* Delete the running status.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*/
public function unlock();
/** ----------------------------------------------------------------------------------------- */
/** DATA ==================================================================================== */
/** ----------------------------------------------------------------------------------------- */
/**
* Tell if a size already has optimization data.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param string $size The size name.
*
* @param string $size The size name.
* @return bool
*/
public function size_has_optimization_data( $size );
@@ -346,13 +271,12 @@ interface ProcessInterface {
/**
* Update the optimization data for a size.
*
* @since 1.9
* @access public
* @author Grégory Viguier
* @since 1.9
*
* @param object $response The API response.
* @param string $size The size name.
* @param int $level The optimization level (0=normal, 1=aggressive, 2=ultra).
*
* @param object $response The API response.
* @param string $size The size name.
* @param int $level The optimization level (0=normal, 1=aggressive, 2=ultra).
* @return array {
* The optimization data.
*