Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/renoki-co/eloquent-settings
Eloquent Settings allows you to bind key-value pairs to any Laravel Eloquent model. It supports even casting for boolean, float or integer types.
https://github.com/renoki-co/eloquent-settings
eloquent eloquent-settings key laravel pair php setting settings value
Last synced: 6 days ago
JSON representation
Eloquent Settings allows you to bind key-value pairs to any Laravel Eloquent model. It supports even casting for boolean, float or integer types.
- Host: GitHub
- URL: https://github.com/renoki-co/eloquent-settings
- Owner: renoki-co
- License: apache-2.0
- Created: 2018-05-29T11:55:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T23:27:55.000Z (10 months ago)
- Last Synced: 2024-05-01T18:12:39.078Z (9 months ago)
- Topics: eloquent, eloquent-settings, key, laravel, pair, php, setting, settings, value
- Language: PHP
- Homepage:
- Size: 156 KB
- Stars: 80
- Watchers: 4
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Laravel Eloquent Settings
=========================
[](https://codecov.io/gh/renoki-co/eloquent-settings/branch/master)
[](https://github.styleci.io/repos/135289030)
[](https://packagist.org/packages/rennokki/eloquent-settings)
[](https://packagist.org/packages/rennokki/eloquent-settings)
[](https://packagist.org/packages/rennokki/eloquent-settings)
[](https://packagist.org/packages/rennokki/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](https://github.com/sponsors/rennokki). 📦**
[
](https://github-content.renoki.org/github-repo/24)
## 🚀 Installation
Install the package:
```bash
$ composer require rennokki/eloquent-settings
```
Publish the config:
```bash
$ php artisan vendor:publish --provider="Rennokki\Settings\SettingsServiceProvider" --tag="config"
```
Publish the migrations:
```bash
$ php artisan vendor:publish --provider="Rennokki\Settings\SettingsServiceProvider" --tag="migrations"
```
## 🙌 Usage
You can add the `HasSettings` trait to any Eloquent model:
```php
use Rennokki\Settings\Traits\HasSettings;
class User extends Model {
use HasSettings;
...
}
```
## Adding settings
```php
$user->newSetting('subscribed.to.newsletter', 1);
$user->newSetting('subscribed.to.newsletter', true);
```
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`.
```php
$user->newSetting('subscribed.to.newsletter', true, 'bool');
```
## Updating settings
Updating settings can be either to values, cast types or both, depending on what has changed.
```php
$user->updateSetting('subscribed.to.newsletter', false, 'bool');
```
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()`:
```php
$user->getSetting('subscribed.to.newsletter'); // does not accept a cast
```
If you plan to get the value, you can use `getSettingValue()`:
```php
$user->getSettingValue('subscribed.to.newsletter'); // true, as boolean
$user->getSettingValue('subscribed.to.newsletter', 'int'); // 1, as integer
```
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.
```php
$user->newSetting('is.cool', true, 'bool');
$user->getSettingValue('is.cool'); // it returns true as boolean
```
Getting values of not-known settings keys, you will return `null`.
```php
$user->getSettingValue('subscribed.to.weekly.newsletter'); // null
```
## Deleting a setting
Deleting settings from the database can be done using `deleteSetting()`.
```php
$user->deleteSetting('subscribed.to.newsletter');
```
To delete all settings, call `deleteSettings()`.
```php
$user->deleteSettings();
```
## 🐛 Testing
``` bash
vendor/bin/phpunit
```
## 🤝 Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## 🔒 Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## 🎉 Credits
- [Alex Renoki](https://github.com/rennokki)
- [All Contributors](../../contributors)