Charcoal\User\AuthAwareTrait

Complexity

Total Complexity

17

Size/Duplication

Total Lines	146
Duplicated Lines	15.07 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setAuthDependencies()	0	5	1
A	setAuthenticator()	0	6	1
A	authenticator()	11	11	2
A	setAuthorizer()	0	6	1
A	authorizer()	11	11	2
B	setRequiredAclPermissions()	0	18	5
A	requiredAclPermissions()	0	4	1
A	isAuthorized()	0	4	1
A	hasPermissions()	0	12	3

<?php

namespace Charcoal\User;

use RuntimeException;

// From Pimple
use Pimple\Container;

// From 'charcoal-user'
use Charcoal\User\Authenticator;
use Charcoal\User\Authorizer;

/**
 * An implementation, as Trait, of the {@see \Charcoal\User\AuthAwareInterface}.
 */
trait AuthAwareTrait
{
    /**
     * @var Authenticator
     */
    private $authenticator;

    /**
     * @var Authorizer
     */
    private $authorizer;

    /**
     * @var string[]
     */
    private $requiredAclPermissions = [];

    /**
     * @param  Container $container The DI container.
     * @return void
     */
    protected function setAuthDependencies(Container $container)
    {
        $this->setAuthenticator($container['admin/authenticator']);
        $this->setAuthorizer($container['admin/authorizer']);
    }

    /**
     * Set the authentication service.
     *
     * @param  Authenticator $authenticator The authentication service.
     * @return AuthAwareInterface
     */
    protected function setAuthenticator(Authenticator $authenticator)
    {
        $this->authenticator = $authenticator;

        return $this;
    }

    /**
     * Retrieve the authentication service.
     *
     * @throws RuntimeException If the authenticator was not previously set.
     * @return Authenticator
     */
    protected function authenticator()

This method seems to be duplicated in your project.

    {
        if (!$this->authenticator) {
            throw new RuntimeException(sprintf(
                'Authenticator service is not defined for "%s"',
                get_class($this)
            ));
        }

        return $this->authenticator;
    }

    /**
     * Set the authorization service.
     *
     * @param  Authorizer $authorizer The authorization service.
     * @return AuthAwareInterface
     */
    protected function setAuthorizer(Authorizer $authorizer)
    {
        $this->authorizer = $authorizer;

        return $this;
    }

    /**
     * Retrieve the authorization service.
     *
     * @throws RuntimeException If the authorizer was not previously set.
     * @return Authorizer
     */
    protected function authorizer()

This method seems to be duplicated in your project.

    {
        if (!$this->authenticator) {
            throw new RuntimeException(sprintf(
                'Authorizer service is not defined for "%s"',
                get_class($this)
            ));
        }

        return $this->authorizer;
    }

     /**
      * @param string[]|string|null $permissions The list of required permissions.
      * @throws InvalidArgumentException If the permissions are not an array or a comma-separated string.
      * @return AuthAwareTrait Chainable

The return type AuthAwareTrait is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

      */
    protected function setRequiredAclPermissions($permissions)
    {
        if ($permissions === null || !$permissions) {
            $this->permissions = [];

The property permissions does not seem to exist. Did you mean requiredAclPermissions?

            return $this;
        }
        if (is_string($permissions)) {
            $permissions = explode(',', $permissions);
            $permissions = array_map('trim', $permissions);
        }
        if (!is_array($permissions)) {
            throw new InvalidArgumentException(
                'Invalid ACL permissions. Must be an array of permissions or a comma-separated string or permissions.'
            );
        }
        $this->requiredAclPermissions = $permissions;
        return $this;
    }

    /**
     * @return string[]
     */
    protected function requiredAclPermissions()
    {
        return $this->requiredAclPermissions;
    }

    /**
     * @return boolean
     */
    public function isAuthorized()
    {
        return $this->hasPermissions($this->requiredAclPermissions());
    }

    /**
     * @param array $permissions The list of required permissions to check.
     * @return boolean
     */
    public function hasPermissions(array $permissions)
    {
        if (empty($permissions)) {
            return true;
        }
        $authUser = $this->authenticator()->authenticate();
        if (!$authUser) {
            return false;
        }
        $authorized = $this->authorizer()->userAllowed($authUser, $permissions);
        return $authorized;
    }
}