hrace009/laravel-settings

Laravel Persistent Settings

1.0.2 2024-07-17 03:39 UTC

Requires

• php: >=5.5.9
• illuminate/support: 5.*|6.*|7.*|8.*|9.*|10.*|11.*

Requires (Dev)

• illuminate/database: >=5.1 <6.0|7.*|8.*|9.*|10.*|11.*
• illuminate/events: >=4.1 <6.0|7.*|8.*|9.*|10.*|11.*
• phpunit/phpunit: 4.6.*

MIT

• Harris Yogasara

• laravel
• Settings
• persistent

README

Laravel Persistent Settings (Database + Cache)

Re-Publish new migration file

$ php artisan vendor:publish --provider="hrace009\LaravelSettings\SettingsServiceProvider" --force

And run

$ php artisan migrate

How to Install

Require this package with composer (Packagist) using the following command:

composer require hrace009/laravel-settings

or modify your composer.json:

   "require": {
      "hrace009/laravel-settings": "1.*"
   }

then run composer update:

After updating composer, Register the ServiceProvider to the providers array in config/app.php

'hrace009\LaravelSettings\SettingsServiceProvider',

Add an alias for the facade to aliases array in your config/app.php

'Settings'  => hrace009\LaravelSettings\Facades\Settings::class,

Publish the config and migration files now (Attention: This command will not work if you don't follow previous instruction):

$ php artisan vendor:publish --provider="hrace009\LaravelSettings\SettingsServiceProvider" --force

Change config/settings.php according to your needs. If you change db_table, don't forget to change the table's name in the migration file as well.

Create the settings table.

$ php artisan migrate

How to Use it?

Set a value

Settings::set('key', 'value');

Get a value

$value = Settings::get('key');

Get a value with Default Value.

$value = Settings::get('key', 'Default Value');

Note: If key is not found (null) in cache or settings table, it will return default value

Get a value via an helper

$value = settings('key');
$value = settings('key', 'default value');

Forget a value

Settings::forget('key');

Forget all values

Settings::flush();

Fallback to Laravel Config (available in v1.0.1)

How to activate?

// Change your config/settings.php
'fallback'   => true

Example

/* 
 * If the value with key => mail.host is not found in cache or DB of Larave Settings
 * it will return same value as config::get('mail.host');
 */     
Settings::get('mail.host');

Note: It will work if default value in laravel setting is not set

Changelogs

v1.0.1 - Dec 4th, 2021

• Second Release

v1.0.0 - Dec 1st, 2021

• First Release

To Do

License

The Laravel 5 Persistent Settings is open-sourced software licensed under the MIT license