Laravel Impersonate makes it easy to authenticate as your users. Add a simple trait to your user model and impersonate as one of your users in one click.
- Requirements
- Installation
- Simple usage
- Advanced Usage
- Configuration
- Blade
- Tests
- Contributors
- Why Not Just Use loginAsId()?
- Laravel 6.x to 11.x
- PHP >= 7.2 or >= 8.0
| Version | Release |
|---|---|
| 6.x to 11.x | 1.7 |
| 6.x, 7.x | 1.6 |
| 5.8 | 1.5 |
| 5.7, 5.6 | 1.2 |
| 5.5, 5.4 | 1.1 |
- Require it with Composer:
composer require lab404/laravel-impersonate- Add the service provider at the end of your
config/app.php:
'providers' => [
// ...
Lab404\Impersonate\ImpersonateServiceProvider::class,
],- Add the trait
Lab404\Impersonate\Models\Impersonateto your User model.
Impersonate a user:
Auth::user()->impersonate($other_user);
// You're now logged as the $other_userLeave impersonation:
Auth::user()->leaveImpersonation();
// You're now logged as your original user.In your routes file, under web middleware, you must call the impersonate route macro.
Route::impersonate();Alternatively, you can execute this macro with your RouteServiceProvider.
namespace App\Providers;
class RouteServiceProvider extends ServiceProvider
{
public function map() {
Route::middleware('web')->group(function (Router $router) {
$router->impersonate();
});
}
}// Where $id is the ID of the user you want impersonate
route('impersonate', $id)
// Or in case of multi guards, you should also add `guardName` (defaults to `web`)
route('impersonate', ['id' => $id, 'guardName' => 'admin'])
// Generate an URL to leave current impersonation
route('impersonate.leave')By default all users can impersonate an user.
You need to add the method canImpersonate() to your user model:
/**
* @return bool
*/
public function canImpersonate()
{
// For example
return $this->is_admin == 1;
}By default all users can be impersonated.
You need to add the method canBeImpersonated() to your user model to extend this behavior:
/**
* @return bool
*/
public function canBeImpersonated()
{
// For example
return $this->can_be_impersonated == 1;
}- Getting the manager:
// With the app helper
app('impersonate')
// Dependency Injection
public function impersonate(ImpersonateManager $manager, $user_id) { /* ... */ }- Working with the manager:
$manager = app('impersonate');
// Find an user by its ID
$manager->findUserById($id);
// TRUE if your are impersonating an user.
$manager->isImpersonating();
// Impersonate an user. Pass the original user and the user you want to impersonate
$manager->take($from, $to);
// Leave current impersonation
$manager->leave();
// Get the impersonator ID
$manager->getImpersonatorId();Protect From Impersonation
You can use the middleware impersonate.protect to protect your routes against user impersonation.
This middleware can be useful when you want to protect specific pages like users subscriptions, users credit cards, ...
Router::get('/my-credit-card', function() {
echo "Can't be accessed by an impersonator";
})->middleware('impersonate.protect');There are two events available that can be used to improve your workflow:
TakeImpersonationis fired when an impersonation is taken.LeaveImpersonationis fired when an impersonation is leaved.
Each events returns two properties $event->impersonator and $event->impersonated containing User model instance.
The package comes with a configuration file.
Publish it with the following command:
php artisan vendor:publish --tag=impersonateAvailable options:
// The session key used to store the original user id.
'session_key' => 'impersonated_by',
// Where to redirect after taking an impersonation.
// Only used in the built-in controller.
// You can use: an URI, the keyword back (to redirect back) or a route name
'take_redirect_to' => '/',
// Where to redirect after leaving an impersonation.
// Only used in the built-in controller.
// You can use: an URI, the keyword back (to redirect back) or a route name
'leave_redirect_to' => '/'There are three Blade directives available.
@canImpersonate($guard = null)
<a href="{{ route('impersonate', $user->id) }}">Impersonate this user</a>
@endCanImpersonateThis comes in handy when you have a user list and want to show an "Impersonate" button next to all the users.
But you don't want that button next to the current authenticated user neither to that users which should not be able to impersonated according your implementation of canBeImpersonated() .
@canBeImpersonated($user, $guard = null)
<a href="{{ route('impersonate', $user->id) }}">Impersonate this user</a>
@endCanBeImpersonated@impersonating($guard = null)
<a href="{{ route('impersonate.leave') }}">Leave impersonation</a>
@endImpersonatingvendor/bin/phpunit- This package was created by MarceauKa and tghpow. Many thanks to all of our contributors.
This package adds broader functionality, including Blade directives to allow you to override analytics and other tracking events when impersonating, fire events based on impersonation status, and more. Brief discussion at issues/5
MIT
