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.
composer require robtrehy/laravel-user-preferences
to include this in your project.php artisan vendor:publish --provider="RobTrehy\LaravelUserPreferences\UserPreferencesServiceProvider" --tag="config"
config/user-preferences.php
.preferences
column to the database. A migration file is included, just run the following command
php artisan vendor:publish --provider="RobTrehy\LaravelUserPreferences\UserPreferencesServiceProvider" --tag="migrations" && php artisan migrate
This will add the column defined in your configuration file to the table defined in your configuration file.
Open config/user-preferences.php
to adjust the packages configuration.
If this file doesn't exist, run
php artisan vendor:public --provider="RobTrehy\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.
Laravel User Preferences uses the Laravel Cache driver to reduce the number of queries on your database. By default Laravel Caches using the file
driver. If you wish to disable this, you can use the null
driver.
The cache key supplied by Laravel User Preferences adds a prefix and suffix to the user's id
. You can supply your own prefix and suffix by changing the cache.prefix
and cache.suffix
configuration values.
In the defaults
array you can set your default values for user preferences.
'database' => [
'table' => 'users',
'column' => 'preferences',
'primary_key' => 'id'
],
'cache' => [
'prefix' => 'user-',
'suffix' => '-preferences',
],
'defaults' => [
'theme' => 'blue',
'show_welcome' => true
]
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
.
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.
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
Use this method to get the value of a preference for the currently authenticated user.
UserPreferences::get(string [setting]);
Use this method to get all of the currently authenticated user's preferences
UserPreferences::all()
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.
All preferences are saved automatically when UserPreferences::set();
is called.
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
This Laravel package is free software distributed under the terms of the MIT license. See LICENSE