larapacks/setting

Persistent Laravel configuration settings.

Setting

, _(*1)

Description

Setting is an easy, encrypted & cached, database key => value store for your laravel application., _(*2)

Requirements

• PHP >= 7.2
• Laravel >= 6.0

Installation

Run the following command:, _(*3)

composer require larapacks/setting

Note: The service provider and Setting facade are registered automatically., _(*4)

Once that's complete, publish the migration and configuration file using:, _(*5)

php artisan vendor:publish --tag="setting"

Then run php artisan migrate., _(*6)

Usage

Note: All usage below can be accessed via the helper method setting()., _(*7)

Setting a value:, _(*8)

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

Setting multiple values:, _(*9)

Setting::set([
    'key.1' => 'value',
    'key.2' => 'value',
    'key.3' => 'value',
]);

Retrieving a value:, _(*10)

$value = Setting::get('key.1');

dd($value); // Returns 'value'

Retrieving a value or return default value if it doesn't exist:, _(*11)

$value = Setting::get('non-existent-key', 'default');

dd($value); // Returns 'default'

Retrieving the Setting model for a particular key:, _(*12)

$model = Setting::find('key.1');

dd($model); // Reurns instance of Model (your configured model).

Retrieving all keys with values:, _(*13)

Setting::set([
    'key.1' => 'value',
    'key.2' => 'value',
    'key.3' => 'value',
]);

$settings = Setting::all();

dd($settings);

// Returns:
// array [
//  'key.1' => 'value',
//  'key.2' => 'value',
//  'key.3' => 'value',
// ]

Retrieving the your configured Setting model:, _(*14)

$model = Setting::model();

$setting = new $model();

$setting->key = 'key';
$setting->value = 'value';

$setting->save();

Determining if a setting exists:, _(*15)

if (Setting::has('key')) {
    // The setting exists.
}

Flipping a boolean setting:, _(*16)

Setting::set('notifications', true);

// Disable notifications.
Setting::flip('notifications');

dd(Setting::get('notifications')); // Returns false.

// Enable notifications.
Setting::flip('notifications');

dd(Setting::get('notifications')); // Returns true.

// Default flip setting:
Setting::flip('new-key');

dd(Setting::get('new-key')); // Retuns true.

Enabling a boolean setting:, _(*17)

Setting::set('notifications', false);

Setting::enable('notifications');

dd(Setting::get('notifications')); // Returns true.

Disabling a boolean setting:, _(*18)

Setting::set('notifications', true);

Setting::disable('notifications');

dd(Setting::get('notifications')); // Returns false.

Using your own model

To use your own model, change the model configuration option in your config/settings.php file., _(*19)

When you create your own model, be sure to include the trait: Larapacks\Setting\Traits\SettingTrait:, _(*20)

namespace App;

use Larapacks\Setting\Traits\SettingTrait;

class Setting extends Model
{
    use SettingTrait;
}

Encryption

Encryption can be enabled or disabled in the published configuration file. By default, it is enabled., _(*21)

Encryption is performed by laravel's included helper methods encrypt() and decrypt()., _(*22)

You can enable or disable encryption at any time, however upon disabling encryption you will receive the raw encrypted string for settings that have previously been encrypted., _(*23)