Download the PHP package creode/laravel-account-approval without Composer
On this page you can find all versions of the php package creode/laravel-account-approval. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download creode/laravel-account-approval
More information about creode/laravel-account-approval
Files in creode/laravel-account-approval
Package laravel-account-approval
Short Description A Laravel package which provides basic functionality for users to require account approval after registration.
License MIT
Homepage https://github.com/creode-modules/laravel-account-approval
Informations about the package laravel-account-approval
Laravel Account Approval
A Laravel package which provides basic functionality for users to require account approval after registration.
Installation
You can install the package via composer:
Migrations
You can publish and run the migrations with:
Configuration
You can publish the config file with:
Thie following options are available in the config file:
users_table
- The name of the users table in the database. Defaults tousers
.account_not_verified_message
- The message shown flashed to session when an account is not verified. Defaults toYour account has not been verified. Please check your email for a verification link.
.
Middleware
In order to prevent users from accessing the site until they have been approved, the AccountActivated
middleware should be added to the web
middleware group in app/Http/Kernel.php
:
This middleware will run on every request, detect if the user is logged in and if they are not approved, redirect them to the login
route. This route can be configured in the config/account-approval.php
file.
Extending Middleware
If you need to execute some custom functionality for the current website you can extend the AccountActivated
middleware and override the accountNotActivated
method. This will allow you to execute your custom functionality. The unverifiedAccountRedirect
function can also be overridden to allow you to redirect to a custom route and set your own messaging/functionality.
Usage
Following package installation, running the migrations command will add an activated
column to the users table. This defaults to false
for all users. It is assumed this is the best configuration to get a site up and running quickly.
Alternatively, running the seeder provided in this module will set all existing users to be approved. This can be run with the following command:
This will resolve the default authentication model and set the activated flag to true
for all users.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Creode
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-account-approval with dependencies
spatie/laravel-package-tools Version ^1.14.0
illuminate/contracts Version ^10.0 | ^11.0