Jasny\Auth\Authz\StateTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	user()	0	3	1
A	context()	0	3	1
A	forUser()	0	3	1
A	inContextOf()	0	3	1

<?php

declare(strict_types=1);

namespace Jasny\Auth\Authz;

use Jasny\Auth\AuthzInterface as Authz;
use Jasny\Auth\ContextInterface as Context;
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);

The expression return $this->withProperty('user', $user) returns the type Jasny\Auth\Authz\StateTrait which is incompatible with the type-hinted return Jasny\Auth\AuthzInterface.

    }

    /**
     * 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);

The expression return $this->withProperty('context', $context) returns the type Jasny\Auth\Authz\StateTrait which is incompatible with the type-hinted return Jasny\Auth\AuthzInterface.

    }

    /**
     * Get current authenticated user.
     *
     * @return User|null
     */
    final public function user(): ?User
    {
        return $this->user;
    }

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