Skip to content

Commit 8ac3cb1

Browse files
committed
Update docs
1 parent 70ed7a5 commit 8ac3cb1

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/api/settings.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ public function get(string|BackedEnum $key, $default = null)
5353
public function all($keys = null): \Illuminate\Support\Collection
5454
```
5555

56+
> {note} The `DotNotationContextSerializer` context serializer must be used for this to work properly.
57+
5658
### has
5759

5860
```php
@@ -119,6 +121,44 @@ public function isTrue(string|BackedEnum $key, $default = true): bool
119121
public function flush($keys = null): void
120122
```
121123

124+
### getTeamId
125+
126+
```php
127+
/**
128+
* Retrieve the current team id for settings.
129+
*/
130+
public function getTeamId(): mixed;
131+
```
132+
133+
### setTeamId
134+
135+
```php
136+
/**
137+
* Set the current team id for teams/groups support.
138+
*
139+
* @param Model|int|null|string $id
140+
*/
141+
public function setTeamId(mixed $id): Settings;
142+
```
143+
144+
### usingTeam
145+
146+
```php
147+
/**
148+
* Use a team for a single call.
149+
*/
150+
public function usingTeam(mixed $teamId): Settings;
151+
```
152+
153+
### withoutTeams
154+
155+
```php
156+
/**
157+
* Perform a single settings call without a team context.
158+
*/
159+
public function withoutTeams(): Settings;
160+
```
161+
122162
### cacheKeyForSetting
123163

124164
```php

0 commit comments

Comments
 (0)