From b6e7df41904fe0cc634d4ce56567cb826ea51c0f Mon Sep 17 00:00:00 2001 From: Randall Wilk Date: Wed, 1 Nov 2023 11:29:10 -0500 Subject: [PATCH] Update docs --- docs/basic-usage/basic-usage.md | 5 +++++ docs/basic-usage/teams.md | 11 +++++++++++ 2 files changed, 16 insertions(+) diff --git a/docs/basic-usage/basic-usage.md b/docs/basic-usage/basic-usage.md index 8d7dfb4..530a5fe 100644 --- a/docs/basic-usage/basic-usage.md +++ b/docs/basic-usage/basic-usage.md @@ -58,6 +58,11 @@ Settings::isFalse('app.debug'); // true Using `all`, you can retrieve all the stored settings, which will be returned as a collection. You may also retrieve a subset of settings by passing in an array of keys to retrieve. +> {note} Either the `ReadableKeyGenerator` or a custom key generator must be configured to be used before this method can be used. +> See [KeyGenerator docs](/docs/laravel-settings/{version}/advanced-usage/custom-generators#user-content-keygenerator) for more information. +> +> In a future major release, the `ReadableKeyGenerator` may be set to be the default key generator. + ```php Settings::all(); diff --git a/docs/basic-usage/teams.md b/docs/basic-usage/teams.md index 3e92ad7..be53b2f 100644 --- a/docs/basic-usage/teams.md +++ b/docs/basic-usage/teams.md @@ -102,6 +102,17 @@ Settings::setTeamId($currentTeamId); > {tip} You can pass in an eloquent model to `setTeamId` instead of an id if you prefer. +#### Temporary Team Switching + +As of `v3.2.0`, to make administering team settings easier, we've added the following convenience methods to `Settings`: + +- `usingTeam($teamId)`: Use this method to scope settings to a specific team on a single call. +- `withoutTeams()`: Use this method to remove team scoping for a single call. + +```php +settings()->usingTeam('my-team-id')->set('foo', 'bar'); +``` + ## Contextual Settings The `Context` object can be used in conjunction with teams for further scoping of settings. The most common scenario for this would be if you have a