Surfnet\Stepup\Identity\Entity\VettedSecondFactor

Complexity

Total Complexity

9

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getType()	0	3	1
A	getIdentifier()	0	3	1
A	getId()	0	3	1
A	create()	0	15	1
A	applyIdentityForgottenEvent()	0	5	1
A	vettingType()	0	3	1
A	__construct()	0	2	1
A	complyWithRevocation()	0	10	1
A	revoke()	0	9	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.
 */

Missing @link tag in file comment

namespace Surfnet\Stepup\Identity\Entity;

use Surfnet\Stepup\Identity\Api\Identity;
use Surfnet\Stepup\Identity\Event\CompliedWithVettedSecondFactorRevocationEvent;
use Surfnet\Stepup\Identity\Event\IdentityForgottenEvent;
use Surfnet\Stepup\Identity\Event\VettedSecondFactorRevokedEvent;
use Surfnet\Stepup\Identity\Value\IdentityId;
use Surfnet\Stepup\Identity\Value\SecondFactorId;
use Surfnet\Stepup\Identity\Value\SecondFactorIdentifier;
use Surfnet\Stepup\Identity\Value\VettingType;
use Surfnet\StepupBundle\Value\SecondFactorType;

/**
 * A second factor whose possession and its Registrant's identity has been vetted by a Registration Authority.
 *
 * @SuppressWarnings("PHPMD.UnusedPrivateFields")
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class VettedSecondFactor extends AbstractSecondFactor
{
    private ?Identity $identity = null;

    private ?SecondFactorId $id = null;

    private ?SecondFactorType $type = null;

    /**
     * @var SecondFactorIdentifier
     */
    private SecondFactorIdentifier $secondFactorIdentifier;

    private ?VettingType $vettingType = null;

    public static function create(
        SecondFactorId $id,
        Identity $identity,
        SecondFactorType $type,
        SecondFactorIdentifier $secondFactorIdentifier,
        VettingType $vettingType,
    ): self {
        $secondFactor = new self();
        $secondFactor->id = $id;
        $secondFactor->identity = $identity;
        $secondFactor->type = $type;
        $secondFactor->secondFactorIdentifier = $secondFactorIdentifier;
        $secondFactor->vettingType = $vettingType;

        return $secondFactor;
    }

    final public function __construct()
    {
    }

    public function getId(): ?SecondFactorId
    {
        return $this->id;
    }

    public function revoke(): void
    {
        $this->apply(
            new VettedSecondFactorRevokedEvent(
                $this->identity->getId(),

The method getId() does not exist on null.

                $this->identity->getInstitution(),
                $this->id,

It seems like $this->id can also be of type null; however, parameter $secondFactorId of Surfnet\Stepup\Identity\Event\VettedSecondFactorRevokedEvent::__construct() does only seem to accept Surfnet\Stepup\Identity\Value\SecondFactorId, maybe add an additional type check?

                $this->type,

It seems like $this->type can also be of type null; however, parameter $secondFactorType of Surfnet\Stepup\Identity\Event\VettedSecondFactorRevokedEvent::__construct() does only seem to accept Surfnet\StepupBundle\Value\SecondFactorType, maybe add an additional type check?

                $this->secondFactorIdentifier,
            ),
        );
    }

    public function complyWithRevocation(IdentityId $authorityId): void
    {
        $this->apply(
            new CompliedWithVettedSecondFactorRevocationEvent(
                $this->identity->getId(),
                $this->identity->getInstitution(),
                $this->id,

It seems like $this->id can also be of type null; however, parameter $secondFactorId of Surfnet\Stepup\Identity\Event\CompliedWithVettedSecondFactorRevocationEvent::__construct() does only seem to accept Surfnet\Stepup\Identity\Value\SecondFactorId, maybe add an additional type check?

                $this->type,

It seems like $this->type can also be of type null; however, parameter $secondFactorType of Surfnet\Stepup\Identity\Event\CompliedWithVettedSecondFactorRevocationEvent::__construct() does only seem to accept Surfnet\StepupBundle\Value\SecondFactorType, maybe add an additional type check?

                $this->secondFactorIdentifier,
                $authorityId,
            ),
        );
    }

    public function vettingType(): VettingType
    {
        return $this->vettingType;
    }

    protected function applyIdentityForgottenEvent(IdentityForgottenEvent $event): void

The parameter $event is not used and could be removed.

    {
        $secondFactorIdentifierClass = $this->secondFactorIdentifier::class;

        $this->secondFactorIdentifier = $secondFactorIdentifierClass::unknown();
    }

    public function getType(): SecondFactorType
    {
        return $this->type;
    }

    public function getIdentifier(): SecondFactorIdentifier
    {
        return $this->secondFactorIdentifier;
    }
}