klongchu / laravel-session-out
Notify the user via modal if session expired
This package is auto-updated.
Last update: 2024-10-25 14:31:43 UTC
README
If for any reason ( user logged out intentionally / session lifetime expired / session flushed for all logged in devices of the user ) the authentication session doesn't exist & still the user is on a page or multiple pages which require the user to be logged in, then showing a message that
authentication session no longer available & to continue your current activity ( may be in the middle of posting an unsaved post etc. ), you are advised to login again
and right after user logged in then hiding the message is all about this package.
📥 Installation
You can install the package via composer:
composer require klongchu/laravel-session-out
Laravel 5.5+ users: this step may be skipped, as we can auto-register the package with the framework.
// Add the ServiceProvider to the providers array in // config/app.php 'providers' => [ '...', 'klongchu\sessionout\sessionExpiredServiceProvider::class', ];
You need to publish the blade
, js
, css
and config
files included in the package using the following artisan command:
php artisan vendor:publish --provider="klongchu\sessionout\sessionExpiredServiceProvider"
⚗️ Usage
just include the blade file to all the blade views which are only available to authenticated users.
@include('vendor.sessionout.notify')
rather copying this line over & over to the views, extend your base blade view and include it there in the bottom
🛠 Configuration
✔ The Config File
publishing the vendor will create config/expiredsession.php
file
return [ // the number of seconds between ajax hits to check auth session 'gap_seconds' => 30, // whether using broadcasting feature to make the modal disappear faster 'avail_broadcasting' => false,
✔ If you want to take advantage of broadcasting
** if you are using
avail_broadcasting = true
i.e. want to use the Laravel Echo for faster output please follow the below steps
- setup broadcasting for your app
and start
usersession
queue worker
php artisan queue:work --queue=default,usersession
- make sure to put the broadcasting client config
js
file above the@include
line not below it, in your blade view.
<script type="text/javascript" src="{{ asset('js/broadcasting.js') }}"></script> //some html between @include('vendor.sessionout.notify')
- in
App\Providers\BroadcastServiceProvider
file in theboot
method require the package's channel file, it contains private channel authentication
require base_path('vendor/klongchu/laravel-session-out/src/routes/channels.php');
- in all the places from where users are authenticated call
klongchu\sessionout\classes\AuthState::sessionAvailable()
. if you are using custom logic to login users then put the line inside your authentication method when login is successful.if you are using laravel's default authentication system then better choice will be to create a listener of the login event, Example :-
// App\Providers\EventServiceProvider protected $listen = [ 'Illuminate\Auth\Events\Login' => [ 'App\Listeners\SuccessfulLogin', ], ];
// App\Listeners\SuccessfulLogin use klongchu\sessionout\classes\AuthState; /** * Handle the event. * * @param Login $event * @return void */ public function handle(Login $user) { AuthState::sessionAvailable(); }
✔ Update the modal design & contents
The modal is created with pure js
and css
no framework has been used, so you can easily customize the modal contents by editing the views/vendor/sessionout/modal.blade.php
& the design by editing public/vendor/sessionout/css/session-modal.css
✔ Advanced
-
🔘 if you want to customize the
js
file which is responsible for checking auth session & modal display then modify thepublic/vendor/sessionout/js/main.js
file but don't forget to compile it with webpack & place the compiledjs
aspublic/vendor/sessionout/dist/js/main.js
-
🔘 you may want to create a login form in the modal, first create the html form in the
views/vendor/sessionout/modal.blade.php
then put the ajax code inpublic/vendor/sessionout/js/main.js
& don't forget to compile as mentioned above,after ajax success close the modal by calling the
closeSessionOutModal()
function
🧐📑 Note
♻ When updating the package
Remember to publish the assets
, views
and config
after each update
use --force
tag after updating the package to publish the updated latest package assets
, views
and config
but remember using --force tag will replace all the publishable files
php artisan vendor:publish --provider="klongchu\sessionout\sessionExpiredServiceProvider" --force php artisan vendor:publish --provider="klongchu\sessionout\sessionExpiredServiceProvider" --tag=public --force
when updating the package take backup of the
config/expiredsession.php
file &public/vendor/sessionout
,views/vendor/sessionout
directories as the files inside these dir. are configurable so if you modify the files then the updated published files will not contain the changes, though after publishing theassets
,views
andconfig
you may again modify the files
🔧 After you tweak things
Run this artisan command after changing the config file.
php artisan config:clear php artisan queue:restart // only when using broadcasting
👋🏼 Say Hi!
Let me know in Twitter | Facebook if you find this package useful 👍🏼
🎀 License
The MIT License (MIT). Please see License File for more information.