Deployed 3bf25ab to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / 5.4 / php / gdpr / index.html
CommitLineData
45ca63d0
TD
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="shortcut icon" href="../../assets/default.favicon.ico">
fb88dc6e 13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.5">
45ca63d0
TD
14
15
16
17 <title>GDPR - WoltLab Suite Documentation</title>
18
19
20
fb88dc6e 21 <link rel="stylesheet" href="../../assets/stylesheets/main.77f3fd56.min.css">
45ca63d0
TD
22
23
24 <link rel="stylesheet" href="../../assets/stylesheets/palette.7fa14f5b.min.css">
25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
fd8430cb
WG
34
35
45ca63d0
TD
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
56 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
57 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
58 <label class="md-overlay" for="__drawer"></label>
59 <div data-md-component="skip">
60
61
62 <a href="#general-data-protection-regulation-gdpr" class="md-skip">
63 Skip to content
64 </a>
65
66 </div>
67 <div data-md-component="announce">
68
69 <aside class="md-announce">
70 <div class="md-announce__inner md-grid md-typeset">
71
72 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
73
74 </div>
75 </aside>
76
77 </div>
78
79
80
81<header class="md-header" data-md-component="header">
82 <nav class="md-header__inner md-grid" aria-label="Header">
83 <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation">
84
85 <img src="../../assets/logo.png" alt="logo">
86
87 </a>
88 <label class="md-header__button md-icon" for="__drawer">
89 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 </label>
91 <div class="md-header__title" data-md-component="header-title">
92 <div class="md-header__ellipsis">
93 <div class="md-header__topic">
94 <span class="md-ellipsis">
95 WoltLab Suite Documentation
96 </span>
97 </div>
98 <div class="md-header__topic" data-md-component="header-topic">
99 <span class="md-ellipsis">
100
101 GDPR
102
103 </span>
104 </div>
105 </div>
106 </div>
107 <div class="md-header__options">
108
109 </div>
110
111 <label class="md-header__button md-icon" for="__search">
112 <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>
113 </label>
114
115<div class="md-search" data-md-component="search" role="dialog">
116 <label class="md-search__overlay" for="__search"></label>
117 <div class="md-search__inner" role="search">
118 <form class="md-search__form" name="search">
119 <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>
120 <label class="md-search__icon md-icon" for="__search">
121 <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>
122 <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>
123 </label>
124 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
125 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.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>
126 </button>
127 </form>
128 <div class="md-search__output">
129 <div class="md-search__scrollwrap" data-md-scrollfix>
130 <div class="md-search-result" data-md-component="search-result">
131 <div class="md-search-result__meta">
132 Initializing search
133 </div>
134 <ol class="md-search-result__list"></ol>
135 </div>
136 </div>
137 </div>
138 </div>
139</div>
140
141
7124f4cb
WG
142 <div class="md-header__source">
143
144<a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
145 <div class="md-source__icon md-icon">
146
147 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 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>
148 </div>
149 <div class="md-source__repository">
150 GitHub
151 </div>
152</a>
153 </div>
154
45ca63d0
TD
155 </nav>
156</header>
157
158 <div class="md-container" data-md-component="container">
159
160
161
162
163 <main class="md-main" data-md-component="main">
164 <div class="md-main__inner md-grid">
165
166
167
168 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
169 <div class="md-sidebar__scrollwrap">
170 <div class="md-sidebar__inner">
171
172
173
174
175
176<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
177 <label class="md-nav__title" for="__drawer">
178 <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
179
180 <img src="../../assets/logo.png" alt="logo">
181
182 </a>
183 WoltLab Suite Documentation
184 </label>
185
7124f4cb
WG
186 <div class="md-nav__source">
187
188<a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
189 <div class="md-source__icon md-icon">
190
191 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 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>
192 </div>
193 <div class="md-source__repository">
194 GitHub
195 </div>
196</a>
197 </div>
198
45ca63d0
TD
199 <ul class="md-nav__list" data-md-scrollfix>
200
201
202
203
204
205
206
207
208 <li class="md-nav__item">
209 <a href="../../getting-started/" class="md-nav__link">
210 Getting Started
211 </a>
212 </li>
213
214
215
216
217
218
219
220
221
222
223
224
225
226 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
227
228
229 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
230
231 <label class="md-nav__link" for="__nav_2">
232 PHP API
233 <span class="md-nav__icon md-icon"></span>
234 </label>
235 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
236 <label class="md-nav__title" for="__nav_2">
237 <span class="md-nav__icon md-icon"></span>
238 PHP API
239 </label>
240 <ul class="md-nav__list" data-md-scrollfix>
241
242
243
244
245
246 <li class="md-nav__item">
247 <a href="../pages/" class="md-nav__link">
248 Pages
249 </a>
250 </li>
251
252
253
254
255
256
257
258 <li class="md-nav__item">
259 <a href="../database-objects/" class="md-nav__link">
260 Database Objects
261 </a>
262 </li>
263
264
265
266
267
268
269
270 <li class="md-nav__item">
271 <a href="../database-access/" class="md-nav__link">
272 Database Access
273 </a>
274 </li>
275
276
277
278
279
280
281
282 <li class="md-nav__item">
283 <a href="../exceptions/" class="md-nav__link">
284 Exceptions
285 </a>
286 </li>
287
288
289
290
291
292
293
294
295 <li class="md-nav__item md-nav__item--nested">
296
297
298 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
299
300 <label class="md-nav__link" for="__nav_2_5">
301 API
302 <span class="md-nav__icon md-icon"></span>
303 </label>
304 <nav class="md-nav" aria-label="API" data-md-level="2">
305 <label class="md-nav__title" for="__nav_2_5">
306 <span class="md-nav__icon md-icon"></span>
307 API
308 </label>
309 <ul class="md-nav__list" data-md-scrollfix>
310
311
312
313
314
315 <li class="md-nav__item">
316 <a href="../api/caches/" class="md-nav__link">
317 Caches
318 </a>
319 </li>
320
321
322
323
324
325
326
327 <li class="md-nav__item">
328 <a href="../api/comments/" class="md-nav__link">
329 Comments
330 </a>
331 </li>
332
333
334
335
336
337
338
339 <li class="md-nav__item">
340 <a href="../api/cronjobs/" class="md-nav__link">
341 Cronjobs
342 </a>
343 </li>
344
345
346
347
348
349
350
351 <li class="md-nav__item">
352 <a href="../api/events/" class="md-nav__link">
353 Events
354 </a>
355 </li>
356
357
358
359
360
361
362
363
364 <li class="md-nav__item md-nav__item--nested">
365
366
367 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
368
369 <label class="md-nav__link" for="__nav_2_5_5">
370 Form Builder
371 <span class="md-nav__icon md-icon"></span>
372 </label>
373 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
374 <label class="md-nav__title" for="__nav_2_5_5">
375 <span class="md-nav__icon md-icon"></span>
376 Form Builder
377 </label>
378 <ul class="md-nav__list" data-md-scrollfix>
379
380
381
382
383
384 <li class="md-nav__item">
385 <a href="../api/form_builder/overview/" class="md-nav__link">
386 Overview
387 </a>
388 </li>
389
390
391
392
393
394
395
396 <li class="md-nav__item">
397 <a href="../api/form_builder/structure/" class="md-nav__link">
398 Structure
399 </a>
400 </li>
401
402
403
404
405
406
407
408 <li class="md-nav__item">
409 <a href="../api/form_builder/form_fields/" class="md-nav__link">
410 Fields
411 </a>
412 </li>
413
414
415
416
417
418
419
420 <li class="md-nav__item">
421 <a href="../api/form_builder/validation_data/" class="md-nav__link">
422 Validation and Data
423 </a>
424 </li>
425
426
427
428
429
430
431
432 <li class="md-nav__item">
433 <a href="../api/form_builder/dependencies/" class="md-nav__link">
434 Dependencies
435 </a>
436 </li>
437
438
439
440 </ul>
441 </nav>
442 </li>
443
444
445
446
447
448
449
450 <li class="md-nav__item">
451 <a href="../api/package_installation_plugins/" class="md-nav__link">
452 Package Installation Plugins
453 </a>
454 </li>
455
456
457
458
459
460
461
462 <li class="md-nav__item">
463 <a href="../api/user_activity_points/" class="md-nav__link">
464 User Activity Points
465 </a>
466 </li>
467
468
469
470
471
472
473
474 <li class="md-nav__item">
475 <a href="../api/user_notifications/" class="md-nav__link">
476 User Notifications
477 </a>
478 </li>
479
480
481
482
483
484
485
486 <li class="md-nav__item">
487 <a href="../api/sitemaps/" class="md-nav__link">
488 Sitemaps
489 </a>
490 </li>
491
492
493
494 </ul>
495 </nav>
496 </li>
497
498
499
500
501
502
503
504 <li class="md-nav__item">
505 <a href="../code-style/" class="md-nav__link">
506 Code Style
507 </a>
508 </li>
509
510
511
512
513
514
515
516 <li class="md-nav__item">
517 <a href="../apps/" class="md-nav__link">
518 Apps
519 </a>
520 </li>
521
522
523
524
525
526
527
528
529
530 <li class="md-nav__item md-nav__item--active">
531
532 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
533
534
535
536
537 <label class="md-nav__link md-nav__link--active" for="__toc">
538 GDPR
539 <span class="md-nav__icon md-icon"></span>
540 </label>
541
542 <a href="./" class="md-nav__link md-nav__link--active">
543 GDPR
544 </a>
545
546
547<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
548
549
550
551
552
553 <label class="md-nav__title" for="__toc">
554 <span class="md-nav__icon md-icon"></span>
555 Table of contents
556 </label>
557 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
558
559 <li class="md-nav__item">
560 <a href="#introduction" class="md-nav__link">
561 Introduction
562 </a>
563
564</li>
565
566 <li class="md-nav__item">
567 <a href="#including-data-in-the-export" class="md-nav__link">
568 Including Data in the Export
569 </a>
570
571 <nav class="md-nav" aria-label="Including Data in the Export">
572 <ul class="md-nav__list">
573
574 <li class="md-nav__item">
575 <a href="#example-code" class="md-nav__link">
576 Example code
577 </a>
578
579</li>
580
581 <li class="md-nav__item">
582 <a href="#data" class="md-nav__link">
583 $data
584 </a>
585
586</li>
587
588 <li class="md-nav__item">
589 <a href="#exportuserproperties" class="md-nav__link">
590 $exportUserProperties
591 </a>
592
593</li>
594
595 <li class="md-nav__item">
596 <a href="#exportuserpropertiesifnotempty" class="md-nav__link">
597 $exportUserPropertiesIfNotEmpty
598 </a>
599
600</li>
601
602 <li class="md-nav__item">
603 <a href="#exportuseroptionsettings" class="md-nav__link">
604 $exportUserOptionSettings
605 </a>
606
607</li>
608
609 <li class="md-nav__item">
610 <a href="#exportuseroptionsettingsifnotempty" class="md-nav__link">
611 $exportUserOptionSettingsIfNotEmpty
612 </a>
613
614</li>
615
616 <li class="md-nav__item">
617 <a href="#ipaddresses" class="md-nav__link">
618 $ipAddresses
619 </a>
620
621</li>
622
623 <li class="md-nav__item">
624 <a href="#skipuseroptions" class="md-nav__link">
625 $skipUserOptions
626 </a>
627
628</li>
629
630 </ul>
631 </nav>
632
633</li>
634
635 </ul>
636
637</nav>
638
639 </li>
640
641
642
643 </ul>
644 </nav>
645 </li>
646
647
648
649
650
651
652
653
654
655
656
657 <li class="md-nav__item md-nav__item--nested">
658
659
660 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
661
662 <label class="md-nav__link" for="__nav_3">
663 Languages, Templates & CSS
664 <span class="md-nav__icon md-icon"></span>
665 </label>
666 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
667 <label class="md-nav__title" for="__nav_3">
668 <span class="md-nav__icon md-icon"></span>
669 Languages, Templates & CSS
670 </label>
671 <ul class="md-nav__list" data-md-scrollfix>
672
673
674
675
676
677 <li class="md-nav__item">
678 <a href="../../view/languages/" class="md-nav__link">
679 Languages
680 </a>
681 </li>
682
683
684
685
686
687
688
689 <li class="md-nav__item">
690 <a href="../../view/templates/" class="md-nav__link">
691 Templates
692 </a>
693 </li>
694
695
696
697
698
699
700
701 <li class="md-nav__item">
702 <a href="../../view/css/" class="md-nav__link">
703 CSS
704 </a>
705 </li>
706
707
708
709 </ul>
710 </nav>
711 </li>
712
713
714
715
716
717
718
719
720
721
722
723 <li class="md-nav__item md-nav__item--nested">
724
725
726 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
727
728 <label class="md-nav__link" for="__nav_4">
729 JavaScript API
730 <span class="md-nav__icon md-icon"></span>
731 </label>
732 <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
733 <label class="md-nav__title" for="__nav_4">
734 <span class="md-nav__icon md-icon"></span>
735 JavaScript API
736 </label>
737 <ul class="md-nav__list" data-md-scrollfix>
738
739
740
741
742
743 <li class="md-nav__item">
744 <a href="../../javascript/general-usage/" class="md-nav__link">
745 General Usage
746 </a>
747 </li>
748
749
750
751
752
753
754
755
756 <li class="md-nav__item md-nav__item--nested">
757
758
759 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
760
761 <label class="md-nav__link" for="__nav_4_2">
762 New API
763 <span class="md-nav__icon md-icon"></span>
764 </label>
765 <nav class="md-nav" aria-label="New API" data-md-level="2">
766 <label class="md-nav__title" for="__nav_4_2">
767 <span class="md-nav__icon md-icon"></span>
768 New API
769 </label>
770 <ul class="md-nav__list" data-md-scrollfix>
771
772
773
774
775
776 <li class="md-nav__item">
777 <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
778 Writing a module
779 </a>
780 </li>
781
782
783
784
785
786
787
788 <li class="md-nav__item">
789 <a href="../../javascript/new-api_data-structures/" class="md-nav__link">
790 Data Structures
791 </a>
792 </li>
793
794
795
796
797
798
799
800 <li class="md-nav__item">
801 <a href="../../javascript/new-api_core/" class="md-nav__link">
802 Core Functions
803 </a>
804 </li>
805
806
807
808
809
810
811
812 <li class="md-nav__item">
813 <a href="../../javascript/new-api_dom/" class="md-nav__link">
814 DOM
815 </a>
816 </li>
817
818
819
820
821
822
823
824 <li class="md-nav__item">
825 <a href="../../javascript/new-api_events/" class="md-nav__link">
826 Event Handling
827 </a>
828 </li>
829
830
831
832
833
834
835
836 <li class="md-nav__item">
837 <a href="../../javascript/new-api_ajax/" class="md-nav__link">
838 Ajax
839 </a>
840 </li>
841
842
843
844
845
846
847
848 <li class="md-nav__item">
849 <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
850 Dialogs
851 </a>
852 </li>
853
854
855
856
857
858
859
860 <li class="md-nav__item">
861 <a href="../../javascript/new-api_browser/" class="md-nav__link">
862 Browser and Screen Sizes
863 </a>
864 </li>
865
866
867
868
869
870
871
872 <li class="md-nav__item">
873 <a href="../../javascript/new-api_ui/" class="md-nav__link">
874 User Interface
875 </a>
876 </li>
877
878
879
880 </ul>
881 </nav>
882 </li>
883
884
885
886
887
888
889
890 <li class="md-nav__item">
891 <a href="../../javascript/legacy-api/" class="md-nav__link">
892 Legacy API
893 </a>
894 </li>
895
896
897
898
899
900
901
902 <li class="md-nav__item">
903 <a href="../../javascript/helper-functions/" class="md-nav__link">
904 Helper Functions
905 </a>
906 </li>
907
908
909
910
911
912
913
914 <li class="md-nav__item">
915 <a href="../../javascript/code-snippets/" class="md-nav__link">
916 Code Snippets
917 </a>
918 </li>
919
920
921
922 </ul>
923 </nav>
924 </li>
925
926
927
928
929
930
931
932
933
934
935
936 <li class="md-nav__item md-nav__item--nested">
937
938
939 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
940
941 <label class="md-nav__link" for="__nav_5">
942 Package Components
943 <span class="md-nav__icon md-icon"></span>
944 </label>
945 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
946 <label class="md-nav__title" for="__nav_5">
947 <span class="md-nav__icon md-icon"></span>
948 Package Components
949 </label>
950 <ul class="md-nav__list" data-md-scrollfix>
951
952
953
954
955
956 <li class="md-nav__item">
957 <a href="../../package/package-xml/" class="md-nav__link">
958 package.xml
959 </a>
960 </li>
961
962
963
964
965
966
967
968
969 <li class="md-nav__item md-nav__item--nested">
970
971
972 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
973
974 <label class="md-nav__link" for="__nav_5_2">
975 PIPs
976 <span class="md-nav__icon md-icon"></span>
977 </label>
978 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
979 <label class="md-nav__title" for="__nav_5_2">
980 <span class="md-nav__icon md-icon"></span>
981 PIPs
982 </label>
983 <ul class="md-nav__list" data-md-scrollfix>
984
985
986
987
988
989 <li class="md-nav__item">
990 <a href="../../package/pip/" class="md-nav__link">
991 Overview
992 </a>
993 </li>
994
995
996
997
998
999
1000
1001 <li class="md-nav__item">
1002 <a href="../../package/pip/acl-option/" class="md-nav__link">
1003 aclOption
1004 </a>
1005 </li>
1006
1007
1008
1009
1010
1011
1012
1013 <li class="md-nav__item">
1014 <a href="../../package/pip/acp-menu/" class="md-nav__link">
1015 acpMenu
1016 </a>
1017 </li>
1018
1019
1020
1021
1022
1023
1024
1025 <li class="md-nav__item">
1026 <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1027 acpSearchProvider
1028 </a>
1029 </li>
1030
1031
1032
1033
1034
1035
1036
1037 <li class="md-nav__item">
1038 <a href="../../package/pip/acp-template/" class="md-nav__link">
1039 acpTemplate
1040 </a>
1041 </li>
1042
1043
1044
1045
1046
1047
1048
1049 <li class="md-nav__item">
1050 <a href="../../package/pip/bbcode/" class="md-nav__link">
1051 bbcode
1052 </a>
1053 </li>
1054
1055
1056
1057
1058
1059
1060
1061 <li class="md-nav__item">
1062 <a href="../../package/pip/box/" class="md-nav__link">
1063 box
1064 </a>
1065 </li>
1066
1067
1068
1069
1070
1071
1072
1073 <li class="md-nav__item">
1074 <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1075 clipboardAction
1076 </a>
1077 </li>
1078
1079
1080
1081
1082
1083
1084
1085 <li class="md-nav__item">
1086 <a href="../../package/pip/core-object/" class="md-nav__link">
1087 coreObject
1088 </a>
1089 </li>
1090
1091
1092
1093
1094
1095
1096
1097 <li class="md-nav__item">
1098 <a href="../../package/pip/cronjob/" class="md-nav__link">
1099 cronjob
1100 </a>
1101 </li>
1102
1103
1104
1105
1106
1107
1108
1109 <li class="md-nav__item">
1110 <a href="../../package/pip/event-listener/" class="md-nav__link">
1111 eventListener
1112 </a>
1113 </li>
1114
1115
1116
1117
1118
1119
1120
1121 <li class="md-nav__item">
1122 <a href="../../package/pip/file/" class="md-nav__link">
1123 file
1124 </a>
1125 </li>
1126
1127
1128
1129
1130
1131
1132
1133 <li class="md-nav__item">
1134 <a href="../../package/pip/language/" class="md-nav__link">
1135 language
1136 </a>
1137 </li>
1138
1139
1140
1141
1142
1143
1144
1145 <li class="md-nav__item">
1146 <a href="../../package/pip/media-provider/" class="md-nav__link">
1147 mediaProvider
1148 </a>
1149 </li>
1150
1151
1152
1153
1154
1155
1156
1157 <li class="md-nav__item">
1158 <a href="../../package/pip/menu/" class="md-nav__link">
1159 menu
1160 </a>
1161 </li>
1162
1163
1164
1165
1166
1167
1168
1169 <li class="md-nav__item">
1170 <a href="../../package/pip/menu-item/" class="md-nav__link">
1171 menuItem
1172 </a>
1173 </li>
1174
1175
1176
1177
1178
1179
1180
1181 <li class="md-nav__item">
1182 <a href="../../package/pip/object-type/" class="md-nav__link">
1183 objectType
1184 </a>
1185 </li>
1186
1187
1188
1189
1190
1191
1192
1193 <li class="md-nav__item">
1194 <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1195 objectTypeDefinition
1196 </a>
1197 </li>
1198
1199
1200
1201
1202
1203
1204
1205 <li class="md-nav__item">
1206 <a href="../../package/pip/option/" class="md-nav__link">
1207 option
1208 </a>
1209 </li>
1210
1211
1212
1213
1214
1215
1216
1217 <li class="md-nav__item">
1218 <a href="../../package/pip/page/" class="md-nav__link">
1219 page
1220 </a>
1221 </li>
1222
1223
1224
1225
1226
1227
1228
1229 <li class="md-nav__item">
1230 <a href="../../package/pip/pip/" class="md-nav__link">
1231 pip
1232 </a>
1233 </li>
1234
1235
1236
1237
1238
1239
1240
1241 <li class="md-nav__item">
1242 <a href="../../package/pip/script/" class="md-nav__link">
1243 script
1244 </a>
1245 </li>
1246
1247
1248
1249
1250
1251
1252
1253 <li class="md-nav__item">
1254 <a href="../../package/pip/smiley/" class="md-nav__link">
1255 smiley
1256 </a>
1257 </li>
1258
1259
1260
1261
1262
1263
1264
1265 <li class="md-nav__item">
1266 <a href="../../package/pip/sql/" class="md-nav__link">
1267 sql
1268 </a>
1269 </li>
1270
1271
1272
1273
1274
1275
1276
1277 <li class="md-nav__item">
1278 <a href="../../package/pip/style/" class="md-nav__link">
1279 style
1280 </a>
1281 </li>
1282
1283
1284
1285
1286
1287
1288
1289 <li class="md-nav__item">
1290 <a href="../../package/pip/template/" class="md-nav__link">
1291 template
1292 </a>
1293 </li>
1294
1295
1296
1297
1298
1299
1300
1301 <li class="md-nav__item">
1302 <a href="../../package/pip/template-listener/" class="md-nav__link">
1303 templateListener
1304 </a>
1305 </li>
1306
1307
1308
1309
1310
1311
1312
1313 <li class="md-nav__item">
1314 <a href="../../package/pip/user-group-option/" class="md-nav__link">
1315 userGroupOption
1316 </a>
1317 </li>
1318
1319
1320
1321
1322
1323
1324
1325 <li class="md-nav__item">
1326 <a href="../../package/pip/user-menu/" class="md-nav__link">
1327 userMenu
1328 </a>
1329 </li>
1330
1331
1332
1333
1334
1335
1336
1337 <li class="md-nav__item">
1338 <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1339 userNotificationEvent
1340 </a>
1341 </li>
1342
1343
1344
1345
1346
1347
1348
1349 <li class="md-nav__item">
1350 <a href="../../package/pip/user-option/" class="md-nav__link">
1351 userOption
1352 </a>
1353 </li>
1354
1355
1356
1357
1358
1359
1360
1361 <li class="md-nav__item">
1362 <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1363 userProfileMenu
1364 </a>
1365 </li>
1366
1367
1368
1369 </ul>
1370 </nav>
1371 </li>
1372
1373
1374
1375
1376
1377
1378
1379 <li class="md-nav__item">
1380 <a href="../../package/database-php-api/" class="md-nav__link">
1381 Database PHP API
1382 </a>
1383 </li>
1384
1385
1386
1387 </ul>
1388 </nav>
1389 </li>
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401 <li class="md-nav__item md-nav__item--nested">
1402
1403
1404 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1405
1406 <label class="md-nav__link" for="__nav_6">
1407 Migration
1408 <span class="md-nav__icon md-icon"></span>
1409 </label>
1410 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1411 <label class="md-nav__title" for="__nav_6">
1412 <span class="md-nav__icon md-icon"></span>
1413 Migration
1414 </label>
1415 <ul class="md-nav__list" data-md-scrollfix>
1416
1417
1418
1419
1420
1421
1422 <li class="md-nav__item md-nav__item--nested">
1423
1424
1425 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1426
1427 <label class="md-nav__link" for="__nav_6_1">
1428 Migrating from WSC 5.3
1429 <span class="md-nav__icon md-icon"></span>
1430 </label>
1431 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1432 <label class="md-nav__title" for="__nav_6_1">
1433 <span class="md-nav__icon md-icon"></span>
1434 Migrating from WSC 5.3
1435 </label>
1436 <ul class="md-nav__list" data-md-scrollfix>
1437
1438
1439
1440
1441
1442 <li class="md-nav__item">
1443 <a href="../../migration/wsc53/php/" class="md-nav__link">
1444 PHP API
1445 </a>
1446 </li>
1447
1448
1449
1450
1451
1452
1453
1454 <li class="md-nav__item">
1455 <a href="../../migration/wsc53/session/" class="md-nav__link">
1456 Session Handling and Authentication
1457 </a>
1458 </li>
1459
1460
1461
1462
1463
1464
1465
1466 <li class="md-nav__item">
1467 <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1468 JavaScript
1469 </a>
1470 </li>
1471
1472
1473
1474
1475
1476
1477
1478 <li class="md-nav__item">
1479 <a href="../../migration/wsc53/templates/" class="md-nav__link">
1480 Templates
1481 </a>
1482 </li>
1483
1484
1485
1486
1487
1488
1489
1490 <li class="md-nav__item">
1491 <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1492 Third Party Libraries
1493 </a>
1494 </li>
1495
1496
1497
1498 </ul>
1499 </nav>
1500 </li>
1501
1502
1503
1504
1505
1506
1507
1508
1509 <li class="md-nav__item md-nav__item--nested">
1510
1511
1512 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1513
1514 <label class="md-nav__link" for="__nav_6_2">
1515 Migrating from WSC 5.2
1516 <span class="md-nav__icon md-icon"></span>
1517 </label>
1518 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1519 <label class="md-nav__title" for="__nav_6_2">
1520 <span class="md-nav__icon md-icon"></span>
1521 Migrating from WSC 5.2
1522 </label>
1523 <ul class="md-nav__list" data-md-scrollfix>
1524
1525
1526
1527
1528
1529 <li class="md-nav__item">
1530 <a href="../../migration/wsc52/php/" class="md-nav__link">
1531 PHP API
1532 </a>
1533 </li>
1534
1535
1536
1537
1538
1539
1540
1541 <li class="md-nav__item">
1542 <a href="../../migration/wsc52/templates/" class="md-nav__link">
1543 Templates and Languages
1544 </a>
1545 </li>
1546
1547
1548
1549
1550
1551
1552
1553 <li class="md-nav__item">
1554 <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1555 Third Party Libraries
1556 </a>
1557 </li>
1558
1559
1560
1561 </ul>
1562 </nav>
1563 </li>
1564
1565
1566
1567
1568
1569
1570
1571
1572 <li class="md-nav__item md-nav__item--nested">
1573
1574
1575 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1576
1577 <label class="md-nav__link" for="__nav_6_3">
1578 Migrating from WSC 3.1
1579 <span class="md-nav__icon md-icon"></span>
1580 </label>
1581 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1582 <label class="md-nav__title" for="__nav_6_3">
1583 <span class="md-nav__icon md-icon"></span>
1584 Migrating from WSC 3.1
1585 </label>
1586 <ul class="md-nav__list" data-md-scrollfix>
1587
1588
1589
1590
1591
1592 <li class="md-nav__item">
1593 <a href="../../migration/wsc31/php/" class="md-nav__link">
1594 PHP API
1595 </a>
1596 </li>
1597
1598
1599
1600 </ul>
1601 </nav>
1602 </li>
1603
1604
1605
1606
1607
1608
1609
1610
1611 <li class="md-nav__item md-nav__item--nested">
1612
1613
1614 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1615
1616 <label class="md-nav__link" for="__nav_6_4">
1617 Migrating from WSC 3.0
1618 <span class="md-nav__icon md-icon"></span>
1619 </label>
1620 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1621 <label class="md-nav__title" for="__nav_6_4">
1622 <span class="md-nav__icon md-icon"></span>
1623 Migrating from WSC 3.0
1624 </label>
1625 <ul class="md-nav__list" data-md-scrollfix>
1626
1627
1628
1629
1630
1631 <li class="md-nav__item">
1632 <a href="../../migration/wsc30/php/" class="md-nav__link">
1633 PHP API
1634 </a>
1635 </li>
1636
1637
1638
1639
1640
1641
1642
1643 <li class="md-nav__item">
1644 <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1645 JavaScript API
1646 </a>
1647 </li>
1648
1649
1650
1651
1652
1653
1654
1655 <li class="md-nav__item">
1656 <a href="../../migration/wsc30/templates/" class="md-nav__link">
1657 Templates
1658 </a>
1659 </li>
1660
1661
1662
1663
1664
1665
1666
1667 <li class="md-nav__item">
1668 <a href="../../migration/wsc30/css/" class="md-nav__link">
1669 CSS
1670 </a>
1671 </li>
1672
1673
1674
1675
1676
1677
1678
1679 <li class="md-nav__item">
1680 <a href="../../migration/wsc30/package/" class="md-nav__link">
1681 Package Components
1682 </a>
1683 </li>
1684
1685
1686
1687 </ul>
1688 </nav>
1689 </li>
1690
1691
1692
1693
1694
1695
1696
1697
1698 <li class="md-nav__item md-nav__item--nested">
1699
1700
1701 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1702
1703 <label class="md-nav__link" for="__nav_6_5">
1704 Migrating from WCF 2.1
1705 <span class="md-nav__icon md-icon"></span>
1706 </label>
1707 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1708 <label class="md-nav__title" for="__nav_6_5">
1709 <span class="md-nav__icon md-icon"></span>
1710 Migrating from WCF 2.1
1711 </label>
1712 <ul class="md-nav__list" data-md-scrollfix>
1713
1714
1715
1716
1717
1718 <li class="md-nav__item">
1719 <a href="../../migration/wcf21/php/" class="md-nav__link">
1720 PHP API
1721 </a>
1722 </li>
1723
1724
1725
1726
1727
1728
1729
1730 <li class="md-nav__item">
1731 <a href="../../migration/wcf21/templates/" class="md-nav__link">
1732 Templates
1733 </a>
1734 </li>
1735
1736
1737
1738
1739
1740
1741
1742 <li class="md-nav__item">
1743 <a href="../../migration/wcf21/css/" class="md-nav__link">
1744 CSS
1745 </a>
1746 </li>
1747
1748
1749
1750
1751
1752
1753
1754 <li class="md-nav__item">
1755 <a href="../../migration/wcf21/package/" class="md-nav__link">
1756 Package Components
1757 </a>
1758 </li>
1759
1760
1761
1762 </ul>
1763 </nav>
1764 </li>
1765
1766
1767
1768 </ul>
1769 </nav>
1770 </li>
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782 <li class="md-nav__item md-nav__item--nested">
1783
1784
1785 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1786
1787 <label class="md-nav__link" for="__nav_7">
1788 Tutorials
1789 <span class="md-nav__icon md-icon"></span>
1790 </label>
1791 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1792 <label class="md-nav__title" for="__nav_7">
1793 <span class="md-nav__icon md-icon"></span>
1794 Tutorials
1795 </label>
1796 <ul class="md-nav__list" data-md-scrollfix>
1797
1798
1799
1800
1801
1802
1803 <li class="md-nav__item md-nav__item--nested">
1804
1805
1806 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1807
1808 <label class="md-nav__link" for="__nav_7_1">
1809 Tutorial Series
1810 <span class="md-nav__icon md-icon"></span>
1811 </label>
1812 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1813 <label class="md-nav__title" for="__nav_7_1">
1814 <span class="md-nav__icon md-icon"></span>
1815 Tutorial Series
1816 </label>
1817 <ul class="md-nav__list" data-md-scrollfix>
1818
1819
1820
1821
1822
1823 <li class="md-nav__item">
1824 <a href="../../tutorial/series/overview/" class="md-nav__link">
1825 Overview
1826 </a>
1827 </li>
1828
1829
1830
1831
1832
1833
1834
1835 <li class="md-nav__item">
1836 <a href="../../tutorial/series/part_1/" class="md-nav__link">
1837 Part 1
1838 </a>
1839 </li>
1840
1841
1842
1843
1844
1845
1846
1847 <li class="md-nav__item">
1848 <a href="../../tutorial/series/part_2/" class="md-nav__link">
1849 Part 2
1850 </a>
1851 </li>
1852
1853
1854
1855
1856
1857
1858
1859 <li class="md-nav__item">
1860 <a href="../../tutorial/series/part_3/" class="md-nav__link">
1861 Part 3
1862 </a>
1863 </li>
1864
1865
1866
1867 </ul>
1868 </nav>
1869 </li>
1870
1871
1872
1873 </ul>
1874 </nav>
1875 </li>
1876
1877
1878
1879 </ul>
1880</nav>
1881 </div>
1882 </div>
1883 </div>
1884
1885
1886
1887 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1888 <div class="md-sidebar__scrollwrap">
1889 <div class="md-sidebar__inner">
1890
1891<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1892
1893
1894
1895
1896
1897 <label class="md-nav__title" for="__toc">
1898 <span class="md-nav__icon md-icon"></span>
1899 Table of contents
1900 </label>
1901 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1902
1903 <li class="md-nav__item">
1904 <a href="#introduction" class="md-nav__link">
1905 Introduction
1906 </a>
1907
1908</li>
1909
1910 <li class="md-nav__item">
1911 <a href="#including-data-in-the-export" class="md-nav__link">
1912 Including Data in the Export
1913 </a>
1914
1915 <nav class="md-nav" aria-label="Including Data in the Export">
1916 <ul class="md-nav__list">
1917
1918 <li class="md-nav__item">
1919 <a href="#example-code" class="md-nav__link">
1920 Example code
1921 </a>
1922
1923</li>
1924
1925 <li class="md-nav__item">
1926 <a href="#data" class="md-nav__link">
1927 $data
1928 </a>
1929
1930</li>
1931
1932 <li class="md-nav__item">
1933 <a href="#exportuserproperties" class="md-nav__link">
1934 $exportUserProperties
1935 </a>
1936
1937</li>
1938
1939 <li class="md-nav__item">
1940 <a href="#exportuserpropertiesifnotempty" class="md-nav__link">
1941 $exportUserPropertiesIfNotEmpty
1942 </a>
1943
1944</li>
1945
1946 <li class="md-nav__item">
1947 <a href="#exportuseroptionsettings" class="md-nav__link">
1948 $exportUserOptionSettings
1949 </a>
1950
1951</li>
1952
1953 <li class="md-nav__item">
1954 <a href="#exportuseroptionsettingsifnotempty" class="md-nav__link">
1955 $exportUserOptionSettingsIfNotEmpty
1956 </a>
1957
1958</li>
1959
1960 <li class="md-nav__item">
1961 <a href="#ipaddresses" class="md-nav__link">
1962 $ipAddresses
1963 </a>
1964
1965</li>
1966
1967 <li class="md-nav__item">
1968 <a href="#skipuseroptions" class="md-nav__link">
1969 $skipUserOptions
1970 </a>
1971
1972</li>
1973
1974 </ul>
1975 </nav>
1976
1977</li>
1978
1979 </ul>
1980
1981</nav>
1982 </div>
1983 </div>
1984 </div>
1985
1986
1987 <div class="md-content" data-md-component="content">
1988 <article class="md-content__inner md-typeset">
1989
1990
7124f4cb
WG
1991 <a href="https://github.com/WoltLab/docs.woltlab.com/edit/master/docs/php/gdpr.md" title="Edit this page" class="md-content__button md-icon">
1992 <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>
1993 </a>
1994
45ca63d0
TD
1995
1996 <h1 id="general-data-protection-regulation-gdpr">General Data Protection Regulation (GDPR)<a class="headerlink" href="#general-data-protection-regulation-gdpr" title="Permanent link">#</a></h1>
1997<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">#</a></h2>
1998<p>The General Data Protection Regulation (GDPR) of the European Union enters into
1999force on May 25, 2018. It comes with a set of restrictions when handling users'
2000personal data as well as to provide an interface to export this data on demand.</p>
2001<p>If you're looking for a guide on the implications of the GDPR and what you will
2002need or consider to do, please read the article <a href="https://www.woltlab.com/article/106-implementation-of-the-gdpr/">Implementation of the GDPR</a>
2003on woltlab.com.</p>
2004<h2 id="including-data-in-the-export">Including Data in the Export<a class="headerlink" href="#including-data-in-the-export" title="Permanent link">#</a></h2>
2005<p>The <code>wcf\acp\action\UserExportGdprAction</code> introduced with WoltLab Suite 3.1.3
2006already includes the Core itself as well as all official apps, but you'll need to
2007include any personal data stored for your plugin or app by yourself.</p>
2008<p>The event <code>export</code> is fired before any data is sent out, but after any Core data
2009has been dumped to the <code>$data</code> property.</p>
2010<h3 id="example-code">Example code<a class="headerlink" href="#example-code" title="Permanent link">#</a></h3>
2011<div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2012<span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span>
2013<span class="k">use</span> <span class="nx">wcf\acp\action\UserExportGdprAction</span><span class="p">;</span>
2014<span class="k">use</span> <span class="nx">wcf\data\user\UserProfile</span><span class="p">;</span>
2015
2016<span class="k">class</span> <span class="nc">MyUserExportGdprActionListener</span> <span class="k">implements</span> <span class="nx">IParameterizedEventListener</span> <span class="p">{</span>
2017 <span class="k">public</span> <span class="k">function</span> <span class="nf">execute</span><span class="p">(</span><span class="sd">/** @var UserExportGdprAction $eventObj */</span><span class="nv">$eventObj</span><span class="p">,</span> <span class="nv">$className</span><span class="p">,</span> <span class="nv">$eventName</span><span class="p">,</span> <span class="k">array</span> <span class="o">&amp;</span><span class="nv">$parameters</span><span class="p">)</span> <span class="p">{</span>
2018 <span class="sd">/** @var UserProfile $user */</span>
2019 <span class="nv">$user</span> <span class="o">=</span> <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">user</span><span class="p">;</span>
2020
2021 <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">data</span><span class="p">[</span><span class="s1">&#39;my.fancy.plugin&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span>
2022 <span class="s1">&#39;superPersonalData&#39;</span> <span class="o">=&gt;</span> <span class="s2">&quot;This text is super personal and should be included in the output&quot;</span><span class="p">,</span>
2023 <span class="s1">&#39;weirdIpAddresses&#39;</span> <span class="o">=&gt;</span> <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">exportIpAddresses</span><span class="p">(</span><span class="s1">&#39;app&#39;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s1">&#39;_non_standard_column_names_for_ip_addresses&#39;</span><span class="p">,</span> <span class="s1">&#39;ipAddressColumnName&#39;</span><span class="p">,</span> <span class="s1">&#39;timeColumnName&#39;</span><span class="p">,</span> <span class="s1">&#39;userIDColumnName&#39;</span><span class="p">)</span>
2024 <span class="p">];</span>
2025 <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">exportUserProperties</span><span class="p">[]</span> <span class="o">=</span> <span class="s1">&#39;shouldAlwaysExportThisField&#39;</span><span class="p">;</span>
2026 <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">exportUserPropertiesIfNotEmpty</span><span class="p">[]</span> <span class="o">=</span> <span class="s1">&#39;myFancyField&#39;</span><span class="p">;</span>
2027 <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">exportUserOptionSettings</span><span class="p">[]</span> <span class="o">=</span> <span class="s1">&#39;thisSettingIsAlwaysExported&#39;</span><span class="p">;</span>
2028 <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">exportUserOptionSettingsIfNotEmpty</span><span class="p">[]</span> <span class="o">=</span> <span class="s1">&#39;someSettingContainingPersonalData&#39;</span><span class="p">;</span>
2029 <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">ipAddresses</span><span class="p">[</span><span class="s1">&#39;my.fancy.plugin&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;wcf&#39;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s1">&#39;_my_fancy_table&#39;</span><span class="p">,</span> <span class="s1">&#39;wcf&#39;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s1">&#39;_i_also_store_ipaddresses_here&#39;</span><span class="p">];</span>
2030 <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">skipUserOptions</span><span class="p">[]</span> <span class="o">=</span> <span class="s1">&#39;thisLooksLikePersonalDataButItIsNot&#39;</span><span class="p">;</span>
2031 <span class="nv">$eventObj</span><span class="o">-&gt;</span><span class="na">skipUserOptions</span><span class="p">[]</span> <span class="o">=</span> <span class="s1">&#39;thisIsAlsoNotPersonalDataPleaseIgnoreIt&#39;</span><span class="p">;</span>
2032 <span class="p">}</span>
2033<span class="p">}</span>
2034</code></pre></div>
45ca63d0
TD
2035<h3 id="data"><code>$data</code><a class="headerlink" href="#data" title="Permanent link">#</a></h3>
2036<p>Contains the entire data that will be included in the exported JSON file, some
2037fields may already exist (such as <code>'com.woltlab.wcf'</code>) and while you may add or
2038edit any fields within, you should restrict yourself to only append data from
2039your plugin or app.</p>
2040<h3 id="exportuserproperties"><code>$exportUserProperties</code><a class="headerlink" href="#exportuserproperties" title="Permanent link">#</a></h3>
2041<p>Only a whitelist of columns in <code>wcfN_user</code> is exported by default, if your plugin
2042or app adds one or more columns to this table that do hold personal data, then
2043you will have to append it to this array. The listed properties will always be
2044included regardless of their content.</p>
2045<h3 id="exportuserpropertiesifnotempty"><code>$exportUserPropertiesIfNotEmpty</code><a class="headerlink" href="#exportuserpropertiesifnotempty" title="Permanent link">#</a></h3>
2046<p>Only a whitelist of columns in <code>wcfN_user</code> is exported by default, if your plugin
2047or app adds one or more columns to this table that do hold personal data, then
2048you will have to append it to this array. Empty values will not be added to the
2049output.</p>
2050<h3 id="exportuseroptionsettings"><code>$exportUserOptionSettings</code><a class="headerlink" href="#exportuseroptionsettings" title="Permanent link">#</a></h3>
2051<p>Any user option that exists within a <code>settings.*</code> category is automatically
2052excluded from the export, with the notable exception of the <code>timezone</code> option.
2053You can opt-in to include your setting by appending to this array, if it contains
2054any personal data. The listed settings are always included regardless of their
2055content.</p>
2056<h3 id="exportuseroptionsettingsifnotempty"><code>$exportUserOptionSettingsIfNotEmpty</code><a class="headerlink" href="#exportuseroptionsettingsifnotempty" title="Permanent link">#</a></h3>
2057<p>Any user option that exists within a <code>settings.*</code> category is automatically
2058excluded from the export, with the notable exception of the <code>timezone</code> option.
2059You can opt-in to include your setting by appending to this array, if it contains
2060any personal data.</p>
2061<h3 id="ipaddresses"><code>$ipAddresses</code><a class="headerlink" href="#ipaddresses" title="Permanent link">#</a></h3>
2062<p>List of database table names per package identifier that contain ip addresses.
2063The contained ip addresses will be exported when the ip logging module is enabled.</p>
2064<p>It expects the database table to use the column names <code>ipAddress</code>, <code>time</code> and
2065<code>userID</code>. If your table does not match this pattern for whatever reason, you'll
2066need to manually probe for <code>LOG_IP_ADDRESS</code> and then call <code>exportIpAddresses()</code>
2067to retrieve the list. Afterwards you are responsible to append these ip addresses
2068to the <code>$data</code> array to have it exported.</p>
2069<h3 id="skipuseroptions"><code>$skipUserOptions</code><a class="headerlink" href="#skipuseroptions" title="Permanent link">#</a></h3>
2070<p>All user options are included in the export by default, unless they start with
2071<code>can*</code> or <code>admin*</code>, or are blacklisted using this array. You should append any
2072of your plugin's or app's user option that should not be exported, for example
2073because it does not contain personal data, such as internal data.</p>
2074
2075
2076
2077
2078
2079
2080
2081 </article>
2082 </div>
2083 </div>
2084 </main>
2085
2086
2087<footer class="md-footer">
2088
2089 <nav class="md-footer__inner md-grid" aria-label="Footer">
2090
2091 <a href="../apps/" class="md-footer__link md-footer__link--prev" rel="prev">
2092 <div class="md-footer__button md-icon">
2093 <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>
2094 </div>
2095 <div class="md-footer__title">
2096 <div class="md-ellipsis">
2097 <span class="md-footer__direction">
2098 Previous
2099 </span>
2100 Apps
2101 </div>
2102 </div>
2103 </a>
2104
2105
2106 <a href="../../view/languages/" class="md-footer__link md-footer__link--next" rel="next">
2107 <div class="md-footer__title">
2108 <div class="md-ellipsis">
2109 <span class="md-footer__direction">
2110 Next
2111 </span>
2112 Languages
2113 </div>
2114 </div>
2115 <div class="md-footer__button md-icon">
2116 <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>
2117 </div>
2118 </a>
2119
2120 </nav>
2121
2122 <div class="md-footer-meta md-typeset">
2123 <div class="md-footer-meta__inner md-grid">
2124 <div class="md-footer-copyright">
2125
2126 <div class="md-footer-copyright__highlight">
2127 Copyright © 2020 WoltLab GmbH
2128 </div>
2129
2130 Made with
2131 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2132 Material for MkDocs
2133 </a>
fb88dc6e 2134
45ca63d0
TD
2135 </div>
2136 <div class="md-footer-copyright">
2137 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2138 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2139</div>
2140 </div>
2141 </div>
2142</footer>
2143
2144 </div>
2145 <div class="md-dialog" data-md-component="dialog">
2146 <div class="md-dialog__inner md-typeset"></div>
2147 </div>
2148 <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.fb4a9340.min.js", "version": {"provider": "mike"}}</script>
2149
2150
fb88dc6e 2151 <script src="../../assets/javascripts/bundle.5cf3e710.min.js"></script>
45ca63d0
TD
2152
2153
2154 </body>
2155</html>