Skip to content

docs: document plural Conditional extension checks #704

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.

Sign up for GitHub

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
DavideIadeluca wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document plural Conditional extension checks #704

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/extend/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,29 @@ Applies extenders only if the given extension is currently enabled.

Applies extenders only if the given extension is currently disabled.

#### `whenExtensionsEnabled(array $extensionIds, ...)`

Applies extenders only if **all** of the given extensions are currently enabled. Use this for integrations that need more than one companion extension at the same time:

```php
(new Extend\Conditional())
->whenExtensionsEnabled(['flarum-tags', 'flarum-likes'], fn () => [
// extenders that rely on both Tags and Likes
])
```

#### `whenExtensionsDisabled(array $extensionIds, ...)`

Applies extenders only if **all** of the given extensions are currently disabled. If any one of them is enabled, the extenders are not applied.

:::info

If some of the listed extensions are enabled and others are disabled, neither `whenExtensionsEnabled` nor `whenExtensionsDisabled` applies its extenders. To react to "at least one of these is enabled", use `when()` with your own callable.

An empty array matches both methods, so their extenders are always applied.

:::

#### `whenSetting(string $key, mixed $expected, ..., strict: false)`

Applies extenders only if a settings value matches an expected value. Uses loose comparison (`==`) by default, so a stored string `'1'` will match a boolean `true`. Pass `strict: true` to use strict comparison (`===`):
Expand Down
Loading