solomon-ochepa / laravel-settings
Store settings as key-value pairs in the database.
Requires
- php: ^7.3|^8.0|^8.1|^8.2
- laravel/framework: ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
Requires (Dev)
- laravel/pint: ^1.16
- mockery/mockery: ^0.9.4 || ~1.0
- orchestra/testbench: 4.*|5.*|6.*|^8.0|^9.0
- phpunit/phpunit: ^8.5|^9.5.10|^10.5
README
Store settings as key-value pairs in the database.
All the settings saved in the database are cached to improve performance by reducing SQL queries to zero.
Installation
You can install the package via composer:
composer require solomon-ochepa/laravel-settings
Laravel 5.4
If you are installing on Laravel 5.4 or lower, you will need to manually register the Service Provider by adding it to the providers array and the Facade to the aliases array in config/app.php.
'providers' => [ //... Oki\Settings\SettingsServiceProvider::class ] 'aliases' => [ //... "Settings" => Oki\Settings\Facades\Settings::class ]
In Laravel 5.5 or above, the service provider automatically gets registered, and the Settings facade will be available immediately.
Get started with Settings::all().
Migration
Optionally, you can publish the migration file by running:
php artisan vendor:publish --provider="Oki\Settings\SettingsServiceProvider" --tag="migrations"
Now, run php artisan migrate to migrate the settings table.
Getting Started
You can utilize the Laravel settings package using either the helper function settings() or the facade Settings::all().
Methods
all()
-- Pass true to ignore cached settings
settings(); // or settings()->all($fresh = false); // or Settings::all($fresh = false);
get()
Get a specific setting
settings($key, $default = null); // or settings()->get($key, $default = null); // or Settings::get($key, $default = null);
my()
Get the auth() user settings.
settings()->my($key, $default = null); // or Settings::my($key, $default = null);
set()
Set a specific setting
settings([$key => $value]); // or settings()->set($key, $value); // or Settings::set($key, $value);
// Set a multiple settings
settings([$key => $value, $key2 => $value2]); // or settings()->set([ $key => $value, $key2 => $value2, ]); // or Settings::set([ $key => $value, $key2 => $value2, ]);
has()
Check if a setting key exists
settings()->has($key); // or Settings::has($key);
remove()
Remove a setting
settings()->remove($key); // or Settings::remove($key);
Groups
You can organize your settings into groups.
If you are upgrading from a previous version, don't forget to run the migration.
Initiate grouping by chaining the group() method:
// Save setting settings([$key => $value])->group($name); // Get setting settings($key)->group($name);
Settable for()
Get/set settings for a specific entity
Settings::for($settable_type, $settable_id = null)->set($key, $value) // or Settings::set($key, $value = null, $settable_type = null, $settable_id = null) // helper function settings()->for($settable_type = null, $settable_id = null)->set($key, $value = null) // or settings()->set($key, $value = null, $settable_type = null, $settable_id = null) // Example: settings()->for(User::class, auth()->id())->set('theme_mode', 'dark');
Settable user()
Bind settings to the auth user.
settings()->user()->all();
Changelog
Please see CHANGELOG for more information on what has changed recently.
Testing
The package contains some integration/smoke tests, set up with Orchestra. The tests can be run via phpunit.
$ composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security-related issues, please email solomonochepa@gmail.com instead of using the issue tracker.
Credits
- ...
About "Oki Technologies Ltd"
Oki Technologies, https://www.okitechnologies.com.ng is a dynamic IT firm dedicated to delivering cutting-edge solutions in software development and related services. With a passion for innovation and a commitment to excellence, Oki Technologies leverages the latest technologies and industry best practices to craft tailored solutions that meet the unique needs of each client.
From web and mobile application development to custom software solutions, Oki Technologies offers a comprehensive suite of services designed to empower businesses and organizations across various industries. With a team of skilled professionals, Oki Technologies combines technical expertise with creative insights to deliver high-quality, scalable, and user-friendly software solutions.
At Oki Technologies, we prioritize customer satisfaction and strive to build long-term partnerships with our clients. Our collaborative approach ensures that we understand our clients' goals and objectives, allowing us to deliver solutions that drive tangible results and add value to their businesses.
Whether you're a startup looking to launch a digital product or an established enterprise seeking to optimize your existing software infrastructure, Oki Technologies is your trusted partner for all your software development needs. Let us help you turn your ideas into reality and propel your business to new heights in the digital age.
License
The MIT License (MIT). Please see License File for more information.