Nova Settings

https://github.com/outl1ne/nova-settings
Admin
Nova Settings is a Laravel Nova package that allows developers to create custom settings in code...
Tokens:39,320
Snippets:311
Trust Score:8.2
License:MIT
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### getSetting usage example

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings-store.md

Example usage of getSetting to read a setting with a default value.

```php
$store->getSetting('posts_per_page', 10);
```

--------------------------------

### Install nova-settings via Composer

Source: https://github.com/outl1ne/nova-settings/blob/main/README.md

Install the package via Composer and run migrations to set up the database tables.

```bash
# Install nova-settings
composer require outl1ne/nova-settings

# Run migrations
php artisan migrate
```

--------------------------------

### nova_get_settings() usage example

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/helpers.md

Usage examples for nova_get_settings(). The first fetches all settings; the second fetches specific keys with defaults and accesses a returned value.

```php
// Basic — all settings
$allSettings = nova_get_settings();

// Selected keys with defaults (non-trivial)
$config = nova_get_settings(
    ['site_name', 'footer_text'],
    ['site_name' => 'My App', 'footer_text' => '© My App']
);

echo $config['site_name'];
```

--------------------------------

### getFields usage example

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings-store.md

Example usage of getFields to retrieve a flat list of Nova fields/panels for the 'general' path.

```php
$fields = $store->getFields('general'); // flat list of Nova fields/panels
```

--------------------------------

### Front-end usage of get() endpoint

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-controller.md

Example of how a front-end consumer can call the settings endpoint using Nova's request helper. It sends a GET request with query parameters for path, editing, and editMode, then extracts fields and panels from the JSON response on success.

```php
// Consumer (front-end) usage
$response = Nova::request()->get('/nova-vendor/nova-settings/settings', [
    'params' => ['path' => 'general', 'editing' => true, 'editMode' => 'update'],
]);

if ($response->status() === 200) {
    $fields = $response->json()['fields'];
    $panels = $response->json()['panels'];
}
```

--------------------------------

### Using getStore() to clear cache

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Example usage of getStore() to retrieve the store and clear the cache for a specific key.

```php
$store = NovaSettings::getStore();
$store->clearCache('site_name');
```

--------------------------------

### canSeeSettings usage

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Usage example for canSeeSettings(): abort with 403 if the user is not authorized to see settings.

```php
if (!NovaSettings::canSeeSettings()) {
    abort(403);
}
```

--------------------------------

### Successful get() JSON response

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-controller.md

Example JSON response returned by the get method on success. Contains panels, fields, and authorization flags. The fields are Nova's resolved field JSON and panels are Nova panel JSON objects.

```json
{
  "panels": [ ... ],
  "fields": [ ... ],
  "authorizations": {
    "authorizedToView": true,
    "authorizedToCreate": true,
    "authorizedToUpdate": true,
    "authorizedToDelete": true
  }
}
```

--------------------------------

### Singleton binding example for NovaSettingsStore

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/service-provider.md

Shows the singleton binding pattern, with the actual store class chosen based on the cache store configuration.

```php
$this->app->singleton(NovaSettingsStore::class, function () {
    return new NovaSettingsCacheStore();
});
// ... or InMemoryStore / NoCacheStore per the branch above
```

--------------------------------

### addCasts usage

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Usage example for addCasts: registers a cast for a setting key.

```php
NovaSettings::addCasts(['json_payload' => 'array']);
```

--------------------------------

### get(Request $request) method signature

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-controller.md

Exact method signature for the get method, which handles GET requests to the settings endpoint. It reads the 'path' query parameter and returns settings data as JSON.

```php
public function get(Request $request)
```

--------------------------------

### Usage of getSettingsTableName()

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Example of retrieving the settings table name, defaulting to 'nova_settings'.

```php
$table = NovaSettings::getSettingsTableName(); // "nova_settings" by default
```

--------------------------------

### Usage of getPageName()

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Examples of converting page keys to human-readable names.

```php
NovaSettings::getPageName('general');   // "General" (translated) or "General" (derived)
NovaSettings::getPageName('seo-tools'); // "Seo Tools"
```

--------------------------------

### Settings getValueForKey usage example

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-model.md

Retrieves the value for the 'site_name' key.

```php
$value = Settings::getValueForKey('site_name');
```

--------------------------------

### addSettingsFields usage example

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings-store.md

Example usage of addSettingsFields with a field, cast, and path. The path 'General' is normalized to 'general'.

```php
$store->addSettingsFields([Text::make('Title', 'title')], ['title' => 'string'], 'General');
// 'General' is stored under path key 'general'
```

--------------------------------

### getAuthorizations usage

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Usage examples for getAuthorizations(): retrieving the full array and checking a single key to conditionally set a setting.

```php
// Basic
$auths = NovaSettings::getAuthorizations();
$canUpdate = $auths['authorizedToUpdate'];

// Single key
if (NovaSettings::getAuthorizations('authorizedToUpdate')) {
    NovaSettings::setSettingValue('maintenance_mode', true);
}
```

--------------------------------

### nova_get_setting() usage example

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/helpers.md

Usage examples for nova_get_setting(). The first fetches a boolean with a default; the second shows usage inside a Blade view with an @if directive. Both are extracted verbatim from the source.

```php
// Basic
$maintenance = nova_get_setting('maintenance_mode', false);

// Non-trivial — nested usage in a view/controller
@if(nova_get_setting('announcement_enabled'))
    <div class="banner">{{ nova_get_setting('announcement_text') }}</div>
@endif
```

--------------------------------

### getFields usage

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Usage examples for getFields: retrieving raw registry with null and resolved fields for a specific page.

```php
// All registered pages (raw)
$all = NovaSettings::getFields();

// Resolved fields for the 'general' page
$generalFields = NovaSettings::getFields('general');
```

--------------------------------

### addSettingsFields usage

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Usage examples for addSettingsFields: basic array form and callable with casts and subpage. Typically called from NovaServiceProvider::boot().

```php
// Basic — array form
\Outl1ne\NovaSettings\NovaSettings::addSettingsFields([
    \Laravel\Nova\Fields\Text::make('Site name', 'site_name'),
    \Laravel\Nova\Fields\Number::make('Posts per page', 'posts_per_page'),
]);

// Callable + casts + subpage (non-trivial)
\Outl1ne\NovaSettings\NovaSettings::addSettingsFields(function () {
    return [
        \Laravel\Nova\Fields\Boolean::make('Public site', 'public_site'),
    ];
}, [
    'public_site' => 'boolean',
], 'site-settings');
```

--------------------------------

### nova_set_setting_value() usage example

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/helpers.md

Usage examples for nova_set_setting_value(). The first stores a boolean; the second stores an array (which will be JSON-encoded); the third stores a timestamp and captures the returned model instance.

```php
// Basic
nova_set_setting_value('maintenance_mode', true);

// Non-trivial — programmatic import of a JSON payload
nova_set_setting_value('homepage_blocks', [
    ['type' => 'hero', 'title' => 'Welcome'],
    ['type' => 'cta', 'title' => 'Get started'],
]);

$row = nova_set_setting_value('cache_bust', time());
```

--------------------------------

### Consumer usage for markdown field preview

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-controller.md

Example of how to call the fieldPreview endpoint from a JavaScript client using Nova.request(). It posts a value to the preview route and logs the rendered HTML from the response.

```javascript
// Consumer usage — markdown field preview
const { data } = await Nova.request().post(
  `/nova-api/nova-settings/general/field/body/preview`,
  { value: '# Hello' }
);
console.log(data.preview); // rendered HTML
```

--------------------------------

### Settings getValueAttribute usage example

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-model.md

Demonstrates how a boolean cast is applied when reading a setting value, returning a real bool.

```php
NovaSettings::addSettingsFields([Boolean::make('Enabled', 'enabled')], ['enabled' => 'boolean']);
Settings::create(['key' => 'enabled', 'value' => 1]);
$row = Settings::where('key', 'enabled')->first();
var_dump($row->value); // bool(true)
```

--------------------------------

### Consumer usage for saving settings via POST /nova-vendor/nova-settings/settings

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-controller.md

Front-end JavaScript example showing how to post FormData to the save endpoint. Handles 204 success and 422 validation errors, and reloads the page when the response contains reload: true.

```javascript
// Consumer usage — front-end posts FormData with each field's payload plus 'path'
const fd = new FormData();
fd.append('path', 'general');
fd.append('site_name', 'Acme');
fd.append('_method', 'POST');

Nova.request().post('/nova-vendor/nova-settings/settings', fd)
  .then(res => {
    if (res.status === 204) { /* saved */ }
    else if (res.data.reload === true) { location.reload(); }
  })
  .catch(err => {
    if (err.response.status === 422) {
      // err.response.data.errors — e.g. { site_name: ["The site name field is required."] }
    }
  });
```

--------------------------------

### GET /nova-vendor/nova-settings/settings

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-controller.md

Fetches settings data for the Nova settings page. Returns resolved fields, panels, and authorization flags. Requires the 'path' query parameter to specify the settings page key.

```APIDOC
## GET /nova-vendor/nova-settings/settings

### Description
Fetches settings data for the Nova settings page, including fields, panels, and authorization flags.

### Method
GET

### Endpoint
/nova-vendor/nova-settings/settings

### Parameters
#### Query Parameters
- **path** (string) - Optional - Page key, defaults to 'general'.
- **editing** (boolean) - Optional - Indicates editing mode.
- **editMode** (string) - Optional - Edit mode, e.g., 'update'.

### Request Example
GET /nova-vendor/nova-settings/settings?path=general&editing=true&editMode=update

### Response
#### Success Response (200)
- **panels** (array) - List of Nova panel JSON objects.
- **fields** (array) - List of Nova resolved field JSON objects, each with an 'attribute' and optional 'meta.fields'.
- **authorizations** (object) - Object containing authorization flags: authorizedToView, authorizedToCreate, authorizedToUpdate, authorizedToDelete.

#### Response Example
{
  "panels": [],
  "fields": [],
  "authorizations": {
    "authorizedToView": true,
    "authorizedToCreate": true,
    "authorizedToUpdate": true,
    "authorizedToDelete": true
  }
}

#### Error Response (403)
- **error** (string) - Error message, e.g., "Unauthorized".

#### Error Example
{
  "error": "Unauthorized"
}
```

--------------------------------

### Handle 404 in Settings.vue

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/errors.md

Frontend check in Settings.vue that ignores 404 responses from the GET call, treating them as an unregistered settings page.

```javascript
if (error.response.status === 404) { /* page not registered */ }
```

--------------------------------

### Settings setValueAttribute usage example

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-model.md

Shows how the mutator stores an array as JSON and a DateTime instance raw when a datetime cast is applied.

```php
$row = new Settings;
$row->key = 'json_payload';
$row->value = ['a' => 1];          // stored as '{"a":1}'
$row->value = new DateTime('now'); // stored raw (needs a 'datetime' cast)
```

--------------------------------

### Consumer usage for deleting an image via DELETE /nova-api/nova-settings/{path}/field/{fieldName}

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-controller.md

Front-end JavaScript example showing how to call the delete endpoint. Handles 403 unauthorized responses.

```javascript
// Consumer usage (Nova front-end file-picker delete handler)
await Nova.request().delete(`/nova-api/nova-settings/${path}/field/${fieldName}`)
  .catch(err => { if (err.response.status === 403) { /* not authorized to update */ } });
```

--------------------------------

### API route definitions in routes/api.php

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/service-provider.md

Defines the API endpoints for getting and saving settings, plus image deletion and field preview routes.

```php
Route::prefix('nova-vendor/nova-settings')->group(function () {
    Route::get('/settings', 'SettingsController@get')->name('nova-settings.get');
    Route::post('/settings', 'SettingsController@save')->name('nova-settings.save');
});

Route::delete('/nova-api/nova-settings/{path}/field/{fieldName}', 'SettingsController@deleteImage');
Route::post('/nova-api/nova-settings/{path}/field/{attribute}/preview', 'SettingsController@fieldPreview')->name('nova-settings.field-preview');
```

--------------------------------

### boot() method signature

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/service-provider.md

Exact signature of the boot() method, which runs on every boot.

```php
public function boot()
```

--------------------------------

### register() method signature

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/service-provider.md

Public method that runs before boot() and performs route registration, config merging, and store binding.

```php
public function register()
```

--------------------------------

### Publish config and migrations

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/configuration.md

Commands to publish the package's configuration file and migrations. Use the `config` tag to publish `config/nova-settings.php` and the `migrations` tag to publish the create-table and value-column migrations.

```bash
php artisan vendor:publish --provider="Outl1ne\NovaSettings\NovaSettingsServiceProvider" --tag="config"
```

```bash
php artisan vendor:publish --provider="Outl1ne\NovaSettings\NovaSettingsServiceProvider" --tag="migrations"
```

--------------------------------

### getStore() method signature

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

The exact signature of the static getStore() method, returning a NovaSettingsStore instance.

```php
public static function getStore(): NovaSettingsStore
```

--------------------------------

### getSetting($settingKey, $default = null)

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Reads a single setting through the configured store (cache-first).

```APIDOC
## getSetting($settingKey, $default = null)

### Description
Reads a single setting through the configured store (cache-first). Values are cast per the registered casts. Returns `$default` when the key has no stored value.

### Method
getSetting

### Signature
```php
public static function getSetting($settingKey, $default = null)
```

### Parameters
- **$settingKey** (string) - Required - Setting key
- **$default** (mixed) - Optional - Returned when no row exists for the key

### Return Value
Returns the setting value, or `$default` if not found.

### Example
```php
// Basic
$siteName = NovaSettings::getSetting('site_name');

// With default
$postsPerPage = NovaSettings::getSetting('posts_per_page', 15);

// Casts apply: if 'public_site' was registered with 'boolean' cast, this is a real bool
if (NovaSettings::getSetting('public_site', false)) {
    // ...
}
```

### Source
`src/NovaSettings.php:117`
```

--------------------------------

### getSettings() method and usage

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Returns an associative key=>value array. With keys, fetches cache hits then a single whereIn query; missing keys fall back to defaults (not persisted/cached). With null keys, loads all rows and warms the cache.

```php
public static function getSettings(?array $settingKeys = null, array $defaults = [])
```

```php
// Basic — a few keys
$values = NovaSettings::getSettings(['site_name', 'posts_per_page']);

// With defaults (non-trivial)
$values = NovaSettings::getSettings(
    ['theme_color', 'max_upload_mb'],
    ['theme_color' => '#ffffff', 'max_upload_mb' => 10]
);

// All settings
$all = NovaSettings::getSettings();
```

--------------------------------

### getStore(): NovaSettingsStore

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Documentation for the static getStore() method of the NovaSettings class.

```APIDOC
## getStore(): NovaSettingsStore

### Description
Resolves the `NovaSettingsStore` singleton from the container (`app()->make(NovaSettingsStore::class)`). The concrete store class depends on `nova-settings.cache.store`.

### Method
`getStore`

### Signature
```php
public static function getStore(): NovaSettingsStore
```

### Returns
- **NovaSettingsStore** - The resolved store instance.

### Example
```php
$store = NovaSettings::getStore();
$store->clearCache('site_name');
```

### Source
`src/NovaSettings.php:142`
```

--------------------------------

### getSettingsModel(): string

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Returns the configured settings model class string.

```APIDOC
## getSettingsModel(): string

### Description
Returns the configured settings model class string: `config('nova-settings.models.settings', Settings::class)`. The configured class must extend `Outl1ne\NovaSettings\Models\Settings`.

### Method
getSettingsModel

### Signature
```php
public static function getSettingsModel(): string
```

### Parameters
None.

### Return Value
Returns the settings model class string.

### Example
```php
$model = NovaSettings::getSettingsModel(); // "Outl1ne\NovaSettings\Models\Settings"
$model::where('key', 'site_name')->first();
```

### Source
`src/NovaSettings.php:132`
```

--------------------------------

### registerSettingsStore() method signature

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/service-provider.md

Protected method that binds the NovaSettingsStore singleton, selecting between cache, in-memory, or no-cache stores based on config.

```php
protected function registerSettingsStore()
```

--------------------------------

### NovaSettingsCacheStore constructor

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings-store.md

Initializes the cache store using the configured cache store from 'nova-settings.cache.store'.

```php
public function __construct()
{
    $this->cache = Cache::store(config('nova-settings.cache.store'));
}
```

--------------------------------

### Settings fields method

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-model.md

Returns an empty field list, as the resource is used for authorization only, not for CRUD screens. Source: src/Nova/Resources/Settings.php:21.

```php
public function fields(Request $request)
{
    return [];
}
```

--------------------------------

### getSettings(?array $settingKeys = null, array $defaults = [])

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Retrieves multiple settings, optionally filtered by keys, with defaults.

```APIDOC
## getSettings(?array $settingKeys = null, array $defaults = [])

### Description
Returns an associative `key => value` array of settings. With keys: loads cache hits, then a single `whereIn('key', $settingKeys)` query; missing keys fall back to `$defaults[$key] ?? null`. With `$settingKeys = null`: loads all rows (`::all()`), warms the cache, returns `key => value` map.

### Method
getSettings

### Signature
```php
public static function getSettings(?array $settingKeys = null, array $defaults = [])
```

### Parameters
- **$settingKeys** (?array) - Optional - If given, only these keys are fetched (batch, cached); `null` fetches every setting
- **$defaults** (array) - Optional - Per-key defaults applied when a key has no stored value

### Return Value
Returns an associative array of `key => value` pairs.

### Example
```php
// Basic — a few keys
$values = NovaSettings::getSettings(['site_name', 'posts_per_page']);

// With defaults (non-trivial)
$values = NovaSettings::getSettings(
    ['theme_color', 'max_upload_mb'],
    ['theme_color' => '#ffffff', 'max_upload_mb' => 10]
);

// All settings
$all = NovaSettings::getSettings();
```

### Note
Defaults are returned but not persisted and not cached; concurrent retrieval of a missing key repeats the DB query.

### Source
`src/NovaSettings.php:122`
```

--------------------------------

### Authorizations array shape

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/types.md

Shape of the authorizations array built by NovaSettings::getAuthorizations. Passed verbatim in the GET /nova-vendor/nova-settings/settings response under 'authorizations'.

```php
[
    'authorizedToView'   => false, // Resource::authorizedToView($request)
    'authorizedToCreate' => false, // Resource::authorizedToCreate($request)
    'authorizedToUpdate' => false, // Resource::authorizedToUpdate($request)
    'authorizedToDelete' => false, // Resource::authorizedToDelete($request)
]
```

--------------------------------

### getSetting() method and usage

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Reads a single setting through the configured store (cache-first). Values are cast per registered casts; returns the default when the key has no stored value.

```php
public static function getSetting($settingKey, $default = null)
```

```php
// Basic
$siteName = NovaSettings::getSetting('site_name');

// With default
$postsPerPage = NovaSettings::getSetting('posts_per_page', 15);

// Casts apply: if 'public_site' was registered with 'boolean' cast, this is a real bool
if (NovaSettings::getSetting('public_site', false)) {
    // ...
}
```

--------------------------------

### Nova UI page route registration

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/service-provider.md

Registers a GET route for the Nova settings page, using Inertia to render the NovaSettings component with basePath and pageId props.

```php
Nova::router()->group(function ($router) {
    $path = config('nova-settings.base_path', 'nova-settings');

    $router
        ->get("{$path}/{pageId?}", fn ($pageId = 'general') => inertia('NovaSettings', ['basePath' => $path, 'pageId' => $pageId]))
        ->middleware(['nova', Authenticate::class])
        ->domain(config('nova.domain', null));
});
```

--------------------------------

### Settings booted method

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-model.md

Registers an updated model-event listener that clears the cache entry for the modified key, keeping cached reads consistent with writes issued outside the store.

```php
protected static function booted()
{
    static::updated(function ($setting) {
        NovaSettings::getStore()->clearCache($setting->key);
    });
}
```

--------------------------------

### getAuthorizations($key = null)

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Builds a fake Nova resource and delegates authorization checks. Returns an array of booleans or a single boolean when a key is provided.

```APIDOC
## getAuthorizations($key = null)

### Description
Builds a fake Nova resource of `Outl1ne\NovaSettings\Nova\Resources\Settings` and delegates each authorization call to the resource. With no `$key` returns the full array of authorization booleans; with a `$key` returns the single boolean.

### Method
GET

### Endpoint
NovaSettings::getAuthorizations

### Parameters
#### Path Parameters
- **$key** (string|null) - Optional - One of `authorizedToView`, `authorizedToCreate`, `authorizedToUpdate`, `authorizedToDelete`.

### Request Example
```php
$auths = NovaSettings::getAuthorizations();
$canUpdate = $auths['authorizedToUpdate'];
```

### Response
#### Success Response (200)
- **authorizedToView** (bool) - Whether the user can view the settings.
- **authorizedToCreate** (bool) - Whether the user can create settings.
- **authorizedToUpdate** (bool) - Whether the user can update settings.
- **authorizedToDelete** (bool) - Whether the user can delete settings.

#### Response Example
```php
[
    'authorizedToView'   => true,
    'authorizedToCreate' => false,
    'authorizedToUpdate' => true,
    'authorizedToDelete' => false,
]
```
```

--------------------------------

### Add settings fields with addSettingsFields

Source: https://github.com/outl1ne/nova-settings/blob/main/README.md

Define settings fields in the boot() method of NovaServiceProvider using either an array or a callable that returns an array of Nova fields.

```php
// Using an array
\Outl1ne\NovaSettings\NovaSettings::addSettingsFields([
    Text::make('Some setting', 'some_setting'),
    Number::make('A number', 'a_number'),
]);

// OR

// Using a callable
\Outl1ne\NovaSettings\NovaSettings::addSettingsFields(function() {
  return [
    Text::make('Some setting', 'some_setting'),
    Number::make('A number', 'a_number'),
  ];
});
```

--------------------------------

### getSetting method signature

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings-store.md

Signature of the method that performs a cache-first single read of a setting.

```php
public function getSetting($settingKey, $default = null)
```

--------------------------------

### GET settings response JSON shape

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/types.md

JSON response shape from SettingsController::get. Contains panels, fields, and authorizations. Panels are Nova panel JSON objects; fields are resolved Nova field JSON objects with at least 'attribute'.

```json
{
  "panels": [ ],
  "fields": [ ],
  "authorizations": { "authorizedToView": true, "authorizedToCreate": true, "authorizedToUpdate": true, "authorizedToDelete": true }
}
```

--------------------------------

### NovaSettings Tool Class

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Documentation for the NovaSettings tool class, including registration, constructor, and public methods.

```APIDOC
## [Class] Outl1ne\NovaSettings\NovaSettings

### Description
Main Tool class for the NovaSettings package, registered into Laravel Nova's sidebar. Provides methods for registering setting fields, reading/writing setting values, and querying authorization state.

### Class Declaration
```php
class NovaSettings extends Tool
```

### Registration
```php
// in app/Providers/NovaServiceProvider.php

use Outl1ne\NovaSettings\NovaSettings;

public function tools(): array
{
    return [
        // Optional: authorize the whole tool via the base Tool API
        NovaSettings::make()->canSee(fn () => user()->isAdmin()),

        // or the plain class
        new NovaSettings,
    ];
}
```

### Constructor
Inherited from `Laravel\Nova\Tool`. Instantiate directly (`new NovaSettings`) or via the `make()` factory the base class provides. No package-specific constructor options.

### Methods

#### boot()

Signature:
```php
public function boot()
```

No parameters. Called by Nova when the tool boots. Registers the Nova script `'nova-settings'` pointing at `__DIR__ . '/../dist/js/entry.js'`. No return value.

#### menu(Request $request)

Signature:
```php
public function menu(Request $request)
```

Parameters:
- `$request` (Illuminate\Http\Request) - Required - The current HTTP request

Builds the sidebar `MenuSection` (or `null`). Returns `null` when any of: `NovaSettings::canSeeSettings()` is false, `config('nova-settings.show_in_sidebar')` is false, or no fields have been registered. When exactly one settings path is registered, returns a `MenuSection` titled with `__('novaSettings.navigationItemTitle')`, `->path($basePath . '/' . array_key_first($fields))`, icon `adjustments-vertical`. When multiple paths exist, returns a collapsable section containing one `MenuItem::link(self::getPageName($key), "{$basePath}/{$key}")` per path. `$basePath` is `config('nova-settings.base_path', 'nova-settings')`.

#### getSettingsTableName(): string

Signature:
```php
public static function getSettingsTableName(): string
```

No parameters. Returns `config('nova-settings.table', 'nova_settings')`. Used by the model to select its DB table and by the package's migrations.

Example:
```php
$table = NovaSettings::getSettingsTableName(); // "nova_settings" by default
```

#### getPageName($key): string

Signature:
```php
public static function getPageName($key): string
```

Parameters:
- `$key` (string) - Required - Settings page key (slugged path)

Returns the human-readable page name. If a translation exists for `"novaSettings.$key"`, it is returned; otherwise the key is prettified with `Str::title(str_replace('-', ' ', $key))` (e.g. `'my-page'` → `'My Page'`).

Examples:
```php
NovaSettings::getPageName('general');   // "General" (translated) or "General" (derived)
NovaSettings::getPageName('seo-tools'); // "Seo Tools"
```
```

--------------------------------

### NovaSettingsStore Public API

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings-store.md

Public methods of the abstract NovaSettingsStore class and its concrete implementations.

```APIDOC
## addSettingsFields($fields = [], $casts = [], $path = 'general')

### Description
Registers fields and casts for a given settings page path. Fields can be an array or a callable that returns an array; the path is normalized to a slug.

### Method
addSettingsFields

### Signature
```php
public function addSettingsFields($fields = [], $casts = [], $path = 'general')
```

### Parameters
- **$fields** (array|callable) - Optional - Default: `[]` - Fields/panels, or a callable returning them.
- **$casts** (array) - Optional - Default: `[]` - Eloquent-style cast map merged into the store's casts.
- **$path** (string) - Optional - Default: `'general'` - Page key, normalized via `Str::lower(Str::slug($path))`.

### Returns
- **$this** - Fluent interface for chaining.

### Example
```php
$store->addSettingsFields([Text::make('Title', 'title')], ['title' => 'string'], 'General');
// 'General' is stored under path key 'general'
```
```

```APIDOC
## addCasts($casts = [])

### Description
Merges additional Eloquent-style casts into the store's cast registry.

### Method
addCasts

### Signature
```php
public function addCasts($casts = [])
```

### Parameters
- **$casts** (array) - Optional - Default: `[]` - Cast map to merge.

### Returns
- **$this** - Fluent interface for chaining.
```

```APIDOC
## getRawFields()

### Description
Returns the raw field registry without resolving callables. Useful for inspecting registered fields before lazy resolution.

### Method
getRawFields

### Signature
```php
public function getRawFields()
```

### Returns
- **array** - Associative array of slugged path => array of fields/callables/panels.
```

```APIDOC
## getFields($path = 'general')

### Description
Resolves and returns the flat list of Nova fields/panels for a given settings page path. Callables are invoked and nested arrays are flattened.

### Method
getFields

### Signature
```php
public function getFields($path = 'general')
```

### Parameters
- **$path** (string) - Optional - Default: `'general'` - Page key.

### Returns
- **array** - Flat list of Nova fields/panels.

### Example
```php
$fields = $store->getFields('general'); // flat list of Nova fields/panels
```
```

```APIDOC
## getCasts()

### Description
Returns the merged casts array used by the Settings model's accessor/mutator.

### Method
getCasts

### Signature
```php
public function getCasts()
```

### Returns
- **array** - Merged cast map.
```

```APIDOC
## getSetting($settingKey, $default = null)

### Description
Reads a single setting value, using cache-first strategy. If not cached, retrieves from the settings model and caches the result.

### Method
getSetting

### Signature
```php
public function getSetting($settingKey, $default = null)
```

### Parameters
- **$settingKey** (string) - Required - The setting key to retrieve.
- **$default** (mixed) - Optional - Default: `null` - Value returned if setting not found.

### Returns
- **mixed** - The setting value or the default.

### Example
```php
$store->getSetting('posts_per_page', 10);
```
```

--------------------------------

### Authorize Middleware matchesTool method

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/middleware.md

Helper method to identify if a tool instance is the NovaSettings tool.

```php
public function matchesTool($tool)
{
    return $tool instanceof NovaSettings;
}
```

--------------------------------

### nova_get_settings($settingKeys = null, $defaults = [])

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/helpers.md

Fetches one or more settings as an associative array. Equivalent to NovaSettings::getSettings().

```APIDOC
## nova_get_settings($settingKeys = null, $defaults = [])

### Description
Fetches one or more settings as an associative array. Equivalent to NovaSettings::getSettings().

### Method
Function

### Signature
```php
function nova_get_settings($settingKeys = null, $defaults = [])
```

### Parameters
- **$settingKeys** (array|null) - Optional - Default: null - Keys to fetch; null fetches all settings
- **$defaults** (array) - Optional - Default: [] - Per-key defaults applied when a key has no stored value

### Returns
Associative array of key => value pairs. Values are subject to registered casts.

### Example
```php
// Basic — all settings
$allSettings = nova_get_settings();

// Selected keys with defaults (non-trivial)
$config = nova_get_settings(
    ['site_name', 'footer_text'],
    ['site_name' => 'My App', 'footer_text' => '© My App']
);

echo $config['site_name'];
```
```

--------------------------------

### menu() method signature

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Signature of the menu() method, builds the sidebar MenuSection.

```php
public function menu(Request $request)
```

--------------------------------

### nova_get_setting($settingKey, $default = null)

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/helpers.md

Fetches a single setting value. Equivalent to NovaSettings::getSetting().

```APIDOC
## nova_get_setting($settingKey, $default = null)

### Description
Fetches a single setting value. Equivalent to NovaSettings::getSetting().

### Method
Function

### Signature
```php
function nova_get_setting($settingKey, $default = null)
```

### Parameters
- **$settingKey** (string) - Required - The setting key
- **$default** (mixed) - Optional - Default: null - Returned when no stored value exists for the key

### Returns
The cast value or the default.

### Example
```php
// Basic
$maintenance = nova_get_setting('maintenance_mode', false);

// Non-trivial — nested usage in a view/controller
@if(nova_get_setting('announcement_enabled'))
    <div class="banner">{{ nova_get_setting('announcement_text') }}</div>
@endif
```
```

--------------------------------

### Publish Nova Settings migrations

Source: https://github.com/outl1ne/nova-settings/blob/main/README.md

Publishes the migration file so it can be overwritten. Run this command to customize the database schema for Nova Settings.

```bash
php artisan vendor:publish --provider="Outl1ne\NovaSettings\NovaSettingsServiceProvider" --tag="migrations"
```

--------------------------------

### Settings class declaration

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-model.md

Defines the Settings resource with static properties for title, model, and navigation visibility. The model is set to null initially and mutated in the constructor.

```php
class Settings extends Resource
{
    public static $title = 'key';
    public static $model = null;
    public static $displayInNavigation = false;
}
```

--------------------------------

### Register settings field panels

Source: https://github.com/outl1ne/nova-settings/blob/main/README.md

Group settings fields into a panel using Nova's Panel::make to organize the settings UI.

```php
// Using an array
\Outl1ne\NovaSettings\NovaSettings::addSettingsFields([
    Panel::make('Panel Title', [
      Text::make('Some setting', 'some_setting'),
      Number::make('A number', 'a_number'),
    ]),
]);
```

--------------------------------

### getSettingsModel() method and usage

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Returns the configured settings model class string from config, defaulting to Settings::class. The configured class must extend the base model.

```php
public static function getSettingsModel(): string
```

```php
$model = NovaSettings::getSettingsModel(); // "Outl1ne\NovaSettings\Models\Settings"
$model::where('key', 'site_name')->first();
```

--------------------------------

### API routes registration with middleware

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/service-provider.md

Registers API routes under the 'nova' and Authorize middleware, with a domain from config, and groups routes from the api.php file.

```php
Route::middleware(['nova', Authorize::class, SettingsPathExists::class])
    ->domain(config('nova.domain', null))
    ->group(__DIR__ . '/../routes/api.php');
```

--------------------------------

### addSettingsFields($fields = [], $casts = [], $path = 'general')

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Registers settings fields, optional casts, and a path. Delegates to the store and returns the store for fluent chaining.

```APIDOC
## addSettingsFields($fields = [], $casts = [], $path = 'general')

### Description
Define settings fields and optional casts. Fields can be an array or a callable returning an array. The path is slugified and lowercased. Delegates to `static::getStore()->addSettingsFields(...)` and returns the store.

### Method
POST

### Endpoint
NovaSettings::addSettingsFields

### Parameters
#### Path Parameters
- **$fields** (array|callable) - Optional - Array of Nova fields/panels or a callable returning one.
- **$casts** (array) - Optional - Cast map same shape as Eloquent's `$casts`.
- **$path** (string) - Optional - Settings page/subpage key; slugified and lowercased.

### Request Example
```php
\Outl1ne\NovaSettings\NovaSettings::addSettingsFields([
    \Laravel\Nova\Fields\Text::make('Site name', 'site_name'),
    \Laravel\Nova\Fields\Number::make('Posts per page', 'posts_per_page'),
]);
```

### Response
#### Success Response (200)
- **store** (NovaSettingsStore) - The store instance for fluent chaining.

#### Response Example
```php
NovaSettingsStore {}
```
```

--------------------------------

### canSeeSettings()

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Returns whether the user can view or update settings. Used by the settings data endpoint and sidebar menu for visibility.

```APIDOC
## canSeeSettings()

### Description
Returns `authorizedToView || authorizedToUpdate`. This is what the settings data endpoint and the sidebar menu use to decide visibility.

### Method
GET

### Endpoint
NovaSettings::canSeeSettings

### Parameters
None

### Request Example
```php
if (!NovaSettings::canSeeSettings()) {
    abort(403);
}
```

### Response
#### Success Response (200)
- **result** (bool) - Whether the user can see settings.

#### Response Example
```php
true
```
```

--------------------------------

### Nova Settings Configuration File

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/configuration.md

Default configuration file for the nova-settings package. Shows all available options: table name, base path, reload behavior, model class, sidebar visibility, and cache settings.

```php
// config/nova-settings.php
return [
    'table' => 'nova_settings',
    'base_path' => 'nova-settings',
    'reload_page_on_save' => false,
    'models' => ['settings' => \Outl1ne\NovaSettings\Models\Settings::class],
    'show_in_sidebar' => true,
    'cache' => [
        'store' => env('NOVA_SETTINGS_CACHE_DRIVER', ':memory:'),
        'prefix' => 'nova-settings:',
    ],
];
```

--------------------------------

### Abstract class declaration

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings-store.md

Declares the abstract storage backend class for Nova Settings.

```php
abstract class NovaSettingsStore
```

--------------------------------

### Settings constructor signature

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-model.md

Standard Eloquent constructor that additionally sets the table name from NovaSettings::getSettingsTableName().

```php
public function __construct(array $attributes = [])
```

--------------------------------

### Settings constructor

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-model.md

Constructor that sets the static model to the configured settings model and calls the parent constructor. Source: src/Nova/Resources/Settings.php:15.

```php
public function __construct($resource)
{
    self::$model = NovaSettings::getSettingsModel();
    parent::__construct($resource);
}
```

--------------------------------

### nova_get_settings() signature

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/helpers.md

Retrieves all settings or a subset by keys. Returns an associative array with values subject to registered casts. Applies per-key defaults when a key has no stored value.

```php
function nova_get_settings($settingKeys = null, $defaults = [])
```

--------------------------------

### Authorize Middleware behavior

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/middleware.md

Logic used to verify if the NovaSettings tool is authorized for the current request.

```php
$tool = collect(Nova::registeredTools())->first([$this, 'matchesTool']);
return optional($tool)->authorize($request) ? $next($request) : abort(403);
```

--------------------------------

### menu() early return condition

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Returns null when unauthorized, hidden from sidebar, or no fields registered.

```php
if (!$isAuthorized || !$showInSidebar || empty($fields)) return null;
```

--------------------------------

### Settings getValueForKey signature

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-model.md

Static method that queries the settings table for a given key and returns the post-cast value, or null when no row exists. Used by NovaSettingsStore::getSetting.

```php
public static function getValueForKey($key)
```

--------------------------------

### Authorize NovaSettings tool with canSee

Source: https://github.com/outl1ne/nova-settings/blob/main/README.md

Hide the entire Settings area from the sidebar by authorizing the NovaSettings tool with canSee.

```php
public function tools(): array
{
    return [
        NovaSettings::make()->canSee(fn () => user()->isAdmin()),
    ];
}
```

--------------------------------

### POST /nova-api/nova-settings/{path}/field/{attribute}/preview

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-controller.md

Endpoint for previewing field content, such as markdown, in the Nova settings panel.

```APIDOC
## POST /nova-api/nova-settings/{path}/field/{attribute}/preview

### Description
Handles field preview requests for markdown and other previewable fields. Returns rendered preview content based on the provided value.

### Method
POST

### Endpoint
`/nova-api/nova-settings/{path}/field/{attribute}/preview`

### Parameters
#### Path Parameters
- **path** (string) - Required - Settings page key (URL segment)
- **attribute** (string) - Required - Field attribute (URL segment)

#### Request Body
- **value** (string) - Required - The content to preview

### Request Example
```json
{
  "value": "# Hello"
}
```

### Response
#### Success Response (200)
- **preview** (string) - The rendered preview HTML

#### Response Example
```json
{
  "preview": "<h1>Hello</h1>"
}
```

#### Error Responses
- **403** - Unauthorized: `{"error": "Unauthorized"}`
- **404** - Field not found: `{"error": "Field not found"}`
```

--------------------------------

### Publish Nova Settings config file

Source: https://github.com/outl1ne/nova-settings/blob/main/README.md

Publishes the Nova Settings configuration file. Use this command to customize settings such as base_path, reload_page_on_save, models.settings, and cache.

```bash
php artisan vendor:publish --provider="Outl1ne\NovaSettings\NovaSettingsServiceProvider" --tag="config"
```

--------------------------------

### Authorize Middleware handle method

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/middleware.md

The handle method signature for the Authorize middleware.

```php
/**
 * Handle the incoming request.
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  \Closure  $next
 * @return \Illuminate\Http\Response
 */
public function handle($request, $next)
```

--------------------------------

### doesPathExist($path)

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Checks if a settings page key exists in the registered fields registry.

```APIDOC
## doesPathExist($path)

### Description
Returns whether the given settings page key exists in the registered fields registry (`array_key_exists($path, static::getFields())`). Used by the `SettingsPathExists` middleware.

### Method
doesPathExist

### Signature
```php
public static function doesPathExist($path)
```

### Parameters
- **$path** (mixed) - Required - The settings page key to check.

### Return Value
Returns `true` if the path exists, `false` otherwise.

### Example
```php
NovaSettings::doesPathExist('general'); // true if 'general' is registered
```

### Source
`src/NovaSettings.php:137`
```

--------------------------------

### NovaSettingsCacheStore getCacheKey method

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings-store.md

Generates a cache key by prefixing the given key with the configured prefix (default 'nova-settings:').

```php
private function getCacheKey($key)
{
    return config('nova-settings.cache.prefix', 'nova-settings:') . $key;
}
```

--------------------------------

### Handle 403 from Nova settings API

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/errors.md

Handle a 403 response from the Nova settings API. The middleware aborts with a non-JSON 403 page when the tool is not registered or its authorize() returns false. Check the HTTP status in the catch block to treat it as permission denied.

```javascript
Nova.request().get('/nova-vendor/nova-settings/settings')
    .catch(err => { if (err.response.status === 403) { /* not authorized */ } });
```

--------------------------------

### SettingsPathExists Middleware behavior

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/middleware.md

Logic to validate that the requested settings path exists in the registry.

```php
$path = $request->get('path') ?: $request->route('path');
$path = !empty($path) ? trim($path) : 'general';
return NovaSettings::doesPathExist($path) ? $next($request) : abort(404);
```

--------------------------------

### getSettingsTableName() method signature

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/nova-settings.md

Signature of the static method returning the settings table name.

```php
public static function getSettingsTableName(): string
```

--------------------------------

### Settings model class declaration and properties

Source: https://github.com/outl1ne/nova-settings/blob/main/_autodocs/api-reference/settings-model.md

Defines the Settings model with a string primary key, no auto-increment, no timestamps, and fillable attributes. The table name is set in the constructor from the nova-settings.table config key.

```php
class Settings extends Model
{
    protected $primaryKey = 'key';
    public $incrementing = false;
    public $timestamps = false;
    public $fillable = ['key', 'value'];
}
```
Tokens:
Raw