-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.html
907 lines (853 loc) · 67.5 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
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Database I/O Manager (DbIo)</title>
<link rel="icon" href="../vinos_favicon.ico" type="image/x-icon" />
<link href="http://fonts.googleapis.com/css?family=Roboto" rel="stylesheet" type="text/css">
<style type="text/css">
<!--
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, img, dt, dl, table { font-family: Roboto, verdana, avantgarde, tahoma, arial, sans-serif; font-size: 12pt; color: black; padding: 0px; margin: 10px 20px; line-height: 1.75em; }
h1, h2, h3, h4 { font-weight: bold; padding: 5px; }
h1 { font-size: 20px; text-align: center; border-bottom: 1px solid #666; }
h2 { font-size: 16px; }
h2, h3 { border: 1px solid #666; background-color: #eee; }
h1+h3 { border: none; background-color: inherit; }
h5 { border-bottom: 1px dashed #666; padding-bottom: 5px; }
code.no-pad, pre.no-pad { padding: 0; margin: 0; }
.tableHead { background-color: #eee; }
ol li, ol li p { margin-left: 0; }
img { margin: 0 20px 10px; float: left; border: 1px solid #666; }
img.wide { width: 95%; float: none; margin: 0 2.5%; }
table, td, th { border: 1px solid black; border-collapse: collapse; }
td, th { padding: 5px; }
th { text-align: left; }
span.title { font-style: italic; font-weight: bold; color: #006666; }
.corefile, .red { color: red; }
.template { color: green; }
.added { color: blue; }
.removed { text-decoration: line-through; }
.osh { color: blue; }
.minspacing li { margin: 0; }
.smallimg { float: left; width: auto; margin: 0.5% 0.25% 0.25% auto; }
ol li, ul li { margin-top: 5px; margin-bottom: 5px; }
ul li ul { padding-left: 0; }
dt { font-weight: bold; margin-bottom: 0; }
dd { margin-top: 0; padding-left: 40px; }
.table { display: table; padding-left: 0.5%; font-size: smaller; }
.head_outer, .item_outer { display: table-row; }
.thead, .item { display: table-cell; padding: 0.25% 0.25%;}
.thead { font-weight: bold; }
.table ul { list-style-type: none; padding-left: 0; margin: 0; }
.table ul li { margin: 0; }
.c1 { text-align: center; font-weight: bold; width: 15%; color: #333333; vertical-align: top; }
.c3 { vertical-align: top; }
.clearBoth { clear: both; }
.smaller { font-size: smaller; }
.e { background-color: #eee; }
ul.simple, ul.simple li { list-style-type: none; padding: 0 0 0 0.5em; margin: 0; }
#table-config-osm tr td:first-child, #table-config-osm tr th:first-child { width: 30em; }
#overview-images { margin-right: 0.5em; }
.back { float: left; }
#fdcv ol { margin: 0; }
.nowrap { white-space: nowrap; }
.h-name { font-style: italic; font-weight: bold; }
#t-handlers td, #t-handlers th { vertical-align: top; }
.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; }
#dbio_layout { text-align: center; float: right; background-color: #ebebeb; }
#dbio_layout2 { padding: 0; }
#dbio_layout2 table, #dbio_layout2 td { margin: 0; border: none; }
#dbio_layout2 tr:first-child td { border-bottom: 1px solid black; }
-->
</style>
<link rel="stylesheet" type="text/css" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js" type="text/javascript"></script>
<script src="../jquery.easytabs.min.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready( function() {
$('#tab-container').easytabs();
});
</script>
</head>
<body>
<h1 id="title">Database I/O Manager (DbIo) for Zen Cart®</h1>
<p>Version 1.6.2 Copyright © 2015-2020, <a href="https://vinosdefrutastropicales.com" target="_blank">Vinos de Frutas Tropicales</a>.</p>
<p>Current Support Thread on the Zen Cart forums: <a href="https://www.zen-cart.com/showthread.php?220569-Database-I-O-Manager-(DbIo)-Support-Thread" target="_blank">https://www.zen-cart.com/showthread.php?220569-Database-I-O-Manager-(DbIo)-Support-Thread</a></p>
<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="#customization">Customization</a></li>
<li class="tab"><a href="#dbio_manager">Using the DbIo Manager</a></li>
<li class="tab"><a href="#dbio_templates">Manage DbIo Templates</a></li>
<li class="tab"><a href="#history">Change History</a></li>
</ul>
<div class="panel-container">
<!-- start overview section -->
<div id="overview">
<noscript><h2>Overview</h2></noscript>
<p><em>DbIo</em> emulates one of the more popular Zen Cart plugins — <em>Easy Populate</em> — providing "handlers" to easily input (import) data to your cart's database and output (export) that data via a comma-separated-value (CSV) or tab-delimited file. In the <em>DbIo</em>, a "handler" is responsible for all I/O actions required to support a specific operation … like importing a set of product specifications or exporting a list of customer orders.</p>
<hr />
<p>Why <em>emulate</em> rather than <em>contribute to</em> the <em>EP-4</em> plugin's development? Given the principles which guided <em>DbIo</em>'s development:</p>
<ol>
<li>Use Zen Cart's built-in processing, especially the database interfaces.</li>
<li>Use a class-based approach, enabling a higher degree of code reuse.</li>
<li>Let the database drive the data; use the database settings to guide "proper" input processing.</li>
<li>Keep the data-pool consistent; broadly define the character-encoding of the .CSV repositories.</li>
<li>Keep to, where possible, the <em>EP-4</em> interface described in its <a href="https://www.zen-cart.com/wiki/index.php/Easy_Populate" target="_blank">wiki</a>.</li>
<li>Multi-language awareness.</li>
<li>Be <em>data-driven</em>. If you've installed a plugin that simply adds a field to an existing table (like products or orders), that field is a candidate for any I/O operation on that database table without additional coding.</li>
</ol>
<p>… the <em>DbIo</em> processing is a <span class="red"><em>revolutionary</em></span> spin-off of <em>Easy Populate</em>; any differences between the <em>EP-4</em> and <em>DbIo</em> handling will be identified in this readme.</p>
</div>
<!-- end overview section -->
<!-- start installation section -->
<div id="installation">
<noscript><h2>Installing, Upgrading or Uninstalling</h2></noscript>
<div class="tab-container" id="inner-container1">
<p>This section identifies the processes you'll use to initially install <em>DbIo</em> or uninstall <em>DbIo</em> entirely.</p>
<ul class="etabs">
<li class="tab"><a href="#initial">Initial Installation</a></li>
<li class="tab"><a href="#uninstall">Uninstalling</a></li>
</ul>
<div class="panel-container">
<div id="initial">
<noscript><h3>Initial Installation</h3></noscript>
<p>There are neither <span class="corefile">core-file overwrites</span> nor <span class="template">template-overrides</span> used by this plugin; you should <strong>always</strong> backup your cart's database and files prior to making any changes. Unzip the plugin's package file and then:</p>
<ol type="A">
<li>Rename the YOUR_ADMIN folder to match your custom admin folder's name.</li>
<li>Sign into your Zen Cart's admin panel.</li>
<li>Copy the plugin's files to your store's folder structure:<ol>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li>/YOUR_ADMIN/dbio_customize.php <span class="smaller">(Added in v1.2.0)</span></li>
<li>/YOUR_ADMIN/dbio/*.*</li>
<li><span class="removed">/YOUR_ADMIN/images/icons/dbio_information.png</span> <span class="smaller">(Removed in v1.2.0)</span></li>
<li>/YOUR_ADMIN/includes/auto_loaders/config.dbio_admin.php</li>
<li>/YOUR_ADMIN/includes/boxes/extra_boxes/dbio_tools_dhtml.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/*.*</li>
<li>/YOUR_ADMIN/includes/extra_datafiles/dbio_file_database_names_admin.php</li>
<li>/YOUR_ADMIN/includes/functions/dbio_manager_functions.php</li>
<li>/YOUR_ADMIN/includes/functions/dbio_mb_string_functions.php <span class="smaller">(Added in v1.4.1)</span></li>
<li>/YOUR_ADMIN/includes/functions/dbio_string_functions.php <span class="smaller">(Added in v1.4.1)</span></li>
<li>/YOUR_ADMIN/includes/functions/extra_functions/dbio_functions.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
<li>/YOUR_ADMIN/includes/javascript/dbio/*.*</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio_customize.php <span class="smaller">(Added in v1.2.0)</span></li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/*.*</li>
<li>/YOUR_ADMIN/includes/languages/english/extra_definitions/dbio_admin_extra_definitions.php</li>
</ol></li>
<li>Click the "Admin Home" link in your Zen Cart's top admin menu. This action will cause the plugin's installation script to run.</li>
</ol>
</div>
<div id="uninstall">
<noscript><h3>Uninstalling</h3></noscript>
<p>First, delete the files that were copied to your Zen Cart's file-system, then copy the contents of the plugin's <code>/docs/dbio/uninstall/uninstall_dbio.sql</code> to your clipboard and paste into your admin's <em>Tools->Install SQL Patches</em> to complete the uninstall process.</p>
</div>
</div>
</div>
</div>
<!-- end installation section -->
<!-- start customization section -->
<div id="customization">
<noscript><h2>Customizing Your <em>DbIo</em> Installation</h2></noscript>
<p>This section identifies the steps you'll take to customize your <em>Database I/O Manager</em> installation.</p>
<p><strong>Note:</strong> The <em>DbIo</em> requires the PHP <code class="no-pad">php-mbstring</code> extension to be loaded for its proper operation; if it's not installed, you'll receive an error message when you attempt to use <em>Tools->Database I/O Manager</em>. If you receive that message, you'll need to contact your webhost and request that the extension be loaded on your store's server.</p>
<div class="tab-container" id="inner-container2">
<ul class="etabs">
<li class="tab"><a href="#considerations">Considerations</a></li>
<li class="tab"><a href="#configure">Configure</a></li>
<li class="tab"><a href="#handlers">I/O Handlers</a></li>
<li class="tab"><a href="#naming">Naming Conventions</a></li>
</ul>
<div class="panel-container">
<div id="considerations">
<noscript><h3>Considerations</h3></noscript>
<p>Here are some things to consider as you're setting up and configuring your <em>DbIo</em> installation:</p>
<ol>
<li><span class="title">Character encoding.</span> I know, boring stuff, but it's <b>very important</b> to the proper operation of <em>DbIo</em>! The plugin's installation verifies that your store's base character-encoding is "proper" by checking that your store's <code>CHARSET</code> is compatible with your store's <code>DB_CHARSET</code> values. It's <b>your</b> job to properly identify the character-set used by the spreadsheet tool you are also using (e.g. Apache OpenOffice or Microsoft Excel).<p>You'll use the <em>Configuration->DbIo Manager Settings->CSV: Encoding</em> setting to instruct <em>DbIo</em> how to interpret the data coming from or going to a <code>.csv</code> file. Set that value to <b>utf8</b> if you are using <em>Apache OpenOffice</em> (or any other known utf8-generating program) or to <b>latin1</b> if you are using <em>Microsoft Excel</em>.</p></li>
<li><span class="title">File naming.</span> <em>DbIo</em> uses the name of an I/O "handler" to identify files to-be-processed by that handler. For example, any <code>.csv</code> files to be processed by the <em>Featured</em> handler reside in the <code>/YOUR_ADMIN/dbio/</code> folder and are named <code class="nowrap">dbio.<b>Featured</b>.<em>anything</em>.csv</code></li>
<li><span class="title">Language-specific Fields.</span> While <em>EP-4</em> uses the convention of appending the <code>language_id</code> (e.g. v_products_name<b>_1</b>) to identify language-specific fields, <em>DbIo</em> appends the (more portable) <code>language_code</code> (e.g. v_products_name<b>_en</b>) when identifying language-specific values.</li>
<li><span class="title">Record removal.</span> While <em>EP-4</em> uses the convention of setting the <code>products_status</code> to a value of <b>9</b> to indicate a product to be removed, <em>DbIo</em> introduces a new column (<code>v_dbio_command</code>) that a handler can <em>conditionally</em> enable to support record-removal and/or other commands. Starting with v1.1.0, the <em>Products</em> handling supports this field; set that column's value to <code>REMOVE</code> for a particular product and, if the product exists, it will be removed.</li>
</ol>
</div>
<div id="configure">
<noscript><h3>Configuration->DbIo Manager Settings</h3></noscript>
<p>Once you've installed <em>DbIo</em>, you can customize its base settings via <em>Configuration->DbIo Manager Settings</em>:</p>
<table>
<tr class="tableHead">
<th>Field Name</th>
<th>Field Description</th>
</tr>
<tr>
<td>Version/Release Date</td>
<td>Displays the plugin's version number and release date.</td>
</tr>
<tr>
<td>CSV: Delimiter</td>
<td>Enter the single character that is used to separate columns within any DbIo CSV file. To use the tab-character as the delimiter value, enter the word <b>TAB</b>. Defaults to the comma (,) character.</td>
</tr>
<tr>
<td>CSV: Enclosure</td>
<td>Enter the single character used to enclose fields within any DbIo CSV file. Defaults to the double-quote (") character.</td>
</tr>
<tr>
<td>CSV: Escape</td>
<td>Enter the single character used as the escape-character within any DbIo CSV file. Defaults to the backslash (\) character.</td>
</tr>
<tr>
<td>CSV: Encoding</td>
<td>Choose the type of encoding to be associated with <b>all</b> DbIo I/O files. If you use Microsoft® Excel, choose <em>latin1</em>; if you use Apache OpenOffice, choose <em>utf8</em>.</td>
</tr>
<tr>
<td>CSV: Import Date Format</td>
<td>Choose the format used by any DbIo CSV file when importing <code>date</code> and <code>datetime</code> fields, one of:<ul class="simple">
<li><b>m-d-y</b></li>
<li><b>d-m-y</b></li>
<li><b>y-m-d</b></li>
</ul>Default: <b>m-d-y</b></td>
</tr>
<tr>
<td>Maximum Execution Time (seconds)</td>
<td>Enter the maximum execution time for a DbIo operation, in seconds. Default: <b>60</b></td>
</tr>
<tr>
<td>Split File: Record Count</td>
<td>Sometimes, splitting a .csv file into multiple, smaller files can help if your server is timing out on an import operation or if an exported .csv is too large to download in a single chunk. Enter the number of records (Default: <b>2000</b>) at which to split these files using the <em>Database I/O Manager</em>.</td>
</tr>
<tr>
<td>Default File Sort Order</td>
<td>Choose the default sort-order that the <em>Database I/O Manager</em> uses when displaying the I/O files it has discovered, one of:<ul class="simple">
<li><b>1a</b>: File name, ascending</li>
<li><b>1d</b>: File name, descending</li>
<li><b>2a</b>: File size, ascending</li>
<li><b>2d</b>: File size, descending</li>
<li><b>3a</b>: File date, ascending</li>
<li><b>3d</b>: File date, descending (default)</li>
</ul></td>
</tr>
<tr>
<td><em>Products</em> Import: Allow Duplicate Models?</td>
<td>Choose whether (<b>Yes</b>) or not (<b>No</b>) any <code class="no-pad">Products</code> import should be allowed to change an existing product's "model number". Default: <b>No</b>. <span class="smaller">(Introduced in v1.1.0)</span></td>
</tr>
<tr>
<td><em>Products</em>: Auto-Create Categories on Import?</td>
<td>How should the <em>DbIo</em> handle missing categories on a <em>Products</em> import? Choose <b>Yes</b> to have any missing categories automatially generated; choose <b>No</b> (the default) to disallow any product imports when the categories don't previously exist. <span class="smaller">(Introduced in v1.3.0)</span></td>
</tr>
<tr>
<td>Enable Debug?</td>
<td>Identify whether (<b>true</b>) or not (<b>false</b>, the default) the DbIo debug is to be enabled. When enabled, all I/O status is written to a dbio-*.log file in your store's <code>/YOUR_ADMIN/dbio/logs</code> folder.</td>
</tr>
<tr>
<td>Debug Date Format</td>
<td>Enter the formatting string used to timestamp all DbIo log entries; see the description of the PHP <a href="http://php.net/manual/en/function.date.php" target="_blank">date</a> function for more information. (Default: <b>Y-m-d H:i:s</b>).</td>
</tr>
</table>
</div>
<div id="handlers">
<noscript><h3>DbIo Handlers</h3></noscript>
<p><em>DbIo</em> uses "Handler" scripts to customize an I/O action; the following table shows the <em>Handlers</em> currently provided.</p>
<table id="t-handlers">
<tr>
<th>Handler Name</th>
<th>Actions</th>
<th>Export Filters</th>
<th>Customizable?</th>
<th>Description</th>
<th>EP-4 Name</th>
</tr>
<tr>
<td class="h-name">Customers</td>
<td>Export</td>
<td>None</td>
<td>No</td>
<td>This handler provides the <em>export-only</em> of all fields in the database's <code>customers</code> table.</td>
<td>—</td>
</tr>
<tr>
<td class="h-name">Featured</td>
<td>Import, Export</td>
<td>None</td>
<td>No</td>
<td>This handler provides the import and export of all fields in the database's <code>featured</code> table.</td>
<td>Featured Products</td>
</tr>
<tr>
<td class="h-name">Manufacturers</td>
<td>Import, Export</td>
<td>None</td>
<td>No</td>
<td>This handler provides the import and export of all fields in the database's <code>manufacturers</code> and <code>manufacturers_info</code> tables, added in v1.2.0.</td>
<td>—</td>
</tr>
<tr>
<td class="h-name">Orders</td>
<td>Export</td>
<td>Orders Status, ID Range, Date Range</td>
<td>Yes</td>
<td>This handler supports <em>export-only</em> of all fields within the <code>orders</code> table. The information <em>does not</em> include the associated products or their attributes.</td>
<td>—</td>
</tr>
<tr>
<td class="h-name">OrdersProducts</td>
<td>Export</td>
<td>Orders Status, ID Range, Date Range</td>
<td>No</td>
<td>This handler supports the <em>export-only</em> of an order's customer information and associated products' model-numbers and names. </td>
<td>—</td>
</tr>
<tr>
<td class="h-name">OrdersProductsAttributes</td>
<td>Export</td>
<td>Orders Status, ID Range, Date Range</td>
<td>No</td>
<td>This handler supports an <em>export-only</em> of an order's customer information and associated products' model-numbers, names and attributes (option name/value pairs).</td>
<td>Filterable Order Exports: Orders Full</td>
</tr>
<tr>
<td class="h-name">Products</td>
<td>Import, Export</td>
<td>Product Status, Manufacturer, Category</td>
<td>Yes</td>
<td>This handler supports import/export of <b>all</b> fields within the <code>products</code>, <code>products_description</code> and <code>meta_tags_products_description</code> tables, the basic product information.<ol>
<li>Starting with <em>DbIo</em> v1.1.0, a product's record can be located via either its <code>products_id</code> or <code>products_model</code> (<b>both columns are <em>required</em> in the import file</b>) and an existing product can be <em>removed</em> by creating a <code>v_dbio_command</code> column with a product's entry set to <code>REMOVE</code>. Starting with v1.4.0, a product's record can be forced to be created when the <code>v_dbio_command</code> column for the product is set to <code>ADD</code>.</li>
<li>Starting with v1.3.0, if a non-existent category is specified in a <code>v_categories_name</code> field, you control whether that category is automatically generated; see the <em>Configure</em> tab for more information. Note that categories cannot be created within categories that currently contain products and that products cannot be added to categories that currently contain sub-categories.</li>
</ol></td>
<td>Complete Products</td>
</tr>
<tr>
<td class="h-name">ProductsOptions</td>
<td>Import, Export</td>
<td>None</td>
<td>No</td>
<td>This handler supports import/export of <b>all</b> fields within the <code>products_options</code> table, the products' options' information. When importing <b>new</b> records for a multi-language store, the import should be run once per language value. Otherwise, the products_options_id will get "out-of-sync" between the multiple languages.</td>
<td>—</td>
</tr>
<tr>
<td class="h-name">ProductsOptionsValues</td>
<td>Import, Export</td>
<td>None</td>
<td>No</td>
<td>This handler supports import/export of <b>all</b> fields within the <code>products_options_values</code> table, the products' options' values' information. When importing <b>new</b> records for a multi-language store, the import should be run once per language value. Otherwise, the products_options_id will get "out-of-sync" between the multiple languages.</td>
<td>—</td>
</tr>
<tr>
<td class="h-name">ProductsAttribsBasic</td>
<td>Import, Export</td>
<td>None</td>
<td>No</td>
<td>This handler supports import/export of the basic fields associated with the <code>products_attributes</code> table, using a <code>products_model</code> value to associate a product to the attribute-values (<code>products_options_type, products_options_name, and products_options_values name</code>).</td>
<td>Basic Products Attributes</td>
</tr>
<tr>
<td class="h-name">ProductsAttribsRaw</td>
<td>Import, Export</td>
<td>None</td>
<td>No</td>
<td>This handler supports import/export of <b>all</b> fields associated with the <code>products_attributes</code> table, using the <code>products_id</code>, <code>options_id</code>, and <code>options_values_id</code> values to identify a record in the table and, thus, whether the record is an insert or an update.</td>
<td>Detailed Products Attributes</td>
</tr>
<tr>
<td class="h-name">ProductsDiscountQuantity</td>
<td>Import, Export</td>
<td>None</td>
<td>No</td>
<td>This handler supports import/export of fields associated with the <code>products_discount_quantity</code> table, using the <code>products_id</code> value to identify the product for which the discount-quantities are to be updated. Refer to the handler's on-screen instructions for additional information.</td>
<td>—</td>
</tr>
<tr>
<td class="h-name">Specials</td>
<td>Import, Export</td>
<td>None</td>
<td>No</td>
<td>This handler supports the import/export of fields associated with the <code>specials</code> table, using the <code>products_id</code> value to identify the product for which a special-price is to be updated. Refer to the handler's on-screen instructions for additional information.<br /><br />A product's <em>special price</em> can be removed using a <code>v_dbio_command</code> column with the value set to <b>REMOVE</b>.</td>
<td>—</td>
</tr>
<tr>
<td class="h-name">Stats</td>
<td>Export</td>
<td>None</td>
<td>No</td>
<td>This handler supports export of <b>all</b> fields present in the <code>dbio_stats</code> table, where <em>DbIo</em> records its statistics. Starting with v1.6.0, once the table is exported, the table is emptied.</td>
<td>—</td>
</tr>
</table>
</div>
<div id="naming">
<noscript><h3>Naming Conventions</h3></noscript>
<p>Following are the <em>naming conventions</em> used by the <em>Database I/O Manager</em>:</p>
<ol>
<li><span class="title">Handler Names.</span> A <em>handler's</em> name consists of characters matching [a-zA-Z0-9_], allowing the handler name to be presumed as its class name. No checks performed; you'll get a PHP error if the name's not a "good" PHP variable.</li>
<li><span class="title">Handler Files.</span> A handler named <b>MyHandler</b> provides two files (and, yes, <b>case is significant</b>):<ol>
<li><code class="no-pad">/YOUR_ADMIN/includes/classes/dbio/DbIo<b>MyHandler</b>Handler.php</code></li>
<li><code class="no-pad">/YOUR_ADMIN/includes/languages/english/dbio/DbIo<b>MyHandler</b>Handler.php</code></li>
</ol></li>
<li><span class="title">Handler Messages.</span> Message defines in a handler's language-file should be named based on the <b>handlerName</b>: DBIO_<b>HANDLERNAME</b>_*.</li>
</ol>
</div>
</div>
</div>
</div>
<!-- end customization section -->
<!-- start dbio_manager section -->
<div id="dbio_manager">
<noscript><h2>Using the DbIo Manager</h2></noscript>
<p>This section describes how to use the <em>Tools->Database I/O Manager</em> tool.</p>
<div class="tab-container" id="inner-container3">
<ul class="etabs">
<li class="tab"><a href="#manager">Display Organization</a></li>
<li class="tab"><a href="#export-area">Export Area</a></li>
<li class="tab"><a href="#config-area">Configuration Area</a></li>
<li class="tab"><a href="#upload-area">File-Upload Area</a></li>
<li class="tab"><a href="#import-area">Import/File-Action Area</a></li>
<li class="tab"><a href="#dbio_files">File Locations</a></li>
</ul>
<div class="panel-container">
<div id="manager">
<noscript><h3>Display Organization</h3></noscript>
<table id="dbio_layout">
<tr>
<td colspan="2">Selection Area</td>
</tr>
<tr>
<td>Export Area</td>
<td>File-Upload Area</td>
</tr>
<tr>
<td>Import/File-Action Area</td>
<td>Configuration Area</td>
</tr>
</table>
<div id="dbio_layout_desc">
<p>The <em>Database I/O Manager</em> organizes its display into five (5) sections:</p>
<ol>
<li><b>Selection Area</b>: The topmost portion of the display contains a drop-down selection where you choose the <em>handler</em> to be used for the current set of actions. That handler, once selected, is saved in the current admin's session, so that the <b><i>DbIo Manager</i></b> remembers your most recent selection for the duration of the admin-login.</li>
<li><b>Export Area</b>: The upper-left portion of the display identifies the features available for the current handler's export. Some of the handlers (like <em>Orders</em>) provide additional filters to limit their output selections and support customization of the fields exported.</li>
<li><b>File-Upload Area</b>: The upper-right portion of the display provides a form that you'll use when you want to upload a <code class="no-pad">.csv</code> file from your computer for the <em>DbIo</em> to handle. That file, once successfully uploaded, is stored in the <code class="no-pad">/YOUR_ADMIN/dbio</code> folder.</li>
<li><b>Import/File-Action Area</b>: The bottom-left portion of the display displays the list of <code class="no-pad">.csv</code> and <code class="no-pad">.log</code> files available for the selected handler. Within this section, you can choose a file to import, split, download or delete; see the <b><em>Other File Actions</em></b> tab for additional details.</li>
<li><b>Configuration Area</b>: The bottom-right portion of the display shows you the <em>DbIo Manager Settings</em> that you've currently got configured as well as some pertinent system-related settings.</li>
</ol>
</div>
<div class="clearBoth"></div>
</div>
<div id="export-area">
<noscript><h3>Export Area</h3></noscript>
<p>This section displays the export options available for the currently-selected handler. Some of the handlers, like <em>Orders</em> shown below, make use of additional filters that enable you to limit the export's output and/or enable export-template customizations.</p>
<p>Filters, if supported by the selected handler, aren't displayed initially, since the generation of those filters can have a negative impact on the tools's performance for stores with large databases. When you tick the "show/hide filters" box, that enables/disables the automatic rendering of the filters for <strong>all</strong> handlers (the selection is stored in the currently-logged-in admin's session variables).</p>
<p>Templates, if supported by the selected handler, enable you to export a subset of the handler's fields. Refer to the <strong>Manage DbIo Templates</strong> tab for additional information. When a handler supports templates, like <em>Orders</em>, you can use a previously-customized template or click the "Manage Templates" button to create a new one.</p>
<p>Make your choices from the options provided by the current handler and click the <b><em>Export</em></b> button; the exported <code class="no-pad">.csv</code> file will be created in the <code class="no-pad">/YOUR_ADMIN/dbio</code> folder. Starting with v1.6.0, if you tick the checkbox next to the <b><em>Export</em></b> button, the generated .csv file will be immediately downloaded upon export; that setting is "remembered" in the currently-logged-in admin's session.</p>
<p><strong>Note:</strong> Additional processing time will be required for the <em>DbIo Manager</em> export if you have the plugin's debug-mode enabled.</p>
<img class="wide" src="export_area.jpg" alt="DbIo Export Area" title="DbIo Export Area" />
</div>
<div id="config-area">
<noscript><h3>Configuration Area</h3></noscript>
<img src="config_area.jpg" alt="DbIo Configuration Area" title="DbIo Configuration Area" />
<p>This section simply displays the <em>DbIo</em>'s current configuration settings (and some of the applicable system settings) so you're aware of how the <em>DbIo Manager</em> is going to process your request. Clicking on the link takes you to the <em>Configuration->Database I/O Manager Settings</em> page.</p>
<div class="clearBoth"></div>
</div>
<div id="upload-area">
<noscript><h3>File-Upload Area</h3></noscript>
<img src="upload_area.jpg" alt="DbIo Upload Area" title="DbIo Upload Area" />
<p>If the currently-selected handler supports imports, you can use this section to upload any <code class="no-pad">.csv</code> files that you plan on importing into your site's database. Use the "Browse" button to select your file, making sure that the file is not larger than the <b>Maximum File Upload Size</b> shown in the <em>DbIo</em> configuration area, and then click the "Upload" button. The file will be saved in the <code class="no-pad">/YOUR_ADMIN/dbio</code> folder.</p>
<p><strong>Note:</strong> The imported file's name must be associated with the currently-selected handler, e.g. if the <em>Products</em> handler is selected, the uploaded file's name must be of the form <code class="no-pad">dbio.Products.*.csv</code>.</p>
<div class="clearBoth"></div>
</div>
<div id="import-area">
<noscript><h3>Import/File-Action Area</h3></noscript>
<img src="import_area.jpg" alt="DbIo Import/Action Area" title="DbIo Import/Action Area" />
<p>This section of the <em>DbIo Manager</em> enables you to manage the .csv files present in your site's <code class="no-pad">/YOUR_ADMIN/dbio</code> folder and the <em>DbIo</em>-generated .log files present in your site's <code class="no-pad">/YOUR_ADMIN/dbio/logs</code> folder.</p>
<p>You can delete selected files by ticking the associated checkbox(es) in the <b>Delete?</b> column and then clicking the "Delete" button — you'll receive a confirmation pop-up just to make sure.</p>
<p class="clearBoth">You can also use the dropdown selection at the top of the display to perform additional actions on the file selected via radio-button in the <b>Choose File</b> column:</p>
<ol>
<li><b>Split</b>. Causes the associated .csv file to be <em>split</em> into multiple (and, thus, smaller) files to enable their download. Refer to the <em>Split Record Count</em> displayed in the configuration area and change that if needed; the value identifies the number of records (i.e. lines in the .csv) that will be associated with each "split".</li>
<li><b>Import (Full)</b>. Results in the associated .csv file to be <em>imported</em> into your site's database. Make sure that you've created a database backup, just in case something goes awry! Note also that a full import should <b>never, ever</b> be run with the <em>DbIo's</em> debug enabled; that will severely reduce the amount of processing that can be performed!</li>
<li><b>Import (Check-Only)</b>. Results in the associated .csv file to be processed like it's going to be imported, <em>but no database changes are performed</em>. You'll use this action, for example, to check your import file for any errors (like invalid dates) before actually updating the database. This action, too, is severely hindered by the <em>DbIo's</em> debug-mode.</li>
<li><b>Download</b>. Results in the associated .csv or .log file being downloaded from your site to your computer.</li>
</ol>
<p>You can sort the files discovered by the <em>DbIo Manager</em> by the file-name, file-size or the last-modified date using the arrow-links in the file-list header.</p>
<div class="clearBoth"></div>
</div>
<div id="dbio_files">
<noscript><h3>DbIo File Locations</h3></noscript>
<p><em>DbIo</em> pre-defines the folder <code class="no-pad">/YOUR_ADMIN/dbio</code> as the location that your comma-separated-value (CSV) files reside. Whenever <em>DbIo</em> outputs (exports) a datafile, the file is created in this folder; any <code class="no-pad">.csv</code> files <em>associated with the currently-active handler</em> found in this folder are displayed within the <em>DbIo</em>'s "Import/File-Action Area".</p>
<p>When you enable <em>DbIo's</em> debug, using <em>Configuration->DbIo Manager Settings->Enable Debug?</em>, the log files are created within the folder <code class="no-pad">/YOUR_ADMIN/dbio/logs</code>.</p>
</div>
</div>
</div>
</div>
<!-- end dbio_manager section -->
<!-- start dbio_template section -->
<div id="dbio_templates">
<noscript><h2>Managing DbIo Templates</h2></noscript>
<p>This section describes how to use the <em>Configure DbIo Templates</em> tool, available via click of the "Manage Templates" button from <b><i>Tools->Database I/O Manager</i></b> when the currently-selected handler supports export <em>templating</em>.</p>
<p>The <em>DbIo</em>'s templating support allows you to choose a subset of the fields provided by the currently-selected handler for a customized export and subsequent import. There are a couple of pre-defined templates for the <em>Products</em> handler that will give you an idea of what you can do with this feature.</p>
<div class="tab-container" id="inner-container4">
<ul class="etabs">
<li class="tab"><a href="#template_listing">Listing Display</a></li>
<li class="tab"><a href="#template_edit">Create or Edit a Template</a></li>
<li class="tab"><a href="#template_copy">Copy a Template</a></li>
</ul>
<div class="panel-container">
<div id="template_listing">
<noscript><h3>Listing Display</h3></noscript>
<p>On initial entry to the <em>DbIo</em> template-manager, the templates for the currently-selected handler are displayed. The following information is displayed for each:</p>
<ul>
<li><strong>Scope</strong>. Indicates whether the template is <em>Public</em> — available for all authorized admins — or <em>Private</em> — available only for the currently-logged-in admin's use.</li>
<li><strong>Template Name</strong>. Contains the "name" of the template; the value must contain only alphanumeric and underscore (_) characters, since the value is used to form a portion of an exported CSV file's name when the export is performed with the template.</li>
<li><strong>Description</strong>. Contains a text-blob (no HTML allowed) that you can use to remind yourself of the purpose of this template. When you select the template in the <em>Database I/O Manager</em>'s export section, this description is displayed.</li>
<li><strong>Last Updated By</strong>. Identifies the name and ID of the admin who last updated the template; the value displays as <em>System</em> for any pre-defined templates.</li>
<li><strong>Last Update Date</strong>. Identifies the date and time of the templates last update.</li>
</ul>
<img class="wide" src="template_listing.jpg" alt="DbIo Template Listing" title="DbIo Template Listing" />
<div class="clearBoth"></div>
</div>
<div id="template_edit">
<noscript><h3>Create or Edit a Template</h3></noscript>
<p>When you create or edit a DbIo template, a page similar to the following is displayed. Within this page, you identify the scope, name and description of the template and then use the <strong>Choose Template Fields</strong> block to select the fields to be included in a template-based export as well as the order that those fields will appear in the output .CSV file. Some features of that section are:</p>
<ol>
<li>Each of the <em>multi-select</em> dropdown lists can be stretched vertically to allow you to view all associated fields.</li>
<li>If the handler supports an import action on the generated CSV, there might be some "key" fields that are required; these are pre-filled into the right-side block and are required fields.</li>
<li>Use the left- and right-arrows to move fields between the left-side (all available fields) and right-side (your customized fields) blocks.</li>
<li>Use the up- and down-arrows to order the fields within the customized-fields' block.</li>
</ol>
<img class="wide" src="new_template.jpg" alt="DbIo Create or Edit a Template" title="DbIo Create or Edit a Template" />
</div>
<div id="template_copy">
<noscript><h3>Copy a Template</h3></noscript>
<p>When you <em>copy</em> an existing template, you can change the template's scope and/or name but the name you choose must be unique within its scope. This feature allows you to make a private copy of a public template and further customize it for your use. You can also make a public copy of a private template that all authorized admins can use.</p>
<img class="wide" src="copy_template.jpg" alt="DbIo Copy a Template" title="DbIo Copy a Template" />
<div class="clearBoth"></div>
</div>
</div>
</div>
</div>
<!-- end dbio_templates section -->
<!-- start history section -->
<div id="history">
<noscript><h3>Version History</h3></noscript>
<p>You can view the details of these changes on the plugin's <a href="https://github.com/lat9/dbio/issues" target="_blank">GitHub repository.</a></p>
<ul>
<li>v1.6.2, 2020-05-14:<ul>
<li>BUGFIX: Correct "Products" export creating multiple records for multi-lingual stores.</li>
<li>BUGFIX: Correct "ProductsAttribsRaw" check-only import MySQL error when inserting a new download attribute.</li>
<li>BUGFIX: Correct MySQL error when importing using "ProductsAttribsBasic" with option-values containing single-quotes.</li>
<li>The following files were changed or <span class="added">added</span>:<ol>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsAttribsBasicHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsAttribsRawHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
</ol></li>
</ul></li>
<li>v1.6.1, 2020-02-12:<ul>
<li>BUGFIX: Hide unwanted (and confusing) link-title on <em>View Import Details</em> pop-up.</li>
<li>BUGFIX: Correct MySQL error on initial install introduced in v1.6.0.</li>
<li>The following files were changed or <span class="added">added</span>:<ol>
<li>/YOUR_ADMIN/includes/javascript/dbio/colorbox.css</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
</ol></li>
</ul></li>
<li>v1.6.0, 2020-02-08:<ul>
<li>BUGFIX: Update <em>ProductsHandler</em> to include the products' meta-tags' language-based settings.</li>
<li>BUGFIX: <em>ProductsAttribsRawHandler</em><ol type="a">
<li>Ensure the export properly outputs possibly not present fields.</li>
<li>Correct management of the (possibly not present) 'products_attributes_downloads' table's fields.</li>
</ol></li>
<li>BUGFIX: Correct <em>Manufacturers</em> only exports default language for multi-lingual stores.</li>
<li>BUGFIX: Correct PHP notice generated if an export completes unsuccessfully, e.g. generating no records.</li>
<li>CHANGE: Enhance various handlers' on-screen instructions.</li>
<li>BUGFIX: Correctly export (and import) a product's language-specific meta-tags' fields.</li>
<li>BUGFIX: Ensure that minimum information is present to create a new product.</li>
<li>BUGFIX: Correct PHP Notice issued when copying a customized template.</li>
<li>BUGFIX: Correct insertion of customized fields, affects <em>Orders</em> and <em>Products</em> handlers.</li>
<li>CHANGE: Enable 'automatic' download of exports.</li>
<li>BUGFIX: Correct database tables' integer fields' defaults (they're now numeric values).</li>
<li>CHANGE: Update the <em>Stats</em> handler to empty the <code>dbio_stats</code> table on an export.</li>
<li>CHANGE: Include a handler (<em>Specials</em>) to import/export fields from the <code>specials</code> table.</li>
<li>The following files were changed or <span class="added">added</span>:<ol>
<li>/YOUR_ADMIN/dbio_customize.php</li>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIo.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoManufacturersHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsAttribsRawHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsHandler.php</li>
<li><span class="added">/YOUR_ADMIN/includes/classes/dbio/DbIoSpecialsHandler.php</span></li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoStatsHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio_customize.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/DbIoManufacturersHandler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/DbIoProductsAttribsBasicHandler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/DbIoProductsAttribsRawHandler.php</li>
<li><span class="added">/YOUR_ADMIN/includes/languages/english/dbio/DbIoSpecialsHandler.php</span></li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/DbIoStatsHandler.php</li>
</ol></li>
</ol></li>
</ul></li>
<li>v1.5.7, 2019-09-22:<ul>
<li>BUGFIX: Correct <em>ProductsAttribsRawHandler</em> PHP error on attribute addition with download.</li>
<li>CHANGE: Add jQuery to enable the multi-select dropdowns to be resized vertically.</li>
<li>CHANGE: Update <em>ProductsAttribsRawHandler</em> to also export each product's manufacturer-name.</li>
<li>The following files were changed:<ol>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsAttribsRawHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
</ol></li>
</ul></li>
<li>v1.5.6, 2019-08-10:<ul>
<li>BUGFIX: "Split" processing improperly encloses lines with blanks.</li>
<li>BUGFIX: Correct PHP Notice when blank lines are found in an import.</li>
<li>CHANGE: Add buttons to select/unselect all files for the delete action.</li>
<li>The following files were changed:<ol>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio_manager.php</li>
</ol></li>
</ul></li>
<li>v1.5.5, 2019-07-24:<ul>
<li>BUGFIX: "Split" processing creates duplicate header lines on first "part".</li>
<li>BUGFIX: Don't log generated SQL when performing a full import — performance issue for large imports.</li>
<li>CHANGE: Disregard blank lines in an imported .csv file.</li>
<li>The following files were changed:<ol>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
</ol></li>
</ul></li>
<li>v1.5.4, 2019-04-30:<ul>
<li>BUGFIX: Correct various PHP Notices.</li>
<li>BUGFIX: <em>ProductsOptions</em> and <em>ProductsOptionsValues</em> handlers won't import when key is 0.</li>
<li>BUGFIX: <em>ProductsAttribsBasic</em> throws MySQL/strict error due to now-invalid <code>GROUP BY</code> clause.</li>
<li>CHANGE: Enable <em>ProductsAttribsRaw</em> to support a <code>v_dbio_command</code> value of <b>REMOVE</b>.</li>
<li>BUGFIX: <em>ProductsDiscountQuantity</em> throws MySQL/strict error due to now-invalid <code>GROUP BY</code> clause.</li>
<li>The following files were changed:<ol>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIo.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbioProductsAttribsBasicHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbioProductsAttribsRawHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsOptionsHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsOptionsValuesHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsDiscountQuantityHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/DbIoProductsAttribsRawHandler.php</li>
</ol></li>
</ul></li>
<li>v1.5.3, 2019-04-22:<ul>
<li>BUGFIX: PHP error thrown for the <em>Products</em> handler, when creating a category.</li>
<li>BUGFIX: PHP errors and/or notices thrown for the <em>Products</em> handler, when forcing a product to be created via DbIo command.</li>
<li>BUGFIX: Incorrect report of invalid <em>integer</em> values in some configurations.</li>
<li>The following files were changed:<ol>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
</ol></li>
</ul></li>
<li>v1.5.2, 2019-03-05:<ul>
<li>BUGFIX: <code>DB_CHARSET</code> of <code>utf8mb4</code> not recognized as valid <em>utf8</em> variant.</li>
<li>BUGFIX: Properly recognize a database field type of <code>double</code>.</li>
<li>BUGFIX: Negative integers, e.g. -30, should be accepted as valid integer values.</li>
<li>The following files were changed:<ol>
<li>/YOUR_ADMIN/dbio_customize.php</li>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
</ol></li>
</ul></li>
<li>v1.5.1, 2018-09-13:<ul>
<li>BUGFIX: <code>Products</code> export columns are "off" for its specially-handled fields, due to <code>v_dbio_command</code> column inserts.</li>
<li>The following files were changed:<ol>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
</ol></li>
</ul></li>
<li>v1.5.0, 2018-07-21:<ul>
<li>CHANGE: Add the <code>ProductsDiscountQuantity</code> handler.</li>
<li>BUGFIX: <code>Products</code> export results in error when imported.</li>
<li>CHANGE: Include each customer's default-address information for a <code>Customers</code> export.</li>
<li>BUGFIX: Correct <code>Products</code> customized language fields' ordering.</li>
<li>The following files were changed or <span class="added">added</span>:<ol>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoCustomersHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsHandler.php</li>
<li><span class="added">/YOUR_ADMIN/includes/classes/dbio/DbIoProductsDiscountQuantityHandler.php</span></li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/DbIoCustomersHandler.php</li>
<li><span class="added">/YOUR_ADMIN/includes/languages/english/dbio/DbIoProductsDiscountQuantityHandler.php</span></li>
</ol></li>
</ul></li>
<li>v1.4.1, 2018-04-05:<ul>
<li>BUGFIX: Zen Cart admin versions less than 1.5.5<b>a</b> don't auto-load jQuery.</li>
<li>BUGFIX: Customized <code>Products</code> export returns <em>all</em> fields of the <code>products_description</code> table.</li>
<li>CHANGE: Allow exports to output multiple lines per request.</li>
<li>BUGFIX: Enable database fields that are <em>nullable</em> to be set to <code>NULL</code>.</li>
<li>BUGFIX: Enable plugin operations when <code>php-mbstring</code> extension is not loaded.</li>
<li>The following files were changed or <span class="added">added</span>:<ol>
<li>/YOUR_ADMIN/dbio_customize.php</li>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIo.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsAttribsBasicHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsHandler.php</li>
<li><span class="added">/YOUR_ADMIN/includes/functions/dbio_string_functions.php</span></li>
<li><span class="added">/YOUR_ADMIN/includes/functions/dbio_mb_string_functions.php</span></li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
</ol></li>
</ul></li>
<li>v1.4.0, 2017-11-28:<ul>
<li>CHANGE: Update the "Products" handler to allow a product to be unconditionally created.</li>
<li>The following files were changed:<ol>
</ol></li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
</ul></li>
<li>v1.3.1, 2017-10-04:<ul>
<li>BUGFIX: Properly detect missing/read-only input-output directories.</li>
<li>BUGFIX: (Products) Import with duplicate records results in debug-log.</li>
<li>BUGFIX: (Products) Import/update of a product doesn't record updated master-categories id.</li>
<li>BUGFIX: (Products) Exports with re-organized manufacturer's name, tax-class id or categories name have mixed data in columns; for (Orders), the same applies for the orders-status name.</li>
<li>BUGFIX: Export error not displayed to admin user</li>
<li>The following files were changed:<ol>
</ol></li>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIo.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoOrdersHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/dbio_messages.php</li>
</ul></li>
<li>v1.3.0, 2017-04-25:<ul>
<li>CHANGE: Display <em>all</em> DbIo configuration settings on the main tool's page.</li>
<li>BUGFIX: Manage the product's date-added/last-modified fields on an import.</li>
<li>BUGFIX: Correct final v1.2.0 initialization fails for "early adopters".</li>
<li>BUGFIX: Update the <em>Products</em> handler to optionally create any associated categories.</li>
<li>CHANGE: Add a control to enable a handler to totally control the import sequencing.</li>
<li>The following files were changed:<ol>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio_manager.php</li>
</ol></li>
</ul></li>
<li>v1.2.1, 2017-03-01:<ul>
<li>BUGFIX: Alert admin-user when "php-mbstring" extension is not installed.</li>
<li>BUGFIX: Add backticks around database field names.</li>
<li>CHANGE: Enable fixed-field handlers to include special-handling fields.</li>
<li>The following files were changed:<ol>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIo.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/dbio_messages.php</li>
</ol></li>
</ul></li>
<li>v1.2.0, 2017-02-06:<ul>
<li>BUGFIX: Truncate character fields to their database-defined maximum length prior to import.</li>
<li>CHANGE: Add an handler to support import/export of the manufacturers' information.</li>
<li>CHANGE: Enable download and removal of <em>DbIo</em> log files.</li>
<li>CHANGE: Reduce creation of "nuisance" DbIo log files.</li>
<li>CHANGE: Use a text-link instead of icon to indicate that import statistics are available.</li>
<li>CHANGE: Enable exported report customizations.</li>
<li>CHANGE: Restructure admin tool's user interface.</li>
<li>CHANGE: Conditionally present a handler's filters for use in the database-export processing.</li>
<li>BUGFIX: Maintain current file selection.</li>
<li>The following files were changed, <span class="added">added</span> or <span class="removed">removed</span>:<ol>
<li>/docs/dbio/uninstall/uninstall_dbio.sql</li>
<li><span class="added">/YOUR_ADMIN/dbio_customize.php</span></li>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li><span class="removed">/YOUR_ADMIN/images/icons/dbio_information.png</span></li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIo.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li><span class="added">/YOUR_ADMIN/classes/dbio/DbIoManufacturersHandler.php</span></li>
<li><span class="added">/YOUR_ADMIN/includes/classes/dbio/DbIoOrdersBase.php</span></li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoOrdersHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoOrdersProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/extra_datafiles/dbio_file_database_names_admin.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
<li><span class="added">/YOUR_ADMIN/includes/languages/english/dbio_customize.php</span></li>
<li>/YOUR_ADMIN/includes/languages/english/dbio_manager.php</li>
<li><span class="added">/YOUR_ADMIN/includes/languages/english/dbio/DbIoManufacturersHandler.php</span></li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/DbIoOrdersHandler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/DbIoOrdersProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/DbIoProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/extra_definitions/dbio_admin_extra_definitions.php</li>
</ol></li>
</ul></li>
<li>v1.1.1, 2017-01-04:<ul>
<li>BUGFIX: <em>OrdersProducts</em> handler generates database error when filtered.</li>
<li>BUGFIX: <em>OrdersProducts</em> handler doesn't encode data on export.</li>
<li>The following files were changed:<ol>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoOrdersProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
</ol></li>
</ul></li>
<li>v1.1.0, 2016-12-19:<ul>
<li>BUGFIX: Correct PHP Notices</li>
<li>CHANGE: Add class-based support for customizable exports; not yet implemented at the <em>Database I/O Manager</em> level.</li>
<li>CHANGE: Add support for the <code class="no-pad">v_dbio_command</code> column, allowing handlers (e.g. <em>Products</em>) to accept commands (like REMOVE).</li>
<li>CHANGE: Split handlers' export-filters' configuration from handlers' base configuration.</li>
<li>CHANGE: Allow handlers to identify a minimum version of the base <code class="no-pad">DbIoHandler</code> class.</li>
<li>CHANGE: Allow handlers to identify "alternate" keys; the <code class="no-pad">DbIoProductsHandler</code> has been updated to enable an import based on either products_id or products_model.</li>
<li>BUGFIX: Cease import processing fully if an initialization error is detected.</li>
<li>BUGFIX: Disallow 'incomplete' records, i.e. fewer columns than the header.</li>
<li>BUGFIX: Fixed-header import misses 'special import' fields.</li>
<li>The following files were changed:<ol>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIo.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoOrdersHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/dbio_messages.php</li>
</ol></li>
</ul></li>
<li>v1.0.1, 2016-10-24:<ul>
<li>CHANGE: Enable a handler to perform some post-processing for the record-set just imported.</li>
<li>CHANGE: Clarify some of the handlers' instructions.</li>
<li>BUGFIX: Missing function importGetFieldValue.</li>
<li>BUGFIX: Unwanted HTML included in CSV-download in some configurations.</li>
<li>BUGFIX: Missing "Customers" handler's language file.</li>
<li>BUGFIX: Only default language exported by "Products" handler on multi-lingual stores.</li>
<li>BUGFIX: v_categories_name field not properly encoded by the "Products" export.</li>
<li>BUGFIX: Empty dates should be allowed when a date/datetime field is <em>nullable</em>.</li>
<li>CHANGE: Allow a handler to be conditionally enabled.</li>
<li>The following files were changed/<span class="added">added</span>:<ol>
<li>/YOUR_ADMIN/dbio_manager.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIo.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoHandler.php</li>
<li>/YOUR_ADMIN/includes/classes/dbio/DbIoProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/init_includes/init_dbio_admin.php</li>
<li><span class="added">/YOUR_ADMIN/includes/languages/english/dbio/DbIoCustomersHandler.php</span></li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/DbIoProductsHandler.php</li>
<li>/YOUR_ADMIN/includes/languages/english/dbio/DbIoProductsAttribsBasicHandler.php</li>
</ol></li>
</ul></li>
<li>v1.0.0, 2016-07-01, Initial release.</li>
</ul>
</div>
<!-- end history section -->
</div>
</div>
<script type="text/javascript">
$( '#outer-container, #inner-container1, #inner-container2, #inner-container3, #inner-container4' ).easytabs();
$( '.side-link' ).click( function() {
window.location.hash = $(this).attr( 'href' );
location.reload();
});
</script>
</body>
</html>