Deployed 30b0201 to 5.4 with MkDocs 1.1.2 and mike 1.0.0
[GitHub/WoltLab/woltlab.github.io.git] / 5.4 / php / database-access / index.html
1
2 <!doctype html>
3 <html lang="en" class="no-js">
4 <head>
5
6 <meta charset="utf-8">
7 <meta name="viewport" content="width=device-width,initial-scale=1">
8
9
10
11
12 <link rel="icon" href="../../assets/default.favicon.ico">
13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.2">
14
15
16
17 <title>Database Access - WoltLab Suite Documentation</title>
18
19
20
21 <link rel="stylesheet" href="../../assets/stylesheets/main.6f955dcd.min.css">
22
23
24 <link rel="stylesheet" href="../../assets/stylesheets/palette.ef6f36e2.min.css">
25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
34
35
36
37
38 <link rel="stylesheet" href="../../stylesheets/extra.css">
39
40
41
42
43
44 </head>
45
46
47
48
49
50
51
52 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
53
54
55 <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
56
57 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
58 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
59 <label class="md-overlay" for="__drawer"></label>
60 <div data-md-component="skip">
61
62
63 <a href="#database-access" class="md-skip">
64 Skip to content
65 </a>
66
67 </div>
68 <div data-md-component="announce">
69
70 <aside class="md-announce">
71 <div class="md-announce__inner md-grid md-typeset">
72
73 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
74
75 </div>
76 </aside>
77
78 </div>
79
80 <header class="md-header" data-md-component="header">
81 <nav class="md-header__inner md-grid" aria-label="Header">
82 <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
83
84 <img src="../../assets/logo.png" alt="logo">
85
86 </a>
87 <label class="md-header__button md-icon" for="__drawer">
88 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
89 </label>
90 <div class="md-header__title" data-md-component="header-title">
91 <div class="md-header__ellipsis">
92 <div class="md-header__topic">
93 <span class="md-ellipsis">
94 WoltLab Suite Documentation
95 </span>
96 </div>
97 <div class="md-header__topic" data-md-component="header-topic">
98 <span class="md-ellipsis">
99
100 Database Access
101
102 </span>
103 </div>
104 </div>
105 </div>
106
107
108
109 <label class="md-header__button md-icon" for="__search">
110 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
111 </label>
112
113 <div class="md-search" data-md-component="search" role="dialog">
114 <label class="md-search__overlay" for="__search"></label>
115 <div class="md-search__inner" role="search">
116 <form class="md-search__form" name="search">
117 <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
118 <label class="md-search__icon md-icon" for="__search">
119 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
120 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
121 </label>
122 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
123 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
124 </button>
125 </form>
126 <div class="md-search__output">
127 <div class="md-search__scrollwrap" data-md-scrollfix>
128 <div class="md-search-result" data-md-component="search-result">
129 <div class="md-search-result__meta">
130 Initializing search
131 </div>
132 <ol class="md-search-result__list"></ol>
133 </div>
134 </div>
135 </div>
136 </div>
137 </div>
138
139
140 <div class="md-header__source">
141
142 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
143 <div class="md-source__icon md-icon">
144
145 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
146 </div>
147 <div class="md-source__repository">
148 GitHub
149 </div>
150 </a>
151 </div>
152
153 </nav>
154 </header>
155
156 <div class="md-container" data-md-component="container">
157
158
159
160
161 <main class="md-main" data-md-component="main">
162 <div class="md-main__inner md-grid">
163
164
165
166 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
167 <div class="md-sidebar__scrollwrap">
168 <div class="md-sidebar__inner">
169
170
171
172 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
173 <label class="md-nav__title" for="__drawer">
174 <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
175
176 <img src="../../assets/logo.png" alt="logo">
177
178 </a>
179 WoltLab Suite Documentation
180 </label>
181
182 <div class="md-nav__source">
183
184 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
185 <div class="md-source__icon md-icon">
186
187 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
188 </div>
189 <div class="md-source__repository">
190 GitHub
191 </div>
192 </a>
193 </div>
194
195 <ul class="md-nav__list" data-md-scrollfix>
196
197
198
199
200
201
202
203
204 <li class="md-nav__item">
205 <a href="../../getting-started/" class="md-nav__link">
206 Getting Started
207 </a>
208 </li>
209
210
211
212
213
214
215
216
217
218
219
220
221
222 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
223
224
225 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
226
227 <label class="md-nav__link" for="__nav_2">
228 PHP API
229 <span class="md-nav__icon md-icon"></span>
230 </label>
231 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
232 <label class="md-nav__title" for="__nav_2">
233 <span class="md-nav__icon md-icon"></span>
234 PHP API
235 </label>
236 <ul class="md-nav__list" data-md-scrollfix>
237
238
239
240
241
242 <li class="md-nav__item">
243 <a href="../pages/" class="md-nav__link">
244 Pages
245 </a>
246 </li>
247
248
249
250
251
252
253
254 <li class="md-nav__item">
255 <a href="../database-objects/" class="md-nav__link">
256 Database Objects
257 </a>
258 </li>
259
260
261
262
263
264
265
266
267
268 <li class="md-nav__item md-nav__item--active">
269
270 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
271
272
273
274
275
276 <label class="md-nav__link md-nav__link--active" for="__toc">
277 Database Access
278 <span class="md-nav__icon md-icon"></span>
279 </label>
280
281 <a href="./" class="md-nav__link md-nav__link--active">
282 Database Access
283 </a>
284
285
286 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
287
288
289
290
291
292
293 <label class="md-nav__title" for="__toc">
294 <span class="md-nav__icon md-icon"></span>
295 Table of contents
296 </label>
297 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
298
299 <li class="md-nav__item">
300 <a href="#the-preparedstatement-object" class="md-nav__link">
301 The PreparedStatement Object
302 </a>
303
304 <nav class="md-nav" aria-label="The PreparedStatement Object">
305 <ul class="md-nav__list">
306
307 <li class="md-nav__item">
308 <a href="#query-parameters" class="md-nav__link">
309 Query Parameters
310 </a>
311
312 </li>
313
314 <li class="md-nav__item">
315 <a href="#fetching-a-single-result" class="md-nav__link">
316 Fetching a Single Result
317 </a>
318
319 </li>
320
321 <li class="md-nav__item">
322 <a href="#fetch-by-column" class="md-nav__link">
323 Fetch by Column
324 </a>
325
326 </li>
327
328 <li class="md-nav__item">
329 <a href="#fetching-all-results" class="md-nav__link">
330 Fetching All Results
331 </a>
332
333 </li>
334
335 </ul>
336 </nav>
337
338 </li>
339
340 <li class="md-nav__item">
341 <a href="#building-complex-conditions" class="md-nav__link">
342 Building Complex Conditions
343 </a>
344
345 </li>
346
347 <li class="md-nav__item">
348 <a href="#insert-or-update-in-bulk" class="md-nav__link">
349 INSERT or UPDATE in Bulk
350 </a>
351
352 </li>
353
354 </ul>
355
356 </nav>
357
358 </li>
359
360
361
362
363
364
365
366 <li class="md-nav__item">
367 <a href="../exceptions/" class="md-nav__link">
368 Exceptions
369 </a>
370 </li>
371
372
373
374
375
376
377
378
379 <li class="md-nav__item md-nav__item--nested">
380
381
382 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
383
384 <label class="md-nav__link" for="__nav_2_5">
385 API
386 <span class="md-nav__icon md-icon"></span>
387 </label>
388 <nav class="md-nav" aria-label="API" data-md-level="2">
389 <label class="md-nav__title" for="__nav_2_5">
390 <span class="md-nav__icon md-icon"></span>
391 API
392 </label>
393 <ul class="md-nav__list" data-md-scrollfix>
394
395
396
397
398
399
400 <li class="md-nav__item md-nav__item--nested">
401
402
403 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
404
405 <label class="md-nav__link" for="__nav_2_5_1">
406 Caches
407 <span class="md-nav__icon md-icon"></span>
408 </label>
409 <nav class="md-nav" aria-label="Caches" data-md-level="3">
410 <label class="md-nav__title" for="__nav_2_5_1">
411 <span class="md-nav__icon md-icon"></span>
412 Caches
413 </label>
414 <ul class="md-nav__list" data-md-scrollfix>
415
416
417
418
419
420 <li class="md-nav__item">
421 <a href="../api/caches/" class="md-nav__link">
422 Overview
423 </a>
424 </li>
425
426
427
428
429
430
431
432 <li class="md-nav__item">
433 <a href="../api/caches_persistent-caches/" class="md-nav__link">
434 Persistent Caches
435 </a>
436 </li>
437
438
439
440
441
442
443
444 <li class="md-nav__item">
445 <a href="../api/caches_runtime-caches/" class="md-nav__link">
446 Runtime Caches
447 </a>
448 </li>
449
450
451
452 </ul>
453 </nav>
454 </li>
455
456
457
458
459
460
461
462 <li class="md-nav__item">
463 <a href="../api/comments/" class="md-nav__link">
464 Comments
465 </a>
466 </li>
467
468
469
470
471
472
473
474 <li class="md-nav__item">
475 <a href="../api/cronjobs/" class="md-nav__link">
476 Cronjobs
477 </a>
478 </li>
479
480
481
482
483
484
485
486 <li class="md-nav__item">
487 <a href="../api/events/" class="md-nav__link">
488 Events
489 </a>
490 </li>
491
492
493
494
495
496
497
498
499 <li class="md-nav__item md-nav__item--nested">
500
501
502 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
503
504 <label class="md-nav__link" for="__nav_2_5_5">
505 Form Builder
506 <span class="md-nav__icon md-icon"></span>
507 </label>
508 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
509 <label class="md-nav__title" for="__nav_2_5_5">
510 <span class="md-nav__icon md-icon"></span>
511 Form Builder
512 </label>
513 <ul class="md-nav__list" data-md-scrollfix>
514
515
516
517
518
519 <li class="md-nav__item">
520 <a href="../api/form_builder/overview/" class="md-nav__link">
521 Overview
522 </a>
523 </li>
524
525
526
527
528
529
530
531 <li class="md-nav__item">
532 <a href="../api/form_builder/structure/" class="md-nav__link">
533 Structure
534 </a>
535 </li>
536
537
538
539
540
541
542
543 <li class="md-nav__item">
544 <a href="../api/form_builder/form_fields/" class="md-nav__link">
545 Fields
546 </a>
547 </li>
548
549
550
551
552
553
554
555 <li class="md-nav__item">
556 <a href="../api/form_builder/validation_data/" class="md-nav__link">
557 Validation and Data
558 </a>
559 </li>
560
561
562
563
564
565
566
567 <li class="md-nav__item">
568 <a href="../api/form_builder/dependencies/" class="md-nav__link">
569 Dependencies
570 </a>
571 </li>
572
573
574
575 </ul>
576 </nav>
577 </li>
578
579
580
581
582
583
584
585 <li class="md-nav__item">
586 <a href="../api/package_installation_plugins/" class="md-nav__link">
587 Package Installation Plugins
588 </a>
589 </li>
590
591
592
593
594
595
596
597 <li class="md-nav__item">
598 <a href="../api/user_activity_points/" class="md-nav__link">
599 User Activity Points
600 </a>
601 </li>
602
603
604
605
606
607
608
609 <li class="md-nav__item">
610 <a href="../api/user_notifications/" class="md-nav__link">
611 User Notifications
612 </a>
613 </li>
614
615
616
617
618
619
620
621 <li class="md-nav__item">
622 <a href="../api/sitemaps/" class="md-nav__link">
623 Sitemaps
624 </a>
625 </li>
626
627
628
629 </ul>
630 </nav>
631 </li>
632
633
634
635
636
637
638
639 <li class="md-nav__item">
640 <a href="../code-style/" class="md-nav__link">
641 Code Style
642 </a>
643 </li>
644
645
646
647
648
649
650
651 <li class="md-nav__item">
652 <a href="../apps/" class="md-nav__link">
653 Apps
654 </a>
655 </li>
656
657
658
659
660
661
662
663 <li class="md-nav__item">
664 <a href="../gdpr/" class="md-nav__link">
665 GDPR
666 </a>
667 </li>
668
669
670
671 </ul>
672 </nav>
673 </li>
674
675
676
677
678
679
680
681
682
683
684
685 <li class="md-nav__item md-nav__item--nested">
686
687
688 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
689
690 <label class="md-nav__link" for="__nav_3">
691 Languages, Templates & CSS
692 <span class="md-nav__icon md-icon"></span>
693 </label>
694 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
695 <label class="md-nav__title" for="__nav_3">
696 <span class="md-nav__icon md-icon"></span>
697 Languages, Templates & CSS
698 </label>
699 <ul class="md-nav__list" data-md-scrollfix>
700
701
702
703
704
705 <li class="md-nav__item">
706 <a href="../../view/languages/" class="md-nav__link">
707 Languages
708 </a>
709 </li>
710
711
712
713
714
715
716
717 <li class="md-nav__item">
718 <a href="../../view/templates/" class="md-nav__link">
719 Templates
720 </a>
721 </li>
722
723
724
725
726
727
728
729 <li class="md-nav__item">
730 <a href="../../view/template-plugins/" class="md-nav__link">
731 Template Plugins
732 </a>
733 </li>
734
735
736
737
738
739
740
741 <li class="md-nav__item">
742 <a href="../../view/css/" class="md-nav__link">
743 CSS
744 </a>
745 </li>
746
747
748
749 </ul>
750 </nav>
751 </li>
752
753
754
755
756
757
758
759
760
761
762
763 <li class="md-nav__item md-nav__item--nested">
764
765
766 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
767
768 <label class="md-nav__link" for="__nav_4">
769 TypeScript and JavaScript API
770 <span class="md-nav__icon md-icon"></span>
771 </label>
772 <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
773 <label class="md-nav__title" for="__nav_4">
774 <span class="md-nav__icon md-icon"></span>
775 TypeScript and JavaScript API
776 </label>
777 <ul class="md-nav__list" data-md-scrollfix>
778
779
780
781
782
783 <li class="md-nav__item">
784 <a href="../../javascript/general-usage/" class="md-nav__link">
785 General Usage
786 </a>
787 </li>
788
789
790
791
792
793
794
795 <li class="md-nav__item">
796 <a href="../../javascript/typescript/" class="md-nav__link">
797 TypeScript
798 </a>
799 </li>
800
801
802
803
804
805
806
807
808 <li class="md-nav__item md-nav__item--nested">
809
810
811 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
812
813 <label class="md-nav__link" for="__nav_4_3">
814 New API
815 <span class="md-nav__icon md-icon"></span>
816 </label>
817 <nav class="md-nav" aria-label="New API" data-md-level="2">
818 <label class="md-nav__title" for="__nav_4_3">
819 <span class="md-nav__icon md-icon"></span>
820 New API
821 </label>
822 <ul class="md-nav__list" data-md-scrollfix>
823
824
825
826
827
828 <li class="md-nav__item">
829 <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
830 Writing a module
831 </a>
832 </li>
833
834
835
836
837
838
839
840 <li class="md-nav__item">
841 <a href="../../javascript/new-api_data-structures/" class="md-nav__link">
842 Data Structures
843 </a>
844 </li>
845
846
847
848
849
850
851
852 <li class="md-nav__item">
853 <a href="../../javascript/new-api_core/" class="md-nav__link">
854 Core Functions
855 </a>
856 </li>
857
858
859
860
861
862
863
864 <li class="md-nav__item">
865 <a href="../../javascript/new-api_dom/" class="md-nav__link">
866 DOM
867 </a>
868 </li>
869
870
871
872
873
874
875
876 <li class="md-nav__item">
877 <a href="../../javascript/new-api_events/" class="md-nav__link">
878 Event Handling
879 </a>
880 </li>
881
882
883
884
885
886
887
888 <li class="md-nav__item">
889 <a href="../../javascript/new-api_ajax/" class="md-nav__link">
890 Ajax
891 </a>
892 </li>
893
894
895
896
897
898
899
900 <li class="md-nav__item">
901 <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
902 Dialogs
903 </a>
904 </li>
905
906
907
908
909
910
911
912 <li class="md-nav__item">
913 <a href="../../javascript/new-api_browser/" class="md-nav__link">
914 Browser and Screen Sizes
915 </a>
916 </li>
917
918
919
920
921
922
923
924 <li class="md-nav__item">
925 <a href="../../javascript/new-api_ui/" class="md-nav__link">
926 User Interface
927 </a>
928 </li>
929
930
931
932 </ul>
933 </nav>
934 </li>
935
936
937
938
939
940
941
942 <li class="md-nav__item">
943 <a href="../../javascript/legacy-api/" class="md-nav__link">
944 Legacy API
945 </a>
946 </li>
947
948
949
950
951
952
953
954 <li class="md-nav__item">
955 <a href="../../javascript/helper-functions/" class="md-nav__link">
956 Helper Functions
957 </a>
958 </li>
959
960
961
962
963
964
965
966 <li class="md-nav__item">
967 <a href="../../javascript/code-snippets/" class="md-nav__link">
968 Code Snippets
969 </a>
970 </li>
971
972
973
974 </ul>
975 </nav>
976 </li>
977
978
979
980
981
982
983
984
985
986
987
988 <li class="md-nav__item md-nav__item--nested">
989
990
991 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
992
993 <label class="md-nav__link" for="__nav_5">
994 Package Components
995 <span class="md-nav__icon md-icon"></span>
996 </label>
997 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
998 <label class="md-nav__title" for="__nav_5">
999 <span class="md-nav__icon md-icon"></span>
1000 Package Components
1001 </label>
1002 <ul class="md-nav__list" data-md-scrollfix>
1003
1004
1005
1006
1007
1008 <li class="md-nav__item">
1009 <a href="../../package/package-xml/" class="md-nav__link">
1010 package.xml
1011 </a>
1012 </li>
1013
1014
1015
1016
1017
1018
1019
1020
1021 <li class="md-nav__item md-nav__item--nested">
1022
1023
1024 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1025
1026 <label class="md-nav__link" for="__nav_5_2">
1027 PIPs
1028 <span class="md-nav__icon md-icon"></span>
1029 </label>
1030 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1031 <label class="md-nav__title" for="__nav_5_2">
1032 <span class="md-nav__icon md-icon"></span>
1033 PIPs
1034 </label>
1035 <ul class="md-nav__list" data-md-scrollfix>
1036
1037
1038
1039
1040
1041 <li class="md-nav__item">
1042 <a href="../../package/pip/" class="md-nav__link">
1043 Overview
1044 </a>
1045 </li>
1046
1047
1048
1049
1050
1051
1052
1053 <li class="md-nav__item">
1054 <a href="../../package/pip/acl-option/" class="md-nav__link">
1055 aclOption
1056 </a>
1057 </li>
1058
1059
1060
1061
1062
1063
1064
1065 <li class="md-nav__item">
1066 <a href="../../package/pip/acp-menu/" class="md-nav__link">
1067 acpMenu
1068 </a>
1069 </li>
1070
1071
1072
1073
1074
1075
1076
1077 <li class="md-nav__item">
1078 <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1079 acpSearchProvider
1080 </a>
1081 </li>
1082
1083
1084
1085
1086
1087
1088
1089 <li class="md-nav__item">
1090 <a href="../../package/pip/acp-template/" class="md-nav__link">
1091 acpTemplate
1092 </a>
1093 </li>
1094
1095
1096
1097
1098
1099
1100
1101 <li class="md-nav__item">
1102 <a href="../../package/pip/bbcode/" class="md-nav__link">
1103 bbcode
1104 </a>
1105 </li>
1106
1107
1108
1109
1110
1111
1112
1113 <li class="md-nav__item">
1114 <a href="../../package/pip/box/" class="md-nav__link">
1115 box
1116 </a>
1117 </li>
1118
1119
1120
1121
1122
1123
1124
1125 <li class="md-nav__item">
1126 <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1127 clipboardAction
1128 </a>
1129 </li>
1130
1131
1132
1133
1134
1135
1136
1137 <li class="md-nav__item">
1138 <a href="../../package/pip/core-object/" class="md-nav__link">
1139 coreObject
1140 </a>
1141 </li>
1142
1143
1144
1145
1146
1147
1148
1149 <li class="md-nav__item">
1150 <a href="../../package/pip/cronjob/" class="md-nav__link">
1151 cronjob
1152 </a>
1153 </li>
1154
1155
1156
1157
1158
1159
1160
1161 <li class="md-nav__item">
1162 <a href="../../package/pip/database/" class="md-nav__link">
1163 database
1164 </a>
1165 </li>
1166
1167
1168
1169
1170
1171
1172
1173 <li class="md-nav__item">
1174 <a href="../../package/pip/event-listener/" class="md-nav__link">
1175 eventListener
1176 </a>
1177 </li>
1178
1179
1180
1181
1182
1183
1184
1185 <li class="md-nav__item">
1186 <a href="../../package/pip/file/" class="md-nav__link">
1187 file
1188 </a>
1189 </li>
1190
1191
1192
1193
1194
1195
1196
1197 <li class="md-nav__item">
1198 <a href="../../package/pip/language/" class="md-nav__link">
1199 language
1200 </a>
1201 </li>
1202
1203
1204
1205
1206
1207
1208
1209 <li class="md-nav__item">
1210 <a href="../../package/pip/media-provider/" class="md-nav__link">
1211 mediaProvider
1212 </a>
1213 </li>
1214
1215
1216
1217
1218
1219
1220
1221 <li class="md-nav__item">
1222 <a href="../../package/pip/menu/" class="md-nav__link">
1223 menu
1224 </a>
1225 </li>
1226
1227
1228
1229
1230
1231
1232
1233 <li class="md-nav__item">
1234 <a href="../../package/pip/menu-item/" class="md-nav__link">
1235 menuItem
1236 </a>
1237 </li>
1238
1239
1240
1241
1242
1243
1244
1245 <li class="md-nav__item">
1246 <a href="../../package/pip/object-type/" class="md-nav__link">
1247 objectType
1248 </a>
1249 </li>
1250
1251
1252
1253
1254
1255
1256
1257 <li class="md-nav__item">
1258 <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1259 objectTypeDefinition
1260 </a>
1261 </li>
1262
1263
1264
1265
1266
1267
1268
1269 <li class="md-nav__item">
1270 <a href="../../package/pip/option/" class="md-nav__link">
1271 option
1272 </a>
1273 </li>
1274
1275
1276
1277
1278
1279
1280
1281 <li class="md-nav__item">
1282 <a href="../../package/pip/page/" class="md-nav__link">
1283 page
1284 </a>
1285 </li>
1286
1287
1288
1289
1290
1291
1292
1293 <li class="md-nav__item">
1294 <a href="../../package/pip/pip/" class="md-nav__link">
1295 pip
1296 </a>
1297 </li>
1298
1299
1300
1301
1302
1303
1304
1305 <li class="md-nav__item">
1306 <a href="../../package/pip/script/" class="md-nav__link">
1307 script
1308 </a>
1309 </li>
1310
1311
1312
1313
1314
1315
1316
1317 <li class="md-nav__item">
1318 <a href="../../package/pip/smiley/" class="md-nav__link">
1319 smiley
1320 </a>
1321 </li>
1322
1323
1324
1325
1326
1327
1328
1329 <li class="md-nav__item">
1330 <a href="../../package/pip/sql/" class="md-nav__link">
1331 sql
1332 </a>
1333 </li>
1334
1335
1336
1337
1338
1339
1340
1341 <li class="md-nav__item">
1342 <a href="../../package/pip/style/" class="md-nav__link">
1343 style
1344 </a>
1345 </li>
1346
1347
1348
1349
1350
1351
1352
1353 <li class="md-nav__item">
1354 <a href="../../package/pip/template/" class="md-nav__link">
1355 template
1356 </a>
1357 </li>
1358
1359
1360
1361
1362
1363
1364
1365 <li class="md-nav__item">
1366 <a href="../../package/pip/template-listener/" class="md-nav__link">
1367 templateListener
1368 </a>
1369 </li>
1370
1371
1372
1373
1374
1375
1376
1377 <li class="md-nav__item">
1378 <a href="../../package/pip/user-group-option/" class="md-nav__link">
1379 userGroupOption
1380 </a>
1381 </li>
1382
1383
1384
1385
1386
1387
1388
1389 <li class="md-nav__item">
1390 <a href="../../package/pip/user-menu/" class="md-nav__link">
1391 userMenu
1392 </a>
1393 </li>
1394
1395
1396
1397
1398
1399
1400
1401 <li class="md-nav__item">
1402 <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1403 userNotificationEvent
1404 </a>
1405 </li>
1406
1407
1408
1409
1410
1411
1412
1413 <li class="md-nav__item">
1414 <a href="../../package/pip/user-option/" class="md-nav__link">
1415 userOption
1416 </a>
1417 </li>
1418
1419
1420
1421
1422
1423
1424
1425 <li class="md-nav__item">
1426 <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1427 userProfileMenu
1428 </a>
1429 </li>
1430
1431
1432
1433 </ul>
1434 </nav>
1435 </li>
1436
1437
1438
1439
1440
1441
1442
1443 <li class="md-nav__item">
1444 <a href="../../package/database-php-api/" class="md-nav__link">
1445 Database PHP API
1446 </a>
1447 </li>
1448
1449
1450
1451 </ul>
1452 </nav>
1453 </li>
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465 <li class="md-nav__item md-nav__item--nested">
1466
1467
1468 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1469
1470 <label class="md-nav__link" for="__nav_6">
1471 Migration
1472 <span class="md-nav__icon md-icon"></span>
1473 </label>
1474 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1475 <label class="md-nav__title" for="__nav_6">
1476 <span class="md-nav__icon md-icon"></span>
1477 Migration
1478 </label>
1479 <ul class="md-nav__list" data-md-scrollfix>
1480
1481
1482
1483
1484
1485
1486 <li class="md-nav__item md-nav__item--nested">
1487
1488
1489 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1490
1491 <label class="md-nav__link" for="__nav_6_1">
1492 Migrating from WSC 5.3
1493 <span class="md-nav__icon md-icon"></span>
1494 </label>
1495 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1496 <label class="md-nav__title" for="__nav_6_1">
1497 <span class="md-nav__icon md-icon"></span>
1498 Migrating from WSC 5.3
1499 </label>
1500 <ul class="md-nav__list" data-md-scrollfix>
1501
1502
1503
1504
1505
1506 <li class="md-nav__item">
1507 <a href="../../migration/wsc53/php/" class="md-nav__link">
1508 PHP API
1509 </a>
1510 </li>
1511
1512
1513
1514
1515
1516
1517
1518 <li class="md-nav__item">
1519 <a href="../../migration/wsc53/session/" class="md-nav__link">
1520 Session Handling and Authentication
1521 </a>
1522 </li>
1523
1524
1525
1526
1527
1528
1529
1530 <li class="md-nav__item">
1531 <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1532 TypeScript and JavaScript
1533 </a>
1534 </li>
1535
1536
1537
1538
1539
1540
1541
1542 <li class="md-nav__item">
1543 <a href="../../migration/wsc53/templates/" class="md-nav__link">
1544 Templates
1545 </a>
1546 </li>
1547
1548
1549
1550
1551
1552
1553
1554 <li class="md-nav__item">
1555 <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1556 Third Party Libraries
1557 </a>
1558 </li>
1559
1560
1561
1562 </ul>
1563 </nav>
1564 </li>
1565
1566
1567
1568
1569
1570
1571
1572
1573 <li class="md-nav__item md-nav__item--nested">
1574
1575
1576 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1577
1578 <label class="md-nav__link" for="__nav_6_2">
1579 Migrating from WSC 5.2
1580 <span class="md-nav__icon md-icon"></span>
1581 </label>
1582 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1583 <label class="md-nav__title" for="__nav_6_2">
1584 <span class="md-nav__icon md-icon"></span>
1585 Migrating from WSC 5.2
1586 </label>
1587 <ul class="md-nav__list" data-md-scrollfix>
1588
1589
1590
1591
1592
1593 <li class="md-nav__item">
1594 <a href="../../migration/wsc52/php/" class="md-nav__link">
1595 PHP API
1596 </a>
1597 </li>
1598
1599
1600
1601
1602
1603
1604
1605 <li class="md-nav__item">
1606 <a href="../../migration/wsc52/templates/" class="md-nav__link">
1607 Templates and Languages
1608 </a>
1609 </li>
1610
1611
1612
1613
1614
1615
1616
1617 <li class="md-nav__item">
1618 <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1619 Third Party Libraries
1620 </a>
1621 </li>
1622
1623
1624
1625 </ul>
1626 </nav>
1627 </li>
1628
1629
1630
1631
1632
1633
1634
1635
1636 <li class="md-nav__item md-nav__item--nested">
1637
1638
1639 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1640
1641 <label class="md-nav__link" for="__nav_6_3">
1642 Migrating from WSC 3.1
1643 <span class="md-nav__icon md-icon"></span>
1644 </label>
1645 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1646 <label class="md-nav__title" for="__nav_6_3">
1647 <span class="md-nav__icon md-icon"></span>
1648 Migrating from WSC 3.1
1649 </label>
1650 <ul class="md-nav__list" data-md-scrollfix>
1651
1652
1653
1654
1655
1656 <li class="md-nav__item">
1657 <a href="../../migration/wsc31/php/" class="md-nav__link">
1658 PHP API
1659 </a>
1660 </li>
1661
1662
1663
1664 </ul>
1665 </nav>
1666 </li>
1667
1668
1669
1670
1671
1672
1673
1674
1675 <li class="md-nav__item md-nav__item--nested">
1676
1677
1678 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1679
1680 <label class="md-nav__link" for="__nav_6_4">
1681 Migrating from WSC 3.0
1682 <span class="md-nav__icon md-icon"></span>
1683 </label>
1684 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1685 <label class="md-nav__title" for="__nav_6_4">
1686 <span class="md-nav__icon md-icon"></span>
1687 Migrating from WSC 3.0
1688 </label>
1689 <ul class="md-nav__list" data-md-scrollfix>
1690
1691
1692
1693
1694
1695 <li class="md-nav__item">
1696 <a href="../../migration/wsc30/php/" class="md-nav__link">
1697 PHP API
1698 </a>
1699 </li>
1700
1701
1702
1703
1704
1705
1706
1707 <li class="md-nav__item">
1708 <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1709 JavaScript API
1710 </a>
1711 </li>
1712
1713
1714
1715
1716
1717
1718
1719 <li class="md-nav__item">
1720 <a href="../../migration/wsc30/templates/" class="md-nav__link">
1721 Templates
1722 </a>
1723 </li>
1724
1725
1726
1727
1728
1729
1730
1731 <li class="md-nav__item">
1732 <a href="../../migration/wsc30/css/" class="md-nav__link">
1733 CSS
1734 </a>
1735 </li>
1736
1737
1738
1739
1740
1741
1742
1743 <li class="md-nav__item">
1744 <a href="../../migration/wsc30/package/" class="md-nav__link">
1745 Package Components
1746 </a>
1747 </li>
1748
1749
1750
1751 </ul>
1752 </nav>
1753 </li>
1754
1755
1756
1757
1758
1759
1760
1761
1762 <li class="md-nav__item md-nav__item--nested">
1763
1764
1765 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1766
1767 <label class="md-nav__link" for="__nav_6_5">
1768 Migrating from WCF 2.1
1769 <span class="md-nav__icon md-icon"></span>
1770 </label>
1771 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1772 <label class="md-nav__title" for="__nav_6_5">
1773 <span class="md-nav__icon md-icon"></span>
1774 Migrating from WCF 2.1
1775 </label>
1776 <ul class="md-nav__list" data-md-scrollfix>
1777
1778
1779
1780
1781
1782 <li class="md-nav__item">
1783 <a href="../../migration/wcf21/php/" class="md-nav__link">
1784 PHP API
1785 </a>
1786 </li>
1787
1788
1789
1790
1791
1792
1793
1794 <li class="md-nav__item">
1795 <a href="../../migration/wcf21/templates/" class="md-nav__link">
1796 Templates
1797 </a>
1798 </li>
1799
1800
1801
1802
1803
1804
1805
1806 <li class="md-nav__item">
1807 <a href="../../migration/wcf21/css/" class="md-nav__link">
1808 CSS
1809 </a>
1810 </li>
1811
1812
1813
1814
1815
1816
1817
1818 <li class="md-nav__item">
1819 <a href="../../migration/wcf21/package/" class="md-nav__link">
1820 Package Components
1821 </a>
1822 </li>
1823
1824
1825
1826 </ul>
1827 </nav>
1828 </li>
1829
1830
1831
1832 </ul>
1833 </nav>
1834 </li>
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846 <li class="md-nav__item md-nav__item--nested">
1847
1848
1849 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1850
1851 <label class="md-nav__link" for="__nav_7">
1852 Tutorials
1853 <span class="md-nav__icon md-icon"></span>
1854 </label>
1855 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1856 <label class="md-nav__title" for="__nav_7">
1857 <span class="md-nav__icon md-icon"></span>
1858 Tutorials
1859 </label>
1860 <ul class="md-nav__list" data-md-scrollfix>
1861
1862
1863
1864
1865
1866
1867 <li class="md-nav__item md-nav__item--nested">
1868
1869
1870 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1871
1872 <label class="md-nav__link" for="__nav_7_1">
1873 Tutorial Series
1874 <span class="md-nav__icon md-icon"></span>
1875 </label>
1876 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1877 <label class="md-nav__title" for="__nav_7_1">
1878 <span class="md-nav__icon md-icon"></span>
1879 Tutorial Series
1880 </label>
1881 <ul class="md-nav__list" data-md-scrollfix>
1882
1883
1884
1885
1886
1887 <li class="md-nav__item">
1888 <a href="../../tutorial/series/overview/" class="md-nav__link">
1889 Overview
1890 </a>
1891 </li>
1892
1893
1894
1895
1896
1897
1898
1899 <li class="md-nav__item">
1900 <a href="../../tutorial/series/part_1/" class="md-nav__link">
1901 Part 1
1902 </a>
1903 </li>
1904
1905
1906
1907
1908
1909
1910
1911 <li class="md-nav__item">
1912 <a href="../../tutorial/series/part_2/" class="md-nav__link">
1913 Part 2
1914 </a>
1915 </li>
1916
1917
1918
1919
1920
1921
1922
1923 <li class="md-nav__item">
1924 <a href="../../tutorial/series/part_3/" class="md-nav__link">
1925 Part 3
1926 </a>
1927 </li>
1928
1929
1930
1931
1932
1933
1934
1935 <li class="md-nav__item">
1936 <a href="../../tutorial/series/part_4/" class="md-nav__link">
1937 Part 4
1938 </a>
1939 </li>
1940
1941
1942
1943
1944
1945
1946
1947 <li class="md-nav__item">
1948 <a href="../../tutorial/series/part_5/" class="md-nav__link">
1949 Part 5
1950 </a>
1951 </li>
1952
1953
1954
1955 </ul>
1956 </nav>
1957 </li>
1958
1959
1960
1961 </ul>
1962 </nav>
1963 </li>
1964
1965
1966
1967 </ul>
1968 </nav>
1969 </div>
1970 </div>
1971 </div>
1972
1973
1974
1975 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1976 <div class="md-sidebar__scrollwrap">
1977 <div class="md-sidebar__inner">
1978
1979 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1980
1981
1982
1983
1984
1985
1986 <label class="md-nav__title" for="__toc">
1987 <span class="md-nav__icon md-icon"></span>
1988 Table of contents
1989 </label>
1990 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1991
1992 <li class="md-nav__item">
1993 <a href="#the-preparedstatement-object" class="md-nav__link">
1994 The PreparedStatement Object
1995 </a>
1996
1997 <nav class="md-nav" aria-label="The PreparedStatement Object">
1998 <ul class="md-nav__list">
1999
2000 <li class="md-nav__item">
2001 <a href="#query-parameters" class="md-nav__link">
2002 Query Parameters
2003 </a>
2004
2005 </li>
2006
2007 <li class="md-nav__item">
2008 <a href="#fetching-a-single-result" class="md-nav__link">
2009 Fetching a Single Result
2010 </a>
2011
2012 </li>
2013
2014 <li class="md-nav__item">
2015 <a href="#fetch-by-column" class="md-nav__link">
2016 Fetch by Column
2017 </a>
2018
2019 </li>
2020
2021 <li class="md-nav__item">
2022 <a href="#fetching-all-results" class="md-nav__link">
2023 Fetching All Results
2024 </a>
2025
2026 </li>
2027
2028 </ul>
2029 </nav>
2030
2031 </li>
2032
2033 <li class="md-nav__item">
2034 <a href="#building-complex-conditions" class="md-nav__link">
2035 Building Complex Conditions
2036 </a>
2037
2038 </li>
2039
2040 <li class="md-nav__item">
2041 <a href="#insert-or-update-in-bulk" class="md-nav__link">
2042 INSERT or UPDATE in Bulk
2043 </a>
2044
2045 </li>
2046
2047 </ul>
2048
2049 </nav>
2050 </div>
2051 </div>
2052 </div>
2053
2054
2055 <div class="md-content" data-md-component="content">
2056 <article class="md-content__inner md-typeset">
2057
2058
2059 <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/database-access.md" title="Edit this page" class="md-content__button md-icon">
2060 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
2061 </a>
2062
2063
2064 <h1 id="database-access">Database Access<a class="headerlink" href="#database-access" title="Permanent link">#</a></h1>
2065 <p><a href="../database-objects/">Database Objects</a> provide a convenient and object-oriented approach to work with the database, but there can be use-cases that require raw access including writing methods for model classes. This section assumes that you have either used <a href="https://en.wikipedia.org/wiki/Prepared_statement">prepared statements</a> before or at least understand how it works.</p>
2066 <h2 id="the-preparedstatement-object">The PreparedStatement Object<a class="headerlink" href="#the-preparedstatement-object" title="Permanent link">#</a></h2>
2067 <p>The database access is designed around <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/database/statement/PreparedStatement.class.php">PreparedStatement</a>, built on top of PHP's <code>PDOStatement</code> so that you call all of <code>PDOStatement</code>'s methods, and each query requires you to obtain a statement object.</p>
2068 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2069 <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepareStatement</span><span class="p">(</span><span class="s2">&quot;SELECT * FROM wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_example&quot;</span><span class="p">);</span>
2070 <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">();</span>
2071 <span class="k">while</span> <span class="p">(</span><span class="nv">$row</span> <span class="o">=</span> <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">fetchArray</span><span class="p">())</span> <span class="p">{</span>
2072 <span class="c1">// handle result</span>
2073 <span class="p">}</span>
2074 </code></pre></div>
2075 <h3 id="query-parameters">Query Parameters<a class="headerlink" href="#query-parameters" title="Permanent link">#</a></h3>
2076 <p>The example below illustrates the usage of parameters where each value is replaced with the generic <code>?</code>-placeholder. Values are provided by calling <code>$statement-&gt;execute()</code> with a continuous, one-dimensional array that exactly match the number of question marks.</p>
2077 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2078 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT *</span>
2079 <span class="s2"> FROM wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_example</span>
2080 <span class="s2"> WHERE exampleID = ?</span>
2081 <span class="s2"> OR bar IN (?, ?, ?, ?, ?)&quot;</span><span class="p">;</span>
2082 <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepareStatement</span><span class="p">(</span><span class="nv">$sql</span><span class="p">);</span>
2083 <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">([</span>
2084 <span class="nv">$exampleID</span><span class="p">,</span>
2085 <span class="nv">$list</span><span class="p">,</span> <span class="nv">$of</span><span class="p">,</span> <span class="nv">$values</span><span class="p">,</span> <span class="nv">$for</span><span class="p">,</span> <span class="nv">$bar</span>
2086 <span class="p">]);</span>
2087 <span class="k">while</span> <span class="p">(</span><span class="nv">$row</span> <span class="o">=</span> <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">fetchArray</span><span class="p">())</span> <span class="p">{</span>
2088 <span class="c1">// handle result</span>
2089 <span class="p">}</span>
2090 </code></pre></div>
2091 <h3 id="fetching-a-single-result">Fetching a Single Result<a class="headerlink" href="#fetching-a-single-result" title="Permanent link">#</a></h3>
2092 <div class="admonition danger">
2093 <p class="admonition-title">Do not attempt to use <code>fetchSingleRow()</code> or <code>fetchSingleColumn()</code> if the result contains more than one row.</p>
2094 </div>
2095 <p>You can opt-in to retrieve only a single row from database and make use of shortcut methods to reduce the code that you have to write.</p>
2096 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2097 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT *</span>
2098 <span class="s2"> FROM wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_example</span>
2099 <span class="s2"> WHERE exampleID = ?&quot;</span><span class="p">;</span>
2100 <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepareStatement</span><span class="p">(</span><span class="nv">$sql</span><span class="p">,</span> <span class="mi">1</span><span class="p">);</span>
2101 <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">([</span><span class="nv">$exampleID</span><span class="p">]);</span>
2102 <span class="nv">$row</span> <span class="o">=</span> <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">fetchSingleRow</span><span class="p">();</span>
2103 </code></pre></div>
2104 <p>There are two distinct differences when comparing with the example on query parameters above:</p>
2105 <ol>
2106 <li>The method <code>prepareStatement()</code> receives a secondary parameter that will be appended to the query as <code>LIMIT 1</code>.</li>
2107 <li>Data is read using <code>fetchSingleRow()</code> instead of <code>fetchArray()</code> or similar methods, that will read one result and close the cursor.</li>
2108 </ol>
2109 <h3 id="fetch-by-column">Fetch by Column<a class="headerlink" href="#fetch-by-column" title="Permanent link">#</a></h3>
2110 <div class="admonition warning">
2111 <p class="admonition-title">There is no way to return another column from the same row if you use <code>fetchColumn()</code> to retrieve data.</p>
2112 </div>
2113 <p>Fetching an array is only useful if there is going to be more than one column per result row, otherwise accessing the column directly is much more convenient and increases the code readability.</p>
2114 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2115 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT bar</span>
2116 <span class="s2"> FROM wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_example&quot;</span><span class="p">;</span>
2117 <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepareStatement</span><span class="p">(</span><span class="nv">$sql</span><span class="p">);</span>
2118 <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">();</span>
2119 <span class="k">while</span> <span class="p">(</span><span class="nv">$bar</span> <span class="o">=</span> <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">fetchColumn</span><span class="p">())</span> <span class="p">{</span>
2120 <span class="c1">// handle result</span>
2121 <span class="p">}</span>
2122 <span class="nv">$bar</span> <span class="o">=</span> <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">fetchSingleColumn</span><span class="p">();</span>
2123 </code></pre></div>
2124 <p>Similar to fetching a single row, you can also issue a query that will select a single row, but reads only one column from the result row.</p>
2125 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2126 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT bar</span>
2127 <span class="s2"> FROM wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_example</span>
2128 <span class="s2"> WHERE exampleID = ?&quot;</span><span class="p">;</span>
2129 <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepareStatement</span><span class="p">(</span><span class="nv">$sql</span><span class="p">,</span> <span class="mi">1</span><span class="p">);</span>
2130 <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">([</span><span class="nv">$exampleID</span><span class="p">]);</span>
2131 <span class="nv">$bar</span> <span class="o">=</span> <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">fetchSingleColumn</span><span class="p">();</span>
2132 </code></pre></div>
2133 <h3 id="fetching-all-results">Fetching All Results<a class="headerlink" href="#fetching-all-results" title="Permanent link">#</a></h3>
2134 <p>If you want to fetch all results of a query but only store them in an array without directly processing them, in most cases, you can rely on built-in methods.</p>
2135 <p>To fetch all rows of query, you can use <code>PDOStatement::fetchAll()</code> with <code>\PDO::FETCH_ASSOC</code> as the first parameter:</p>
2136 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2137 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT *</span>
2138 <span class="s2"> FROM wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_example&quot;</span><span class="p">;</span>
2139 <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepareStatement</span><span class="p">(</span><span class="nv">$sql</span><span class="p">);</span>
2140 <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">();</span>
2141 <span class="nv">$rows</span> <span class="o">=</span> <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">fetchAll</span><span class="p">(</span><span class="nx">\PDO</span><span class="o">::</span><span class="na">FETCH_ASSOC</span><span class="p">);</span>
2142 </code></pre></div>
2143 <p>As a result, you get an array containing associative arrays with the rows of the <code>wcf{WCF_N}_example</code> database table as content.</p>
2144 <p>If you only want to fetch a list of the values of a certain column, you can use <code>\PDO::FETCH_COLUMN</code> as the first parameter:</p>
2145 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2146 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT exampleID</span>
2147 <span class="s2"> FROM wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_example&quot;</span><span class="p">;</span>
2148 <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepareStatement</span><span class="p">(</span><span class="nv">$sql</span><span class="p">);</span>
2149 <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">();</span>
2150 <span class="nv">$exampleIDs</span> <span class="o">=</span> <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">fetchAll</span><span class="p">(</span><span class="nx">\PDO</span><span class="o">::</span><span class="na">FETCH_COLUMN</span><span class="p">);</span>
2151 </code></pre></div>
2152 <p>As a result, you get an array with all <code>exampleID</code> values.</p>
2153 <p>The <code>PreparedStatement</code> class adds an additional methods that covers another common use case in our code:
2154 Fetching two columns and using the first column's value as the array key and the second column's value as the array value.
2155 This case is covered by <code>PreparedStatement::fetchMap()</code>:</p>
2156 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2157 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT exampleID, userID</span>
2158 <span class="s2"> FROM wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_example_mapping&quot;</span><span class="p">;</span>
2159 <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepareStatement</span><span class="p">(</span><span class="nv">$sql</span><span class="p">);</span>
2160 <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">();</span>
2161 <span class="nv">$map</span> <span class="o">=</span> <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">fetchMap</span><span class="p">(</span><span class="s1">&#39;exampleID&#39;</span><span class="p">,</span> <span class="s1">&#39;userID&#39;</span><span class="p">);</span>
2162 </code></pre></div>
2163 <p><code>$map</code> is a one-dimensional array where each <code>exampleID</code> value maps to the corresponding <code>userID</code> value.</p>
2164 <div class="admonition warning">
2165 <p class="admonition-title">If there are multiple entries for a certain <code>exampleID</code> value with different <code>userID</code> values, the existing entry in the array will be overwritten and contain the last read value from the database table. Therefore, this method should generally only be used for unique combinations.</p>
2166 </div>
2167 <p>If you do not have a combination of columns with unique pairs of values, but you want to get a list of <code>userID</code> values with the same <code>exampleID</code>, you can set the third parameter of <code>fetchMap()</code> to <code>false</code> and get a list:</p>
2168 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2169 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT exampleID, userID</span>
2170 <span class="s2"> FROM wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_example_mapping&quot;</span><span class="p">;</span>
2171 <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepareStatement</span><span class="p">(</span><span class="nv">$sql</span><span class="p">);</span>
2172 <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">();</span>
2173 <span class="nv">$map</span> <span class="o">=</span> <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">fetchMap</span><span class="p">(</span><span class="s1">&#39;exampleID&#39;</span><span class="p">,</span> <span class="s1">&#39;userID&#39;</span><span class="p">,</span> <span class="k">false</span><span class="p">);</span>
2174 </code></pre></div>
2175 <p>Now, as a result, you get a two-dimensional array with the array keys being the <code>exampleID</code> values and the array values being arrays with all <code>userID</code> values from rows with the respective <code>exampleID</code> value.</p>
2176 <h2 id="building-complex-conditions">Building Complex Conditions<a class="headerlink" href="#building-complex-conditions" title="Permanent link">#</a></h2>
2177 <p>Building conditional conditions can turn out to be a real mess and it gets even worse with SQL's <code>IN (…)</code> which requires as many placeholders as there will be values. The solutions is <code>PreparedStatementConditionBuilder</code>, a simple but useful helper class with a bulky name, it is also the class used when accessing <code>DatabaseObjecList::getConditionBuilder()</code>.</p>
2178 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2179 <span class="nv">$conditions</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\database\util\PreparedStatementConditionBuilder</span><span class="p">();</span>
2180 <span class="nv">$conditions</span><span class="o">-&gt;</span><span class="na">add</span><span class="p">(</span><span class="s2">&quot;exampleID = ?&quot;</span><span class="p">,</span> <span class="p">[</span><span class="nv">$exampleID</span><span class="p">]);</span>
2181 <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="k">empty</span><span class="p">(</span><span class="nv">$valuesForBar</span><span class="p">))</span> <span class="p">{</span>
2182 <span class="nv">$conditions</span><span class="o">-&gt;</span><span class="na">add</span><span class="p">(</span><span class="s2">&quot;(bar IN (?) OR baz = ?)&quot;</span><span class="p">,</span> <span class="p">[</span><span class="nv">$valuesForBar</span><span class="p">,</span> <span class="nv">$baz</span><span class="p">]);</span>
2183 <span class="p">}</span>
2184 </code></pre></div>
2185 <p>The <code>IN (?)</code> in the example above is automatically expanded to match the number of items contained in <code>$valuesForBar</code>. Be aware that the method will generate an invalid query if <code>$valuesForBar</code> is empty!</p>
2186 <h2 id="insert-or-update-in-bulk">INSERT or UPDATE in Bulk<a class="headerlink" href="#insert-or-update-in-bulk" title="Permanent link">#</a></h2>
2187 <p>Prepared statements not only protect against SQL injection by separating the logical query and the actual data, but also provides the ability to reuse the same query with different values. This leads to a performance improvement as the code does not have to transmit the query with for every data set and only has to parse and analyze the query once.</p>
2188 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2189 <span class="nv">$data</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;abc&#39;</span><span class="p">,</span> <span class="s1">&#39;def&#39;</span><span class="p">,</span> <span class="s1">&#39;ghi&#39;</span><span class="p">];</span>
2190
2191 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;INSERT INTO wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_example</span>
2192 <span class="s2"> (bar)</span>
2193 <span class="s2"> VALUES (?)&quot;</span><span class="p">;</span>
2194 <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepareStatement</span><span class="p">(</span><span class="nv">$sql</span><span class="p">);</span>
2195
2196 <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">beginTransaction</span><span class="p">();</span>
2197 <span class="k">foreach</span> <span class="p">(</span><span class="nv">$data</span> <span class="k">as</span> <span class="nv">$bar</span><span class="p">)</span> <span class="p">{</span>
2198 <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">([</span><span class="nv">$bar</span><span class="p">]);</span>
2199 <span class="p">}</span>
2200 <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">commitTransaction</span><span class="p">();</span>
2201 </code></pre></div>
2202 <p>It is generally advised to wrap bulk operations in a transaction as it allows the database to optimize the process, including fewer I/O operations.</p>
2203 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2204 <span class="nv">$data</span> <span class="o">=</span> <span class="p">[</span>
2205 <span class="mi">1</span> <span class="o">=&gt;</span> <span class="s1">&#39;abc&#39;</span><span class="p">,</span>
2206 <span class="mi">3</span> <span class="o">=&gt;</span> <span class="s1">&#39;def&#39;</span><span class="p">,</span>
2207 <span class="mi">4</span> <span class="o">=&gt;</span> <span class="s1">&#39;ghi&#39;</span>
2208 <span class="p">];</span>
2209
2210 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;UPDATE wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_example</span>
2211 <span class="s2"> SET bar = ?</span>
2212 <span class="s2"> WHERE exampleID = ?&quot;</span><span class="p">;</span>
2213 <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepareStatement</span><span class="p">(</span><span class="nv">$sql</span><span class="p">);</span>
2214
2215 <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">beginTransaction</span><span class="p">();</span>
2216 <span class="k">foreach</span> <span class="p">(</span><span class="nv">$data</span> <span class="k">as</span> <span class="nv">$exampleID</span> <span class="o">=&gt;</span> <span class="nv">$bar</span><span class="p">)</span> <span class="p">{</span>
2217 <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">([</span>
2218 <span class="nv">$bar</span><span class="p">,</span>
2219 <span class="nv">$exampleID</span>
2220 <span class="p">]);</span>
2221 <span class="p">}</span>
2222 <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">commitTransaction</span><span class="p">();</span>
2223 </code></pre></div>
2224
2225
2226
2227
2228 <hr>
2229 <div class="md-source-date">
2230 <small>
2231
2232 Last update: 2021-01-08
2233
2234 </small>
2235 </div>
2236
2237
2238
2239
2240
2241
2242
2243
2244 </article>
2245 </div>
2246 </div>
2247
2248 </main>
2249
2250
2251 <footer class="md-footer">
2252
2253 <nav class="md-footer__inner md-grid" aria-label="Footer">
2254
2255 <a href="../database-objects/" class="md-footer__link md-footer__link--prev" rel="prev">
2256 <div class="md-footer__button md-icon">
2257 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
2258 </div>
2259 <div class="md-footer__title">
2260 <div class="md-ellipsis">
2261 <span class="md-footer__direction">
2262 Previous
2263 </span>
2264 Database Objects
2265 </div>
2266 </div>
2267 </a>
2268
2269
2270 <a href="../exceptions/" class="md-footer__link md-footer__link--next" rel="next">
2271 <div class="md-footer__title">
2272 <div class="md-ellipsis">
2273 <span class="md-footer__direction">
2274 Next
2275 </span>
2276 Exceptions
2277 </div>
2278 </div>
2279 <div class="md-footer__button md-icon">
2280 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2281 </div>
2282 </a>
2283
2284 </nav>
2285
2286 <div class="md-footer-meta md-typeset">
2287 <div class="md-footer-meta__inner md-grid">
2288 <div class="md-footer-copyright">
2289
2290 <div class="md-footer-copyright__highlight">
2291 Copyright © 2020 WoltLab GmbH
2292 </div>
2293
2294 Made with
2295 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2296 Material for MkDocs
2297 </a>
2298
2299 </div>
2300 <div class="md-footer-copyright">
2301 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2302 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2303 </div>
2304 </div>
2305 </div>
2306 </footer>
2307
2308 </div>
2309 <div class="md-dialog" data-md-component="dialog">
2310 <div class="md-dialog__inner md-typeset"></div>
2311 </div>
2312 <script id="__config" type="application/json">{"base": "../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
2313
2314
2315 <script src="../../assets/javascripts/bundle.4ea5477f.min.js"></script>
2316
2317
2318 </body>
2319 </html>