Laravel олицетворяет

Олицетворение Laravel

Laravel Impersonate упрощает аутентификацию ваших пользователей . Добавьте простую черту в свою пользовательскую модель и выдавайте себя за одного из своих пользователей одним щелчком мыши.

• Требования
• Установка
• Простое использование
  • Использование встроенного контроллера
• Расширенное использование
  • Определение разрешения на выдачу себя за другое лицо
  • Использование собственной стратегии
  • Промежуточное ПО
  • События
• Конфигурация
• Лезвие
• Тесты
• Авторы
• Почему бы просто не использовать loginAsId()?

Требования

• Ларавел от 6.x до 11.x
• PHP >= 7.2 или >= 8.0

Поддержка Ларавел

Версия	Выпускать
с 6.x по 11.x	1,7
6.х, 7.х	1,6
5,8	1,5
5,7, 5,6	1.2
5,5, 5,4	1.1

Установка

• Требуйте это с помощью Composer:

composer require lab404/laravel-impersonate

• Добавьте поставщика услуг в конец вашего config/app.php :

 ' providers ' => [
    // ...
    Lab404  Impersonate  ImpersonateServiceProvider ::class,
],

• Добавьте признак Lab404ImpersonateModelsImpersonate в вашу модель пользователя .

Простое использование

Выдать себя за пользователя:

 Auth :: user ()-> impersonate ( $ other_user );
// You're now logged as the $other_user

Оставьте выдачу себя за другое лицо:

 Auth :: user ()-> leaveImpersonation ();
// You're now logged as your original user.

Использование встроенного контроллера

В файле маршрутов в промежуточном веб-программном обеспечении вы должны вызвать макрос impersonate маршрута.

 Route :: impersonate ();

Альтернативно вы можете выполнить этот макрос с помощью 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 ' )

Расширенное использование

Определение разрешения на выдачу себя за другое лицо

По умолчанию все пользователи могут выдавать себя за пользователя.
Вам необходимо добавить метод canImpersonate() в вашу пользовательскую модель:

    /**
     * @return bool
     */
    public function canImpersonate ()
    {
        // For example
        return $ this -> is_admin == 1 ;
    }

По умолчанию все пользователи могут выдавать себя за других .
Вам нужно добавить метод canBeImpersonated() в вашу пользовательскую модель, чтобы расширить это поведение:

    /**
     * @return bool
     */
    public function canBeImpersonated ()
    {
        // For example
        return $ this -> can_be_impersonated == 1 ;
    }

Использование собственной стратегии

• Получение менеджера:

 // With the app helper
app ( ' impersonate ' )
// Dependency Injection
public function impersonate ( ImpersonateManager $ manager , $ user_id ) { /* ... */ }

• Работа с менеджером:

 $ 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 ();

Промежуточное ПО

Защитить от выдачи себя за другое лицо

Вы можете использовать промежуточное программное обеспечение impersonate.protect для защиты ваших маршрутов от подделки пользователя.
Это промежуточное программное обеспечение может быть полезно, если вы хотите защитить определенные страницы, такие как подписки пользователей, кредитные карты пользователей и т. д.

middleware('impersonate.protect');">

 Router :: get ( ' /my-credit-card ' , function () {
    echo " Can't be accessed by an impersonator " ;
})-> middleware ( ' impersonate.protect ' );

События

Доступны два события, которые можно использовать для улучшения рабочего процесса:

• TakeImpersonation запускается, когда выполняется олицетворение.
• LeaveImpersonation запускается, когда олицетворение прекращается.

Каждое событие возвращает два свойства $event->impersonator и $event->impersonated содержащие экземпляр модели пользователя.

Конфигурация

В комплект поставки входит файл конфигурации.

Опубликуйте его с помощью следующей команды:

php artisan vendor:publish --tag=impersonate

Доступные варианты:

    // 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 ' => ' / ' 

Лезвие

Доступны три директивы Blade.

Когда пользователь может выдавать себя за другое лицо

id) }}">Impersonate this user @endCanImpersonate">

 @canImpersonate ( $guard = null )
    < a href = " {{ route ( ' impersonate ' , $user -> id ) } } " >Impersonate this usera >
@endCanImpersonate

Когда пользователя можно выдать за другое лицо

Это удобно, если у вас есть список пользователей и вы хотите отобразить кнопку «Олицетворять» рядом со всеми пользователями. Но вам не нужна эта кнопка рядом с текущим аутентифицированным пользователем, а также с теми пользователями, которые не должны иметь возможность выдавать себя за другое лицо в соответствии с вашей реализацией canBeImpersonated() .

id) }}">Impersonate this user @endCanBeImpersonated">

 @canBeImpersonated ( $user , $guard = null )
    < a href = " {{ route ( ' impersonate ' , $user -> id ) } } " >Impersonate this usera >
@endCanBeImpersonated

Когда пользователь выдает себя за другого

Leave impersonation @endImpersonating">

 @impersonating ( $guard = null )
    < a href = " {{ route ( ' impersonate.leave ' ) } } " >Leave impersonationa >
@endImpersonating 

Тесты

vendor/bin/phpunit

Авторы

• Этот пакет был создан MarceauKa и tghpow. Большое спасибо всем нашим участникам.

Обоснование

Почему бы просто не использовать loginAsId() ?

Этот пакет добавляет более широкую функциональность, включая директивы Blade, которые позволяют вам переопределять аналитику и другие события отслеживания при олицетворении, запускать события на основе статуса олицетворения и многое другое. Краткое обсуждение вопросов/5

Лицензия

Массачусетский технологический институт