Surfnet\Stepup\Identity\Event\IdentityRestoredEvent

Complexity

Total Complexity

8

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getAllowlist()	0	3	1
A	getAuditLogMetadata()	0	7	1
A	getSensitiveData()	0	5	1
A	serialize()	0	7	1
A	obtainUserData()	0	5	1
A	__construct()	0	7	1
A	deserialize()	0	7	1
A	setSensitiveData()	0	4	1

<?php

/**
 * Copyright 2025 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Missing @link tag in file comment

namespace Surfnet\Stepup\Identity\Event;

use Surfnet\Stepup\Identity\AuditLog\Metadata;
use Surfnet\Stepup\Identity\Value\CommonName;
use Surfnet\Stepup\Identity\Value\Email;
use Surfnet\Stepup\Identity\Value\IdentityId;
use Surfnet\Stepup\Identity\Value\Institution;
use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\Forgettable;
use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\RightToObtainDataInterface;
use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\SensitiveData;

class IdentityRestoredEvent extends IdentityEvent implements Forgettable, RightToObtainDataInterface

Missing doc comment for class IdentityRestoredEvent

{

    /**
     * @var string[]
     */
    private array $allowlist = [
        'id',
        'common_name',
        'email',
        'institution',
    ];

    public function __construct(
        private readonly IdentityId $id,
        private readonly Institution $institution,
        public CommonName $commonName,
        public Email $email,
    ) {
        parent::__construct($id, $institution);
    }

    public function getAuditLogMetadata(): Metadata
    {
        $metadata = new Metadata();
        $metadata->identityId = $this->id;
        $metadata->identityInstitution = $this->institution;

        return $metadata;
    }

    /**
     * @param array<string,string> $data
     */

Missing @return tag in function comment

    public static function deserialize(array $data): self
    {
        return new self(
            new IdentityId($data['id']),
            new Institution($data['institution']),
            new CommonName($data['common_name']),
            new Email($data['email']),
        );
    }

    /**
     * @return array<string,string>
     */
    public function serialize(): array
    {
        return [
            'id' => (string)$this->id,
            'institution' => (string)$this->institution,
            'common_name' => (string)$this->commonName,
            'email' => (string)$this->email,
        ];
    }

    public function getSensitiveData(): SensitiveData
    {
        return (new SensitiveData)
            ->withCommonName($this->commonName)
            ->withEmail($this->email);
    }

    public function setSensitiveData(SensitiveData $sensitiveData): void
    {
        $this->commonName = $sensitiveData->getCommonName();
        $this->email = $sensitiveData->getEmail();
    }

    /**
     * @return array<string,string>
     */
    public function obtainUserData(): array
    {
        $serializedPublicUserData = $this->serialize();
        $serializedSensitiveUserData = $this->getSensitiveData()->serialize();
        return array_merge($serializedPublicUserData, $serializedSensitiveUserData);
    }

    /**
     * @return string[]
     */
    public function getAllowlist(): array
    {
        return $this->allowlist;
    }
}