/laravel-multiauth

Multi Auth and admin auth in Laravel Project

Primary LanguagePHPMIT LicenseMIT

Laravel Multi Auth

Build Status Scrutinizer Code Quality Maintainability StyleCI Total Downloads GitHub license GitHub stars Latest Stable Version GitHub issues

This package is just create admin side (multi auth), which is totaly isolated from your normal auth ( which we create using php artisan make:auth )

On top of that, you can use multiple authentication types, simultaneously, so you can be logged in as a user and an admin, without conflicts!

Version Guidance

Laravel version Branch Install
5.4 5.4 composer require bitfumes/laravel-multiauth:5.4.x-dev
5.5 5.5 composer require bitfumes/laravel-multiauth:5.5.x-dev
5.6, 5.7, 5.8, 6.0 Master composer require bitfumes/laravel-multiauth
JWT Api version jwt-auth composer require bitfumes/laravel-multiauth:dev-jwtauth

Installation

Install via composer.

composer require bitfumes/laravel-multiauth

Before proceeding : you can make a normal auth, check this doc

Publish Migrations

php artisan vendor:publish --tag="multiauth:migrations"

Run the Migration to have tables in your database.

php artisan migrate

Caveat

If you have added new column to admin migration then you should need admin factory to generate first super admin via above command.

php artisan vendor:publish --tag="multiauth:factories"

First Admin

Obviously, first time you need at least one super admin to login with and then create other admins.

php artisan multiauth:seed --role=super

Now you can login your admin side by going to https://localhost:8000/admin with creadential of email = super@admin.com and password = secret Obviously you can later change these things.

Register new Admin

To register new use you need to go to https://localhost:8000/admin/register.

Keep in mind that only a Super Admin can create new Admin.

Changing admin views

You can Publish package views files and overrides with yours so that you can have views which suits your project design.

php artisan vendor:publish --tag="multiauth:views"

Validations

Yes you can write validation rules to your new columns or change existing validation rules by publishing config file.

php artisan vendor:publish --tag="multiauth:config"

Activate or Deactive admin

Now super admin can activate or deactivate other admin. This will be usefull when you want to deactivate any admin for some reason.

By default new admin is deactivate, so that you can activate him when you want.

To activate admin, just go to the proceedure of editing admin.

Change Prefix

You can change the prefix in your config file you have just published. With prefix we mean what you want to call your admin side, we call it admin you can call it whatever you want. Suppose you have changed prefix to 'master' now everywhere instead of 'admin' word, that changed to 'master'

 /*
    |--------------------------------------------------------------------------
    | Prefix
    |--------------------------------------------------------------------------
    |
    | Use prefix to before the routes of multiauth package.
    | This way you can keep your admin page secure.
    | Default : admin
    */
    'prefix' => 'admin', // can change it to, lets say 'prefix' => 'master'

Redirect after Login

You can change the redirect path after login for admin section. Just change this setting on config/multiauth.php file.

/*
    |--------------------------------------------------------------------------
    | Redirect After Login
    |--------------------------------------------------------------------------
    |
    | It will redirect to a path defined here after login.
    | You can change it to where ever you want to
    | redirect the admin after login.
    | Default : /admin/home
    */
    'redirect_after_login' => '/admin/home',

Create Roles

To create a new role you have two options:

  1. Using artisan command
php artisan multiauth:role rolename
  1. Using Interface Just go to https://localhost:8000/admin/role.

Now you can click on 'Add Role' button to create new role.

Edit or Delete Role can also be done with same interface

Publish Routes file

php artisan vendor:publish --tag="multiauth:routes"

Access Level

With Middleware

  1. You can use 'role' middleware to allow various admin for accessing certain section according to their role.
Route::get('admin/check',function(){
    return "This route can only be accessed by admin with role of Editor"
})->middleware('role:editor');

Here it does't matter if you give role as uppercase or lowercase or mixed, this package take care of all these.

  1. If you want a section to be accessed by only super user then use role:super middleware A super admin can access all lower role sections.
Route::get('admin/check',function(){
    return "This route can only be accessed by super admin"
})->middleware('role:super');

With Blade Syntax

You can simply use blade syntax for showing or hiding any section for admin with perticular role. For example, If you want to show a button for admin with role of editor then write.

@admin('editor')
    <button>Only For Editor</button>
@endadmin

If you want to add multiple role, you can do like this

@admin('editor,publisher,any_role')
    <button> This is visible to admin with all these role</button>
@endadmin

Another Auth

Apart from Admin section, you can make a another auth

This is fully compatible with laravel MustVerifyEmail trait, so that you can make user to must verify email. click here more details

php artisan multiauth:make {guard}

After you run this command you will get steps in which files has been added/changed. For Make

You can rollback this auth also if you want.

php artisan multiauth:rollback {guard}

This command will show you steps to rollback and file that has changed/removed. For Rollback

License

This package inherits the licensing of its parent framework, Laravel, and as such is open-sourced software licensed under the MIT license