fefo-p / laravel-user-preferences
A package for Laravel to store user preferences for your project.
Requires
- php: ^8.0
- doctrine/dbal: ^3.0
- laravel/framework: ^8.0
Requires (Dev)
- nunomaduro/collision: ^5.3
- orchestra/testbench: ^6.16
- phpunit/phpunit: ^9.3
- squizlabs/php_codesniffer: ^3.5
README
Forked from RobTrehy/LaravelUserPreferences
This is a package for Laravel that can be used to store and access preferences of the currently authenticated user.
The preferences are stored as JSON in a single database column. The default configuration stores this alongside the user record in
the users
table.
Installation
- Run
composer require fefo-p/laravel-user-preferences
to include this in your project. - Publish the config file with the following command
php artisan vendor:publish --provider="FefoP\LaravelUserPreferences\UserPreferencesServiceProvider" --tag="config"
- Modify the published configuration file to your requirements. The file is located at
config/user-preferences.php
. - Add the
preferences
column to the database. A migration file is included, just run the following command
This will add the column defined in your configuration file to the table defined in your configuration file.php artisan vendor:publish --provider="FefoP\LaravelUserPreferences\UserPreferencesServiceProvider" --tag="migrations" && php artisan migrate
Configuration
Open config/user-preferences.php
to adjust the packages configuration.
If this file doesn't exist, run
php artisan vendor:public --provider="FefoP\LaravelUserPreferences\UserPreferencesServiceProvider" --tag="config"
to create the default configuration file.
Set table
, column
, and primary_key
to match your requirements. primary_key
should be the users id.
In the defaults
array you can set your default values for user preferences.
Example configuration
'database' => [ 'table' => 'users', 'column' => 'preferences', 'primary_key' => 'id' ], 'defaults' => [ 'theme' => 'blue', 'show_welcome' => true ]
Usage
Set a preference
Use this method to set a preference for the currently authenticated user
UserPreferences::set(string [setting], [value]);
If a default preference value is set in the config file, the new value must match the type of the default value.
If no default value exists, any value type can be saved. If the default value type is not matched
UserPreferences::save()
will return an InvalidArgumentException
.
Reset all default preferences
Use this method to reset the currently authenticated user to the default preferences found in the config file.
UserPreferences::setDefaultPreferences();
Note: This will not adjust user preferences that do not contain a default value in the config file.
Reset a specific default preference
Use this method to reset a single preference, for the currently authenticated user, to the default value found in your config file, if it exists. If no default value is set in the config file, the preference will be removed from the currently authenticated user's record.
UserPreferences::reset(string [setting]);
This method will return true
if a default value was set from the config file.
If no default value was found, this method will return false
Get a preference
Use this method to get the value of a preference for the currently authenticated user.
UserPreferences::get(string [setting]);
Get all preferences
Use this method to get all of the currently authenticated user's preferences
UserPreferences::all()
Check if a user has a specific preference
To check if the currently authenticated user has a specific preference set, you can call
UserPreferences::has(string [setting]);
This will return true
if a value was found, false
if not.
Save a preference
All preferences are saved automatically when UserPreferences::set();
is called.
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.
License
This Laravel package is free software distributed under the terms of the MIT license. See LICENSE
Local testing of this package
Add the following to composer.json
"repositories": [ { "type": "path", "url": "relative_path_to_package_sources" } ]