Valkyrja\Auth\AbstractAuthenticator

Complexity

Total Complexity

15

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setAuthenticatedUsers()	0	5	1
A	authenticate()	0	17	3
A	getImpersonated()	0	11	2
A	__construct()	0	6	1
A	getAuthenticatedUsers()	0	3	1
A	getAuthenticated()	0	11	2
A	unauthenticate()	0	13	3
A	isAuthenticated()	0	4	2

<?php

declare(strict_types=1);

/*
 * This file is part of the Valkyrja Framework package.
 *
 * (c) Melech Mizrachi <melechmizrachi@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Valkyrja\Auth;

use Valkyrja\Auth\Contract\Authenticator as Contract;
use Valkyrja\Auth\Data\Attempt\Contract\AuthenticationAttempt;
use Valkyrja\Auth\Data\Contract\AuthenticatedUsers;
use Valkyrja\Auth\Data\Retrieval\RetrievalById;
use Valkyrja\Auth\Entity\Contract\User;
use Valkyrja\Auth\Exception\InvalidAuthenticationException;
use Valkyrja\Auth\Hasher\Contract\PasswordHasher;
use Valkyrja\Auth\Store\Contract\Store;

/**
 * Abstract Class AbstractAuthenticator.
 *
 * @author Melech Mizrachi
 *
 * @template U of User
 *
 * @implements Contract<U>
 */
abstract class AbstractAuthenticator implements Contract
{
    /** @var U|null */

The type Valkyrja\Auth\U was not found. Maybe you did not declare it correctly or list all dependencies?

    protected User|null $current = null;
    /** @var U|null */
    protected User|null $impersonated = null;

    /**
     * @param Store<U>        $store  The store
     * @param class-string<U> $entity The user entity

The doc comment class-string<U> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<U>.

     */
    public function __construct(
        protected Store $store,
        protected PasswordHasher $hasher,
        protected string $entity,
        protected AuthenticatedUsers $authenticatedUsers = new Data\AuthenticatedUsers(),
    ) {
    }

    /**
     * @inheritDoc
     */
    public function isAuthenticated(): bool
    {
        return $this->authenticatedUsers->hasCurrent()
            || $this->authenticatedUsers->isImpersonating();
    }

    /**
     * Get the current authenticated user if one exists.
     *
     * @return U|null
     */
    public function getAuthenticated(): User|null
    {
        $id = $this->authenticatedUsers->getCurrent();

        if ($id === null) {
            return null;
        }

        return $this->current ??= $this->store->retrieve(
            retrieval: new RetrievalById($id),
            user: $this->entity
        );
    }

    /**
     * Get the current impersonated user if one exists.
     *
     * @return U|null
     */
    public function getImpersonated(): User|null
    {
        $id = $this->authenticatedUsers->getImpersonated();

        if ($id === null) {
            return null;
        }

        return $this->impersonated ??= $this->store->retrieve(
            retrieval: new RetrievalById($id),
            user: $this->entity
        );
    }

    /**
     * @inheritDoc
     */
    public function getAuthenticatedUsers(): AuthenticatedUsers
    {
        return $this->authenticatedUsers;
    }

    /**
     * @inheritDoc
     */
    public function setAuthenticatedUsers(AuthenticatedUsers $authenticatedUsers): static
    {
        $this->authenticatedUsers = $authenticatedUsers;

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function authenticate(AuthenticationAttempt $attempt): User
    {
        $user = $this->store->retrieve($attempt->getRetrieval(), $this->entity);

        if ($user === null) {
            throw new InvalidAuthenticationException('User not found');
        }

        if (! $this->hasher->confirmPassword($attempt->getPassword(), $user->getPasswordValue())) {
            throw new InvalidAuthenticationException('Incorrect password');
        }

        $this->authenticatedUsers->setCurrent($user->getIdValue());

        $this->current = $user;

It seems like $user of type Valkyrja\Auth\Entity\Contract\User is incompatible with the declared type Valkyrja\Auth\U|null of property $current.

        return $user;
    }

    /**
     * @inheritDoc
     */
    public function unauthenticate(int|string $id): static
    {
        $this->authenticatedUsers->remove($id);

        if ($this->current?->getIdValue() === $id) {
            $this->current = null;
        }

        if ($this->impersonated?->getIdValue() === $id) {
            $this->impersonated = null;
        }

        return $this;
    }
}