class.jetpack-photon-image.php — Jetpack – WP Security, Backup, Speed, & Growth 12.1.3

jetpack / _inc / lib / class.jetpack-photon-image.php

jetpack / _inc / lib Last commit date

class.jetpack-photon-image.php

265 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* The Image Class.
4	*
5	* @package automattic/jetpack
6	*/
7
8	/**
9	* Represents a resizable image, exposing properties necessary for properly generating srcset.
10	*/
11	class Jetpack_Photon_Image {
12
13	/**
14	* Attachment's Filename.
15	*
16	* @var string
17	*/
18	public $filename;
19
20	/**
21	* Attachment's mime-type, WP_Error on failure when recalculating the dimensions.
22	*
23	* @var string\|WP_Error
24	*/
25	private $mime_type;
26
27	/**
28	* Image original width.
29	*
30	* @var int
31	*/
32	private $original_width;
33
34	/**
35	* Image original height.
36	*
37	* @var int
38	*/
39	private $original_height;
40
41	/**
42	* Current attachment's width.
43	*
44	* @var int
45	*/
46	private $width;
47
48	/**
49	* Current attachment's height.
50	*
51	* @var int
52	*/
53	private $height;
54
55	/**
56	* Whether the attachment has been resized yet, or not.
57	*
58	* @var bool
59	*/
60	private $is_resized = false;
61
62	/**
63	* Constructs the image object.
64	*
65	* The $data array should provide at least
66	* file : string Image file path
67	* width : int Image width
68	* height : int Image height
69	*
70	* @param array $data Array of attachment metadata, typically value of _wp_attachment_metadata postmeta.
71	* @param string\|\WP_Error $mime_type Typically value returned from get_post_mime_type function.
72	*/
73	public function __construct( $data, $mime_type ) {
74	$this->filename = $data['file'];
75	$this->original_width = $data['width'];
76	$this->original_height = $data['height'];
77	$this->width = $this->original_width;
78	$this->height = $this->original_height;
79	$this->mime_type = $mime_type;
80	}
81
82	/**
83	* Resizes the image to given size.
84	*
85	* @param array $size_data Array of width, height, and crop properties of a size.
86	*
87	* @return bool\|\WP_Error True if resize was successful, WP_Error on failure.
88	*/
89	public function resize( $size_data ) {
90
91	$dimensions = $this->image_resize_dimensions( $size_data['width'], $size_data['height'], $size_data['crop'] );
92
93	if ( true === is_wp_error( $dimensions ) ) {
94	return $dimensions; // Returns \WP_Error.
95	}
96
97	if ( true === is_wp_error( $this->mime_type ) ) {
98	return $this->mime_type; // Returns \WP_Error.
99	}
100
101	$this->set_width_height( $dimensions );
102
103	$this->is_resized = true;
104
105	return true;
106	}
107
108	/**
109	* Generates size data for usage in $metadata['sizes'];.
110	*
111	* @param array $size_data Array of width, height, and crop properties of a size.
112	*
113	* @return array\|\WP_Error An array containing file, width, height, and mime-type keys and it's values. WP_Error on failure.
114	*/
115	public function get_size( $size_data ) {
116
117	$is_resized = $this->resize( $size_data );
118
119	if ( true === is_wp_error( $is_resized ) ) {
120	return $is_resized;
121	}
122
123	return array(
124	'file' => $this->get_filename(),
125	'width' => $this->get_width(),
126	'height' => $this->get_height(),
127	'mime-type' => $this->get_mime_type(),
128	);
129	}
130
131	/**
132	* Resets the image to it's original dimensions.
133	*
134	* @return bool True on successful reset to original dimensions.
135	*/
136	public function reset_to_original() {
137	$this->width = $this->original_width;
138	$this->height = $this->original_height;
139	$this->is_resized = false;
140
141	return true;
142	}
143
144	/**
145	* Return the basename filename. If the image has been resized, including
146	* the resizing params for Jetpack CDN.
147	*
148	* @return string Basename of the filename.
149	*/
150	public function get_filename() {
151	return wp_basename( $this->get_raw_filename() );
152	}
153
154	/**
155	* Return the absolute filename. If the image has been resized, including
156	* the resizing params for Jetpack CDN.
157	*
158	* @return string Filename.
159	*/
160	public function get_raw_filename() {
161	return $this->is_resized() ? $this->get_resized_filename() : $this->filename;
162	}
163
164	/**
165	* Returns current image width. Either original, or after resize.
166	*
167	* @return int
168	*/
169	public function get_width() {
170	return (int) $this->width;
171	}
172
173	/**
174	* Returns current image height. Either original, or after resize.
175	*
176	* @return int
177	*/
178	public function get_height() {
179	return (int) $this->height;
180	}
181
182	/**
183	* Returns image mime type.
184	*
185	* @return string\|WP_Error Image's mime type or WP_Error if it was not determined.
186	*/
187	public function get_mime_type() {
188	return $this->mime_type;
189	}
190
191	/**
192	* Checks the resize status of the image.
193	*
194	* @return bool If the image has been resized.
195	*/
196	public function is_resized() {
197	return ( true === $this->is_resized );
198	}
199
200	/**
201	* Get filename with proper args for the Photon service.
202	*
203	* @return string Filename with query args for Photon service
204	*/
205	protected function get_resized_filename() {
206	$query_args = array(
207	'resize' => join(
208	',',
209	array(
210	$this->get_width(),
211	$this->get_height(),
212	)
213	),
214	);
215
216	return add_query_arg( $query_args, $this->filename );
217	}
218
219	/**
220	* Get resize dimensions used for the Jetpack CDN service.
221	*
222	* Converts the list of values returned from `image_resize_dimensions()` to
223	* associative array for the sake of more readable code no relying on index
224	* nor `list`.
225	*
226	* @param int $max_width Maximum width.
227	* @param int $max_height Maximum height.
228	* @param bool\|array $crop Cropping parameters.
229	*
230	* @return array\|\WP_Error Array of dimensions matching the parameters to imagecopyresampled. WP_Error on failure.
231	*/
232	protected function image_resize_dimensions( $max_width, $max_height, $crop ) {
233	$dimensions = image_resize_dimensions( $this->original_width, $this->original_height, $max_width, $max_height, $crop );
234	if ( ! $dimensions ) {
235	return new WP_Error( 'error_getting_dimensions', __( 'Could not calculate resized image dimensions', 'jetpack' ), $this->filename );
236	}
237
238	return array_combine(
239	array(
240	'dst_x',
241	'dst_y',
242	'src_x',
243	'src_y',
244	'dst_w',
245	'dst_h',
246	'src_w',
247	'src_h',
248	),
249	$dimensions
250	);
251	}
252
253	/**
254	* Sets proper width and height from dimensions.
255	*
256	* @param array $dimensions an array of image dimensions.
257	* @return void
258	*/
259	protected function set_width_height( $dimensions ) {
260	$this->width = (int) $dimensions['dst_w'];
261	$this->height = (int) $dimensions['dst_h'];
262	}
263
264	}
265