Download the PHP package rennokki/eloquent-settings without Composer
On this page you can find all versions of the php package rennokki/eloquent-settings. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rennokki/eloquent-settings
More information about rennokki/eloquent-settings
Files in rennokki/eloquent-settings
Package eloquent-settings
Short Description Eloquent Settings allows you to bind key-value pairs to any Laravel Eloquent model. It supports even casting for boolean, float or integer types.
License Apache-2.0
Homepage https://github.com/renoki-co/eloquent-settings
Informations about the package eloquent-settings
Laravel Eloquent Settings
Eloquent Settings allows you to bind key-value pairs to any Laravel Eloquent model.
🤝 Supporting
If you are using one or more Renoki Co. open-source packages in your production apps, in presentation demos, hobby projects, school projects or so, sponsor our work with Github Sponsors. 📦
🚀 Installation
Install the package:
Publish the config:
Publish the migrations:
🙌 Usage
You can add the HasSettings
trait to any Eloquent model:
Adding settings
By default, settings' values are stored as string
. Later, if you try to get them with cast, they will return the value you have initially stored.
If you store 'true' as a string, if you cast it to a boolean, you'll get true
.
If you plan to store it with cast type other than string
, you can pass an additional third parameter that can be either string
, boolean
, bool
, int
, integer
, float
or double
.
Updating settings
Updating settings can be either to values, cast types or both, depending on what has changed.
If you don't specify a cast parameter, it will not change, only the value will change, or viceversa.
Getting settings & values
You can get the Setting instance, not the value using getSetting()
:
If you plan to get the value, you can use getSettingValue()
:
Remember, when you update or create a new setting, the cast type is stored. By default, next time you don't have to call the cast parameter again because it will cast it the way it was specified on storing.
Getting values of not-known settings keys, you will return null
.
Deleting a setting
Deleting settings from the database can be done using deleteSetting()
.
To delete all settings, call deleteSettings()
.
🐛 Testing
🤝 Contributing
Please see CONTRIBUTING for details.
🔒 Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
🎉 Credits
- Alex Renoki
- All Contributors