imagify / classes / Bulk / BulkInterface.php

BulkInterface.php in Imagify Image Optimization: Optimize Images | Compress & Convert to WebP/AVIF 2.1, at classes/Bulk/BulkInterface.php

62 lines 1.6 KB

Raw Download Zip

1	<?php
2	namespace Imagify\Bulk;
3
4	/**
5	* Interface to use for bulk.
6	*
7	* @since 1.9
8	*/
9	interface BulkInterface {
10	/**
11	* Get all unoptimized media ids.
12	*
13	* @since 1.9
14	*
15	* @param int $optimization_level The optimization level.
16	* @return array A list of unoptimized media. Array keys are media IDs prefixed with an underscore character, array values are the main file’s URL.
17	*/
18	public function get_unoptimized_media_ids( $optimization_level );
19
20	/**
21	* Get ids of all optimized media without WebP versions.
22	*
23	* @since 1.9
24	* @since 1.9.5 The method doesn't return the IDs directly anymore.
25	*
26	* @return array {
27	* @type array $ids A list of media IDs.
28	* @type array $errors {
29	* @type array $no_file_path A list of media IDs.
30	* @type array $no_backup A list of media IDs.
31	* }
32	* }
33	*/
34	public function get_optimized_media_ids_without_webp();
35
36	/**
37	* Tell if there are optimized media without WebP versions.
38	*
39	* @since 1.9
40	*
41	* @return int The number of media.
42	*/
43	public function has_optimized_media_without_webp();
44
45	/**
46	* Get the context data.
47	*
48	* @since 1.9
49	*
50	* @return array {
51	* The formated data.
52	* The array keys corresponds to the table cell classes: "imagify-cell-{key}".
53	*
54	* @type string $count-optimized Number of media optimized.
55	* @type string $count-errors Number of media having an optimization error, with a link to the page listing the optimization errors.
56	* @type string $optimized-size Optimized filesize.
57	* @type string $original-size Original filesize.
58	* }
59	*/
60	public function get_context_data();
61	}
62