1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
<?php
namespace Imagify\Media;
use Imagify\CDN\PushCDNInterface;
use Imagify\Context\ContextInterface;
defined( 'ABSPATH' ) || die( 'Cheatin’ uh?' );
/**
* Interface to use for "media groups" (aka attachments).
*
* @since 1.9
* @author Grégory Viguier
*/
interface MediaInterface {
/**
* 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
*
* @param mixed $id Whatever.
* @return bool
*/
public static function constructor_accepts( $id );
/**
* Get the media ID.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return int
*/
public function get_id();
/**
* Tell if the current media is valid.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return bool
*/
public function is_valid();
/**
* Get the media context name.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return string
*/
public function get_context();
/**
* Get the media context instance.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return ContextInterface
*/
public function get_context_instance();
/**
* Get the CDN instance.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return bool|PushCDNInterface A PushCDNInterface instance. False if no CDN is used.
*/
public function get_cdn();
/** ----------------------------------------------------------------------------------------- */
/** ORIGINAL FILE =========================================================================== */
/** ----------------------------------------------------------------------------------------- */
/**
* Get the original file path, even if the file doesn't exist.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return string|bool The file path. False on failure.
*/
public function get_raw_original_path();
/**
* Get the original media's path if the file exists.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return string|bool The file path. False if it doesn't exist.
*/
public function get_original_path();
/** ----------------------------------------------------------------------------------------- */
/** FULL SIZE FILE ========================================================================== */
/** ----------------------------------------------------------------------------------------- */
/**
* Get the URL of the media’s full size file.
*
* @since 1.9.8
* @access public
* @author Grégory Viguier
*
* @return string|bool The file URL. False on failure.
*/
public function get_fullsize_url();
/**
* Get the path to the media’s full size file, even if the file doesn't exist.
*
* @since 1.9.8
* @access public
* @author Grégory Viguier
*
* @return string|bool The file path. False on failure.
*/
public function get_raw_fullsize_path();
/**
* Get the path to the media’s full size file if the file exists.
*
* @since 1.9.8
* @access public
* @author Grégory Viguier
*
* @return string|bool The file path. False if it doesn't exist.
*/
public function get_fullsize_path();
/** ----------------------------------------------------------------------------------------- */
/** BACKUP FILE ============================================================================= */
/** ----------------------------------------------------------------------------------------- */
/**
* Get the backup URL, even if the file doesn't exist.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return string|bool The file URL. False on failure.
*/
public function get_backup_url();
/**
* Get the backup file path, even if the file doesn't exist.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return string|bool The file path. False on failure.
*/
public function get_raw_backup_path();
/**
* Get the backup file path if the file exists.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return string|bool The file path. False if it doesn't exist.
*/
public function get_backup_path();
/**
* Check if the media has a backup of the original file.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return bool True if the media has a backup.
*/
public function has_backup();
/** ----------------------------------------------------------------------------------------- */
/** THUMBNAILS ============================================================================== */
/** ----------------------------------------------------------------------------------------- */
/**
* Create the media thumbnails.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return bool|WP_Error True on success. A \WP_Error instance on failure.
*/
public function generate_thumbnails();
/** ----------------------------------------------------------------------------------------- */
/** MEDIA DATA ============================================================================== */
/** ----------------------------------------------------------------------------------------- */
/**
* Tell if the current media type is supported.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return bool
*/
public function is_supported();
/**
* Tell if the current media refers to an image, based on file extension.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return bool Returns false in case it's an image but not in a supported format (bmp for example).
*/
public function is_image();
/**
* Tell if the current media refers to a pdf, based on file extension.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return bool
*/
public function is_pdf();
/**
* Get the original file extension (if supported by Imagify).
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return string|null
*/
public function get_extension();
/**
* Get the original file mime type (if supported by Imagify).
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return string
*/
public function get_mime_type();
/**
* Get the file mime type + file extension (if the file is supported by Imagify).
* This test is ran against the original file.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return array
*/
public function get_allowed_mime_types();
/**
* Tell if the current media has the required data (the data containing the file paths and thumbnails).
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return bool
*/
public function has_required_media_data();
/**
* Get the list of the files of this media, including the original file.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return array {
* An array with the size names as keys ('full' is used for the original file), and arrays of data as values:
*
* @type string $path Absolute path to the file.
* @type int $width The file width.
* @type int $height The file height.
* @type string $mime-type The file mime type.
* }
*/
public function get_media_files();
/**
* If the media is an image, get its width and height.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return array
*/
public function get_dimensions();
/**
* If the media is an image, update the dimensions in the database with the current file dimensions.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return bool True on success. False on failure.
*/
public function update_dimensions();
}
|