Arcanedev\LaravelImpersonator\Policies\ImpersonationPolicy

Complexity

Total Complexity

7

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	prefix()	0	4	1
A	abilities()	0	18	1
A	canImpersonate()	0	8	2
A	canBeImpersonated()	0	8	2
A	isEnabled()	0	4	1

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelImpersonator\Policies;

use Arcanedev\LaravelImpersonator\Contracts\Impersonatable;
use Arcanedev\LaravelPolicies\Policy;
use Illuminate\Foundation\Auth\User;

/**
 * Class     ImpersonationPolicy
 *
 * @package  Arcanedev\LaravelImpersonator\Policies
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class ImpersonationPolicy extends Policy
{
    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get the ability's prefix.
     *
     * @return string
     */
    protected static function prefix(): string
    {
        return 'auth.impersonator.';
    }

    public function abilities(): iterable
    {
        return [

            // auth.impersonator.can-impersonate
            static::makeAbility('can-impersonate', 'canImpersonate')->setMetas([
                'name'        => 'Ability to impersonate',
                'description' => 'Ability to impersonate other users',
            ]),

            // auth.impersonator.can-be-impersonated
            static::makeAbility('can-be-impersonated', 'canBeImpersonated')->setMetas([
                'name'        => 'Ability to be impersonated',
                'description' => 'Ability to be impersonated by other users',
            ]),

        ];
    }

    /* -----------------------------------------------------------------
     |  Policies
     | -----------------------------------------------------------------
     */

    /**
     * Check if the current user can impersonate.
     *
     * @param  \Arcanedev\LaravelImpersonator\Contracts\Impersonatable|\Illuminate\Foundation\Auth\User  $user
     *
     * @return bool
     */
    public function canImpersonate(User $user): bool
    {
        if ( ! $this->isEnabled()) {
            return false;
        }

        return $user->canImpersonate();
    }

    /**
     * Check if the given user can be impersonated.
     *
     * @param  \Arcanedev\LaravelImpersonator\Contracts\Impersonatable|\Illuminate\Foundation\Auth\User  $user
     * @param  \Arcanedev\LaravelImpersonator\Contracts\Impersonatable                                   $impersonated
     *
     * @return bool
     */
    public function canBeImpersonated(User $user, Impersonatable $impersonated): bool
    {
        if ( ! $this->canImpersonate($user)) {
            return false;
        }

        return $impersonated->canBeImpersonated();
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check if the impersonation is enabled.
     *
     * @return bool
     */
    private function isEnabled()
    {
        return config('impersonator.enabled', false);
    }
}