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

@@ -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.
*