---
title: "The Options facade — Options for Laravel | Roundly"
description: "The full Options facade surface — flat verbs, for(), option(), key() and group() handles, registry, observers, access control and cache."
url: https://roundly-consulting.com/open-source/docs/options-for-laravel/facade
language: en
---

[All packages](https://roundly-consulting.com/open-source.md)

[Options for Laravel](https://roundly-consulting.com/open-source/docs/options-for-laravel.md)

# The Options facade

RoundlyConsulting\\Options\\Facades\\Options is the recommended entry point. It proxies the OptionsManager singleton, and every method takes an option class-string or a registered key, plus an optional owner model (omit it, or pass null, for a global option):

```php
use RoundlyConsulting\Options\Facades\Options;

// Flat verbs: a class-string or a registered key, plus an optional owner
Options::get(ThemeOption::class, $user);
Options::set(ThemeOption::class, 'dark', $user);
Options::many([ThemeOption::class, LocaleOption::class], $user);
Options::all($user);
Options::export($team);
Options::import($json);

// Handles
Options::for($user)->set(ThemeOption::class, 'light');         // PendingOptions — one owner
Options::option(ThemeOption::class)->default();                // OptionContext — one option
Options::key('theme')->set('dark');                            // OptionContext by registered key
Options::group(AppearanceSettings::class)->for($user)->all();  // PendingGroup — a settings screen

// Registry, observers, access control, config bridge, cache
Options::register(['theme' => ThemeOption::class]);
Options::observe(ThemeOption::class, RecompileThemeListener::class);
Options::withoutAuthorization(fn () => Options::set(MaintenanceModeOption::class, true));
Options::overrides('app.name', AppNameOption::class);
Options::flushCache();
```

## Every method

| Method | Returns | What it does |
| --- | --- | --- |
| `get($option, $owner = null)` | `mixed` | The typed value, or default() when nothing is stored. |
| `set($option, $value, $owner = null)` | `void` | Validate, cast and persist a value. |
| `has($option, $owner = null)` | `bool` | Whether a value is stored for the scope. |
| `forget($option, $owner = null) / reset(…)` | `void` | Delete the stored value; reset() is an alias. |
| `remember($option, Closure $callback, $owner = null)` | `mixed` | The stored value, or compute, store and return it. Stores only if nothing is stored by then, so concurrent first callers all return the one stored value. |
| `resolve($option, $owner = null)` | `OptionInterface` | The option instance bound to the owner. |
| `many(array $options, $owner = null)` | `array` | Several values at once, keyed by what you passed. |
| `setMany(array $values, $owner = null)` | `void` | Several writes, all or nothing: every value is authorized and validated first, then written in one transaction. |
| `all($owner = null)` | `Collection` | Every stored value of the scope, raw key => value, one query. With access control on, leaves out what the user may not read. |
| `export($owner = null, bool $globalOnly = false)` | `list<OptionPayload>` | Stored options as raw payloads — one owner, everything, or only the global ones. With access control on, leaves out what the user may not read. |
| `exportJson($owner = null, bool $globalOnly = false)` | `string` | export() as a JSON array of rows. |
| `import(array\|string $payload)` | `int` | Upsert from JSON, decoded rows or OptionPayloads, all or nothing; returns the count. |
| `for(?Model $owner)` | `PendingOptions` | Owner-bound handle; for(null) is the global scope. |
| `option($option) / key($key)` | `OptionContext` | A single-option handle, by class-string or registered key. |
| `group($group, $owner = null)` | `PendingGroup` | A settings group: all(), set(), definition(), options(). |
| `register(array $options) / registered()` | `void / array` | Add key => class mappings at runtime; read the registry. |
| `resolveClass($option)` | `class-string` | Turn a key or class into the option class-string. |
| `observe($option, $callback)` | `void` | Attach a targeted observer (closure or invokable class). |
| `forgetObservers($option) / flushObservers()` | `void` | Drop one option’s observers, or all of them. |
| `actingAs(?Authenticatable $user, Closure $callback)` | `mixed` | Run a callback authorized as that user. |
| `withoutAuthorization(Closure $callback)` | `mixed` | Run a callback with access control bypassed. |
| `overrides($configKey, $option)` | `void` | Map a config() key to an option, applied immediately. |
| `configOverrides() / applyConfigOverrides()` | `array / void` | The active config-bridge map; re-apply every mapping now. |
| `flushCache()` | `void` | Flush the in-request memo and the persistent cache, on any store. |
| `fake()` | `OptionsFake` | Facade only: swap in the recording in-memory fake (see Testing). |

The assert\*() methods listed in the facade’s docblock exist only after Options::fake() — see Testing.

## One manager behind every path

The facade, the for() / option() / key() / group() handles, option instances, the HasOptions trait and the options() helper all funnel into the same OptionsManager methods. Pick whichever reads best — they validate, cast, cache, authorize and fire events identically:

```php
// One OptionsManager behind every spelling — identical behaviour, all visible to Options::fake()
Options::set(ThemeOption::class, 'dark', $user);      // the facade
Options::for($user)->set(ThemeOption::class, 'dark'); // a handle
ThemeOption::for($user)->set('dark');                 // an option instance
$user->option(ThemeOption::class)->set('dark');       // the HasOptions trait
options()->set(ThemeOption::class, 'dark', $user);    // the helper
```

## Show your open-source love

This package is free and MIT-licensed. If it saves you time, a one-off donation or a Patreon membership keeps it maintained, tested and documented.

[More ways to support, including crypto](https://roundly-consulting.com/support-us.md)

By donating, you agree to our [donation terms](https://roundly-consulting.com/donation-terms.md).

[Support our open source work (opens in a new tab)](https://donate.stripe.com/dRmeVe8FX5PF1Qd9pXcEw00) [Join us on Patreon (opens in a new tab)](https://www.patreon.com/cw/roundly)

## Want this built into your product?

We integrate our packages into custom Laravel and AI builds. Tell us what you're working on and we'll reply within 48 hours.

[Get a quote in 48 hours](https://roundly-consulting.com/contact.md) [Browse all packages](https://roundly-consulting.com/open-source/docs/options-for-laravel.md)