laravel ban 다운로드 - laravel ban 소스 코드 다운로드

laravel ban

기타 카테고리

4.9.0

다운로드

라라벨 반

톱니바퀴 금지

소개

Laravel Ban은 Eloquent 모델의 금지 관리를 단순화합니다. 몇 분 안에 어떤 모델이든 금지 가능하게 만드세요!

사용 사례는 사용자 모델로 제한되지 않으며 조직, 팀, 그룹 등 모든 Eloquent 모델이 금지될 수 있습니다.

내용물

특징
설치
용법
- 금지 가능한 모델 준비
- 금지 가능한 모델 데이터베이스 테이블 준비
- 사용 가능한 방법
- 범위
- 이벤트
- 미들웨어
- 스케줄링
통합
변경 내역
업그레이드 중
기여
테스트
보안
기여자
대안
특허
CyberCog 소개

특징

모델에는 여러 가지 금지 조치가 있을 수 있습니다.
기록에 일시 삭제된 기록으로 보관된 차단이 제거되었습니다.
로직의 대부분은 BanService 에 의해 처리됩니다.
금지된 사용자 경로 액세스를 방지하는 미들웨어가 있습니다.
사용 사례는 User 모델로 제한되지 않으며 모든 Eloquent 모델이 금지될 수 있습니다.
모델 ban 및 unban 시 이벤트가 발생합니다.
Laravel Eloquent 모델과 함께 작동하도록 설계되었습니다.
Laravel Nova를 지원합니다.
계약을 사용하여 높은 맞춤화 기능을 유지합니다.
특성을 사용하여 즉시 사용 가능한 기능을 가져옵니다.
PHP 표준 권장 사항을 따르십시오.
- PSR-1(기본 코딩 표준).
- PSR-2(코딩 스타일 가이드).
- PSR-4(자동 로딩 표준).
단위 테스트로 다룹니다.

설치

먼저 Composer를 통해 패키지를 가져옵니다.

composer require cybercog/laravel-ban

패키지 등록 중

패키지가 자동으로 등록됩니다. 이 단계는 Laravel 5.4 또는 이전 릴리스에만 필요합니다.

app/config/app.php 내에 서비스 제공자를 포함합니다.

 ' providers ' => [
    Cog  Laravel  Ban  Providers BanServiceProvider::class,
],

데이터베이스 마이그레이션 적용

마지막으로 데이터베이스 마이그레이션을 게시하고 실행해야 합니다.

php artisan vendor:publish --provider= " CogLaravelBanProvidersBanServiceProvider " --tag= " migrations "
php artisan migrate

용법

금지 가능한 모델 준비

 use Cog  Contracts  Ban  Bannable as BannableInterface ;
use Cog  Laravel  Ban  Traits  Bannable ;
use Illuminate  Foundation  Auth  User as Authenticatable ;

class User extends Authenticatable implements BannableInterface
{
    use Bannable;
}

금지 가능한 모델 데이터베이스 테이블 준비

Bannable 모델에는 banned_at 이라는 nullable timestamp 열이 있어야 합니다. 플래그로 사용되는 이 값은 사용자가 금지되었는지 확인하고 단순화합니다. 기본 Laravel 사용자 모델을 금지 가능하게 만들려는 경우 아래 예를 사용할 수 있습니다.

새 마이그레이션 파일 만들기

php artisan make:migration add_banned_at_column_to_users_table

그런 다음 마이그레이션 파일에 다음 코드를 삽입합니다.

 <?php

use Illuminate  Database  Migrations  Migration ;
use Illuminate  Database  Schema  Blueprint ;
use Illuminate  Support  Facades  Schema ;

return new class extends Migration
{
    public function up (): void
    {
        Schema:: table ( ' users ' , function ( Blueprint $ table ) {
            $ table -> timestamp ( ' banned_at ' )-> nullable ();
        });
    }

    public function down (): void
    {
        Schema:: table ( ' users ' , function ( Blueprint $ table ) {
            $ table -> dropColumn ( ' banned_at ' );
        });
    }
};

사용 가능한 방법

엔터티에 대한 금지 적용

 $ user -> ban ();

이유 설명이 포함된 엔터티에 대해 금지 적용

 $ user -> ban ([
    ' comment ' => ' Enjoy your ban! ' ,
]);

시간이 지남에 따라 삭제될 엔터티에 대해 금지를 적용합니다.

 $ user -> ban ([
    ' expired_at ' => ' 2086-03-28 00:00:00 ' ,
]);

expired_at 속성은 CarbonCarbon 인스턴스이거나 CarbonCarbon::parse($string) 메서드로 구문 분석할 수 있는 문자열일 수 있습니다.

 $ user -> ban ([
    ' expired_at ' => ' +1 month ' ,
]);

엔터티에서 금지 제거

 $ user -> unban ();

unban 시 관련된 모든 금지 모델은 일시 삭제됩니다.

엔터티가 금지되었는지 확인

 $ user -> isBanned ();

엔터티가 금지되지 않았는지 확인하세요.

 $ user -> isNotBanned ();

만료된 차단을 수동으로 삭제

 app ( Cog  Contracts  Ban BanService::class)-> deleteExpiredBans ();

금지가 영구적인지 확인

 $ ban = $ user -> ban ();

$ ban -> isPermanent (); // true

또는 null 값을 전달합니다.

 $ ban = $ user -> ban ([
   ' expired_at ' => null ,
]);

$ ban -> isPermanent (); // true

금지가 일시적인지 확인

 $ ban = $ user -> ban ([
   ' expired_at ' => ' 2086-03-28 00:00:00 ' ,
]);

$ ban -> isTemporary (); // true

범위

금지되지 않은 모든 모델을 얻으십시오

 $ users = User:: withoutBanned ()-> get ();

금지된 모델과 금지되지 않은 모델을 받으세요

 $ users = User:: withBanned ()-> get ();

금지된 모델만 가져오기

 $ users = User:: onlyBanned ()-> get ();

범위 자동 적용

항상 쿼리 범위를 적용하려면 bannable 모델에서 shouldApplyBannedAtScope 메서드를 정의하면 됩니다. 메서드가 true 반환하면 금지된 모든 모델이 기본적으로 숨겨집니다.

 use Cog  Contracts  Ban  Bannable as BannableInterface ;
use Cog  Laravel  Ban  Traits  Bannable ;
use Illuminate  Foundation  Auth  User as Authenticatable ;

class User extends Authenticatable implements BannableInterface
{
    use Bannable;
    
    /**
     * Determine if BannedAtScope should be applied by default.
     *
     * @return bool
     */
    public function shouldApplyBannedAtScope ()
    {
        return true ;
    }
}

이벤트

엔터티가 금지된 경우 CogLaravelBanEventsModelWasBanned 이벤트가 시작됩니다.

엔터티가 금지 해제되었습니까 CogLaravelBanEventsModelWasUnbanned 이벤트가 발생합니다.

미들웨어

이 패키지에는 금지된 사용자가 보호된 경로로 이동하는 것을 방지하도록 설계된 경로 미들웨어가 있습니다.

이를 사용하려면 app/Http/Kernel.php 파일의 $routeMiddleware 배열에 새 미들웨어를 정의하세요.

 protected $ routeMiddleware = [
    ' forbid-banned-user ' =>  Cog  Laravel  Ban  Http  Middleware ForbidBannedUser::class,
]

그런 다음 보호해야 하는 모든 경로 및 경로 그룹에서 이를 사용합니다.

Route:: get ( ' / ' , [
    ' uses ' => ' UsersController@profile ' ,
    ' middleware ' => ' forbid-banned-user ' ,
]);

보호된 경로 액세스에서 사용자를 강제로 로그아웃시키려면 LogsOutBannedUser 미들웨어를 대신 사용하십시오.

 protected $ routeMiddleware = [
    ' logs-out-banned-user ' =>  Cog  Laravel  Ban  Http  Middleware LogsOutBannedUser::class,
]

스케줄링

기본 설치를 수행한 후 ban:delete-expired 명령을 사용하여 시작할 수 있습니다. 대부분의 경우 만료된 금지 및 금지 해제 모델을 삭제해야 할 때마다 수동으로 실행할 필요가 없도록 이러한 명령을 예약할 수 있습니다.

이 명령은 다른 명령과 마찬가지로 Laravel의 콘솔 커널에서 예약할 수 있습니다.

 // app/Console/Kernel.php

protected function schedule ( Schedule $ schedule )
{
    $ schedule -> command ( ' ban:delete-expired ' )-> everyMinute ();
}