IdentityCreatedEvent::serialize()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 7
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 5
nc 1
nop 0
dl 0
loc 7
rs 10
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * Copyright 2014 SURFnet bv
5
 *
6
 * Licensed under the Apache License, Version 2.0 (the "License");
7
 * you may not use this file except in compliance with the License.
8
 * You may obtain a copy of the License at
9
 *
10
 *     http://www.apache.org/licenses/LICENSE-2.0
11
 *
12
 * Unless required by applicable law or agreed to in writing, software
13
 * distributed under the License is distributed on an "AS IS" BASIS,
14
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
 * See the License for the specific language governing permissions and
16
 * limitations under the License.
17
 */
18
19
namespace Surfnet\Stepup\Identity\Event;
20
21
use Surfnet\Stepup\Identity\AuditLog\Metadata;
22
use Surfnet\Stepup\Identity\Value\CommonName;
23
use Surfnet\Stepup\Identity\Value\Email;
24
use Surfnet\Stepup\Identity\Value\IdentityId;
25
use Surfnet\Stepup\Identity\Value\Institution;
26
use Surfnet\Stepup\Identity\Value\Locale;
0 ignored issues
show
Bug introduced by
The type Surfnet\Stepup\Identity\Value\Locale was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
27
use Surfnet\Stepup\Identity\Value\NameId;
28
use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\Forgettable;
29
use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\RightToObtainDataInterface;
30
use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\SensitiveData;
31
32
class IdentityCreatedEvent extends IdentityEvent implements Forgettable, RightToObtainDataInterface
33
{
34
    /**
35
     * @var string[]
36
     */
37
    private array $allowlist = [
38
        'id',
39
        'institution',
40
        'name_id',
41
        'preferred_locale',
42
        'common_name',
43
        'email',
44
    ];
45
46
    public function __construct(
47
        IdentityId $id,
48
        Institution $institution,
49
        public NameId $nameId,
50
        public CommonName $commonName,
51
        public Email $email,
52
        public Locale $preferredLocale,
53
    ) {
54
        parent::__construct($id, $institution);
55
    }
56
57
    public function getAuditLogMetadata(): Metadata
58
    {
59
        $metadata = new Metadata();
60
        $metadata->identityId = $this->identityId;
61
        $metadata->identityInstitution = $this->identityInstitution;
62
63
        return $metadata;
64
    }
65
66
    public static function deserialize(array $data): self
67
    {
68
        return new self(
69
            new IdentityId($data['id']),
70
            new Institution($data['institution']),
71
            new NameId($data['name_id']),
72
            CommonName::unknown(),
73
            Email::unknown(),
74
            new Locale($data['preferred_locale']),
75
        );
76
    }
77
78
    /**
79
     * The data ending up in the event_stream, be careful not to include sensitive data here!
80
     *
81
     * @return array<string, mixed>
82
     */
83
    public function serialize(): array
84
    {
85
        return [
86
            'id' => (string)$this->identityId,
87
            'institution' => (string)$this->identityInstitution,
88
            'name_id' => (string)$this->nameId,
89
            'preferred_locale' => (string)$this->preferredLocale,
90
        ];
91
    }
92
93
    public function getSensitiveData(): SensitiveData
94
    {
95
        return (new SensitiveData)
0 ignored issues
show
Coding Style introduced by
Parentheses must be used when instantiating a new class
Loading history...
96
            ->withCommonName($this->commonName)
97
            ->withEmail($this->email);
98
    }
99
100
    public function setSensitiveData(SensitiveData $sensitiveData): void
101
    {
102
        $this->email = $sensitiveData->getEmail();
103
        $this->commonName = $sensitiveData->getCommonName();
104
    }
105
106
    public function obtainUserData(): array
107
    {
108
        $serializedPublicUserData = $this->serialize();
109
        $serializedSensitiveUserData = $this->getSensitiveData()->serialize();
110
        return array_merge($serializedPublicUserData, $serializedSensitiveUserData);
111
    }
112
113
    /**
114
     * @return string[]
115
     */
116
    public function getAllowlist(): array
117
    {
118
        return $this->allowlist;
119
    }
120
}
121