/
PersonalData.php
590 lines (478 loc) · 14.3 KB
/
PersonalData.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
<?php
namespace SpecShaper\GdprBundle\Model;
use DateInterval;
use DateTimeInterface;
use NumberFormatter;
/**
* Personal Data Object.
*
* @author Mark Ogilvie
*/
class PersonalData
{
/**
* How the data item can identify an individual.
*/
public const ID_METHOD_DIRECT = 'DIRECT';
public const ID_METHOD_INDIRECT = 'INDIRECT';
/**
* What to do with the data when it becomes expired.
*/
public const DISPOSE_BY_SET_NULL = 'SET_NULL';
public const DISPOSE_BY_AGGREGATE = 'AGGREGATE';
public const DISPOSE_BY_ANONYMISE = 'ANONYMISE';
public const DISPOSE_BY_ANONYMISE_IP = 'ANONYMISE_IP';
public const DISPOSE_BY_ANONYMISE_DATE = 'ANONYMISE_DATE';
public const DISPOSE_BY_REGEX_REPLACE = 'REGEX_REPLACE';
/**
* How the data is received or transmitted between the provider and the data store.
*/
public const TRANSFER_METHOD_HTTP = 'HTTP';
public const TRANSFER_METHOD_HTTPS = 'HTTPS';
public const TRANSFER_METHOD_FTP = 'FTP';
public const TRANSFER_METHOD_FTPS = 'FTPS';
public const TRANSFER_METHOD_PDF = 'PDF';
public const TRANSFER_METHOD_ENCRYPTED_PDF = 'ENCRYPTED_PDF';
public const TRANSFER_METHOD_EMAIL = 'EMAIL';
public const TRANSFER_METHOD_POST = 'POST';
public const TRANSFER_METHOD_REGISTERED_POST = 'REGISTERED_POST';
public const TRANSFER_METHOD_PHONE = 'PHONE';
/**
* What format the data is provided in, and should be displayed as by default.
*/
public const FORMAT_STRING = 'STRING';
public const FORMAT_DATE = 'DATE';
public const FORMAT_DATETIME = 'DATETIME';
public const FORMAT_CURRENCY = 'CURRENCY';
public const FORMAT_FLOAT = 'FLOAT';
public const FORMAT_INTEGER = 'INTEGER';
/**
* Basis for collection of data.
*/
/**
* The processing is necessary to protect someone’s life.
*/
public const BASIS_VITAL_INTEREST = 'VITAL_INTEREST';
/**
* The processing is necessary for you to perform a task in the public interest or for your official functions, and
* the task or function has a clear basis in law.
*/
public const BASIS_PUBLIC_INTEREST = 'PUBLIC_INTEREST';
/**
* The processing is necessary for a contract you have with the data subject, or
* because they have asked you to take specific steps before entering into a contract.
*/
public const BASIS_CONTRACT_NECESSITY = 'CONTRACT_NECESSTITY';
/**
* The processing is necessary for you to comply with the law (not including contractual obligations).
*/
public const BASIS_LEGAL_REQUIREMENT = 'LEGAL_REQUIREMENT';
/**
* The data subject has given clear consent for you to process their personal data for a specific purpose.
*/
public const BASIS_CONSENT = 'CONSENT';
/**
* The processing is necessary for your legitimate interests or the legitimate interests of a third party unless
* there is a good reason to protect the individual’s personal data which overrides those
* legitimate interests. (This cannot apply if you are a public authority processing data to perform your official tasks.).
*/
public const BASIS_LEGITIMATE_INTEREST = 'LEGITIMATE_INTEREST';
/**
* The data that is being stored.
*
* If encryption is enabled then this data is encrypted by the subscriber via the onFlush event.
* It is decrypted by the onLoad event.
*
* When the original data becomes expired then it is replaced with the replacement value as specified
* by the disposeBy field.
*
* Gender identity, health details, political affiliations.
*/
public ?string $data = null;
/**
* The date time object that the data was created.
*
* Set in the subscriber via the GdprSubscriber via the UoW insert process.
*/
public ?DateTimeInterface $createdOn;
/**
* The date time object when the data was last updated.
*
* Set in the GdprSubscriber via the UoW update process
*/
public ?DateTimeInterface $updatedOn;
/**
* The format for the string data.
*
* Use the constants provided in this class.
*/
public ?string $format = null;
/**
* The max length of the data.
*
* If a number then it is also considered the precision.
*/
public ?int $length = null;
/**
* The number of digits after the decimal of a number.
*/
public ?int $scale = null;
/**
* True if the data isExpired.
*
* When data becomes expired the original data is replaced with aggregated, nulled or anonymised data.
*
*/
public bool $isExpired;
/**
* True if the information is classified as sensitive personal information.
*
* Gender identity, health details, political affiliations.
*/
public bool $isSensitive;
/**
* If the parameter should be encrypted.
*
*/
public bool $isEncrypted;
/**
* The method that the data could be used to identify someone.
* Either:
* - DIRECT, such as a name, email address
* - INDIRECT, such as a street address, job title.
*
* Indirect information is where this particular piece of information might be combined with another
* data set to identify an individual.
*/
public ?string $idMethod = null;
/**
* What is the basis for collection of this data?
*
* Use constants:
* - The vital interest of the individual
* - The public interest
* - Contractual necessity
* - Compliance with legal obligations
* - Unambiguous consent of the individual
* - Legitimate interest of the data controller
*/
public ?string $basisOfCollection = null;
/**
* Identifiable By.
*
* A note on how this particular piece of data might be used to identify an invididual.
*
* @var string The method by which the information might identify an individual
*/
public ?string $identifiableBy = null;
/**
* Who typically provides the data.
*
* Was it user supplied, client supplied, generated?
*/
public ?string $providedBy = null;
/**
* How did we receive this information?
*
* The method of transfer from the supplier to this database.
*/
public ?array $methodOfReceipt = [];
/**
* How is the data protected in transit.
*/
public ?array $receiptProtection = [];
/**
* Why do you need this data.
*
* @var string a text note explaining why this information is required
*/
public ?string $purposeFor = null;
/**
* How long the information is to be retained in the database for.
*
* @var DateInterval A DateInterval string such as P6Y
*/
public null|string|DateInterval $retainFor = null;
/**
* Disposal method.
*
* What happens at the end of the data's usefulness.
* Dispose, aggregate or make anonymous
*/
public ?string $disposeBy = null;
/**
* Disposal method arguments.
*/
public ?array $disposeByArgs = [];
/**
* Keep Until.
*
* The date when the data will be kept until
*/
public ?DateTimeInterface $keepUntil = null;
/**
* How do we return this data.
*/
public ?array $methodOfReturn = [];
/**
* How is the date protected when returned, rendered or displayed?
*/
public ?array $returnProtection = [];
/**
* Return a string of the data based on data format.
*/
public function toString(): string
{
return $this->__toString();
}
public function __toString()
{
if (null === $this->getData()) {
return '';
}
// If the data is expired then return the raw data.
if (true === $this->isExpired) {
return (string) $this->getData();
}
// If the data is current then format it according to type.
switch ($this->getFormat()) {
case PersonalData::FORMAT_DATE:
$string = $this->getData()->format('d M Y');
break;
case PersonalData::FORMAT_DATETIME:
$string = $this->getData()->format('d M Y h:m');
break;
case PersonalData::FORMAT_CURRENCY:
$f = NumberFormatter::create('en', NumberFormatter::CURRENCY);
$string = $f->formatCurrency($this->getData(), 'EUR');
break;
default:
$string = (string) $this->getData();
}
return $string;
}
public function __construct()
{
$this->isSensitive = false;
$this->isEncrypted = false;
$this->isExpired = false;
$this->disposeByArgs = [];
return $this;
}
public function isExpired(): bool
{
return $this->isExpired;
}
public function setIsExpired(bool $isExpired): PersonalData
{
$this->isExpired = $isExpired;
return $this;
}
public function getIdMethod(): ?string
{
return $this->idMethod;
}
public function setIdMethod(?string $idMethod): PersonalData
{
$this->idMethod = $idMethod;
return $this;
}
public function isSensitive(): bool
{
return $this->isSensitive;
}
public function setIsSensitive(bool $isSensitive): PersonalData
{
$this->isSensitive = $isSensitive;
return $this;
}
public function isEncrypted(): bool
{
return $this->isEncrypted;
}
public function setIsEncrypted(bool $isEncrypted): PersonalData
{
$this->isEncrypted = $isEncrypted;
return $this;
}
public function getBasisOfCollection(): ?string
{
return $this->basisOfCollection;
}
public function setBasisOfCollection(string $basisOfCollection): PersonalData
{
$this->basisOfCollection = $basisOfCollection;
return $this;
}
public function getIdentifiableBy(): ?string
{
return $this->identifiableBy;
}
public function setIdentifiableBy(?string $identifiableBy): PersonalData
{
$this->identifiableBy = $identifiableBy;
return $this;
}
public function getProvidedBy(): ?string
{
return $this->providedBy;
}
public function setProvidedBy(string $providedBy): PersonalData
{
$this->providedBy = $providedBy;
return $this;
}
public function getPurposeFor(): ?string
{
return $this->purposeFor;
}
public function setPurposeFor(string $purposeFor): PersonalData
{
$this->purposeFor = $purposeFor;
return $this;
}
public function getRetainFor(): ?DateInterval
{
return $this->retainFor;
}
public function setRetainFor(string $retainFor): PersonalData
{
$interval = new DateInterval($retainFor);
$this->retainFor = $interval;
return $this;
}
public function getDisposeBy(): ?string
{
return $this->disposeBy;
}
public function setDisposeBy(string $disposeBy): PersonalData
{
$this->disposeBy = $disposeBy;
return $this;
}
public function getKeepUntil(): ?DateTimeInterface
{
return $this->keepUntil;
}
public function setKeepUntil(?DateTimeInterface $keepUntil): PersonalData
{
$this->keepUntil = $keepUntil;
return $this;
}
public function getReturnFormat(): ?string
{
// return $this->returnFormat;
return null;
}
/**
* Set ReturnFormat.
*
* @param mixed $returnFormat
*
* @return PersonalData
*/
public function setReturnFormat(?string $returnFormat)
{
// $this->returnFormat = $returnFormat;
return $this;
}
public function getData(): ?string
{
return $this->data;
}
public function setData(?string $data): PersonalData
{
$this->data = $data;
return $this;
}
public function getMethodOfReceipt(): array
{
return $this->methodOfReceipt;
}
public function setMethodOfReceipt(array $methodOfReceipt): PersonalData
{
$this->methodOfReceipt = $methodOfReceipt;
return $this;
}
public function getReceiptProtection(): ?array
{
return $this->receiptProtection;
}
public function setReceiptProtection(array $receiptProtection): PersonalData
{
$this->receiptProtection = $receiptProtection;
return $this;
}
public function getMethodOfReturn(): ?array
{
return $this->methodOfReturn;
}
public function setMethodOfReturn(array $methodOfReturn): PersonalData
{
$this->methodOfReturn = $methodOfReturn;
return $this;
}
public function getReturnProtection(): ?array
{
return $this->returnProtection;
}
public function setReturnProtection(array $returnProtection): PersonalData
{
$this->returnProtection = $returnProtection;
return $this;
}
public function getFormat(): ?string
{
return $this->format;
}
public function setFormat(string $format): PersonalData
{
$this->format = $format;
return $this;
}
public function getLength(): ?int
{
return $this->length;
}
public function setLength(int $length): ?PersonalData
{
$this->length = $length;
return $this;
}
public function getScale(): ?int
{
return $this->scale;
}
public function setScale(int $scale): PersonalData
{
$this->scale = $scale;
return $this;
}
public function getCreatedOn(): ?DateTimeInterface
{
return $this->createdOn;
}
public function setCreatedOn(DateTimeInterface $createdOn): PersonalData
{
$this->createdOn = $createdOn;
return $this;
}
public function getUpdatedOn(): ?DateTimeInterface
{
return $this->updatedOn;
}
public function setUpdatedOn(DateTimeInterface $updatedOn): PersonalData
{
$this->updatedOn = $updatedOn;
return $this;
}
public function getDisposeByArgs(): ?array
{
return $this->disposeByArgs;
}
public function setDisposeByArgs(array $disposeByArgs): PersonalData
{
$this->disposeByArgs = $disposeByArgs;
return $this;
}
}