Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glorand/laravel-model-settings
Model Settings for your Laravel app
https://github.com/glorand/laravel-model-settings
eloquent-models laravel laravel-settings settings trait
Last synced: about 1 month ago
JSON representation
Model Settings for your Laravel app
- Host: GitHub
- URL: https://github.com/glorand/laravel-model-settings
- Owner: glorand
- License: mit
- Created: 2018-12-28T07:37:42.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-18T17:49:32.000Z (5 months ago)
- Last Synced: 2024-09-08T16:43:55.512Z (4 months ago)
- Topics: eloquent-models, laravel, laravel-settings, settings, trait
- Language: PHP
- Size: 110 KB
- Stars: 781
- Watchers: 12
- Forks: 55
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Model Settings for your Laravel app
The package requires PHP 8.1+ and follows the FIG standards PSR-1, PSR-2, PSR-4 and PSR-12
to ensure a high level of interoperability between shared PHP.
Bug reports, feature requests, and pull requests can be submitted by following our [Contribution Guide](CONTRIBUTING.md).
## Table of contents
- [Installation](#installation)
- [Updating your Eloquent Models](#update_models)
- [Option 1 - `HasSettingsField` trait](#update_models_1)
- [Option 2 - `HasSettingsTable` trait](#update_models_2)
- [Option 3 - `HasSettingsRedis` trait](#update_models_3)
- [Default Settings](#default_settings)
- [Usage](#usage)
- [Check if the settings for the entity is empty (exist)](#empty)
- [Check settings (exist)](#exist)
- [Get all model's settings](#get_all)
- [Get a specific setting](#get)
- [Add / Update setting](#add_update)
- [Check if the model has a specific setting](#check)
- [Remove a setting from a model](#remove)
- [Persistence](#persistence)
- [Using another method name other than `settings()`](#invokeSettingsBy)
- [Validation system for settings data](#validation)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [License](#license)
## Installation
```shell
$ composer require glorand/laravel-model-settings
```
```
{
"require": {
"glorand/laravel-model-settings": "^4.0"
}
}
```
## Env (config) variables **(.env file)**
Default name for the settings field - when you use the `HasSettingsField`
`MODEL_SETTINGS_FIELD_NAME=settings`
Default name for the settings table - when you use the `HasSettingsTable`
`MODEL_SETTINGS_TABLE_NAME=model_settings`
## Updating your Eloquent Models
Your models should use the `HasSettingsField` or `HasSettingsTable` trait.
#### Option 1 - `HasSettingsField` trait
Run the `php artisan model-settings:model-settings-field` in order to create a migration file for a table.\
This command will create a json field (default name `settings`, from config) for the mentioned table.
You can choose another than default, in this case you have to specify it in you model.
```php
public $settingsFieldName = 'user_settings';
```
Complete example:
```php
use Glorand\Model\Settings\Traits\HasSettingsField;
class User extends Model
{
use HasSettingsField;
//define only if you select a different name from the default
public $settingsFieldName = 'user_settings';
//define only if the model overrides the default connection
protected $connection = 'mysql';
}
```
#### Option 2 - `HasSettingsTable` trait
Run before the command `php artisan model-settings:model-settings-table`.\
The command will copy for you the migration class to create the table where the setting values will be stored.\
The default name of the table is `model_settings`; change the config or env value `MODEL_SETTINGS_TABLE_NAME` if you want to rewrite the default name (**before you run the command!**)
```php
use Glorand\Model\Settings\Traits\HasSettingsTable;
class User extends Model
{
use HasSettingsTable;
}
```
#### Option 3 - `HasSettingsRedis` trait
```php
use Glorand\Model\Settings\Traits\HasSettingsRedis;
class User extends Model
{
use HasSettingsRedis;
}
```
You can set default configs for a table in model_settings.php config file
```php
return [
// start other config options
// end other config options
// defaultConfigs
'defaultSettings' => [
'users' => [
'key_1' => 'val_1',
]
]
];
```
Or in your model itself:
```php
use Glorand\Model\Settings\Traits\HasSettingsTable;
class User extends Model
{
public $defaultSettings = [
'key_1' => 'val_1',
];
}
```
> Please note that if you define settings in the model, the settings from configs will have no effect, they will just be ignored.
```php
$user = App\User::first();
```
#### Check if the settings for the entity is empty
```php
$user->settings()->empty();
```
#### Check settings (exist)
```php
$user->settings()->exist();
```
#### Get all model's settings
```php
$user->settings()->all();
$user->settings()->get();
```
#### Get a specific setting
```php
$user->settings()->get('some.setting');
$user->settings()->get('some.setting', 'default value');
//multiple
$user->settings()->getMultiple(
[
'some.setting_1',
'some.setting_2',
],
'default value'
);
```
#### Add / Update setting
```php
$user->settings()->apply((array)$settings);
$user->settings()->set('some.setting', 'new value');
$user->settings()->update('some.setting', 'new value');
//multiple
$user->settings()->setMultiple([
'some.setting_1' => 'new value 1',
'some.setting_2' => 'new value 2',
]);
```
#### Check if the model has a specific setting
```php
$user->settings()->has('some.setting');
```
#### Remove a setting from a model
```php
$user->settings()->delete('some.setting');
//multiple
$user->settings()->deleteMultiple([
'some.setting_1',
'some.setting_2',
]);
//all
$user->settings()->clear();
```
#### Persistence for settings field
In case of field settings the auto-save is configurable.
**The ``default`` value is ``true``**
- Use an attribute on model
```php
protected $persistSettings = true; //boolean
```
- Environment (.env) variable
```dotenv
MODEL_SETTINGS_PERSISTENT=true
```
- Config value - model settings config file
```php
'settings_persistent' => env('MODEL_SETTINGS_PERSISTENT', true),
```
If the persistence is `false` you have to save the model after the operation.
### Using another method name other than `settings()`
If you prefer to use another name other than `settings` ,
you can do so by defining a `$invokeSettingsBy` property.
This forward calls (such as `configurations()`) to the `settings()` method.
### Validation system for settings data
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## License
The MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
## Related Stuff
- [LaraNews - Laravel Model Settings](https://laravel-news.com/laravel-model-settings)
- [made with Laravel - Laravel Model Settings](https://madewithlaravel.com/laravel-model-settings)