Spiral\Security\Traits\GuardedTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	allows()	0	3	1
A	denies()	0	3	1
A	resolvePermission()	0	8	2
A	getGuard()	0	10	3

<?php

/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */

declare(strict_types=1);

namespace Spiral\Security\Traits;

use Spiral\Core\ContainerScope;
use Spiral\Core\Exception\ScopeException;
use Spiral\Security\GuardInterface;

/**
 * Embeds GuardInterface functionality into class and provides ability to isolate permissions
 * using guard namespace. GuardedTrait operates using global container scope.
 */
trait GuardedTrait
{
    /**
     * @return GuardInterface
     * @throws ScopeException
     */
    public function getGuard(): GuardInterface
    {
        $container = ContainerScope::getContainer();
        if (empty($container) || !$container->has(GuardInterface::class)) {
            throw new ScopeException(
                'Unable to get `GuardInterface`, binding is missing or container scope is not set'
            );
        }

        return $container->get(GuardInterface::class);
    }

    /**
     * @param string $permission
     * @param array  $context
     * @return bool
     */
    protected function allows(string $permission, array $context = []): bool
    {
        return $this->getGuard()->allows($this->resolvePermission($permission), $context);
    }

    /**
     * @param string $permission
     * @param array  $context
     * @return bool
     */
    protected function denies(string $permission, array $context = []): bool
    {
        return !$this->allows($permission, $context);
    }

    /**
     * Automatically prepend permission name with local RBAC namespace.
     *
     * @param string $permission
     * @return string
     */
    protected function resolvePermission(string $permission): string
    {
        if (defined('static::GUARD_NAMESPACE')) {
            // Yay! Isolation
            $permission = constant(get_called_class() . '::' . 'GUARD_NAMESPACE') . '.' . $permission;
        }

        return $permission;
    }
}