(DX) Civi::contactSettings - Add a facade for working with the logged-in user's settings #12879
Conversation
This file contains 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
…-in user's settings
Before
------
To read/write a setting for the logged-in user, you need a snippet like this:
```php
$cid = CRM_Core_Session::getLoggedInContactID();
$myFilter = Civi::service('settings_manager')
->getBagByContact(NULL, $cid)
->get('activity_tab_filter');
```
After
-----
To read/write a setting for the logged-in user, you can use a snippet like this:
```php
$myFilter = Civi::contactSettings()->get('activity_tab_filter');
```
Technical Details
-----------------
* A convenience function like this is liable to be used in lazy circumstances where
the developer is unlikely to check their conditions carefully. Therefore, the
errors are reported as exceptions so that mistakes are easiliy revealed.
* This is technically a small contract change to `SettingsManager::getBagByContact()`
because it now interprets `$contactId===NULL` as meaning "the logged-in user".
However, I don't think NULL was a sensible value before, and this interface
isn't widely known/used.
|
I've tested this out by updating the activity_tab_filter setting code to use new fascade and it all works beautifully. |
|
Jenkins re test this please |
|
Jenkins re test this please |
|
Test fails unrelated |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Before
To read/write a setting for the logged-in user, you need a snippet like this:
After
To read/write a setting for the logged-in user, you can use a snippet like this:
Technical Details
the developer is unlikely to check their conditions carefully. Therefore, the
errors are reported as exceptions so that mistakes are easiliy revealed.
SettingsManager::getBagByContact()because it now interprets
$contactId===NULLas meaning "the logged-in user".However, I don't think NULL was a sensible value before, and this interface
isn't widely known/used.