laravel banダウンロード - laravel banソースコードのダウンロード

laravel ban

その他のカテゴリー

4.9.0

ダウンロード

ララベル禁止

コグ-laravel-ban

導入

Laravel Ban は、Eloquent モデルの禁止の管理を簡素化します。あらゆるモデルを数分で禁止可能にします!

使用例はユーザーモデルに限定されず、組織、チーム、グループなど、あらゆる Eloquent モデルが禁止される可能性があります。

コンテンツ

特徴
インストール
使用法
- 禁止モデルの準備
- 禁止モデルデータベーステーブルの準備
- 利用可能な方法
- スコープ
- イベント
- ミドルウェア
- スケジュール設定
統合
変更履歴
アップグレード中
貢献する
テスト
安全
貢献者
代替案
ライセンス
サイバーコグについて

特徴

モデルには多くの禁止が設定される場合があります。
論理的に削除されたレコードとして履歴に保存されていた禁止を削除しました。
ロジックの大部分は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 ();

スコープの自動適用

クエリスコープを常に適用するには、禁止可能モデルで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 ();
}