Arcanedev\LaravelImpersonator\Traits\CanImpersonate

Complexity

Total Complexity

4

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	impersonate()	0	5	1
A	stopImpersonation()	0	4	2
	canImpersonate()	0	1	?
	canBeImpersonated()	0	1	?
A	isImpersonated()	0	4	1

<?php namespace Arcanedev\LaravelImpersonator\Traits;

use Arcanedev\LaravelImpersonator\Contracts\Impersonatable;

/**
 * Trait     HasImpersonation
 *
 * @package  Arcanedev\LaravelImpersonator\Traits
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
trait CanImpersonate
{
    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Impersonate the given user.
     *
     * @param   \Arcanedev\LaravelImpersonator\Contracts\Impersonatable  $impersonated
     *
     * @return  bool
     */
    public function impersonate(Impersonatable $impersonated)
    {
        /** @var  \Arcanedev\LaravelImpersonator\Contracts\Impersonatable  $this */
        return impersonator()->start($this, $impersonated);
    }

    /**
     * Stop the impersonation.
     *
     * @return  bool
     */
    public function stopImpersonation()
    {
        return $this->isImpersonated() ? impersonator()->stop() : false;
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check if the current modal can impersonate other models.
     *
     * @return  bool
     */
    abstract public function canImpersonate();

    /**
     * Check if the current model can be impersonated.
     *
     * @return  bool
     */
    abstract public function canBeImpersonated();

    /**
     * Check if impersonation is ongoing.
     *
     * @return  bool
     */
    public function isImpersonated()
    {
        return impersonator()->isImpersonating();
    }
}