22[ ![ Code Coverage] ( https://scrutinizer-ci.com/g/bavix/laravel-settings/badges/coverage.png?b=master )] ( https://scrutinizer-ci.com/g/bavix/laravel-settings/?branch=master )
33[ ![ Build Status] ( https://scrutinizer-ci.com/g/bavix/laravel-settings/badges/build.png?b=master )] ( https://scrutinizer-ci.com/g/bavix/laravel-settings/build-status/master )
44[ ![ Code Intelligence Status] ( https://scrutinizer-ci.com/g/bavix/laravel-settings/badges/code-intelligence.svg?b=master )] ( https://scrutinizer-ci.com/code-intelligence )
5+ [ ![ Mutation testing badge] ( https://badge.stryker-mutator.io/github.com/bavix/laravel-settings/master )] ( https://packagist.org/packages/bavix/laravel-settings )
56
67[ ![ Package Rank] ( https://phppackages.org/p/bavix/laravel-settings/badge/rank.svg )] ( https://packagist.org/packages/bavix/laravel-settings )
78[ ![ Latest Stable Version] ( https://poser.pugx.org/bavix/laravel-settings/v/stable )] ( https://packagist.org/packages/bavix/laravel-settings )
@@ -14,10 +15,40 @@ laravel-settings - Keep user settings easy.
1415* ** Vendor** : bavix
1516* ** Package** : laravel-settings
1617* ** Version** : [ ![ Latest Stable Version] ( https://poser.pugx.org/bavix/laravel-settings/v/stable )] ( https://packagist.org/packages/bavix/laravel-settings )
17- * ** PHP Version** : 7.1 +
18+ * ** PHP Version** : 7.2 +
1819* ** Laravel Version** : ` 5.5 ` , ` 5.6 ` , ` 5.7 ` , ` 5.8 ` , ` 6.0 `
1920* ** [ Composer] ( https://getcomposer.org/ ) :** ` composer require bavix/laravel-settings `
2021
22+ ### Usage
23+ Add the ` HasSettings ` , ` HasSetSettings ` , ` HasGetSettings ` trait and ` Settingable ` interface to model.
24+ ``` php
25+ use Bavix\Settings\Traits\HasSettings;
26+ use Bavix\Settings\Traits\HasSetSettings;
27+ use Bavix\Settings\Traits\HasGetSettings;
28+ use Bavix\Settings\Interfaces\Settingable;
29+
30+ class User extends Model implements Settingable
31+ {
32+ use HasGetSettings, HasSetSettings, HasSettings;
33+ }
34+ ```
35+
36+ Checking user settings.
37+
38+ ``` php
39+ $user = User::first();
40+ $user->getSetting('notify'); // null
41+ $user->getSettingBool('notify'); // null
42+ $user->getSettingBool('notify', false); // bool(false)
43+ ```
44+
45+ Let's save the settings.
46+
47+ ``` php
48+ (bool)$user->setSettingBool('notify', false); // bool(true)
49+ $user->getSettingBool('notify', false); // bool(false)
50+ ```
51+
2152---
2253Supported by
2354
0 commit comments