Valkyrja\Auth\Data\AuthenticatedUsers

Complexity

Total Complexity

18

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	setImpersonated()	0	7	1
A	isUserAuthenticated()	0	15	4
A	remove()	0	17	4
A	getCurrent()	0	3	1
A	hasCurrent()	0	3	1
A	getImpersonated()	0	3	1
A	isImpersonating()	0	3	1
A	setCurrent()	0	7	1
A	__construct()	0	7	2
A	all()	0	3	1
A	add()	0	5	1

<?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\Data;

use Valkyrja\Auth\Data\Contract\AuthenticatedUsers as Contract;

use function in_array;

/**
 * Class AuthenticatedUsers.
 *
 * @author Melech Mizrachi
 */
class AuthenticatedUsers implements Contract
{
    /**
     * The users.
     *
     * @var array<int|non-empty-string, non-empty-string|int>

The doc comment array<int|non-empty-string, non-empty-string|int> at position 4 could not be parsed: Unknown type name 'non-empty-string' at position 4 in array<int|non-empty-string, non-empty-string|int>.

     */
    protected array $users = [];

    /**
     * @param non-empty-string|int|null $currentId      The current user's id

The doc comment non-empty-string|int|null at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string|int|null.

     * @param non-empty-string|int|null $impersonatedId The impersonated user's id
     * @param non-empty-string|int      ...$users       The users
     */
    public function __construct(
        protected string|int|null $currentId = null,
        protected string|int|null $impersonatedId = null,
        string|int ...$users
    ) {
        foreach ($users as $user) {
            $this->add($user);
        }
    }

    /**
     * @inheritDoc
     */
    public function hasCurrent(): bool
    {
        return $this->currentId !== null;
    }

    /**
     * @inheritDoc
     */
    public function getCurrent(): string|int|null
    {
        return $this->currentId ?? null;
    }

    /**
     * @inheritDoc
     *
     * @param non-empty-string|int $id The user

The doc comment non-empty-string|int at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string|int.

     */
    public function setCurrent(string|int $id): static
    {
        $this->currentId = $id;

        $this->add($id);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function isImpersonating(): bool
    {
        return $this->impersonatedId !== null;
    }

    /**
     * @inheritDoc
     */
    public function getImpersonated(): string|int|null
    {
        return $this->impersonatedId ?? null;
    }

    /**
     * @inheritDoc
     *
     * @param non-empty-string|int $id The user

The doc comment non-empty-string|int at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string|int.

     */
    public function setImpersonated(string|int $id): static
    {
        $this->impersonatedId = $id;

        $this->add($id);

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function isUserAuthenticated(string|int $id): bool
    {
        if ($this->currentId === $id) {
            return true;
        }

        if ($this->impersonatedId === $id) {
            return true;
        }

        if (in_array($id, $this->users, true)) {
            return true;
        }

        return false;
    }

    /**
     * @inheritDoc
     *
     * @param non-empty-string|int $id The user

The doc comment non-empty-string|int at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string|int.

     */
    public function add(string|int $id): static
    {
        $this->users[$id] = $id;

        return $this;
    }

    /**
     * @inheritDoc
     *
     * @param non-empty-string|int $id The id of the user to remove

The doc comment non-empty-string|int at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string|int.

     */
    public function remove(string|int $id): static
    {
        unset($this->users[$id]);

        if ($this->currentId === $id) {
            $this->currentId = null;

            if (! empty($this->users)) {
                $this->setCurrent($this->users[array_key_first($this->users)]);
            }
        }

        if ($this->impersonatedId === $id) {
            $this->impersonatedId = null;
        }

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function all(): array
    {
        return $this->users;
    }
}