Surfnet\Stepup\Identity\Event\IdentityEmailChangedEvent

Complexity

Total Complexity

8

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

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

<?php

/**
 * Copyright 2014 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.
 */

namespace Surfnet\Stepup\Identity\Event;

use Surfnet\Stepup\Identity\AuditLog\Metadata;
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 IdentityEmailChangedEvent extends IdentityEvent implements Forgettable, RightToObtainDataInterface
{
    /**
     * @var string[]
     */
    private array $allowlist = [
        'id',
        'identity_institution',
        'email',
    ];

    public function __construct(IdentityId $identityId, Institution $institution, public Email $email)
    {
        parent::__construct($identityId, $institution);
    }

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

        return $metadata;
    }

    /**
     * @param array $data
     * @return IdentityEmailChangedEvent
     */
    public static function deserialize(array $data): self
    {
        return new self(
            new IdentityId($data['id']),
            new Institution($data['institution']),
            Email::unknown(),
        );
    }

    /**
     * The data ending up in the event_stream, be careful not to include sensitive data here!
     *
     * @return array<string, mixed>
     */
    public function serialize(): array
    {
        return [
            'id' => (string)$this->identityId,
            'institution' => (string)$this->identityInstitution,
        ];
    }

    public function getSensitiveData(): SensitiveData
    {
        return (new SensitiveData)

Parentheses must be used when instantiating a new class

            ->withEmail($this->email);
    }

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

    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;
    }
}