Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KABBOUCHI/nova-impersonate
A Laravel Nova field allows you to authenticate as your users.
https://github.com/KABBOUCHI/nova-impersonate
impersonate laravel nova
Last synced: about 2 months ago
JSON representation
A Laravel Nova field allows you to authenticate as your users.
- Host: GitHub
- URL: https://github.com/KABBOUCHI/nova-impersonate
- Owner: KABBOUCHI
- License: mit
- Created: 2018-09-09T16:31:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-18T19:01:30.000Z (almost 2 years ago)
- Last Synced: 2024-10-20T11:49:30.960Z (2 months ago)
- Topics: impersonate, laravel, nova
- Language: PHP
- Homepage:
- Size: 1.86 MB
- Stars: 232
- Watchers: 5
- Forks: 37
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Nova Impersonate Field
[](https://packagist.org/packages/kabbouchi/nova-impersonate)
[](https://packagist.org/packages/kabbouchi/nova-impersonate)
This field allows you to authenticate as your users.
Behind the scenes [404labfr/laravel-impersonate](https://github.com/404labfr/laravel-impersonate) is used.
## Installation
You can install the package in to a Laravel app that uses [Nova](https://nova.laravel.com) via composer:
```bash
composer require kabbouchi/nova-impersonate
```
## Usage
Add `Impersonate::make($this)` field in `App\Nova\User.php`
```php
sortable(),
Gravatar::make(),
Text::make('Name')
->sortable()
->rules('required', 'max:255'),
Text::make('Email')
->sortable()
->rules('required', 'email', 'max:255')
->creationRules('unique:users,email')
->updateRules('unique:users,email,{{resourceId}}'),
Password::make('Password')
->onlyOnForms()
->creationRules('required', 'string', 'min:6')
->updateRules('nullable', 'string', 'min:6'),
Impersonate::make($this), // <---
// or
Impersonate::make($this->resource), // works in lenses
// or
Impersonate::make($this)->withMeta([
'hideText' => false,
]),
// or
Impersonate::make($this)->withMeta([
'redirect_to' => '/custom-redirect-url'
]),
];
}
...
}
```
## Advanced Usage
By default all users can **impersonate** an user.
You need to add the method `canImpersonate()` to your user model:
```php
/**
* @return bool
*/
public function canImpersonate($impersonated = null)
{
// 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:
Please make sure to pass instance Model or Nova Resource ``Impersonate::make($this)`` ``Impersonate::make($this->resource)``
```php
/**
* @return bool
*/
public function canBeImpersonated(?\Illuminate\Contracts\Auth\Authenticatable $impersonator = null)
{
// For example
return $this->can_be_impersonated == 1;
}
```
By default `name` field is used for when displaying what user is impersonated at a moment.
You need to add the method `impersonateName()` to your user model to extend this behavior:
Please make sure to pass instance Model or Nova Resource ``Impersonate::make($this)`` ``Impersonate::make($this->resource)``
```php
/**
* @return string
*/
public function impersonateName()
{
// For example
return $this->email;
}
```
---
#### Events
You can hook onto the underlying package events
May be userful for things like setting session data
- `Lab404\Impersonate\Events\TakeImpersonation`
- `Lab404\Impersonate\Events\LeaveImpersonation`
---
You can optionally publish the config file with:
```bash
php artisan vendor:publish --tag=nova-impersonate-config
```
This is the default content of the config file published at `config/nova-impersonate.php`:
```php
true, // To inject the 'nova-impersonate::reverse' view in every route when impersonating
'redirect_back' => true, // false (nova path), true or
'redirect_to' => '/',
'key_down' => 'i', // Press `i` to impersonate user in details page
'middleware' => [
'base' => 'web', // Middleware used for nova-impersonate routes
'leave' => 'auth', // Extra middleware used for leave route
],
];
```
You can publish and customize the `nova-impersonate::reverse` view
```bash
php artisan vendor:publish --tag=nova-impersonate-views
```
## Credits
- [Georges KABBOUCHI](https://github.com/kabbouchi)
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.