forked from DivaVocals/zen_Image-Handler
-
Notifications
You must be signed in to change notification settings - Fork 3
/
readme.html
737 lines (709 loc) · 51.8 KB
/
readme.html
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="http://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<title>Image Handler 5</title>
<style>
a, a:active, a:visited { color: #006666; text-decoration: none; }
a:hover { color:#00CC99; text-decoration: underline; }
BODY, P, H1, H2, H3, H4, H5, H6, LI, TD, DD, DT, pre, img, table, #outer-container {
font-family: Roboto, Verdana, AvantGarde, Tahoma, Arial, sans-serif;
font-size: 12pt;
color: black;
padding: 0px;
margin: 20px;
line-height: 1.75em;
}
H1, H2, H3, H4 { font-weight: bold; }
h1 { font-size: 20px; }
h2 { font-size: 16px; }
pre, code {font-family: Courier; font-size: 12pt; }
pre.no-pad, code.no-pad { padding: 0; margin: 0; }
legend { font-weight: bold; font-style: italic; }
ol li, ul li, ul li ul li { margin: 5px 0; padding: 0; }
img { margin: 0 20px; float: left; border: 1px solid #666; }
img.wide { width: 95%; float: none; margin: 0 2.5%; }
textarea { width: 100%; }
.corefile, .red { color: red; }
.template { color: green; }
.forward { float: right; }
.back { float: back; }
.clearBoth { clear: both; }
#buttons, #fa-buttons { margin-left: 20px; width: 300px; }
#fa-buttons { margin-top: 5px; }
table, td, th { border: 1px solid black; border-collapse: collapse; }
td, th { padding: 5px; }
th { background-color: #eee; }
.smaller { font-size: smaller; }
.removed { text-decoration: line-through; }
.added { color: blue; }
.code-samp { border: 1px solid #666; padding: 5px 5px 0; }
.etabs { margin: 0; padding: 0; }
.tab { display: inline-block; zoom:1; *display:inline; background: #eee; border: solid 1px #999; border-bottom: none; border-radius: 4px 4px 0 0; margin: 0; }
.tab a { font-size: 14px; line-height: 2em; display: block; padding: 0 10px; outline: none; }
.tab a:hover { text-decoration: underline; }
.tab.active { background: #fff; padding-top: 6px; position: relative; top: 1px; border-color: #666; }
.tab a.active { font-weight: bold; }
.tab-container .panel-container { background: #fff; border: solid #666 1px; padding: 10px; border-radius: 0 4px 4px 4px; }
.panel-container { margin-bottom: 10px; }
a[target=_blank] { text-decoration: underline; }
</style>
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous">
<script src="../jquery-1.7.1.min.js"></script>
<script src="../jquery.easytabs.min.js"></script>
<script>
$(document).ready( function() {
$('#tab-container').easytabs();
});
</script>
</head>
<body>
<h1>Image Handler<sup>5</sup> for Zen Cart v1.5.7 (and later)</h1>
<h3>Version 5.3.4 by lat9, Zen4All, brittainmark, torvista, proseLA, marco-pm and pilou2</h3>
<p>Current Support Thread at Zen Cart Forums: <a href="https://www.zen-cart.com/showthread.php?222983-Image-Handler-5-(for-v1-5-5)-Support-Thread" target="_blank">https://www.zen-cart.com/showthread.php?222983-Image-Handler-5-(for-v1-5-5)-Support-Thread</a></p>
<p><strong>Notes:</strong></p>
<ol>
<li>The majority of this readme, other than installation instructions and change history, has been migrated online to the plugin's GitHub <a href="https://github.com/DivaVocals/zen_Image-Handler" target="_blank">repository</a>. That enables the readme to be updated as-required without the need to provide a plugin update for documentation corrections.</li>
<li>Change history prior to v5.0.0 of <em>IH<sup>5</sup></em> has been archived on the plugin's GitHub repository.</li>
<li>As of <em>IH</em><sup>5</sup> v5.1.11, the minimum PHP version supported is PHP 5.6.</li>
<li><b>As of <em>IH</em><sup>5</sup> v5.3.0, the minimum Zen Cart version supported is 1.5.7.</b></li>
</ol>
<hr>
<p><i class="fas fa-exclamation-circle fa-5x red"></i> If you are using IH<sup>5</sup> on a site that also uses <a href="https://www.zen-cart.com/downloads.php?do=file&id=367" target="_blank">SitemapXML</a> and have configured <em>SitemapXML</em> to <b>Add Products Images</b>, you'll need to edit one of the <em>SitemapXML</em>'s files to allow those images to be properly reported. Editing <code>/includes/modules/pages/sitemapxml/sitemapxml_products.php</code>, you'll see this code-block towards the top of the file:</p>
<pre class="code-samp">
define('SITEMAPXML_PRODUCTS_IMAGES_SIZE', 'large');
define('SITEMAPXML_PRODUCTS_IMAGES_ADDITIONAL', 'false'); // true false
define('SITEMAPXML_PRODUCTS_IMAGES_FUNCTION', 'false'); // true false
</pre>
<p>… and you'll make the highlighted change to instruct <em>SitemapXML</em> to use the built-in Zen Cart function to create the images' links:</p>
<pre class="code-samp">
define('SITEMAPXML_PRODUCTS_IMAGES_SIZE', 'large');
define('SITEMAPXML_PRODUCTS_IMAGES_ADDITIONAL', 'false'); // true false
define('SITEMAPXML_PRODUCTS_IMAGES_FUNCTION', '<b class="red">true</b>'); // true false
</pre>
<hr>
<div class="tab-container" id="outer-container">
<ul class="etabs">
<li class="tab"><a href="#overview">Overview</a></li>
<li class="tab"><a href="#installation">Installation</a></li>
<li class="tab"><a href="#version">Change History</a></li>
</ul>
<div class="panel-container">
<div id="overview">
<h2>Overview</h2>
<p>Image Handler<sup>5</sup> (<em>IH</em><sup>5</sup>) simplifies the management of product images (particularly <em>additional</em> product images) and helps to improve page performance by optimizing those images. Product images (based on your image settings) are created in the Image Handler<sup>5</sup> <code>bmz_cache</code> directory. The original images are <b>not</b> modified, so it's <em>perfectly</em> safe to use on an existing store.</p>
<p>Image Handler<sup>5</sup> enables you to use GD libraries or ImageMagick (if installed on your server) to generate and resize small, medium and large images on the fly as they're required. You can simply upload just one image or you can have different sources for medium and large images. Image Handler<sup>5</sup> further enables you to watermark your images (overlay a second specific translucent image) and have medium or large images pop up when you move your mouse over a small image (fancy hover).</p>
<p> This contribution includes a powerful admin interface to browse your products just like you would with the Attribute Manager and upload, delete or add additional images without having to do this manually via <acronym title="File Transfer Protocol">FTP</acronym>. IH<sup>5</sup> works fine with mass update utilities like <em>EZ-Populate</em> and the <em>Database I/O Manager (DbIo)</em>.</p>
<p>For additional information, please refer to the documentation on the plugin's GitHub repository; see above for the link.</p>
</div>
<div id="installation">
<p>This section identifies the procedure you'll use to install, upgrade or remove the plugin for your Zen Cart.</p>
<div class="tab-container" id="inner-container2">
<ul class="etabs">
<li class="tab"><a href="#install">Installation</a></li>
<li class="tab"><a href="#remove">Uninstall</a></li>
</ul>
<div class="panel-container">
<div id="install">
<fieldset>
<legend>Requirements</legend>
<ul>
<li>Zen Cart v1.5.7 or later (not backwards compatible with older versions of Zen Cart).</li>
<li>PHP v5.6 or later (not backwards compatible with older versions of PHP).</li>
<li><strong>Either</strong> GD libraries version 2 or greater, <strong>or</strong> ImageMagick version 6 or greater.</li>
<li>If you are using Fual Slimbox or ColorBox for Zen Cart with Image Handler<sup>5</sup> you <strong>must</strong> read the "Misc" tab.</li>
</ul>
<p>In order to resize and modify images, Image Handler<sup>5</sup> needs either GD libraries or ImageMagick installed. You can check if your version of PHP includes the GD libraries by going to <em>Admin > Tools > Server Info</em> and searching for GD. You have to ask your host (or read your site's documentation) to learn about an ImageMagick installation.</p>
<p><strong>If you want to render GIF images</strong>, you need to have GD libraries version 2.0.28 or newer installed.</p>
</fieldset>
<fieldset>
<legend>Before You Install</legend>
<p>The <em>IH<sup>5</sup></em> installation provides updates (see below for additional information) for two of the more popular large-image viewers: <a href="https://www.zen-cart.com/downloads.php?do=file&id=584" target="_blank">Fual Slimbox</a> and <a href="https://www.zen-cart.com/downloads.php?do=file&id=1322" target="_blank">ColorBox for Zen Cart</a>. Those updates contain plugin-specific modules that work in conjunction with the newly-added <em>IH<sup>5</sup></em> "notifiers".</p>
<p>What all that techno-babble means for your <em>IH<sup>5</sup></em> installation (or upgrade!) is that there are two installation routes, dependent on whether you use a large-image viewer and, if so, which one …</p>
<p>Regardless the route you choose, I <strong>highly</strong> recommend an initial installation on a development version of your site. If you are serious about running your store it is always worth having a second version of the store so that you can experiment on that first. I know that this seems like a lot of work but it really is worth it and does not actually take that much time.</p>
<h2>Route 1</h2>
<p class="boldemphasis">This route works for <em>IH<sup>5</sup></em> installation/upgrade into stores that have either no modifications or only <em>Fual Slimbox</em> or <em>ColorBox</em> changes to those two template-override files.</p>
<p>Just install or upgrade Image Handler<sup>5</sup> — see below — and it will work. If your admin is in a language other than english then read further down for additional instructions.</p>
<h2>Route 2</h2>
<p class="boldemphasis">This route works for stores that have additional changes (i.e. another large-image viewer) or if you are unsure of the changes to those two template-override modules.</p>
<p>Review the installation instructions below. Once you have unzipped the <em>IH<sup>5</sup></em> package, use a file-comparison program (like WinMerge or Beyond Compare) to merge the template-override changes required by <em>IH<sup>5</sup></em> with your template's pre-existing changes.</p>
</fieldset>
<fieldset>
<legend><a href="https://www.zen-cart.com/downloads.php?do=file&id=584" target="_blank">Fual Slimbox</a> or <a href="https://www.zen-cart.com/downloads.php?do=file&id=1322" target="_blank">ColorBox for Zen Cart</a> with Image Handler<sup>5</sup></legend>
<p>Both of these plugins provide a large-image popup using jQuery methods and are pre-integrated with <em>IH<sup>5</sup></em>. <em>IH<sup>5</sup></em> was validated using <em>Fual Slimbox</em> v2.0.1a and <em>ColorBox for Zen Cart</em> v2.1.1 on Zen Cart 1.5.5e.</p>
<p>When your store is using <em>IH<sup>5</sup></em> along with one of these plugins, the order in which the plugin and <em>IH<sup>5</sup></em> are installed is important:</p>
<table class="misc-table">
<tr>
<th>If your store …</th>
<th>… then …</th>
</tr>
<tr>
<td>… has an <em>existing</em> installation of either large-image popup plugin …</td>
<td>Install <em>IH<sup>5</sup></em> as if you had a "fresh" Zen Cart installation, overwriting (or creating) the two template-override files required by <em>IH<sup>5</sup></em>.</td>
</tr>
<tr>
<td>… has an <em>existing</em> installation of <em>IH<sup>5</sup></em> and you are now going to install one of the large-image popup plugins …</td>
<td>Install the large-image popup as instructed <b>but do not overwrite the two template-override files in the /includes/modules sub-directory</b>. The base zc156b+ installation already includes modules that enable that large-image popup to do its thing.</td>
</tr>
<tr>
<td>… has neither <em>IH<sup>5</sup></em> nor an <em>existing</em> large-image popup plugin …</td>
<td>Install <em>IH<sup>5</sup></em>, copying all its distributed files, then proceed to install the large-image popup plugin as described above.</td>
</tr>
</table>
<p><em>IH<sup>5</sup></em>'s distribution contains the following files that provide its interoperability with these two large-image popup plugins. If your store uses a different popup plugin, you'll need to review the code associated with one of the plugin integrations provided.</p>
<table class="misc-table">
<tr>
<th>Plugin Name</th>
<th>/includes/auto_loaders File</th>
<th>/includes/classes/observers File</th>
</tr>
<tr>
<td><b>Fual Slimbox</b></td>
<td>config.fual_slimbox.php</td>
<td>FualSlimboxObserver.php</td>
</tr>
<tr>
<td><b>ColorBox</b></td>
<td>config.colorbox.php</td>
<td>ColorBoxObserver.php</td>
</tr>
</table>
</fieldset>
<fieldset>
<legend>Installation/Upgrade Instructions</legend>
<ol>
<li>BACK UP your database & store.</li>
<li><span class="boldemphasis">BACK UP your database & store!!!!!</span></li>
<li><span class="boldemphasis">BACK UP your database & store!!!!!</span></li>
<li>Unzip the Image Handler<sup>5</sup> package to your local hard drive, retaining the directory structure.</li>
<li>Rename the <code>YOUR_ADMIN</code> directory to match the name of your Zen Cart admin directory.<br /><br /><strong>IMPORTANT!!!:</strong> If your shop is using languages other than english, you <b>must</b> also copy the contents of the <code>YOUR_ADMIN/includes/languages/english</code> directory to <code>YOUR_ADMIN/includes/languages/YOUR_LANGUAGE</code> for each additional language.</li>
<li>Once you've gotten any file-merge changes completed (i.e. you're using installation route 2), log in to your store's admin.</li>
<li>Next, using an FTP program, upload the files from the following distribution sub-directories:<ol type="a">
<li>bmz_cache</li>
<li>images</li>
<li>includes</li>
<li>YOUR_ADMIN <span class="smaller">(renamed)</span></li>
</ol></li>
<li>Return to your store's admin and click on <em>any</em> link. If you followed the instructions above, you will see a message in the message stack at the top of your admin screen confirming a successful install or upgrade.</li>
<li>Navigate to <strong>Admin > Configuration > Images</strong>, set <b>IH resize images</b> to <em>yes</em>.</li>
<li>If you followed all instructions to the letter, you are ready to move on to the online <a href="https://github.com/DivaVocals/zen_Image-Handler" target="_blank">documentation</a> to learn how to modify the default configuration settings.</li>
</ol>
</fieldset>
</div>
<div id="remove">
<h2>Un-Install Instructions</h2>
<p><strong>Note:</strong> <em>IH</em><sup>5</sup>'s uninstall processing is provided as a separate script, so you can use your admin's <b>Admin / Admin Profiles</b> tool to restrict its usage to authorized admin-users.</p>
<ol>
<li>BACK UP your database and store.</li>
<li>Log into your Zen Cart admin and navigate to <em>Tools > Image Handler<sup>5</sup></em> and:<ul>
<li>Click the "Admin Tools" link at the top of the page.</li>
<li>Click the "Uninstall Image Handler" link at the top of the page.</li>
<li>You'll be presented an <em>Uninstall Image Handler</em> page. To continue with the uninstall, click the "Go" button; to cancel, click the "Cancel" button.</li>
<li>You'll be presented a confirmation page. Click "Go" one more time and the uninstall script will remove all files (except for the list below) in the <em>IH<sup>5</sup></em> distribution as well as the changes it makes to the database.</li>
</ul>The following files remain after <em>IH<sup>5</sup></em> is uninstalled:<ol type="a">
<li>/includes/auto_loaders/config.colorbox.php <span class="smaller">(remains <em>only if</em> ColorBox is installed)</span></li>
<li>/includes/auto_loaders/config.fual_slimbox.php <span class="smaller">(remains <em>only if</em> Fual Slimbox is installed)</span></li>
<li>/includes/classes/observers/ColorBoxObserver.php <span class="smaller">(remains <em>only if</em> ColorBox is installed)</span></li>
<li>/includes/classes/observers/FualSlimboxObserver.php <span class="smaller">(remains <em>only if</em> Fual Slimbox is installed)</span></li>
</ol></li>
</ol>
</div>
</div>
</div>
</div>
<div id="version">
<p>This section identifies the files added or modified for this plugin as well as the plugin's change history.</p>
<div class="tab-container" id="inner-container3">
<ul class="etabs">
<li class="tab"><a href="#changes">Change History</a></li>
<li class="tab"><a href="#files">File List</a></li>
<li class="tab"><a href="#credits">Credits</a></li>
</ul>
<div class="panel-container">
<div id="files">
<p>The plugin provides the following files in its distribution zip-file.</p>
<table id="files-list">
<tr>
<th>File Name</th>
<th>Comments</th>
</tr>
<tr>
<td>/bmz_cache/.htaccess</td>
<td> </td>
</tr>
<tr>
<td>/images/watermark.png</td>
<td> </td>
</tr>
<tr>
<td>/images/medium/watermark_MED.png</td>
<td> </td>
</tr>
<tr>
<td>/images/large/watermark_LRG.png</td>
<td> </td>
</tr>
<tr>
<td>/includes/auto_loaders/config.colorbox.php</td>
<td>Added in v5.0.0.</td>
</tr>
<tr>
<td>/includes/auto_loaders/config.fual_slimbox.php</td>
<td>Added in v5.0.0.</td>
</tr>
<tr>
<td>/includes/auto_loaders/config.image_handler.php</td>
<td>Added in v5.0.0.</td>
</tr>
<tr>
<td><span class="removed">/includes/classes/bmz_gif_info.class.php</span></td>
<td>Unused, removed in v5.2.0.</td>
</tr>
<tr>
<td>/includes/classes/bmz_image_handler.class.php</td>
<td> </td>
</tr>
<tr>
<td>/includes/classes/observers/ColorBoxObserver.php</td>
<td> Added in v5.0.0.</td>
</tr>
<tr>
<td>/includes/classes/observers/FualSlimboxObserver.php</td>
<td>Added in v5.0.0.</td>
</tr>
<tr>
<td>/includes/classes/observers/ImageHandlerObserver.php</td>
<td>Added in v5.0.0.</td>
</tr>
<tr>
<td>/includes/extra_configures/bmz_image_handler_conf.php</td>
<td> </td>
</tr>
<tr>
<td>/includes/extra_configures/bmz_io_conf.php</td>
<td> </td>
</tr>
<tr>
<td>/includes/extra_datafiles/image_handler_logging.php</td>
<td>Added in v5.1.0.</td>
</tr>
<tr>
<td>/includes/functions/extra_functions/functions_bmz_image_handler.php</td>
<td> </td>
</tr>
<tr>
<td>/includes/functions/extra_functions/functions_bmz_io.php</td>
<td> </td>
</tr>
<tr>
<td><span class="template removed">/includes/modules/YOUR_TEMPLATE/additional_images.php</span></td>
<td>No longer distributed, as of v5.2.0.</td>
</tr>
<tr>
<td><span class="template removed">/includes/modules/YOUR_TEMPLATE/main_product_image.php</span></td>
<td>No longer distributed, as of v5.2.0.</td>
</tr>
<tr>
<td><span class="removed">/includes/templates/YOUR_TEMPLATE/css/style_imagehover.css</span></td>
<td>Removed in v5.2.0.</td>
</tr>
<tr>
<td><span class="removed">/includes/templates/YOUR_TEMPLATE/jscript/jscript_imagehover.js</span></td>
<td>Removed in v5.2.0.</td>
</tr>
<tr>
<td>/YOUR_ADMIN/image_handler.php</td>
<td> </td>
</tr>
<tr>
<td>/YOUR_ADMIN/image_handler_uninstall.php</td>
<td>Added in v5.0.0.</td>
</tr>
<tr>
<td>/YOUR_ADMIN/image_handler_view_config.php</td>
<td>Added in v5.0.1.</td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/ih_manager.php</td>
<td> </td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/auto_loaders/config.image_handler.php</td>
<td> </td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/classes/ImageHandlerAdmin.php</td>
<td>Added in v5.0.0. Contains functions used by image_handler.php, moved from that module.</td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/css/image_handler.css</td>
<td>Added in v5.3.0.</td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/extra_configures/bmz_image_handler_conf.php</td>
<td> </td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/extra_configures/bmz_io_conf.php</td>
<td> </td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/extra_datafiles/image_handler.php</td>
<td> </td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/extra_datafiles/image_handler_admin_logging.php</td>
<td>Added in v5.1.0.</td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/functions/extra_functions/functions_bmz_image_handler.php</td>
<td> </td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/functions/extra_functions/functions_bmz_io.php</td>
<td> </td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</td>
<td> </td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/languages/english/image_handler.php</td>
<td>Added in v5.0.0.</td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/languages/english/image_handler_about.php</td>
<td>Added in v5.0.1.</td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/languages/english/image_handler_uninstall.php</td>
<td>Added in v5.0.0.</td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/languages/english/image_handler_view_config.php</td>
<td>Added in v5.0.1.</td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/languages/english/extra_definitions/bmz_image_handler.php</td>
<td>Comments only for v5.0.0; definitions moved to image_handler.php.</td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/languages/english/extra_definitions/bmz_language_admin.php</td>
<td>Comments only for v5.0.0; definitions moved to image_handler_extra_definitions.php.</td>
</tr>
<tr>
<td>/YOUR_ADMIN/includes/languages/english/extra_definitions/image_handler_extra_definitions.php</td>
<td>Added in v5.0.0.</td>
</tr>
</table>
</div>
<div id="changes">
<ul>
<li>v5.3.4, 2023-07-02:<ul>
<li>BUGFIX: Correct <var>/bmz_cache/.htaccess</var> for Apache 2.4 installations (pilou2).</li>
<li>The following files were changed:<ol>
<li>/bmz_cache/.htaccess</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.3.3, 2023-04-26:<ul>
<li>BUGFIX: Correct MySQL error on initial install due to unescaped single-quotes.</li>
<li>BUGFIX: Correct "Implicit conversion" PHP Warning.</li>
<li>The following files were changed:<ol>
<li>/includes/classes/bmz_image_handler.class.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.3.2, 2023-03-07:<ul>
<li>BUGFIX: Add support for webp images.</li>
<li>BUGFIX: Don't count on an image's extension identifying the image's type; check the image's type programmatically (brittainmark).</li>
<li>BUGFIX: Restore watermarks for <em>all</em> "Cache-file Naming Conventions" (was only working for <code>Hashed</code>.</li>
<li>The following files were changed or <span class="added">added</span>:<ol>
<li>/includes/classes/bmz_image_handler.class.php</li>
<li>/includes/functions/extra_functions/functions_bmz_image_handler.php</li>
<li>/YOUR_ADMIN/image_handler.php</li>
<li>/YOUR_ADMIN/includes/classes/ImageHandlerAdmin.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.3.1, 2022-11-18:<ul>
<li>BUGFIX: Pre-declare all class-variables; PHP 8.2+ requirement.</li>
<li>BUGFIX: Don't process images, e.g. those with a .webp extension, that aren't resizeable via PHP built-in functions.</li>
<li>The following files were changed or <span class="added">added</span>:<ol>
<li>/includes/classes/bmz_image_handler.class.php</li>
<li>/includes/classes/observers/ImageHandlerObserver.php</li>
<li>/includes/functions/extra_functions/functions_bmz_image_handler.php</li>
<li>/YOUR_ADMIN/image_handler.php</li>
<li>/YOUR_ADMIN/includes/classes/ImageHandlerAdmin.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.3.0, 2022-07-31:<ul>
<li>BUGFIX: Ensure that images' width/height values are integer-type.</li>
<li>CHANGE: Removing <em>1_Installation_Files (v1.5.5)</em> directory; all sub-directories moved to distribution 'root'.</li>
<li>BUGFIX: 'imagecolorallocatealpha' expects ints, but 'alphablend' returns floats; fatal PHP 8.1 error.</li>
<li>CHANGE: Updated to support zc157 and later as well as PHP 8.1.</li>
<li>BUGFIX: Properly handle corrupt image file.</li>
<li>BUGFIX: zc158 products' default sort is by products_model, use products_name instead.</li>
<li>The following files were changed or <span class="added">added</span>:<ol>
<li>/includes/auto_loaders/config.image_handler.php</li>
<li>/includes/classes/bmz_image_handler.class.php</li>
<li>/includes/classes/observers/ImageHandlerObserver.php</li>
<li>/YOUR_ADMIN/image_handler.php</li>
<li>/YOUR_ADMIN/image_handler_uninstall.php</li>
<li>/YOUR_ADMIN/image_handler_view_config.php</li>
<li>/YOUR_ADMIN/includes/ih_manager.php</li>
<li>/YOUR_ADMIN/includes/auto_loaders/config.image_handler.php</li>
<li>/YOUR_ADMIN/includes/classes/ImageHandlerAdmin.php</li>
<li><span class="added">/YOUR_ADMIN/includes/css/image_handler.css</span></li>
<li>/YOUR_ADMIN/includes/functions/extra_functions/functions_bmz_image_handler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/image_handler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/image_handler_about.php</li>
</ol></li>
</ul></li>
<li>v5.2.0, 2021-11-25:<ul>
<li>CHANGE: Various future-proofing refactors.</li>
<li>BUGFIX: Correct PHP errors when supplied image is missing.</li>
<li>BUGFIX: Ensure that images' width/height values are integer-type.</li>
<li>CHANGE: Small-image 'zoom' feature removed.</li>
<li>CHANGE: No longer distributing image-handling modules' template-overrides; changes are present in the zc156b+ core.</li>
<li>CHANGE: Remove unused class file (bmz_gif_info.class.php).</li>
<li>The following files were changed or <span class="removed">removed</span> (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li><span class="removed">/includes/classes/bmz_gif_info.class.php</span></li>
<li>/includes/classes/bmz_image_handler.class.php</li>
<li>/includes/functions/extra_functions/functions_bmz_image_handler.php</li>
<li>/includes/functions/extra_functions/functions_bmz_io.php</li>
<li><span class="removed">/includes/modules/YOUR_TEMPLATE/additional_images.php</span></li>
<li><span class="removed">/includes/modules/YOUR_TEMPLATE/main_product_image.php</span></li>
<li><span class="removed">/includes/templates/YOUR_TEMPLATE/css/style_imagehover.css</span></li>
<li><span class="removed">/includes/templates/YOUR_TEMPLATE/jscript/jscript_imagehover.js</span></li>
<li>/YOUR_ADMIN/image_handler_view_config.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/image_handler_about.php</li>
</ol></li>
</ul></li>
<li>v5.1.11, 2021-03-28:<ul>
<li>INTROP: PHP 8.1 and zc158 interoperation.</li>
<li>BUGFIX: Correct 'file not found' on admin sidebox display.</li>
<li>BUGFIX: No image preview for disabled products; the storefront <code>popup_image</code> doesn't display when a product is disabled.</li>
<li>The following files were changed (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li>/YOUR_ADMIN/image_handler.php</li>
<li>/YOUR_ADMIN/image_handler_view_config.php</li>
<li>/YOUR_ADMIN/includes/ih_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/ImageHandlerAdmin.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/image_handler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/image_handler_about.php</li>
</ol></li>
</ul></li>
<li>v5.1.10, 2021-02-19:<ul>
<li>BUGFIX: Correct PHP 8.0.0+ fatal error.</li>
<li>BUGFIX: Unwanted modifications made to input variables when IH is disabled.</li>
<li>INTROP: Changing use of $GLOBALS to global in preparation for PHP 8.1+.</li>
<li>The following files were changed (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li>/includes/classes/bmz_image_handler.class.php</li>
<li>/includes/functions/extra_functions/functions_bmz_image_handler.php</li>
<li>/includes/modules/YOUR_TEMPLATE/additional_images.php</li>
<li>/includes/modules/YOUR_TEMPLATE/main_product_image.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.1.9, 2020-10-21:<ul>
<li>BUGFIX: Remove unneeded <code>spiffyCal</code> elements. Thanks, @Zen4All!</li>
<li>BUGFIX: Include on-screen instructions, identifying why additional images' <em>medium</em> image isn't automatically created.</li>
<li>CHANGE: Additional "Cache Naming" type to help spread the files over multiple <code>bmz_cache</code> sub-directories. Thanks, @brittainmark!.</li>
<li>CHANGE: Simplify the description of the "Cache Naming" configuration setting.</li>
<li>The following files were changed (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li>/includes/classes/bmz_image_handler.class.php</li>
<li>/YOUR_ADMIN/image_handler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.1.8, 2020-01-04:<ul>
<li>BUGFIX: Future-proofing; correct curly-brace usage for PHP 7.4.</li>
<li>BUGFIX: Document configuration required for SiteMapXml images' creation.</li>
<li>The following files were changed (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li>/includes/classes/bmz_image_handler_class.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.1.7, 2019-11-06:<ul>
<li>BUGFIX: 'Submit' buttons inoperative on admin tool.</li>
<li>BUGFIX: Check for empty values prior to using <code>strpos</code>.</li>
<li>The following files were changed (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li>/includes/classes/bmz_image_handler_class.php</li>
<li>/YOUR_ADMIN/image_handler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.1.6, 2019-10-03:<ul>
<li>BUGFIX: Include required parameter in <code>additional_images</code> notifier.</li>
<li>BUGFIX: Correct formation of 'image-hover' links.</li>
<li>CHANGE: Use CSS buttons instead of images (thanks, @proseLA!).</li>
<li>CHANGE: Use HTML5 'doctype'.</li>
<li>BUGFIX: Correct target page for category/product search; it changed for zc156 and later.</li>
<li>The following files were changed (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li>/includes/classes/bmz_image_handler_class.php</li>
<li>/includes/modules/YOUR_TEMPLATE/additional_images.php</li>
<li>/YOUR_ADMIN/image_handler.php</li>
<li>/YOUR_ADMIN/image_handler_uninstall.php</li>
<li>/YOUR_ADMIN/image_handler_view_config.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.1.5, 2019-07-24:<ul>
<li>BUGFIX: Correct undefined "IH_VERSION" PHP Notice on initial installation.</li>
<li>BUGFIX: Correct undefined index on initial installation; missing a configuration setting's description.</li>
<li>The following files were changed (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/extra_definitions/image_handler_extra_definitions.php</li>
</ol></li>
</ul></li>
<li>v5.1.4, 2019-07-11:<ul>
<li>BUGFIX: Correct "missing constant" PHP warning on initial installation.</li>
<li>BUGFIX: Correct <code>edit product</code> link; broken by zc156 <em>Categories / Products</em> restructuring.</li>
<li>BUGFIX: Correct "Can't determine the page link" on new product-image creation.</li>
<li>BUGFIX: Correct various PHP Notice logs.</li>
<li>BUGFIX: Correct 'force canvas' and proportional height/widths image creation.</li>
<li>BUGFIX: Correct image-generation for products that can't be added to the cart.</li>
<li>The following files were changed (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li>/includes/classes/bmz_image_handler.class.php</li>
<li>/includes/functions/extra_functions/functions_bmz_image_handler.php</li>
<li>/YOUR_ADMIN/image_handler.php</li>
<li>/YOUR_ADMIN/includes/ih_manager.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.1.3, 2019-05-01:<ul>
<li>BUGFIX: Correct upgrade from IH versions that didn't include an <b>IH_VERSION</b> value.</li>
<li>BUGFIX: Correct overlapping previous/next product buttons on Zen Cart 1.5.6 and later.</li>
<li>CHANGE: PSR-2 standardization.</li>
<li>BUGFIX: Correct image auto-update conditional.</li>
<li>The following files were changed (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li>/includes/classes/bmz_image_handler.class.php</li>
<li>/includes/modules/YOUR_TEMPLATE/additional_images.php</li>
<li>/YOUR_ADMIN/image_handler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.1.2, 2019-02-24:<ul>
<li>BUGFIX: Correct undefined <code>LARGE_IMAGE_WIDTH</code> and <code>_HEIGHT</code> constants.</li>
<li>BUGFIX: Correct <code>configuration_description</code> for small/medium/large image backgrounds.</li>
<li>BUGFIX: Correct <code>ih_log*.log</code> contents when DIR_FS_CATALOG is set to '/'.</li>
<li>BUGFIX: Suppress image-conversion errors, recording only when the IH debug is active.</li>
<li>BUGFIX: Correct invalid numeric issues for later versions of PHP.</li>
<li>BUGFIX: Move "new file" button in <em>Tools->Image Handler<sup>5</sup></em> to improve workflow.</li>
<li>The following files were changed (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li>/includes/classes/bmz_image_handler.class.php</li>
<li>/includes/classes/observers/FualSlimboxObserver.php</li>
<li>/YOUR_ADMIN/image_handler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.1.1, 2018-06-20:<ul>
<li>BUGFIX: Correct 'bmz_cache' file location when DIR_FS_CATALOG is set to '/'.</li>
<li>BUGFIX: Image-add corrections.</li>
<li>BUGFIX: Correct debug-log generated on initial entry.</li>
<li>The following files were changed (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li>/includes/classes/bmz_image_handler.class.php</li>
<li>/YOUR_ADMIN/includes/ih_manager.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
</ol></li>
</ul></li>
<li>v5.1.0, 2018-05-29:<ul>
<li>CHANGE: Added <em>View Image Handler Configuration</em> to the <em>IH</em><sup>5</sup> admin menu.</li>
<li>CHANGE: Removed <em>Scan for old images</em> tool from the <em>IH</em><sup>5</sup> admin menu.</li>
<li>BUGFIX: Invalid "quality" parameter supplied to <code>imagepng</code>, resulting in oversized images being created.</li>
<li>CHANGE: Move <em>Image Handler</em><sup>5</sup> help-text to a separate language file.</li>
<li>BUGFIX: Background checker not recognizing "transparent" (with no RGB) as a valid setting.</li>
<li>BUGFIX: Notifiers in the additional- and main-product-image modules need to be "globalized".</li>
<li>BUGFIX: Check for the presence of the <em>zen_lightbox</em> function before enabling the Fual Slimbox observer.</li>
<li>CHANGE: <b>Major</b> admin-level restructuring and additional logging for debug.</li>
<li>CHANGE: Remove 'allow_mixed_case_ext' handling.</li>
<li>BUGFIX: Correct interaction with <em>Zen ColorBox</em>.</li>
<li>BUGFIX: Correct 'missing' definition.</li>
<li>BUGFIX: Correct unwanted PHP warning when product-image is set, but missing.</li>
<li>CHANGE: Add admin-activity record when an admin clears the bmz_cache.</li>
<li>The following files were changed (all in the <em>1_Installation_Files (v1.5.5)</em> directory):<ol>
<li>/includes/classes/bmz_image_handler.class.php</li>
<li>/includes/classes/observers/ColorBoxObserver.php</li>
<li>/includes/classes/observers/FualSlimboxObserver.php</li>
<li>/includes/classes/observers/ImageHandlerObserver.php</li>
<li>/includes/extra_configures/bmz_image_handler_conf.php</li>
<li>/includes/extra_datafiles/image_handler_logging.php <span class="smaller">(Added)</span></li>
<li>/includes/functions/extra_functions/functions_bmz_image_handler.php</li>
<li>/includes/functions/extra_functions/functions_bmz_io.php</li>
<li>/includes/modules/YOUR_TEMPLATE/additional_images.php</li>
<li>/includes/modules/YOUR_TEMPLATE/main_product_image.php</li>
<li>/YOUR_ADMIN/image_handler.php</li>
<li>/YOUR_ADMIN/image_handler_uninstall.php</li>
<li>/YOUR_ADMIN/image_handler_view_config.php <span class="smaller">(Added)</span></li>
<li>/YOUR_ADMIN/includes/ih_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/ImageHandlerAdmin.php</li>
<li>/YOUR_ADMIN/includes/extra_datafiles/image_handler.php</li>
<li>/YOUR_ADMIN/includes/extra_datafiles/image_handler_admin_logging.php <span class="smaller">(Added)</span></li>
<li>/YOUR_ADMIN/includes/init_includes/init_image_handler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/image_handler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/image_handler_about.php <span class="smaller">(Added)</span></li>
<li>/YOUR_ADMIN/includes/languages/english/image_handler_view_config.php <span class="smaller">(Added)</span></li>
<li>/YOUR_ADMIN/includes/languages/english/extra_definitions/image_handler_extra_definitions.php</li>
</ol></li>
</ul></li>
<li>v5.0.0, 2017-11-10:<ul>
<li><b>Major</b> changes to the plugin's distribution, installation and uninstall procedures.<ol>
<li>Drops support for Zen Cart versions prior to 1.5.5.</li>
<li>Installation no longer auto-removes the plugin's installation/upgrade modules.</li>
<li>No more <b>core-file</b> overwrites; only two template-override file changes needed.</li>
<li>Includes integration with <em>Fual Slimbox</em> and <em>ColorBox</em>.</li>
<li>Separate uninstall script included.</li>
</ol></li>
<li>Correct javascript error in imagehover processing.</li>
<li>Detect and correct invalid transparency settings.</li>
<li>Use CSS3 media-queries to "hide" imagehover pop-up on smaller devices.</li>
<li>Restore search functionality.</li>
</ul></li>
</ul>
</div>
<div id="credits">
<p>Based on Image Handler<sup>2</sup> <strong>Ver 2.0 Rev 7</strong> for Zen Cart 1.3.8a updated by ckosloff.</span></p>
<p>Image Handler<sup>4</sup> v4.0 modifications by:</p>
<ul>
<li>nagelkruid (nagelkruid@gmail.com)</li>
<li>Nigelt74 (http://webzings.com)</li>
<li>C Jones (http://overthehillweb.com)</li>
<li>K Hudson (http://empowermentsanctuary.com)</li>
<li>N Collie (http://www.clearright.co.uk)</li>
<li>Jörg Schönberger (http://www.webchills.at)</li>
<li>lat9 (https://vinosdefrutastropicales.com)</li>
<li>Chad M (mc12345678@cox.net)</li>
</ul>
<p>and <em>Image Handler<sup>5</sup></em> modifications by:</p>
<ul>
<li>lat9 (https://vinosdefrutastropicales.com)</li>
<li>jazzman346 (https://github.com/jazzman346)</li>
<li>jeking (https://www.zen-cart.com/member.php?16702-jeking)</li>
<li>Zen4All (https://github.com/Zen4All)</li>
<li>brittainmark (https://github.com/brittainmark)</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<script type="text/javascript">
$('#outer-container, #inner-container2, #inner-container3').easytabs();
$( '.side-link' ).click( function() {
window.location.hash = $(this).attr( 'href' );
location.reload();
});
</script>
</body>
</html>