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
|
<?php
/**
* Class to calculate thumb dimensions for a gallery. The default gallery templates
* require width and height attributes on the thumb img tags. In some cases these need to be
* calculated based on the aspect ratio of the individual thumbs.
*
* Date: 21/03/2017
*/
if ( ! class_exists( 'FooGallery_Thumbnail_Dimensions' ) ) {
class FooGallery_Thumbnail_Dimensions
{
function __construct()
{
//hook into the filter that build up the img attributes
// and add the width and height attributes if the gallery requires them
add_filter( 'foogallery_attachment_html_image_attributes', array( $this, 'include_thumb_dimension_attributes' ), 10, 3 );
//calculate the thumbnail dimensions for all attachments in the gallery
// for the specific gallery template that is being used.
add_action( 'foogallery_located_template', array( $this, 'calculate_all_thumbnail_dimensions' ) );
}
/**
* Helper function to check if the gallery requires thumbnail dimensions
* @param $gallery_template string
* @return bool
*/
function does_gallery_template_use_thumbnail_dimensions( $gallery_template ) {
if ( empty( $gallery_template ) ) return false;
//first do a check if the template needs thumbnail dimensions calculated
$template_data = foogallery_get_gallery_template( $gallery_template );
if ( $template_data && array_key_exists( 'thumbnail_dimensions', $template_data ) && true === $template_data['thumbnail_dimensions'] ) {
//this template requires thumb dimensions to be provided
return true;
}
return false;
}
function empty_dimensions( $thumbnail_dimensions ) {
if ( isset( $thumbnail_dimensions ) && is_array( $thumbnail_dimensions ) ) {
$thumb_width = (int)$thumbnail_dimensions['width'];
$thumb_height = (int)$thumbnail_dimensions['height'];
return $thumb_width === 0 && $thumb_height === 0;
}
return true;
}
/**
* Calculates all the thumbnail dimensions for the gallery
* @param $foogallery FooGallery
*/
function calculate_all_thumbnail_dimensions( $foogallery ) {
global $current_foogallery;
global $current_foogallery_template;
global $current_foogallery_arguments;
//check if we are dealing with a gallery. This check ensures this is not done for albums
if ( isset( $current_foogallery ) && isset( $current_foogallery_template ) ) {
//first do a check if the template needs thumbnail dimensions calculated
if ($this->does_gallery_template_use_thumbnail_dimensions( $current_foogallery_template ) ) {
//load the thumbnail dimensions specific to the gallery, taking preference to arguments
$thumbnail_dimensions = apply_filters( 'foogallery_calculate_thumbnail_dimensions-' . $current_foogallery_template, array(), $current_foogallery_arguments );
//if we have no dimensions then load them from the gallery settings
if ( $this->empty_dimensions( $thumbnail_dimensions ) ) {
$thumbnail_dimensions = apply_filters( 'foogallery_template_thumbnail_dimensions-' . $current_foogallery_template, $thumbnail_dimensions, $current_foogallery );
}
if ( isset( $thumbnail_dimensions ) && is_array( $thumbnail_dimensions ) ) {
//$thumbnail_dimensions
$thumb_width = (int)$thumbnail_dimensions['width'];
$thumb_height = (int)$thumbnail_dimensions['height'];
$thumb_crop = (bool)$thumbnail_dimensions['crop'];
//set the appropriate arguments on the attachments so that they can be
// picked up and used in the 'include_thumb_dimension_attributes' function below
foreach ($foogallery->attachments() as $attachment) {
if ( $thumb_crop && $thumb_width > 0 && $thumb_height > 0 ) {
//we have set width and height and crop = true
//we do not need to calculate the dimensions
$calculated_thumb_width = $thumb_width;
$calculated_thumb_height = $thumb_height;
} else {
$size_array = image_resize_dimensions( $attachment->width, $attachment->height, $thumb_width, $thumb_height, $thumb_crop );
if ( false !== $size_array ) {
$calculated_thumb_width = $size_array[4];
$calculated_thumb_height = $size_array[5];
} else {
$size_array = $this->calculate_dimensions( $attachment->width, $attachment->height, $thumb_width, $thumb_height );
if ( false !== $size_array ) {
$calculated_thumb_width = $size_array[0];
$calculated_thumb_height = $size_array[1];
} else {
//fallback for when we cannot calculate dimensions. Use the originals
$calculated_thumb_width = $attachment->width;
$calculated_thumb_height = $attachment->height;
}
}
}
$attachment->has_thumbnail_dimensions = true;
$attachment->thumb_width = $calculated_thumb_width;
$attachment->thumb_height = $calculated_thumb_height;
}
}
}
}
}
/**
* Returns a resized width and height value given the original dimensions and then either the new width or height value, one can be 0.
*
* @param {int} $orig_width - The original width of the image.
* @param {int} $orig_height - The original height of the image.
* @param {int} $new_width - The new width for the image or 0 to calculate it from the supplied new height and original dimensions.
* @param {int} $new_height - The new height for the image or 0 to calculate it from the supplied new width and original dimensions.
*
* @return array|false - Returns an array with the width value at index 0 and the height value at index 1.
* Returns false if the original dimensions are invalid or if both the new width and height are invalid.
*
* @example
*
* $size_1 = calculate_dimensions(800, 600, 0, 300); // => [400, 300]
*
* $size_2 = calculate_dimensions(800, 600, 400, 0); // => [400, 300]
*/
function calculate_dimensions($orig_width, $orig_height, $new_width, $new_height){
// if we have an invalid original size provided exit early and return false
if (!is_numeric($orig_width) || $orig_width === 0 || !is_numeric($orig_height) || $orig_height === 0){
return false;
}
$needs_width = !is_numeric($new_width) || $new_width === 0;
$needs_height = !is_numeric($new_height) || $new_height === 0;
// if we have an invalid new size provided i.e. both new values are not numbers or both are 0 then exit early and return false
if ($needs_width && $needs_height){
return false;
}
// otherwise get the ratio of the original so we can calculate any missing new values
$ratio = $orig_width / $orig_height;
if ($needs_width){
$new_width = $new_height * $ratio;
}
if ($needs_height){
$new_height = $new_width / $ratio;
}
return array($new_width, $new_height);
}
/**
* Include the thumb dimension html attributes in the rendered HTML
*
* @param $attr
* @param $args
* @param $foogallery_attachment
*
* @return array
*/
function include_thumb_dimension_attributes( $attr, $args, $foogallery_attachment ) {
global $current_foogallery;
//check if we are dealing with a gallery. This check ensures this is not done for albums
if ( isset( $current_foogallery ) ) {
//check if we have anything set
if ( isset( $foogallery_attachment->has_thumbnail_dimensions ) ) {
if ( $foogallery_attachment->thumb_width > 0 ) {
$attr['width'] = $foogallery_attachment->thumb_width;
}
if ( $foogallery_attachment->thumb_height > 0 ) {
$attr['height'] = $foogallery_attachment->thumb_height;
}
}
}
return $attr;
}
}
}
|