# General
# What setting types are available?
As of 15/09/2026, there are ten setting types available:
| **Type**
| **Description**
|
| String | Stores text values. |
| Boolean | Stores `true`/`false` values. |
| Integer | Stores whole-number values. |
| Float | Stores decimal values. |
| Array | Stores multiple values of different types. |
| Eloquent | Stores eloquent models. |
| Encrypted | Stores encrypted values. |
| Date | Stores a date. |
| Date Range | Stores a start and end date. |
| Cron | Stores a cron expression. |
---
## Base Setting
All setting types inherit the base setting which exposes the following methods.
| **Method**
| **Description**
|
| `map(\Closure $map)`
| Provide a map to format the setting value prior to retrieval. |
| `default($default)`
| Sets the default value for the setting. |
| `section(string $section)`
| Assigns the setting to a specific section.
|
| `label(string $label)`
| Sets the display label for the setting.
|
| `hint(string $hint)`
| Adds hint text for the setting.
|
| `required()`
| Marks the setting as required.
|
| `addRule($rule)`
| Adds a validation rule to the setting.
|
| `addRules(array $rules)`
| Adds multiple validation rules to the setting.
|
| `removeRule($rule)`
| Removes a validation rule from the setting.
|
| `removeRules(array $rules)`
| Removes multiple validation rules from the setting.
|
| `showIf(string $key, $value = true)`
| Conditionally displays the setting input based on another setting's value.
|
| `showWhen(string $key, $value = true)`
| Alias for `showIf()`.
|
---
## String Setting
String settings store text values and provide additional methods for controlling how the value is entered.
| **Method**
| **Description**
|
| `__construct(string $key)`
| Creates a new string setting using the specified `$key`. |
| `textarea()`
| Displays using a `textarea` instead of a text input. |
| `wyiswyg()`
| Displays using a `wysiwyg` editor instead of a text input.
|
String settings use the [Dropdown Rules](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-dropdown-rules), [Size Rules](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-size-rules) & [String Rules](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-string-rules) traits.
### Example Usage
```php
\Aero\Common\Facades\Settings::group('acme', function (Aero\Common\Settings\SettingGroup $group) {
// Basic
$group->string('order_reference_prefix')->default('WEB');
// Textarea
$group->string('order_notes')->textarea();
// WYSIWYG editor
$group->string('rich_text')->wysiwyg();
// Associative dropdown
$group->string('short_date_format')->associative()
->in([
'D jS M, H:i' => now()->format('D jS M, H:i'),
'D jS M Y, H:i' => now()->format('D jS M Y, H:i'),
])
->default('D jS M, H:i')
->section('Date & Time');
});
```
---
## Boolean Setting
Boolean settings store `true`/`false` values and provide additional methods for controlling how multiple boolean values are handled.
| **Method**
| **Description**
|
| `__construct(string $key)`
| Creates a new boolean setting using the specified `$key`. |
| `onlyReturnTrueKeys()` | Only return keys corresponding to `true` values (when using `multiple()`) |
| `onlyReturnFalseKeys()` | Only return keys corresponding to `false` values (when using `multiple()`) |
Boolean settings use the [Can Have Multiple](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-can-have-multiple) trait.
### Example Usage
```php
\Aero\Common\Facades\Settings::group('acme', function (Aero\Common\Settings\SettingGroup $group) {
// Basic
$group->boolean('is_enabled')->default(true);
// Multiple values
$group->boolean('outstanding_order_states')
->multiple([
\Aero\Cart\Models\OrderStatus::CANCELED => false,
\Aero\Cart\Models\OrderStatus::ON_HOLD => true,
\Aero\Cart\Models\OrderStatus::SUCCESSFUL => true,
\Aero\Cart\Models\OrderStatus::COMPLETE => false,
\Aero\Cart\Models\OrderStatus::PROCESSING => true,
\Aero\Cart\Models\OrderStatus::CLOSED => false,
\Aero\Cart\Models\OrderStatus::PARTIALLY_DISPATCHED => true,
\Aero\Cart\Models\OrderStatus::DISPATCHED => false,
\Aero\Cart\Models\OrderStatus::PARTIALLY_RETURNED => false,
\Aero\Cart\Models\OrderStatus::RETURNED => false,
])
->onlyReturnTrueKeys();
});
```
---
## Integer Setting
Integer settings store whole-number values and provide additional methods for constraining the value and defining allowed options.
| **Method**
| **Description**
|
| `__construct(string $key)` | Creates a new integer setting using the specified `$key`. |
Integer settings use the [Dropdown Rules](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-dropdown-rules) & [Size Rules](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-size-rules) traits.
### Example Usage
```php
\Aero\Common\Facades\Settings::group('acme', function (Aero\Common\Settings\SettingGroup $group) {
// Basic
$group->integer('failed_attempts_limit')->default(5);
// Dropdown
$group->integer('per_page')
->in([24, 48, 96, 240, 360])
->default(24);
});
```
---
## Float Setting
Float settings store decimal values and provide additional methods for constraining the value and defining allowed options.
| **Method**
| **Description**
|
| `__construct(string $key)` | Creates a new float setting using the specified `$key`. |
| `step(float $step)`
| Sets the step increment used by the float setting, uses `0.01` by default. |
Float settings use the [Dropdown Rules](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-dropdown-rules) & [Size Rules](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-size-rules) traits.
### Example Usage
```php
\Aero\Common\Facades\Settings::group('acme', function (Aero\Common\Settings\SettingGroup $group) {
// Basic
$group->float('commission_percentage')->default(1.2)
// Dropdown
$group->float('fallback_tax_rate')
->in([0.0, 5.0, 12.5, 20.0])
->default(20.0);
});
```
---
## Array Setting
Array settings store arrays of values and provide additional methods for defining the structure and validation rules for each item.
| **Method**
| **Description**
|
| `__construct(string $key)` | Creates a new array setting using the specified `$key`. |
| `associative()`
| Enables associative mode. |
| `definition(array $definition)`
| Defines the structure and validation rules for each array item. |
Array settings use the [Size Rules](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-size-rules) & [Can Sort](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-can-sort) traits.
### Example Usage
```php
\Aero\Common\Facades\Settings::group('acme', function (Aero\Common\Settings\SettingGroup $group) {
// Basic
$group->array('allowed_upload_types')
->default([
'image/jpeg',
'image/png',
'image/gif',
'image/svg+xml',
'image/webp',
]);
// Custom structure (each definition has a key input by default)
$group->array('form_fields')
->definition([
'type' => ['required', 'string', 'in:text,number'],
'required' => ['boolean'],
])
->default([
'first_name' => [
'type' => 'text',
'required' => true,
],
'age' => [
'type' => 'number',
'required' => true,
]
]);
});
```
---
### Eloquent Setting
Eloquent settings store references to Eloquent models and provide additional methods for searching and sorting the results.
| **Method**
| **Description**
|
| `__construct(string $key, string $class)` | Creates a new eloquent setting using the specified `$key` for the model with class `$class`.
|
| `dontLoadModel()`
| Disables loading the eloquent model on retrieval, returns the id instead.
|
| `dontLoadModels()`
| Alias for `dontLoadModel()`
|
| `searchField($searchField, $displayField = null)`
| Configures a single field to use when searching for models, with an optional field for displaying the model name.
|
| `searchFields(array $searchFields, $displayField = null)`
| Adds one or more fields to use when searching for models and optionally sets the display field.
|
Eloquent settings use the [Can Have Multiple](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-can-have-multiple) & [Can Sort](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-can-sort) traits.
### Example Usage
```php
\Aero\Common\Facades\Settings::group('acme', function (Aero\Common\Settings\SettingGroup $group) {
// Single
$group->eloquent('image', \Aero\Common\Models\Image::class);
// Multiple
$group->eloquent('vip_customer_groups', \Aero\Account\Models\CustomerGroup::class)->multiple();
});
```
---
## Encrypted Setting
Encrypted settings store encrypted string values and provide additional methods for constraining the value and validating its format.
| **Method**
| **Description**
|
| `__construct(string $key)` | Creates a new encrypted setting using the specified `$key`. |
Encrypted settings use the [Size Rules](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-size-rules) & [String Rules](https://support.aerocommerce.com/books/settings/page/what-setting-types-are-available#bkmrk-string-rules) traits.
### Example Usage
```php
\Aero\Common\Facades\Settings::group('acme', function (Aero\Common\Settings\SettingGroup $group) {
$group->encrypted('api_key')->default('secret');
});
```
---
## Date Setting
Date settings store date values and provide additional methods for validating the date.
| **Method**
| **Description**
|
| `__construct(string $key)` | Creates a new date setting using the specified `$key`. |
| `beforeToday()`
| Validates the date is in the past. |
| `beforeDate($date)`
| Validates the date is before some specified date. |
| `afterToday()`
| Validates the date is in the future. |
| `afterDate($date)`
| Validates the date is after some specified date. |
### Example Usage
```php
\Aero\Common\Facades\Settings::group('acme', function (Aero\Common\Settings\SettingGroup $group) {
$group->date('today')->default('today');
});
```
---
## Date Range Setting
Date range settings store date ranges.
| **Method**
| **Description**
|
| `__construct(string $key)` | Creates a new date range setting using the specified `$key`. |
### Example Usage
```php
\Aero\Common\Facades\Settings::group('acme', function (Aero\Common\Settings\SettingGroup $group) {
$group->dateRange('available_days')->default([
'start' => '2026-01-01 07:00:00',
'end' => '2026-12-31 15:00:00',
]);
});
```
---
## Cron Setting
Cron settings store cron expressions for defining scheduled tasks.
| **Method**
| **Description**
|
| `__construct(string $key)` | Creates a new cron setting using the specified `$key`. |
### Example Usage
```php
\Aero\Common\Facades\Settings::group('acme', function (Aero\Common\Settings\SettingGroup $group) {
$group->cron('delete_old_logs')->default('0 0 * * *'); //Every day at midnight
});
```
---
## Traits
### Dropdown Rules
| **Method**
| **Description** |
| `in($in)`
| Defines the allowed values for the dropdown. Accepts an array of options or a closure that resolves to an array. |
| `associative()`
| Configures the dropdown to use associative array keys as the allowed values. |
The order is important: `associative()` should be used before `in()` if required.
### Size Rules
| **Method**
| **Description** |
| `between($min, $max)` | Validates that the value is between the specified minimum and maximum values.
|
| `max($size)`
| Validates that the value does not exceed the specified maximum size.
|
| `min($size)`
| Validates that the value is at least the specified minimum size.
|
| `size($size)`
| Validates that the value has exactly the specified size.
|
| `greaterThan($value)`
| Validates that the value is greater than the specified value.
|
| `lessThan($value)`
| Validates that the value is less than the specified value.
|
### String Rules
| **Method**
| **Description** |
| `email(string $options = 'rfc,dns')`
| Validates the value is an email using the comma-separated values provided. |
| `uuid()`
| Validates the value is a uuid. |
| `url()`
| Validates the value is a url. |
| `ip()`
| Validates the value is an ip. |
| `startsWith(string $needle)`
| Validates the value starts with `$needle`. |
| `startsWithOneOfMany(array $needles)`
| Validates the value starts with one of many `$needles`. |
### Can Have Multiple
| **Method**
| **Description** |
| `multiple(array $defaults = [])`
| Enables multiple-value selection. Optionally sets default values and, when no options are configured, derives the available options from the default array keys.
|
| `options(array $options = [])`
| Sets the available options.
|
| `addMultipleRules(array $rules)`
| Adds validation rules, applied to each selected value.
|
| `addMultipleRule($rule)`
| Adds a single validation rule, applied to each selected value.
|
| `removeMultipleRules(array $rules)`
| Removes validation rules from being applied to each selected value.
|
| `removeMultipleRule($rule)`
| Removes a single validation rule from being applied to each selected value.
|
### Can Sort
| **Method**
| **Description** |
| `sortable()`
| Enables sorting for the setting. |