Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/visual-ideas/laravel-site-settings
Easy laravel cached settings (stored in MYSQL) package with MoonShine/Filament Laravel Admin GUI
https://github.com/visual-ideas/laravel-site-settings
filament filamentphp laravel laravel-admin moonshine mysql php settings
Last synced: about 9 hours ago
JSON representation
Easy laravel cached settings (stored in MYSQL) package with MoonShine/Filament Laravel Admin GUI
- Host: GitHub
- URL: https://github.com/visual-ideas/laravel-site-settings
- Owner: visual-ideas
- License: mit
- Created: 2022-12-11T11:12:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-26T18:05:04.000Z (9 months ago)
- Last Synced: 2024-11-09T00:52:57.706Z (10 days ago)
- Topics: filament, filamentphp, laravel, laravel-admin, moonshine, mysql, php, settings
- Language: PHP
- Homepage:
- Size: 94.7 KB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Easy laravel cached settings
Easy laravel cached settings (stored in MYSQL) package with MoonShine/Filament Laravel Admin GUI
[](https://packagist.org/packages/visual-ideas/laravel-site-settings)
[](https://packagist.org/packages/visual-ideas/laravel-site-settings)
## Installation
You can install the package via composer:
```bash
composer require visual-ideas/laravel-site-settings
```
You must run the migrations with:
```bash
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --provider="VI\LaravelSiteSettings\LaravelSiteSettingsProvider" --tag="config"
```
This is the contents of the published config file:
```php
return [
'cache_key' => env('LSS_CACHE_KEY','laravel_site_settings_data'),
// Set to true if you're using Filament (https://filamentphp.com/)
'filament' => false,
];
```
## Usage
You can use this package as default laravel config() function!
```php
function settings($key = null, $default = null)
{
if (is_null($key)) {
return app('Settings')->all();
}
if (is_array($key)) {
return app('Settings')->set($key);
}
return app('Settings')->get($key, $default);
}
```
or Blade directive @settings
```php
@settings('group.setting')
```
For PHPStorm you can set this blade directive with [This instruction](https://www.jetbrains.com/help/phpstorm/blade-page.html)
or as part of native Laravel config()
```php
@config('settings.group.setting')
```
Not working in console!
## Update settings
You can use models VI\LaravelSiteSettings\Models\SettingGroup and VI\LaravelSiteSettings\Models\Setting
or set settings values with the settings() function:
```php
settings(['group.setting' => 'Value']);
settings(['setting' => 'Value']);
```
## Usage with MoonShine Laravel Admin panel
Please see [MoonShine](https://moonshine.cutcode.ru/)
You can use settings in your MoonShine admin panel, like this:
```php
MenuGroup::make('Settings', [
MenuItem::make(
'Setting groups',
new \VI\LaravelSiteSettings\MoonShine\Resources\SettingGroupResource(),
'heroicons.outline.wrench-screwdriver'
),
MenuItem::make(
'Settings',
new \VI\LaravelSiteSettings\MoonShine\Resources\SettingResource(),
'heroicons.outline.wrench'
),
], 'heroicons.outline.cog-8-tooth'),
```
## Usage with Filament Laravel Admin panel
Please see [Filament](https://filamentphp.com)
You can use settings in your Filament admin panel!
Just change config file:
```php
//...
// Set to true if you're using Filament (https://filamentphp.com/)
'filament' => true,
//...
```
## Seeding settings
I recommend saving the settings in the seeders using the [orangehill/iseed](https://github.com/orangehill/iseed) package:
```bash
php artisan iseed setting_groups,settings
```
But you can use seeder or migration to set your settings
```php
settings([
['group.setting1' => 'Value1'],
['group.setting2' => 'Value2'],
['group.setting3' => 'Value3'],
['setting1' => 'Value4'],
['setting2' => 'Value5'],
['setting3' => 'Value6'],
['setting4' => 'Value7'],
['setting5' => 'Value8']
]);
```
## Credits
- [Alex](https://github.com/alexvenga)
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.