Jasny\Auth\Authz\StateTrait

Complexity

Total Complexity

10

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	forUser()	0	3	1
A	inContextOf()	0	3	1
A	user()	0	7	2
A	isLoggedIn()	0	3	2
A	context()	0	3	1
A	isPartiallyLoggedIn()	0	3	1
A	isLoggedOut()	0	3	1
A	outOfContext()	0	3	1

<?php

declare(strict_types=1);

namespace Jasny\Auth\Authz;

use Jasny\Auth\AuthException;
use Jasny\Auth\AuthzInterface as Authz;
use Jasny\Auth\ContextInterface as Context;
use Jasny\Auth\User\PartiallyLoggedIn;
use Jasny\Auth\UserInterface as User;
use Jasny\Immutable;

/**
 * Trait for keeping state (user and context) in authz service.
 */
trait StateTrait
{
    use Immutable\With;

    /**
     * Current authenticated user
     */
    protected ?User $user = null;

    /**
     * The authorization context. This could be an organization, where a user has specific roles per organization
     * rather than roles globally.
     */
    protected ?Context $context = null;

    /**
     * Get a copy of the service for the given user.
     *
     * @param User|null $user
     * @return static&Authz
     */
    public function forUser(?User $user): Authz
    {
        return $this->withProperty('user', $user);
    }

    /**
     * Get a copy of the service for the given context.
     * Returns $this if authz hasn't changed.
     *
     * @param Context|null $context
     * @return static&Authz
     */
    public function inContextOf(?Context $context): Authz
    {
        return $this->withProperty('context', $context);
    }

    /**
     * Alias of `inContextOf(null)`.
     *
     * @return static&Authz
     */
    final public function outOfContext(): Authz
    {
        return $this->inContextOf(null);
    }

    /**
     * Get current authenticated user.
     *
     * @throws AuthException if no user is logged in.
     */
    final public function user(): User
    {
        if ($this->user === null) {
            throw new AuthException("The user is not logged in");
        }

        return $this->user;
    }

    /**
     * Get the current context.
     */
    final public function context(): ?Context
    {
        return $this->context;
    }

    /**
     * Check if the current user is logged in.
     */
    public function isLoggedIn(): bool
    {
        return $this->user !== null && !$this->isPartiallyLoggedIn();
    }

    /**
     * Check if the current user is partially logged in.
     * Typically this means MFA verification is required.
     */
    public function isPartiallyLoggedIn(): bool
    {
        return $this->user instanceof PartiallyLoggedIn;
    }

    /**
     * Check if current user is not logged in or partially logged in.
     */
    public function isLoggedOut(): bool
    {
        return $this->user === null;
    }
}