Download the PHP package theupriser/laravel-impersonate without Composer
On this page you can find all versions of the php package theupriser/laravel-impersonate. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download theupriser/laravel-impersonate
More information about theupriser/laravel-impersonate
Files in theupriser/laravel-impersonate
Package laravel-impersonate
Short Description Laravel Impersonate is a plugin that allows to you to authenticate as your users.
License MIT
Informations about the package laravel-impersonate
Laravel Impersonate
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
- Using the built-in controller
- Advanced Usage
- Defining impersonation authorization
- Using your own strategy
- Middleware
- Events
- Configuration
- Blade
- Tests
- Contributors
- Why Not Just Use loginAsId()?
Requirements
- Laravel 6.x to 11.x
- PHP >= 7.2 or >= 8.0
Laravel support
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 |
Installation
-
Require it with Composer:
-
Add the service provider at the end of your
config/app.php
: - Add the trait
Lab404\Impersonate\Models\Impersonate
to your User model.
Simple usage
Impersonate a user:
Leave impersonation:
Using the built-in controller
In your routes file, under web middleware, you must call the impersonate
route macro.
Alternatively, you can execute this macro with your RouteServiceProvider
.
Advanced Usage
Defining impersonation authorization
By default all users can impersonate an user.
You need to add the method canImpersonate()
to your user model:
By default all users can be impersonated.
You need to add the method canBeImpersonated()
to your user model to extend this behavior:
Using your own strategy
-
Getting the manager:
- Working with the manager:
Middleware
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, ...
Events
There are two events available that can be used to improve your workflow:
TakeImpersonation
is fired when an impersonation is taken.LeaveImpersonation
is fired when an impersonation is leaved.
Each events returns two properties $event->impersonator
and $event->impersonated
containing User model instance.
Configuration
The package comes with a configuration file.
Publish it with the following command:
Available options:
Blade
There are three Blade directives available.
When the user can impersonate
When the user can be impersonated
This 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()
.
When the user is impersonated
Tests
Contributors
- This package was created by MarceauKa and tghpow. Many thanks to all of our contributors.
Rationale
Why not just use loginAsId()
?
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
Licence
MIT
All versions of laravel-impersonate with dependencies
laravel/framework Version ^6.0 | ^7.0 | ^8.0 | ^9.0 | ^10.0 | ^11.0