-
Notifications
You must be signed in to change notification settings - Fork 27
feat: add batch setting operations #161
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
memleakd
wants to merge
3
commits into
codeigniter4:develop
Choose a base branch
from
memleakd:feat/batch-setting-operations
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,13 +30,32 @@ when retrieved. | |
| service('settings')->set('App.siteName', 'My Great Site'); | ||
| ``` | ||
|
|
||
| You can save multiple values with `setMany()`. This behaves like calling `set()` for each key/value pair, | ||
| but allows supported handlers to persist the changes more efficiently. | ||
|
|
||
| ```php | ||
| service('settings')->setMany([ | ||
| 'App.siteName' => 'My Great Site', | ||
| 'App.siteEmail' => '[email protected]', | ||
| ]); | ||
| ``` | ||
|
|
||
| You can delete a value from the persistent storage with the `forget()` method. Since it is removed from the storage, | ||
| it effectively resets itself back to the default value in config file, if any. | ||
|
|
||
| ```php | ||
| service('settings')->forget('App.siteName'); | ||
| ``` | ||
|
|
||
| You can delete multiple values with `forgetMany()`. | ||
|
|
||
| ```php | ||
| service('settings')->forgetMany([ | ||
| 'App.siteName', | ||
| 'App.siteEmail', | ||
| ]); | ||
| ``` | ||
|
|
||
| If you ever need to completely remove all settings from their persistent storage, you can use the `flush()` method. This immediately removes all settings from the database and the in-memory cache. | ||
|
|
||
| ```php | ||
|
|
@@ -62,6 +81,16 @@ $context = 'user:' . user_id(); | |
| service('settings')->set('App.theme', 'dark', $context); | ||
| ``` | ||
|
|
||
| The same context can be applied to a batch of values: | ||
|
|
||
| ```php | ||
| $context = 'user:' . user_id(); | ||
| service('settings')->setMany([ | ||
| 'App.theme' => 'dark', | ||
| 'App.locale' => 'en', | ||
| ], $context); | ||
| ``` | ||
|
|
||
| Now when your filter is determining which theme to apply it can check for the current user as the context: | ||
|
|
||
| ```php | ||
|
|
@@ -91,9 +120,17 @@ setting('App.siteName', 'My Great Site'); | |
| // Using the service through the helper | ||
| $name = setting()->get('App.siteName'); | ||
| setting()->set('App.siteName', 'My Great Site'); | ||
| setting()->setMany([ | ||
| 'App.siteName' => 'My Great Site', | ||
| 'App.siteEmail' => '[email protected]', | ||
| ]); | ||
|
|
||
| // Forgetting a value | ||
| setting()->forget('App.siteName'); | ||
| setting()->forgetMany([ | ||
| 'App.siteName', | ||
| 'App.siteEmail', | ||
| ]); | ||
| ``` | ||
|
|
||
| !!! Note | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.