Configurables

Laravel Essentials turns on a set of opinionated defaults once your app has booted. Each default is a small class called a "configurable".

How it works

Every configurable implements Foxws\Essentials\Contracts\Configurable:

use Foxws\Essentials\Contracts\Configurable;

interface Configurable
{
    public function enabled(): bool;

    public function configure(): void;
}

After your app boots, Foxws\Essentials\Essentials::configure() looks at every configurable in the list, keeps only the ones whose enabled() returns true, and calls configure() on each of those. This happens automatically — you don't need to call anything yourself.

Built-in configurables

Configurable	Enabled when	What it does
AggressivePrefetching	Always	Vite::useAggressivePrefetching()
AutomaticallyEagerLoadRelationships	Always	Model::automaticallyEagerLoadRelationships()
EnforceMorphMap	essentials.morph_map is not empty	Relation::enforceMorphMap(...)
FakeSleep	Running unit tests	Sleep::fake()
ForceHttpsScheme	Always	URL::forceHttps()
ForceSecurePassword	Running in production	Password::defaults() with a 12–64 char, mixed-case, numbers, symbols, and "uncompromised" policy
ImmutableDates	Always	Date::use(CarbonImmutable::class)
ModelShouldBeStrict	Always	Model::shouldBeStrict()
ModelUnguard	Opt-in	Model::unguard()
PreventStrayRequests	Running unit tests	Http::preventStrayRequests()
ProhibitDestructiveCommands	Running in production	DB::prohibitDestructiveCommands()
ResourceWithoutWrapping	Always	JsonResource::withoutWrapping()

Want to change which ones run, or the order they run in? Publish the config file and edit the configurables array:

php artisan vendor:publish --tag="essentials-config"

// config/essentials.php
'configurables' => [
    Foxws\Essentials\Configurables\ForceHttpsScheme::class,
    Foxws\Essentials\Configurables\ImmutableDates::class,
    // ...
],

Writing your own configurable

namespace App\Configurables;

use Foxws\Essentials\Contracts\Configurable;
use Illuminate\Support\Facades\Date;

final readonly class UseUtcTimezone implements Configurable
{
    public function enabled(): bool
    {
        return true;
    }

    public function configure(): void
    {
        Date::setTestNow();
    }
}

Add it to config('essentials.configurables'), or register it while your app is running — for example, from your own package's service provider:

use App\Configurables\UseUtcTimezone;
use Foxws\Essentials\Essentials;

Essentials::extend(UseUtcTimezone::class);

// A class-string is resolved through the container; an instance works too.
Essentials::extend(new UseUtcTimezone);