PluginProbe
Photonic Gallery & Lightbox for Flickr, SmugMug & Others / 3.36
Photonic Gallery & Lightbox for Flickr, SmugMug & Others v3.36
3.36 3.35 3.34 3.33 2.19 2.20 2.21 2.22 2.23 2.24 2.25 2.26 2.27 2.28 2.29 2.30 2.31 2.32 2.33 2.34 2.40 2.41 2.42 2.43 2.44 All 141 releases
photonic / Options / Flickr.php

Flickr.php in Photonic Gallery & Lightbox for Flickr, SmugMug & Others 3.36, at Options/Flickr.php

489 lines 19.5 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2
3 namespace Photonic_Plugin\Options;
4
5 use Photonic_Plugin\Core\Utilities;
6
7 class Flickr extends Option_Tab {
8 protected function __construct() {
9 $this->options = [
10 [
11 'name' => "How To",
12 'desc' => "Control generic settings for the plugin",
13 'category' => 'flickr-how-to',
14 'buttons' => 'no-buttons',
15 'type' => 'section',
16 ],
17
18 [
19 'name' => "Creating a gallery",
20 'desc' => "<strong>Please complete the setup steps in the \"Flickr Settings\" tab before attempting to create a gallery!</strong> <br/><br/>
21 To create a gallery with Flickr content you can use either a <strong><em>Gutenberg Block</em></strong>
22 or the <em>Add / Edit Photonic Gallery</em> button in the <strong><em>Classic Editor</em></strong>:<br/><br/>
23 <img src='" . PHOTONIC_URL . "Options/screenshots/Flickr-1.png' style='max-width: 600px;' alt='Wizard' />",
24 'grouping' => 'flickr-how-to',
25 'type' => 'blurb',
26 ],
27
28 [
29 'name' => "Flickr settings",
30 'desc' => "Control settings for Flickr",
31 'category' => 'flickr-settings',
32 'type' => 'section',
33 ],
34
35 [
36 'name' => "Flickr API Key",
37 'desc' => "To make use of the Flickr functionality you have to use your Flickr API Key.
38 You can <a href='https://www.flickr.com/services/api/misc.api_keys.html'>obtain a key online</a> if you don't have one.
39 Note that you are responsible for following the Flickr API's <a href='https://www.flickr.com/services/api/tos/'>Terms of Service</a>",
40 'id' => 'flickr_api_key',
41 'grouping' => 'flickr-settings',
42 'type' => 'text'
43 ],
44
45 [
46 'name' => "Flickr API Secret",
47 'desc' => "To make use of authenticated Flickr functionality you have to use your Flickr API secret.
48 You can <a href='https://www.flickr.com/services/api/misc.api_keys.html'>obtain a key online</a> if you don't have one.
49 Note that you are responsible for following the Flickr API's <a href='https://www.flickr.com/services/api/tos/'>Terms of Service</a>",
50 'id' => 'flickr_api_secret',
51 'grouping' => 'flickr-settings',
52 'type' => 'text'
53 ],
54
55 [
56 'name' => "Access Token",
57 'desc' => "To get your token go to <em>Photonic &rarr; Authentication &rarr; Flickr</em>, and authenticate. Save the token you get here. <br/>If you have set
58 up a token, your users can see protected Flickr photos without a Flickr account. See <a href='https://aquoid.com/plugins/photonic/authentication/'>here</a> for more.",
59 'id' => 'flickr_access_token',
60 'grouping' => 'flickr-settings',
61 'type' => 'text'
62 ],
63
64 [
65 'name' => "Access Token Secret",
66 'desc' => "To get your token secret go to <em>Photonic &rarr; Authentication &rarr; Flickr</em>, and authenticate. Save the token secret you get here. Your token secret works with the token set in the previous option. See <a href='https://aquoid.com/plugins/photonic/authentication/'>here</a> for more.",
67 'id' => 'flickr_token_secret',
68 'grouping' => 'flickr-settings',
69 'type' => 'text'
70 ],
71
72 [
73 'name' => 'Default user',
74 'desc' => 'If no user is specified in the shortcode this one will be used. <strong>Note that this is not the username from https://www.flickr.com/photos/<span style="text-decoration: underline">username</span>/</strong>, but you can get the user id from <em>Photonic &rarr; Helpers</em>.',
75 'id' => 'flickr_default_user',
76 'grouping' => 'flickr-settings',
77 'type' => 'text'
78 ],
79
80 [
81 'name' => 'Media to show',
82 'desc' => 'You can choose to include photos as well as videos in your output. This can be overridden by the <code>media</code> parameter in the shortcode:',
83 'id' => 'flickr_media',
84 'grouping' => 'flickr-settings',
85 'type' => 'select',
86 'options' => Utilities::media_options()
87 ],
88
89 [
90 'name' => 'Thumbnail size',
91 'desc' => 'Flickr lets you display a thumbnail in the following sizes:',
92 'id' => 'flickr_thumb_size',
93 'grouping' => 'flickr-settings',
94 'type' => 'select',
95 'options' => [
96 's' => 'Small square, 75x75px',
97 'q' => 'Large square, 150x150px',
98 't' => 'Thumbnail, 100px on longest side',
99 'm' => 'Small, 240px on longest side',
100 'n' => 'Small, 320px on longest side',
101 ]
102 ],
103
104 [
105 'name' => 'Main image size',
106 'desc' => 'When you click on a thumbnail this size will be displayed if you are using a slideshow. If you are not using a slideshow you will be taken to the Flickr page:',
107 'id' => 'flickr_main_size',
108 'grouping' => 'flickr-settings',
109 'type' => 'select',
110 'options' => [
111 'none' => 'Medium, 500px on the longest side',
112 'z' => 'Medium, 640px on longest side',
113 'c' => 'Medium, 800px on longest side',
114 'b' => 'Large, 1024px on longest side',
115 'h' => 'Large, 1600px on longest side',
116 'k' => 'Large, 2048px on longest side',
117 'o' => 'Original',
118 ]
119 ],
120
121 [
122 'name' => 'Tile image size',
123 'desc' => "<strong>This is applicable only if you are using the random tiled gallery, masonry or mosaic layouts.</strong> This size will be used as the image for the tiles. Picking a size smaller than the Main image size above will save bandwidth if your users <strong>don't click</strong> on individual images. Conversely, leaving this the same as the Main image size will save bandwidth if your users <strong>do click</strong> on individual images:",
124 'id' => 'flickr_tile_size',
125 'grouping' => 'flickr-settings',
126 'type' => 'select',
127 'options' => [
128 'same' => 'Same as Main image size',
129 'n' => 'Small, 320px on longest side',
130 'none' => 'Medium, 500px on the longest side',
131 'z' => 'Medium, 640px on longest side',
132 'c' => 'Medium, 800px on longest side',
133 'b' => 'Large, 1024px on longest side',
134 'h' => 'Large, 1600px on longest side',
135 'k' => 'Large, 2048px on longest side',
136 'o' => 'Original',
137 ]
138 ],
139
140 [
141 'name' => "Video size",
142 'desc' => "This is the video size that will be used for the lightbox:",
143 'id' => 'flickr_video_size',
144 'grouping' => 'flickr-settings',
145 'type' => 'select',
146 'options' => [
147 'Site MP4' => 'Site MP4',
148 'Mobile MP4' => 'Mobile MP4',
149 'HD MP4' => 'HD MP4',
150 'Video Original' => 'Video Original',
151 'Video Player' => 'Video Player',
152 '1080p' => '1080p',
153 '720p' => '720p',
154 '360p' => '360p',
155 '288p' => '288p',
156 ]
157 ],
158
159 [
160 'name' => "Disable lightbox linking",
161 'desc' => "Check this to disable linking the photo title in the lightbox to the original photo page.",
162 'id' => 'flickr_disable_title_link',
163 'grouping' => 'flickr-settings',
164 'type' => 'checkbox'
165 ],
166
167 [
168 'name' => "Photo titles and captions for the galleries / slideshows",
169 'desc' => "What do you want to show as the photo title in the gallery / slideshow? This is used for the tooltips and title displays.",
170 'id' => 'flickr_title_caption',
171 'grouping' => 'flickr-settings',
172 'type' => 'select',
173 'options' => Utilities::title_caption_options()
174 ],
175
176 $this->get_layout_engine_options('flickr_layout_engine', 'flickr-settings'),
177
178 [
179 'name' => "Collections",
180 'desc' => "Control settings for Flickr collection thumbnails",
181 'category' => 'flickr-collections',
182 'type' => 'section',
183 ],
184
185 [
186 'name' => "What is this section?",
187 'desc' => "Options in this section are in effect when you pick the following wizard options:<br/><br/>
188 <img src='" . PHOTONIC_URL . "Options/screenshots/Flickr-5.png' style='max-width: 600px;' alt='Collections'/><br/><br/>
189 If you are using the shortcode, the settings kick in for <code>[gallery type='flickr' user_id='abc' view='collections']</code>
190 or <code>[gallery type='flickr' user_id='abc' collection_id='xyz']</code>. They are used to control the collection's thumbnail display.",
191 'grouping' => 'flickr-collections',
192 'type' => 'blurb',
193 ],
194
195 [
196 'name' => "Hide Empty Collection Details",
197 'desc' => "This will hide the collection header if your collection has no sets. Nested collections will be displayed, however.",
198 'id' => 'flickr_hide_empty_collection_details',
199 'grouping' => 'flickr-collections',
200 'type' => 'checkbox'
201 ],
202
203 [
204 'name' => "Hide Collection Thumbnail",
205 'desc' => "This will hide the thumbnail that is auto-generated by Flickr for your collection.",
206 'id' => 'flickr_hide_collection_thumbnail',
207 'grouping' => 'flickr-collections',
208 'type' => 'checkbox'
209 ],
210
211 [
212 'name' => "Hide Collection Title",
213 'desc' => "This will hide the title for your Flickr collection.",
214 'id' => 'flickr_hide_collection_title',
215 'grouping' => 'flickr-collections',
216 'type' => 'checkbox'
217 ],
218
219 [
220 'name' => "Hide Number of Sets",
221 'desc' => "This will hide the number of Photosets / Albums in your Flickr collection.",
222 'id' => 'flickr_hide_collection_set_count',
223 'grouping' => 'flickr-collections',
224 'type' => 'checkbox'
225 ],
226
227 [
228 'name' => "Photoset / Album Thumbnails (with other Photosets / Albums)",
229 'desc' => "Control settings for Flickr Photoset thumbnails",
230 'category' => 'flickr-sets',
231 'type' => 'section',
232 ],
233
234 [
235 'name' => "What is this section?",
236 'desc' => "Options in this section are in effect when you pick the following wizard options:<br/><br/>
237 <img src='" . PHOTONIC_URL . "Options/screenshots/Flickr-3.png' style='max-width: 600px;' alt='Albums'/><br/><br/>
238 If you are using the shortcode, the settings kick in for <code>[gallery type='flickr' user_id='abc' view='photosets']</code> or <code>[gallery type='flickr' user_id='abc' collection_id='xyz']</code>
239 or <code>[gallery type='flickr' user_id='abc' view='collections']</code>. They are used to control the Photoset's thumbnail display",
240 'grouping' => 'flickr-sets',
241 'type' => 'blurb',
242 ],
243
244 [
245 'name' => "Photoset Title Display",
246 'desc' => "How do you want the title of the Photoset?",
247 'id' => 'flickr_collection_set_title_display',
248 'grouping' => 'flickr-sets',
249 'type' => 'radio',
250 'options' => $this->title_styles()
251 ],
252
253 [
254 'name' => "Hide Photo Count in Title Display",
255 'desc' => "This will hide the number of photos in your Photoset's title.",
256 'id' => 'flickr_hide_collection_set_photos_count_display',
257 'grouping' => 'flickr-sets',
258 'type' => 'checkbox'
259 ],
260
261 [
262 'name' => "Constrain Photosets Per Row",
263 'desc' => "How do you want the control the number of photoset thumbnails per row? This can be overridden by adding the '<code>columns</code>' parameter to the '<code>gallery</code>' shortcode.",
264 'id' => 'flickr_collection_set_per_row_constraint',
265 'grouping' => 'flickr-sets',
266 'type' => 'select',
267 'options' => [
268 'padding' => 'Automatically calculate thumbnails per row',
269 'count' => 'Fix the number of thumbnails per row',
270 ]
271 ],
272
273 [
274 'name' => "Fixed number of thumbnails",
275 'desc' => " If you have fixed the number of thumbnails per row above, enter the number of thumbnails",
276 'id' => 'flickr_collection_set_constrain_by_count',
277 'grouping' => 'flickr-sets',
278 'type' => 'select',
279 'options' => $this->selection_range(1, 10)
280 ],
281
282 [
283 'name' => "Photoset / Album Headers (Standalone Photosets / Albums)",
284 'desc' => "Control settings for Flickr Photosets when displayed in your page",
285 'category' => 'flickr-set',
286 'type' => 'section',
287 ],
288
289 [
290 'name' => "What is this section?",
291 'desc' => "Options in this section are in effect when you pick the following wizard options:<br/><br/>
292 <img src='" . PHOTONIC_URL . "Options/screenshots/Flickr-4.png' style='max-width: 600px;' alt='Individual albums'/><br/><br/>
293 If you are using the shortcode, the settings kick in for <code>[gallery type='flickr' user_id='abc' photoset_id='xyz']</code> to show its contents on the page,
294 or if you use <code>[gallery type='flickr' user_id='abc' view='photosets']</code> and click on a thumbnail to open the included images in a popup.",
295 'grouping' => 'flickr-set',
296 'type' => 'blurb',
297 ],
298
299 [
300 'name' => "Hide Header Thumbnail",
301 'desc' => "This will hide the thumbnail in the header for your Flickr Photoset.",
302 'id' => 'flickr_hide_set_thumbnail',
303 'grouping' => 'flickr-set',
304 'type' => 'checkbox'
305 ],
306
307 [
308 'name' => "Hide Header Title",
309 'desc' => "This will hide the title in the header for your Flickr Photoset.",
310 'id' => 'flickr_hide_set_title',
311 'grouping' => 'flickr-set',
312 'type' => 'checkbox'
313 ],
314
315 [
316 'name' => "Hide Number of Photos",
317 'desc' => "This will hide the number of photos in the header in your Flickr Photoset.",
318 'id' => 'flickr_hide_set_photo_count',
319 'grouping' => 'flickr-set',
320 'type' => 'checkbox'
321 ],
322
323 [
324 'name' => "Gallery Thumbnails (with other Galleries)",
325 'desc' => "Control settings for Flickr Gallery thumbnails",
326 'category' => 'flickr-galleries',
327 'type' => 'section',
328 ],
329
330 [
331 'name' => "What is this section?",
332 'desc' => "Options in this section are in effect when you pick the following wizard options:<br/><br/>
333 <img src='" . PHOTONIC_URL . "Options/screenshots/Flickr-6.png' style='max-width: 600px;' alt='Galleries'/><br/><br/>
334 If you are using the shortcode, the settings kick in for <code>[gallery type='flickr' user_id='abc' view='galleries']</code>. They are used to control the Gallery's thumbnail display",
335 'grouping' => 'flickr-galleries',
336 'type' => 'blurb',
337 ],
338
339 [
340 'name' => "Gallery Title Display",
341 'desc' => "How do you want the title of the Gallery?",
342 'id' => 'flickr_gallery_title_display',
343 'grouping' => 'flickr-galleries',
344 'type' => 'radio',
345 'options' => $this->title_styles()
346 ],
347
348 [
349 'name' => "Hide Photo Count in Title Display",
350 'desc' => "This will hide the number of photos in your Gallery's title.",
351 'id' => 'flickr_hide_gallery_photos_count_display',
352 'grouping' => 'flickr-galleries',
353 'type' => 'checkbox'
354 ],
355
356 [
357 'name' => "Constrain Galleries Per Row",
358 'desc' => "How do you want the control the number of gallery thumbnails per row? This can be overridden by adding the '<code>columns</code>' parameter to the '<code>gallery</code>' shortcode.",
359 'id' => 'flickr_galleries_per_row_constraint',
360 'grouping' => 'flickr-galleries',
361 'type' => 'select',
362 'options' => [
363 'padding' => 'Automatically calculate thumbnails per row',
364 'count' => 'Fix the number of thumbnails per row',
365 ]
366 ],
367
368 [
369 'name' => "Fixed number of thumbnails",
370 'desc' => " If you have fixed the number of thumbnails per row above, enter the number of thumbnails",
371 'id' => 'flickr_galleries_constrain_by_count',
372 'grouping' => 'flickr-galleries',
373 'type' => 'select',
374 'options' => $this->selection_range(1, 10)
375 ],
376
377 [
378 'name' => "Gallery Headers (Standalone Galleries)",
379 'desc' => "Control settings for Flickr Galleries when displayed in your page",
380 'category' => 'flickr-gallery',
381 'type' => 'section',
382 ],
383
384 [
385 'name' => "What is this section?",
386 'desc' => "Options in this section are in effect when you pick the following wizard options:<br/><br/>
387 <img src='" . PHOTONIC_URL . "Options/screenshots/Flickr-7.png' style='max-width: 600px;' alt='Individual galleries'/><br/><br/>
388 If you are using the shortcode, the settings kick in for <code>[gallery type='flickr' user_id='abc' gallery_id='xyz']</code> to show its contents on the page, or if you use <code>[gallery type='flickr' user_id='abc' view='galleries']</code> and click on a thumbnail to open the included images in a popup.",
389 'grouping' => 'flickr-gallery',
390 'type' => 'blurb',
391 ],
392
393 [
394 'name' => "Hide Header Thumbnail",
395 'desc' => "This will hide the thumbnail in the header for your Flickr Gallery.",
396 'id' => 'flickr_hide_gallery_thumbnail',
397 'grouping' => 'flickr-gallery',
398 'type' => 'checkbox'
399 ],
400
401 [
402 'name' => "Hide Header Title",
403 'desc' => "This will hide the title in the header for your Flickr Gallery.",
404 'id' => 'flickr_hide_gallery_title',
405 'grouping' => 'flickr-gallery',
406 'type' => 'checkbox'
407 ],
408
409 [
410 'name' => "Hide Number of Photos",
411 'desc' => "This will hide the number of photos in the header in your Flickr Gallery.",
412 'id' => 'flickr_hide_gallery_photo_count',
413 'grouping' => 'flickr-gallery',
414 'type' => 'checkbox'
415 ],
416
417 [
418 'name' => "Photos (Main Page)",
419 'desc' => "Control settings for Flickr Photos when displayed in your page",
420 'category' => 'flickr-photos',
421 'type' => 'section',
422 ],
423
424 [
425 'name' => "What is this section?",
426 'desc' => "Options in this section are in effect when you pick the following wizard options:<br/><br/>
427 <img src='" . PHOTONIC_URL . "Options/screenshots/Flickr-2.png' style='max-width: 600px;' alt='Photostream'/><br/><br/>
428 If you are using the shortcode, the settings kick in for <code>[gallery type='flickr' user_id='abc' photoset_id='xyz']</code>
429 or <code>[gallery type='flickr' user_id='abc' view='photos']</code>. In other words, the photos are printed directly on the page.",
430 'grouping' => 'flickr-photos',
431 'type' => 'blurb',
432 ],
433
434 [
435 'name' => "Photo Title Display",
436 'desc' => "How do you want the title of the photos?",
437 'id' => 'flickr_photo_title_display',
438 'grouping' => 'flickr-photos',
439 'type' => 'radio',
440 'options' => $this->title_styles()
441 ],
442
443 [
444 'name' => "Constrain Photos Per Row",
445 'desc' => "How do you want the control the number of photo thumbnails per row by default? This can be overridden by adding the '<code>columns</code>' parameter to the '<code>gallery</code>' shortcode.",
446 'id' => 'flickr_photos_per_row_constraint',
447 'grouping' => 'flickr-photos',
448 'type' => 'select',
449 'options' => [
450 'padding' => 'Automatically calculate thumbnails per row',
451 'count' => 'Fix the number of thumbnails per row',
452 ]
453 ],
454
455 [
456 'name' => "Fixed number of thumbnails",
457 'desc' => " If you have fixed the number of thumbnails per row above, enter the number of thumbnails",
458 'id' => 'flickr_photos_constrain_by_count',
459 'grouping' => 'flickr-photos',
460 'type' => 'select',
461 'options' => $this->selection_range(1, 10)
462 ],
463
464 [
465 'name' => "Photos (Overlaid Popup Panel)",
466 'desc' => "Control settings for Flickr Photos when displayed in a popup",
467 'category' => 'flickr-photos-pop',
468 'type' => 'section',
469 ],
470
471 [
472 'name' => "What is this section?",
473 'desc' => "Options in this section are in effect when you click on a Photoset thumbnail to launch an overlaid gallery. In other words, the photos are printed directly on a popup.",
474 'grouping' => 'flickr-photos-pop',
475 'type' => 'blurb',
476 ],
477
478 [
479 'name' => "Photo Title Display",
480 'desc' => "How do you want the title of the photos?",
481 'id' => 'flickr_photo_pop_title_display',
482 'grouping' => 'flickr-photos-pop',
483 'type' => 'radio',
484 'options' => $this->title_styles()
485 ],
486 ];
487 }
488 }
489