ersee/laravel-setting

Global setting module for Laravel application.

0.2.0 2021-03-30 09:12 UTC

Requires

• php: ^7.2|^8.0
• laravel/framework: ^6.0|^7.0|^8.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.18
• orchestra/testbench: ^4.0|^5.0|^6.0

MIT

• ersee

• laravel
• setting
• laravel-setting

README

Global setting package for Laravel application.

Installation

composer require ersee/laravel-setting -vvv

Publish config:

php artisan vendor:publish --provider="Ersee\LaravelSetting\Providers\SettingServiceProvider"

Run migrations:

php artisan migrate

Usage

• Facade

// get all
\Setting::all(); // array

// check exists
\Setting::has('key'); // bool

// get
\Setting::get('key'); // default null
\Setting::get('key', 'default'); 
\Setting::get(['key1', 'key2']); // default null
\Setting::get(['key1' => 'default1', 'key2' => 'default2']);

// set
\Setting::set('key', 'value');
\Setting::set(['key1' => 'value1', 'key2' => 'value2']);

// set datatype
\Setting::set('key', 100); // int
\Setting::set('key', 100.123); // float
\Setting::set('key', 'string'); // string
\Setting::set('key', true); // bool
\Setting::set('key', ['ka' => 'va', 'kb' => 'vb']); // array
\Setting::set('key', new \DateTime()); // object

// increment or decrement
\Setting::increment('key');
\Setting::increment('key', 100);
\Setting::decrement('key');
\Setting::decrement('key', 100);

// forget
\Setting::forget('key');
\Setting::forget(['key1', 'key2']);

• Helper

// get all
setting()->all(); // array

// check exists
setting()->has('key'); // bool

// get
setting('key'); // default null
setting('key', 'default'); 
setting()->get(['key1', 'key2']); // default null
setting()->get(['key1' => 'default1', 'key2' => 'default2']);

// set
setting(['key1' => 'value1', 'key2' => 'value2']);

// set datatype
setting(['key' => 100]); // int
setting(['key' => 100.123]); // float
setting(['key' => 'string']); // string
setting(['key' => true]); // bool
setting(['key' => ['ka' => 'va', 'kb' => 'vb']]); // array
setting(['key' => new \DateTime()]); // object

// increment or decrement
setting()->increment('key');
setting()->increment('key', 100);
setting()->decrement('key');
setting()->decrement('key', 100);

// forget
setting()->forget('key');
setting()->forget(['key1', 'key2']);

Console commands

php artisan setting:all
php artisan setting:get <key>...
php artisan setting:set <key> <value>
php artisan setting:increment <key> [<value=1>]
php artisan setting:decrement <key> [<value=1>]
php artisan setting:forget <key>...

Events

• \Ersee\LaravelSetting\Events\Missed::class
• \Ersee\LaravelSetting\Events\Hit::class
• \Ersee\LaravelSetting\Events\Written::class
• \Ersee\LaravelSetting\Events\Forgotten::class

License

MIT