LocalePreferenceExpressedEvent::deserialize()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 4
nc 1
nop 1
dl 0
loc 6
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
 */
0 ignored issues
show
Coding Style introduced by
Missing @link tag in file comment
Loading history...
18
19
namespace Surfnet\Stepup\Identity\Event;
20
21
use Surfnet\Stepup\Identity\AuditLog\Metadata;
22
use Surfnet\Stepup\Identity\Value\IdentityId;
23
use Surfnet\Stepup\Identity\Value\Institution;
24
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...
25
use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\RightToObtainDataInterface;
26
27
class LocalePreferenceExpressedEvent extends IdentityEvent implements RightToObtainDataInterface
0 ignored issues
show
Coding Style introduced by
Missing doc comment for class LocalePreferenceExpressedEvent
Loading history...
28
{
29
    /**
30
     * @var string[]
31
     */
32
    private array $allowlist = [
33
        'id',
34
        'institution',
35
        'preferred_locale',
36
    ];
37
38
    /**
39
     * @param IdentityId $id
0 ignored issues
show
Coding Style introduced by
Expected 2 spaces after parameter type; 1 found
Loading history...
40
     * @param Institution $institution
41
     * @param Locale $preferredLocale
0 ignored issues
show
Coding Style introduced by
Expected 6 spaces after parameter type; 1 found
Loading history...
42
     */
43
    public function __construct(IdentityId $id, Institution $institution, public Locale $preferredLocale)
44
    {
45
        parent::__construct($id, $institution);
46
    }
47
48
    public function getAuditLogMetadata(): Metadata
49
    {
50
        $metadata = new Metadata();
51
        $metadata->identityId = $this->identityId;
52
        $metadata->identityInstitution = $this->identityInstitution;
53
54
        return $metadata;
55
    }
56
57
    public static function deserialize(array $data): self
58
    {
59
        return new self(
60
            new IdentityId($data['id']),
61
            new Institution($data['institution']),
62
            new Locale($data['preferred_locale']),
63
        );
64
    }
65
66
    /**
67
     * The data ending up in the event_stream, be careful not to include sensitive data here!
68
     *
69
     * @return array<string, mixed>
70
     */
71
    public function serialize(): array
72
    {
73
        return [
74
            'id' => (string)$this->identityId,
75
            'institution' => (string)$this->identityInstitution,
76
            'preferred_locale' => (string)$this->preferredLocale,
77
        ];
78
    }
79
80
    public function obtainUserData(): array
81
    {
82
        return $this->serialize();
83
    }
84
85
    /**
86
     * @return string[]
87
     */
88
    public function getAllowlist(): array
89
    {
90
        return $this->allowlist;
91
    }
92
}
93