Arcanedev\LaravelImpersonator\Impersonator

Complexity

Total Complexity

24

Size/Duplication

Total Lines	272
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

98.57%

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	auth()	0	4	1
A	session()	0	4	1
A	config()	0	4	1
A	events()	0	4	1
A	getSessionKey()	0	4	1
A	getImpersonatorId()	0	4	1
A	checkImpersonation()	0	7	1
A	start()	0	17	2
A	stop()	0	20	2
A	clear()	0	4	1
A	findUserById()	0	4	1
A	isImpersonating()	0	4	1
A	isEnabled()	0	4	1
A	mustBeEnabled()	0	7	2
A	mustBeDifferentImpersonatable()	0	7	2
A	checkImpersonater()	0	7	2
A	checkImpersonated()	0	7	2

<?php namespace Arcanedev\LaravelImpersonator;

use Arcanedev\LaravelImpersonator\Contracts\Impersonatable;
use Illuminate\Contracts\Foundation\Application;

/**
 * Class     Impersonator
 *
 * @package  Arcanedev\LaravelImpersonator
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class Impersonator implements Contracts\Impersonator
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var  \Illuminate\Contracts\Foundation\Application */
    protected $app;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Impersonator constructor.
     *
     * @param  \Illuminate\Contracts\Foundation\Application  $app
     */
    public function __construct(Application $app)
    {
        $this->app = $app;
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the guard session instance.
     *
     * @return \Illuminate\Auth\AuthManager|\Arcanedev\LaravelImpersonator\Guard\SessionGuard
     */
    protected function auth()
    {
        return $this->app['auth'];
    }

    /**
     * Get the session store instance.
     *
     * @return \Illuminate\Contracts\Session\Session
     */
    protected function session()
    {
        return $this->app['session'];
    }

    /**
     * Get the config repository.
     *
     * @return \Illuminate\Contracts\Config\Repository
     */
    protected function config()
    {
        return $this->app['config'];
    }

    /**
     * Get the event dispatcher.
     *
     * @return \Illuminate\Contracts\Events\Dispatcher
     */
    protected function events()
    {
        return $this->app['events'];
    }

    /**
     * Get the session key.
     *
     * @return string
     */
    public function getSessionKey()
    {
        return $this->config()->get('impersonator.session.key', 'impersonator_id');
    }

    /**
     * Get the impersonator id.
     *
     * @return  int|null
     */
    public function getImpersonatorId()
    {
        return $this->session()->get($this->getSessionKey(), null);
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Start the impersonation.
     *
     * @param  \Arcanedev\LaravelImpersonator\Contracts\Impersonatable  $impersonater
     * @param  \Arcanedev\LaravelImpersonator\Contracts\Impersonatable  $impersonated
     *
     * @return bool
     */
    public function start(Impersonatable $impersonater, Impersonatable $impersonated)
    {
        $this->checkImpersonation($impersonater, $impersonated);

        try {
            session()->put($this->getSessionKey(), $impersonater->getAuthIdentifier());
            $this->auth()->silentLogout();

The method silentLogout does only exist in Arcanedev\LaravelImpersonator\Guard\SessionGuard, but not in Illuminate\Auth\AuthManager.

            $this->auth()->silentLogin($impersonated);

The method silentLogin does only exist in Arcanedev\LaravelImpersonator\Guard\SessionGuard, but not in Illuminate\Auth\AuthManager.

            $this->events()->dispatch(
                new Events\ImpersonationStarted($impersonater, $impersonated)
            );

            return true;
        }
        catch (\Exception $e) { return false; }
    }

    /**
     * Stop the impersonation.
     *
     * @return bool
     */
    public function stop()
    {
        try {
            $impersonated = $this->auth()->user();

The method user does only exist in Arcanedev\LaravelImpersonator\Guard\SessionGuard, but not in Illuminate\Auth\AuthManager.

            $impersonater = $this->findUserById($this->getImpersonatorId());

            $this->auth()->silentLogout();

The method silentLogout does only exist in Arcanedev\LaravelImpersonator\Guard\SessionGuard, but not in Illuminate\Auth\AuthManager.

            $this->auth()->silentLogin($impersonater);

The method silentLogin does only exist in Arcanedev\LaravelImpersonator\Guard\SessionGuard, but not in Illuminate\Auth\AuthManager.

            $this->clear();

            $this->events()->dispatch(
                new Events\ImpersonationStopped($impersonater, $impersonated)
            );

            return true;
        }
        catch (\Exception $e) {
            return false;
        }
    }

    /**
     * Clear the impersonation.
     */
    public function clear()
    {
        $this->session()->forget($this->getSessionKey());
    }

    /**
     * Find a user by the given id.
     *
     * @param  int|string  $id
     *
     * @return \Arcanedev\LaravelImpersonator\Contracts\Impersonatable
     *
     * @throws \Exception
     */
    public function findUserById($id)
    {
        return call_user_func([$this->config()->get('auth.providers.users.model'), 'findOrFail'], $id);
    }

    /* -----------------------------------------------------------------
     |  Check Functions
     | -----------------------------------------------------------------
     */

    /**
     * Check if it's impersonating.
     *
     * @return bool
     */
    public function isImpersonating()
    {
        return $this->session()->has($this->getSessionKey());
    }

    /**
     * Check if the impersonations is enabled.
     *
     * @return bool
     */
    public function isEnabled()
    {
        return $this->config()->get('impersonator.enabled', false);
    }

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

    /**
     * Check the impersonation.
     *
     * @param  \Arcanedev\LaravelImpersonator\Contracts\Impersonatable  $impersonater
     * @param  \Arcanedev\LaravelImpersonator\Contracts\Impersonatable  $impersonated
     */
    private function checkImpersonation(Impersonatable $impersonater, Impersonatable $impersonated)
    {
        $this->mustBeEnabled();
        $this->mustBeDifferentImpersonatable($impersonater, $impersonated);
        $this->checkImpersonater($impersonater);
        $this->checkImpersonated($impersonated);
    }

    /**
     * Check if the impersonation is enabled.
     *
     * @throws \Arcanedev\LaravelImpersonator\Exceptions\ImpersonationException
     */
    private function mustBeEnabled()
    {
        if ( ! $this->isEnabled())
            throw new Exceptions\ImpersonationException(
                'The impersonation is disabled.'
            );
    }

    /**
     * Check the impersonater and the impersonated are different.
     *
     * @param  \Arcanedev\LaravelImpersonator\Contracts\Impersonatable  $impersonater
     * @param  \Arcanedev\LaravelImpersonator\Contracts\Impersonatable  $impersonated
     *
     * @throws \Arcanedev\LaravelImpersonator\Exceptions\ImpersonationException
     */
    private function mustBeDifferentImpersonatable(Impersonatable $impersonater, Impersonatable $impersonated)
    {
        if ($impersonater->getAuthIdentifier() == $impersonated->getAuthIdentifier())
            throw new Exceptions\ImpersonationException(
                'The impersonater & impersonated with must be different.'
            );
    }

    /**
     * Check the impersonater.
     *
     * @param  \Arcanedev\LaravelImpersonator\Contracts\Impersonatable  $impersonater
     *
     * @throws \Arcanedev\LaravelImpersonator\Exceptions\ImpersonationException
     */
    private function checkImpersonater(Impersonatable $impersonater)
    {
        if ( ! $impersonater->canImpersonate())
            throw new Exceptions\ImpersonationException(
                "The impersonater with `{$impersonater->getAuthIdentifierName()}`=[{$impersonater->getAuthIdentifier()}] doesn't have the ability to impersonate."
            );
    }

    /**
     * Check the impersonated.
     *
     * @param  \Arcanedev\LaravelImpersonator\Contracts\Impersonatable  $impersonated
     *
     * @throws \Arcanedev\LaravelImpersonator\Exceptions\ImpersonationException
     */
    private function checkImpersonated(Impersonatable $impersonated)
    {
        if ( ! $impersonated->canBeImpersonated())
            throw new Exceptions\ImpersonationException(
                "The impersonated with `{$impersonated->getAuthIdentifierName()}`=[{$impersonated->getAuthIdentifier()}] cannot be impersonated."
            );
    }
}