Laravel Multidomain

https://github.com/gecche/laravel-multidomain
Admin
Laravel Multidomain is a package that enables a single Laravel installation to serve multiple HTTP...
Tokens:48,596
Snippets:385
Trust Score:8.5
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Domain list output example

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

Example of the associative array returned by the domainList() method, showing installed domains info.

```php
[ 
    site1.com => [
        'storage_path' => <LARAVEL-STORAGE-PATH>/site1_com,
        'env' => '.env.site1.com'
    ]
 ]
```

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

### Configure usage example in bootstrap/app.php

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Example of using Application::configure() with routing, middleware, and exceptions to create the application. Shows the recommended Laravel 11+ bootstrap pattern.

```php
use Gecche\Multidomain\Foundation\Application;

return Application::configure(basePath: dirname(__DIR__))
    ->withRouting(
        web: __DIR__.'/../routes/web.php',
        commands: __DIR__.'/../routes/console.php',
        health: '/up',
    )
    ->withMiddleware(function ($middleware) {
        //
    })
    ->withExceptions(function ($exceptions) {
        //
    })->create();
```

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

### environmentFile() usage example

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Shows how to call `$app->environmentFile()` to get the current environment file name, which could be a per-domain file like `.env.site1.com` or the default `.env`.

```php
$app->environmentFile(); // ".env.site1.com" or ".env"
```

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

### fullDomain() usage example

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Shows how to call `$app->fullDomain()` to get the full domain string including scheme and port, and check membership against given values.

```php
echo $app->fullDomain(); // "https://site1.com:443"

if ($app->fullDomain('http://site1.com')) {
    // ...
}
```

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

### Cache path accessors usage example

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Example command showing config:cache with --domain=site2.com writes bootstrap/cache/config-site2_com.php.

```php
php artisan config:cache --domain=site2.com
// writes bootstrap/cache/config-site2_com.php
```

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

### storagePath usage example

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Example call showing storage_path('app/public') resolves to '/path/to/storage/site1_com/app/public' for the current domain.

```php
storage_path('app/public'); // /path/to/storage/site1_com/app/public
```

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

### environmentFileDomain Example

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Resolves the .env.<domain> file name for a given domain, searching from most specific to least specific and falling back to .env. The example sets SERVER_NAME to 'sub1.site1.com' and expects only .env.site1.com to exist, so it returns '.env.site1.com'.

```php
$_SERVER['SERVER_NAME'] = 'sub1.site1.com';
// only .env.site1.com exists
echo $app->environmentFileDomain(); // ".env.site1.com"
```

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

### Domain-specific configuration file example

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

Create a PHP file under config/domains/ with the sanitized domain name. Values are merged recursively into the standard configuration.

```php
<?php

return [
    'app' => [
        'name' => 'Site 1 Application',
    ],
];
```

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

### Example of detect() with web and console scenarios

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/02-domain-detector.md

Shows how detect() returns the domain for web and console scenarios, including a console example with --domain argument.

```php
$_SERVER['SERVER_NAME'] = 'site1.com';
$detector = new DomainDetector();
echo $detector->detect();              // "site1.com"

$consoleArgs = ['artisan', 'list', '--domain=site1.com'];
echo $detector->detect($consoleArgs);  // "site1.com"
```

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

### Example instantiation of Application with domain detection

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Shows how to create an Application instance with a custom environment path and a domain detection function that reads HTTP_HOST from the server variables.

```php
$app = new Application(
    basePath: dirname(__DIR__),
    environmentPath: dirname(__DIR__) . DIRECTORY_SEPARATOR . 'envs',
    domainParams: [
        'domain_detection_function_web' => function () {
            return \Illuminate\Support\Arr::get($_SERVER, 'HTTP_HOST');
        },
    ]
);
```

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

### Example: creating ListenerOptions with domain

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/05-queue-integration.md

Shows how to instantiate ListenerOptions with a named domain. The $domain property is set to 'site1.com' and can be echoed directly.

```php
use Gecche\Multidomain\Queue\ListenerOptions;

$options = new ListenerOptions(
    name: 'default',
    environment: 'production',
    domain: 'site1.com',
);
echo $options->domain; // "site1.com"
```

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

### detectDomain usage example

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Example of calling detectDomain() and accessing the registered container bindings for domain, scheme, and port. Shows expected output values for a typical domain.

```php
$app->detectDomain();

echo $app['domain'];        // "site1.com"
echo $app['domain_scheme']; // "http"
echo $app['domain_port'];    // 80
```

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

### Example: configure() with domain_detection_function_web

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/configuration.md

Example of using Application::configure() with a domain_detection_function_web closure that returns HTTP_HOST from $_SERVER. The closure is passed to DomainDetector and called in detectWebDomain().

```php
use Gecche\Multidomain\Foundation\Application;

$domainParams = [
    'domain_detection_function_web' => function () {
        return \Illuminate\Support\Arr::get($_SERVER, 'HTTP_HOST');
    },
];

return Application::configure(
    basePath: dirname(__DIR__),
    environmentPath: null,
    domainParams: $domainParams,
)->withRouting(...)->withMiddleware(...)->withExceptions(...)->create();
```

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

### Example: creating SupervisorOptions and generating commands

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Shows how to instantiate `SupervisorOptions` with a named domain and generate supervisor and worker command strings. The output includes `--domain="site1.com"` in both commands.

```php
use Gecche\Multidomain\Horizon\SupervisorOptions;

$options = new SupervisorOptions('site1', 'redis', domain: 'site1.com');
echo $options->toSupervisorCommand(); // ... --domain="site1.com"
echo $options->toWorkerCommand();     // ... --domain="site1.com"
```

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

### buildResult return example

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/04-console-commands.md

Example of the array structure returned by `buildResult()`. Shows one row per domain with storage_dir and env_file paths.

```php
[
    ['domain' => 'site1.com', 'storage_dir' => '.../storage/site1_com', 'env_file' => '.../.env.site1.com'],
    // ...
]
```

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

### domain:list command example

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/04-console-commands.md

Example of running the `domain:list` command with `--output=json`. Output is a JSON array of domain objects.

```bash
php artisan domain:list --output=json
# [{"domain":"site1.com","storage_dir":"...","env_file":"..."}]
```

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

### domain() usage example

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Shows how to call `$app->domain()` to get the current domain and check if it matches one of the given values. The method forces domain detection first via `checkDomainDetection()`.

```php
$domain = $app->domain();

if ($app->domain('site1.com', 'site2.com')) {
    // shared logic for both sites
}
```

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

### get static method override

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Builds a ProvisioningPlan from config('horizon.environments') with each supervisor option array prefixed by ['domain' => $domain] (only when nested values are arrays), plus config('horizon.defaults', []).

```php
public static function get($master, string $domain = 'localhost')
```

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

### env_path usage examples

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/07-helpers.md

Examples of env_path with no argument and with a relative path. The function returns the environment path (base or custom) plus the appended path.

```php
env_path();                  // "/path/to/app" (or the custom env folder)
env_path('.env.site1.com'); // "/path/to/app/.env.site1.com"
```

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

### Add APP_PUBLIC_STORAGE entry to .env

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

Add an entry to .env.site1.com (and .env.site2.com) to define the storage link suffix. Example shows the entry for the first domain.

```bash
APP_PUBLIC_STORAGE=-site1_com
```

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

### exactDomainStoragePath usage example

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Example call showing the returned path for domain 'site1.com' becomes '/path/to/storage/site1_com'. The domain is sanitized by replacing dots with underscores.

```php
$app->exactDomainStoragePath('site1.com'); // /path/to/storage/site1_com
```

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

### Example of split() with various domain strings

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/02-domain-detector.md

Shows how split() returns an array with scheme, name, and port for different inputs.

```php
[$scheme, $name, $port] = $detector->split('https://site1.com:8443');
// $scheme = 'https', $name = 'site1.com', $port = '8443'
```

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

### domainStoragePath Example

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Returns the absolute path of the domain's storage folder, replacing dots with underscores, or the base storage path if no domain-specific folder exists. The example assumes storage/site1_com/ exists, so it returns that path for the current domain and the base path for 'site2.com'.

```php
// Given storage/site1_com/ exists
$app->domainStoragePath();                 // /path/to/storage/site1_com
$app->domainStoragePath('site2.com');      // /path/to/storage  (no site2_com dir)
```

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

### domain_root_url usage examples

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/07-helpers.md

Examples of domain_root_url with and without a path, and with a non-default port. The port is omitted when it equals :80 or :443; other ports are included.

```php
// app('domain') = 'site1.com', app('domain_scheme') = 'https', app('domain_port') = 443
domain_root_url();               // "https://site1.com"
domain_root_url('/dashboard');   // "https://site1.com/dashboard"

// port 8080 → included
domain_root_url();               // "https://site1.com:8080"
```

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

### domainsList usage example

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Iterates over the domainsList() result to print each domain's environment file and storage path. Uses app()->domainsList() to access the method.

```php
foreach (app()->domainsList() as $domain => $info) {
    echo $domain . ' uses ' . $info['env']
        . ' and storage ' . $info['storage_path'] . PHP_EOL;
}
```

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

### Example: calling artisan command with domain

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/03-kernels-bootstrappers.md

Shows how to invoke an artisan command with a --domain parameter and force bootstrap. The call returns the artisan command exit code.

```php
use Illuminate\Contracts\Console\Kernel;

app(Kernel::class)->call('migrate', ['--domain' => 'site1.com'], null, true);
```

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

### Example of instantiating DomainDetector with a custom closure

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/02-domain-detector.md

Shows how to create a DomainDetector instance with a custom closure that reads the HTTP_HOST from $_SERVER.

```php
$detector = new DomainDetector(function () {
    return \Illuminate\Support\Arr::get($_SERVER, 'HTTP_HOST');
});
```

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

### HorizonCommand handle method override

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Overrides the handle method to check for an existing master supervisor, create one, deploy the provisioning plan, and start monitoring.

```php
public function handle(MasterSupervisorRepository $masters)
```

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

### Queue configuration for separate domains

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

Example database queue configuration using QUEUE_DEFAULT env variable to set a default queue per domain. This is part of a workflow to manage jobs separately for domains sharing the same database.

```php
'database' => [
    'driver' => 'database',
    'table' => 'jobs',
    'queue' => env('QUEUE_DEFAULT','default'),
    'retry_after' => 90,
],
```

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

### Example of php artisan domain:add command

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/04-console-commands.md

Example invocation of the 'domain:add' command with a domain name and --domain_values JSON. Creates .env.site1.com, storage/site1_com/ mirroring the storage_dirs tree from config/domain.php, and a site1.com entry in config/domain.php domains.

```bash
php artisan domain:add site1.com \
  --domain_values='{"DB_DATABASE":"db_site1","QUEUE_DEFAULT":"default1"}'
```

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

### Command usage examples

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/04-console-commands.md

Shows two invocations: without `--force` removes only the env file and config entry; with `--force` also deletes the storage directory `storage/site2_com/`.

```bash
php artisan domain:remove site2.com            # env file + config entry only
php artisan domain:remove site2.com --force    # also deletes storage/site2_com/
```

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

### Example usage of domain:update_env

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/04-console-commands.md

Shows how to update all domain env files (including .env) or a single domain's env file using the `--domain_values` option with a JSON object.

```bash
# Update every domain env file (and .env)
php artisan domain:update_env --domain_values='{"TOM_DRIVER":"TOMMY"}'

# Update only one domain env file
php artisan domain:update_env site1.com --domain_values='{"TOM_DRIVER":"TOMMY"}'
```

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

### Example using DomainCommandTrait in a custom command

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/04-console-commands.md

Shows how to use the `DomainCommandTrait` in a custom artisan command. The trait provides methods like `getDomainEnvFilePath` and `getVarsArray`.

```php
use Gecche\Multidomain\Foundation\Console\DomainCommandTrait;

class MyDomainCommand extends \Illuminate\Console\Command
{
    use DomainCommandTrait;

    public function handle()
    {
        $this->domain = $this->argument('domain');
        $envFile = $this->getDomainEnvFilePath();
        $vars = $this->getVarsArray($envFile);
        // ...
    }
}
```

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

### domainsList return array structure

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Example of the array structure returned by domainsList(). Each domain entry contains 'storage_path' and 'env' keys, populated by calling domainStoragePath($domain) and environmentFileDomain($domain).

```php
[
    'site1.com' => [
        'storage_path' => '/path/to/storage/site1_com',
        'env'          => '.env.site1.com',
    ],
    // ...
]
```

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

### Custom HTTP domain detection with domainParams

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

Pass a Closure as 'domain_detection_function_web' in the 'domainParams' argument of Application's constructor to customize HTTP domain detection. This example uses $_SERVER['HTTP_HOST'] instead of $_SERVER['SERVER_NAME']. Requires Laravel 11+ style bootstrap file.

```php
//use Illuminate\Foundation\Application;
use Gecche\Multidomain\Foundation\Application;
use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Foundation\Configuration\Middleware;

$environmentPath = null;

$domainParams = [
    'domain_detection_function_web' => function() {
        return \Illuminate\Support\Arr::get($_SERVER,'HTTP_HOST');
    }
];

return Application::configure(basePath: dirname(__DIR__),
    environmentPath: $environmentPath,
    domainParams: $domainParams)
    ->withRouting(
        web: __DIR__.'/../routes/web.php',
        commands: __DIR__.'/../routes/console.php',
        health: '/up',
    )
    ->withMiddleware(function (Middleware $middleware) {
        //
    })
    ->withExceptions(function (Exceptions $exceptions) {
        //
    })->create();
```

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

### new Application()

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/configuration.md

Creates a new Application instance with multidomain support. Accepts the same parameters as configure().

```APIDOC
## new Application()

### Description
Creates a new Application instance with multidomain support. Accepts the same parameters as `configure()`.

### Method
`new Application`

### Parameters
- **basePath** (string) - Required - The base path of the application.
- **environmentPath** (string|null) - Optional - Path to a dedicated folder for `.env*` files.
- **domainParams** (array) - Optional - Configuration array. Supported key:
  - `domain_detection_function_web` (Closure|null) - Optional - Closure invoked for the web scenario; must return the domain string.

### Example
```php
use Gecche\Multidomain\Foundation\Application;

$domainParams = [
    'domain_detection_function_web' => function () {
        return \Illuminate\Support\Arr::get($_SERVER, 'HTTP_HOST');
    },
];

$app = new Application($basePath, $environmentPath, $domainParams);
```
```

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

### domain_sanitized usage examples

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/07-helpers.md

Examples of domain_sanitized with different inputs and replacement characters. The function returns str_replace('.', $replacing_char, $domain).

```php
domain_sanitized('site1.com');        // "site1_com"
domain_sanitized('sub.site1.com');    // "sub_site1_com"
domain_sanitized('site1.com', '-');   // "site1-com"
```

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

### Default environment file search order for a domain

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

When no specific environment file exists for a domain (e.g., .env.sub1.site1.com), the package searches for the first available file by splitting the domain name with dots. The same logic applies to storage folders.

```text
.env.site1.com
.env.com
.env
```

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

### Run tests with phpunit

Source: https://github.com/gecche/laravel-multidomain/blob/master/tests/README.md

Launch the test suite from the package folder using the standard PHPUnit binary.

```bash
../../../vendor/bin/phpunit
```

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

### Add a domain with domain:add

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

Run the artisan command to add a new HTTP domain. Creates a new environment file and storage folder for the domain.

```bash
php artisan domain:add site1.com 
```

```bash
php artisan domain:add site2.com 
```

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

### Example of php artisan domain command

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/04-console-commands.md

Example invocation of the 'domain' command with the --domain option. Output shows 'Current application domain: site1.com--80--http'.

```bash
php artisan domain --domain=site1.com
# Current application domain: site1.com--80--http
```

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

### Bind queue.listener singleton

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/05-queue-integration.md

Creates the Listener instance with the application base path.

```php
$this->app->singleton('queue.listener', function () {
    return new Listener($this->app->basePath());
});
```

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

### QueueCommandString toOptionsString return format

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Returns a sprintf string with all options, including --domain which defaults to 'localhost' for plain base-class options. Appends --force and --paused when applicable.

```php
sprintf('--backoff=%s --max-time=%s --max-jobs=%s --memory=%s --queue="%s" --sleep=%s --timeout=%s --tries=%s --domain="%s"',
    ...,
    (($options instanceof SupervisorOptions) ? $options->domain : 'localhost'));
```

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

### ListenerOptions construction

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/05-queue-integration.md

Builds a ListenerOptions instance from command options, including the domain option.

```php
return new ListenerOptions(
    name: $this->option('name'),
    environment: $this->option('env'),
    backoff: $backoff,            // 'backoff' option, falling back to 'delay'
    memory: $this->option('memory'),
    timeout: $this->option('timeout'),
    sleep: $this->option('sleep'),
    rest: $this->option('rest'),
    maxTries: $this->option('tries'),
    force: $this->option('force'),
    domain: $this->option('domain')
);
```

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

### toSupervisorCommand method

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Returns a string via `SupervisorCommandString::fromOptions($this)`, producing the supervisor command line including `--domain` (inherits `fromOptions` from the base class).

```php
public function toSupervisorCommand()
```

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

### Publish the config file

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

Run this artisan command to publish the package configuration. The package uses Laravel's discovery feature.

```bash
php artisan vendor:publish 
```

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

### Application::configure (static)

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Static factory method that creates an ApplicationBuilder pre-configured with kernels, events, commands, and providers. It is the recommended bootstrap entry point for Laravel 11+ style bootstrap/app.php files.

```APIDOC
## [STATIC] Application::configure

### Description
Static factory method that creates an ApplicationBuilder pre-configured with kernels, events, commands, and providers. It is the recommended bootstrap entry point for Laravel 11+ style bootstrap/app.php files.

### Method
Static

### Signature
`public static function configure(?string $basePath = null, ?string $environmentPath = null, array $domainParams = [])`

### Parameters
- **$basePath** (?string) - Optional - Base path; if not a string, `static::inferBasePath()` is used.
- **$environmentPath** (?string) - Optional - Folder containing the `.env` files.
- **$domainParams** (array) - Optional - See constructor.

### Returns
`\Gecche\Multidomain\Foundation\Configuration\ApplicationBuilder` — a builder already chained with `->withKernels()->withEvents()->withCommands()->withProviders()`.

### Example
```php
use Gecche\Multidomain\Foundation\Application;

return Application::configure(basePath: dirname(__DIR__))
    ->withRouting(
        web: __DIR__.'/../routes/web.php',
        commands: __DIR__.'/../routes/console.php',
        health: '/up',
    )
    ->withMiddleware(function ($middleware) {
        //
    })
    ->withExceptions(function ($exceptions) {
        //
    })->create();
```
```

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

### ListDomainCommand class definition

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/04-console-commands.md

Defines the artisan command `domain:list` with an `--output` option (txt, table, or json). The command lists domains installed in the application.

```php
class ListDomainCommand extends Command
{
    use DomainCommandTrait;

    protected $signature = 'domain:list
                            {--output=txt : the output type json or txt (txt as default)}';

    protected $description = "Lists domains installed in the application.";
}
```

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

### ProvisioningPlan class declaration

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Class extends the base provisioning plan.

```php
class ProvisioningPlan extends BaseProvisioningPlan
```

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

### Create symbolic links for multiple storage domains

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

Manually create symbolic links for each domain's storage folder. This is required because the storage:link command always creates a link named 'storage'.

```bash
ln -s storage/site1_com/app/public public/storage-site1_com
```

```bash
ln -s storage/site2_com/app/public public/storage-site2_com
```

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

### InputOption for --domain

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/03-kernels-bootstrappers.md

Creates the --domain option with VALUE_OPTIONAL and a description. Used by getDomainOption().

```php
new InputOption('--domain', null, InputOption::VALUE_OPTIONAL,
                'The domain the command should run under.')
```

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

### environmentFile() method signature

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Declares the public method `environmentFile()` with no parameters. Returns `$this->environmentFile` if explicitly set, otherwise the resolved per-domain env file name from `environmentFileDomain()`.

```php
public function environmentFile()
```

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

### convert protected method override

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Returns SupervisorOptions::fromArray(['domain' => $options['domain']] + parent::convert(...)->toArray()).

```php
protected function convert($supervisor, $options)
```

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

### SupervisorOptions constructor with domain parameter

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Constructor accepting all base options plus a new `$domain` parameter (default 'localhost'). Delegates all but `$domain` to the parent constructor, then sets `$this->domain = $domain`.

```php
public function __construct($name,
                            $connection,
                            $queue = null,
                            $workersName = 'default',
                            $balance = 'off',
                            $backoff = 0,
                            $maxTime = 0,
                            $maxJobs = 0,
                            $maxProcesses = 1,
                            $minProcesses = 1,
                            $memory = 128,
                            $timeout = 60,
                            $sleep = 3,
                            $maxTries = 0,
                            $force = false,
                            $nice = 0,
                            $balanceCooldown = 3,
                            $balanceMaxShift = 1,
                            $parentId = 0,
                            string $domain = 'localhost')
```

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

### queue:work with --domain option

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

The 'queue:work' command accepts a new 'domain' option to use the corresponding domain settings.

```bash
php artisan queue:work --domain=site1.com
```

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

### bootstrap/app.php: Optional environmentPath

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/configuration.md

Shows how to set a dedicated environmentPath folder for all .env* files. If set, the standard .env must live in that folder as well.

```php
$environmentPath = dirname(__DIR__) . DIRECTORY_SEPARATOR . 'envs';

return Application::configure(
    basePath: dirname(__DIR__),
    environmentPath: $environmentPath,
    domainParams: [],
)->withRouting(...)->withMiddleware(...)->withExceptions(...)->create();
```

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

### Constructor signature for Application

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Defines the constructor parameters: $basePath, $environmentPath, and $domainParams. The environment path defaults to the base path, and the only supported domain param is 'domain_detection_function_web'.

```php
public function __construct($basePath = null, $environmentPath = null, $domainParams = [])
```

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

### Application constructor and configure() with domainParams

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/configuration.md

Shows the two accepted ways to pass domainParams to the Application constructor or configure() method. The domain_detection_function_web closure must return the domain string and is used when $_SERVER['SERVER_NAME'] is unavailable.

```php
new Application($basePath, $environmentPath, $domainParams);

Application::configure(basePath: ..., environmentPath: ..., domainParams: $domainParams);
```

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

### Configure public disk for custom storage link

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

Update the 'public' disk in filesystems.php to use the APP_PUBLIC_STORAGE environment variable in the URL, enabling distinct storage links per domain.

```php
'public' => [
    'driver' => 'local',
    'root' => storage_path('app/public'),
    'url' => env('APP_URL').'/storage'.env('APP_PUBLIC_STORAGE'),
    'visibility' => 'public',
],
```

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

### Extend ListenCommand binding

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/05-queue-integration.md

Replaces the framework's ListenCommand with QueueListenCommand constructed with the queue.listener singleton.

```php
$this->app->extend(ListenCommand::class, function ($command, $app) {
    return new QueueListenCommand($app['queue.listener']);
});
```

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

### Cache config for site1.com

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

Run config:cache with the --domain option to include merged domain-specific configuration in the cached file.

```bash
php artisan config:cache --domain=site1.com
```

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

### Application::__construct

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Creates a new multidomain-aware Laravel application instance. It accepts the base path, an optional environment path, and domain handling parameters.

```APIDOC
## Application::__construct

### Description
Creates a new multidomain-aware Laravel application instance. It accepts the base path, an optional environment path, and domain handling parameters.

### Method
Constructor

### Signature
```php
public function __construct($basePath = null, $environmentPath = null, $domainParams = [])
```

### Parameters
- `$basePath` (string|null) - Optional - Laravel application base path.
- `$environmentPath` (string|null) - Optional - Folder where `.env` files live; falls back to `$basePath`.
- `$domainParams` (array) - Optional - Domain handling parameters; the only supported key so far is `domain_detection_function_web` (`null|Closure`).

### Behavior
Stores `$domainParams`, defaults the environment path to the base path, calls `useEnvironmentPath(rtrim($environmentPath,'\/'))` and then delegates to the parent constructor.

### Example
```php
$app = new Application(
    basePath: dirname(__DIR__),
    environmentPath: dirname(__DIR__) . DIRECTORY_SEPARATOR . 'envs',
    domainParams: [
        'domain_detection_function_web' => function () {
            return \Illuminate\Support\Arr::get($_SERVER, 'HTTP_HOST');
        },
    ]
);
```
```

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

### Queue worker and listener commands for a domain

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/05-queue-integration.md

Shows how to run queue:work and queue:listen for a specific domain. The worker subprocess receives --domain=site1.com, and the DetectDomain bootstrapper loads .env.site1.com.

```bash
# Worker for a domain
php artisan queue:work --domain=site1.com --queue=default1

# Listener for a domain
php artisan queue:listen --domain=site1.com --queue=default1
```

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

### toWorkerCommand method

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Returns a string via `WorkerCommandString::fromOptions($this)`, producing the worker command line including `--domain`.

```php
public function toWorkerCommand()
```

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

### Register multidomain kernels as singletons

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/03-kernels-bootstrappers.md

Registers the multidomain HTTP and Console kernels as singletons against the framework contracts.

```php
$this->app->singleton(
    \Illuminate\Contracts\Http\Kernel::class,
    \Gecche\Multidomain\Foundation\Http\Kernel::class,
);

$this->app->singleton(
    \Illuminate\Contracts\Console\Kernel::class,
    \Gecche\Multidomain\Foundation\Console\Kernel::class,
);
```

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

### Horizon environments configuration shape with domain key

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/types.md

Shows the structure of config('horizon.environments') after ProvisioningPlan::get() adds a 'domain' key to the innermost supervisor-options arrays. The 'domain' key is prepended to each supervisor's options, while intermediate environment-to-supervisor groupings remain unchanged.

```php
// config('horizon.environments')
[
    'production' => [
        'supervisor-1' => [
            'connection' => 'redis',
            'queue'      => 'default',
            // + 'domain' => 'site1.com'  (prepended by ProvisioningPlan::get)
        ],
    ],
]
```

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

### SupervisorOptions::__construct

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Creates a new SupervisorOptions instance with the given parameters. The constructor delegates all but the domain parameter to the parent constructor and then sets the domain property.

```APIDOC
## SupervisorOptions::__construct

### Description
Creates a new SupervisorOptions instance with the given parameters. The constructor delegates all but the domain parameter to the parent constructor and then sets the domain property.

### Method
Constructor

### Signature
```php
public function __construct($name,
                            $connection,
                            $queue = null,
                            $workersName = 'default',
                            $balance = 'off',
                            $backoff = 0,
                            $maxTime = 0,
                            $maxJobs = 0,
                            $maxProcesses = 1,
                            $minProcesses = 1,
                            $memory = 128,
                            $timeout = 60,
                            $sleep = 3,
                            $maxTries = 0,
                            $force = false,
                            $nice = 0,
                            $balanceCooldown = 3,
                            $balanceMaxShift = 1,
                            $parentId = 0,
                            string $domain = 'localhost')
```

### Parameters
- `$name` (string) - Required - Supervisor name.
- `$connection` (string) - Required - Queue connection.
- `$queue` (string|null) - Optional - Queue(s) to supervise.
- `$workersName` (string) - Optional - Worker pool name.
- `$balance` (string) - Optional - Balancing strategy (`off`, `simple`, `auto`).
- `$backoff` (int) - Optional - Seconds between retries.
- `$maxTime` (int) - Optional - Max seconds a worker may run (0 = unlimited).
- `$maxJobs` (int) - Optional - Max jobs per worker (0 = unlimited).
- `$maxProcesses` (int) - Optional - Max supervisor processes.
- `$minProcesses` (int) - Optional - Min supervisor processes.
- `$memory` (int) - Optional - Memory limit in MB.
- `$timeout` (int) - Optional - Worker timeout in seconds.
- `$sleep` (int) - Optional - Sleep in seconds when idle.
- `$maxTries` (int) - Optional - Max tries (0 = unlimited).
- `$force` (bool) - Optional - Run in maintenance mode.
- `$nice` (int) - Optional - Process priority.
- `$balanceCooldown` (int) - Optional - Seconds between balance ops.
- `$balanceMaxShift` (int) - Optional - Max process shift per balance pass.
- `$parentId` (int) - Optional - Parent supervisor PID.
- `$domain` (string) - Optional - Domain for this supervisor.

### Returns
No return value (constructor).
```

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

### QueueCommandString toOptionsString signature

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Static override method that builds a command string with options, including domain and optional paused flag.

```php
public static function toOptionsString(BaseSupervisorOptions $options, $paused = false)
```

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

### TimeoutCommand handle method override

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Overrides the handle method to load the provisioning plan and print the timeout value.

```php
public function handle()
```

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

### domainsList()

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Returns an associative array of all configured domains and their associated storage paths and environment files. This method is part of the application's public API and can be called directly on the application instance.

```APIDOC
## `domainsList()`

### Description
Returns an associative array keyed by domain name, built from `config('domain.domains', [])`. Each entry contains the storage path and environment file for that domain.

### Method
`domainsList()`

### Endpoint
`app()->domainsList()`

### Parameters
None

### Returns
- **array** - Associative array keyed by domain name, with each value containing:
  - **storage_path** (string) - The storage path for the domain.
  - **env** (string) - The environment file for the domain.

### Example
```php
foreach (app()->domainsList() as $domain => $info) {
    echo $domain . ' uses ' . $info['env']
        . ' and storage ' . $info['storage_path'] . PHP_EOL;
}
```
```

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

### ListenerOptions constructor signature

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/05-queue-integration.md

Constructor accepts worker parameters including the new $domain argument. Sets $this->domain first, then delegates to the parent constructor with the remaining arguments.

```php
public function __construct($name = 'default', $environment = null, $backoff = 0, $memory = 128, $timeout = 60, $sleep = 3, $maxTries = 1, $force = false, $rest = 0, ?string $domain = null)
```

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

### SupervisorOptions::toSupervisorCommand

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Generates the supervisor command line string for this options instance. The command includes the domain parameter.

```APIDOC
## SupervisorOptions::toSupervisorCommand

### Description
Generates the supervisor command line string for this options instance. The command includes the domain parameter.

### Method
Method

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

### Returns
- (string) - The supervisor command line string, including `--domain`.
```

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

### makeProcess method signature

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/05-queue-integration.md

Builds the worker subprocess command, optionally adding the --domain flag when ListenerOptions has a domain set.

```php
public function makeProcess($connection, $queue, BaseListenerOptions $options)
```

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

### Run tests with SERVER_NAME=site1.test

Source: https://github.com/gecche/laravel-multidomain/blob/master/tests/README.md

Simulate the site1.test domain by setting the SERVER_NAME environment variable before running PHPUnit.

```bash
SERVER_NAME=site1.test ../../../vendor/bin/phpunit
```

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

### addDomain method signature

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/05-queue-integration.md

Appends the --domain option to the command array.

```php
protected function addDomain(array $command, ListenerOptions $options) : array
```

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

### environmentFileDomain($domain = null)

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Resolves the environment file name for a given domain, searching from most specific to least specific domain variants and falling back to '.env'. Returns the name of the '.env.<domain>' file to use.

```APIDOC
## environmentFileDomain($domain = null)

### Description
Resolves the environment file name for a given domain, searching from most specific to least specific domain variants and falling back to '.env'. Returns the name of the '.env.<domain>' file to use.

### Method
environmentFileDomain

### Signature
public function environmentFileDomain($domain = null)

### Parameters
- **$domain** (string|null) - Optional - Domain to resolve; defaults to the current `app('domain')`.

### Returns
- **string** - The name of the `.env.<domain>` file to use for the given domain.

### Resolution Logic
The domain is split on dots; the package looks for `.env.<full-domain>`, then `.env.<domain-without-first-label>`, etc., until it finds an existing file; falls back to `.env`. For `sub1.site1.com` it searches `.env.sub1.site1.com` → `.env.site1.com` → `.env.com` → `.env`.

### Example
```php
$_SERVER['SERVER_NAME'] = 'sub1.site1.com';
// only .env.site1.com exists
echo $app->environmentFileDomain(); // ".env.site1.com"
```

### Source
`src/Foundation/Application.php:169`
```

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

### DomainConsoleServiceProvider boot method

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/03-kernels-bootstrappers.md

Defines the boot method that returns void. It publishes the package config file to config/domain.php.

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

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

### Run tests with SERVER_NAME=site2.test

Source: https://github.com/gecche/laravel-multidomain/blob/master/tests/README.md

Simulate the site2.test domain by setting the SERVER_NAME environment variable before running PHPUnit.

```bash
SERVER_NAME=site2.test ../../../vendor/bin/phpunit
```

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

### SupervisorCommandString toOptionsString signature

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Static override method that returns QueueCommandString::toSupervisorOptionsString($options).

```php
public static function toOptionsString(SupervisorOptions $options)
```

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

### Cache config for a specific domain

Source: https://github.com/gecche/laravel-multidomain/blob/master/README.md

Run config:cache with the --domain option to generate a domain-specific cached config file.

```bash
php artisan config:cache --domain=site2.com 
```

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

### getDomainOption method signature

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/03-kernels-bootstrappers.md

Returns an InputOption for the --domain option.

```php
protected function getDomainOption()
```

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

### fullDomain() method signature

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Declares the public method `fullDomain()` with no parameters but accepts variadic values. Operates on `app('full_domain')` which includes the HTTP scheme and port.

```php
public function fullDomain()
```

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

### ListenerOptions::__construct

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/05-queue-integration.md

Creates a new ListenerOptions instance for configuring queue workers in a multidomain environment. The constructor accepts worker parameters and an optional domain to run the worker under.

```APIDOC
## ListenerOptions::__construct

### Description
Creates a new ListenerOptions instance for configuring queue workers in a multidomain environment. The constructor accepts worker parameters and an optional domain to run the worker under.

### Method
Constructor

### Signature
```php
public function __construct($name = 'default', $environment = null, $backoff = 0, $memory = 128, $timeout = 60, $sleep = 3, $maxTries = 1, $force = false, $rest = 0, ?string $domain = null)
```

### Parameters
- `$name` (string) - Optional - Worker/process name. Default: `'default'`.
- `$environment` (string|null) - Optional - Environment (`--env`) passed to the worker. Default: `null`.
- `$backoff` (int) - Optional - Seconds to wait before retrying a job. Default: `0`.
- `$memory` (int) - Optional - Memory limit in MB. Default: `128`.
- `$timeout` (int) - Optional - Worker timeout in seconds. Default: `60`.
- `$sleep` (int) - Optional - Seconds to sleep when no job is available. Default: `3`.
- `$maxTries` (int) - Optional - Maximum job attempts. Default: `1`.
- `$force` (bool) - Optional - Force the worker to run even in maintenance mode. Default: `false`.
- `$rest` (int) - Optional - Seconds to rest between jobs. Default: `0`.
- `$domain` (?string) - Optional - Domain passed to the worker; `null` keeps base-env behavior. Default: `null`.

### Description
Sets `$this->domain` first, then delegates to the parent constructor with the same (minus `$domain`) arguments.

### Example
```php
use Gecche\Multidomain\Queue\ListenerOptions;

$options = new ListenerOptions(
    name: 'default',
    environment: 'production',
    domain: 'site1.com',
);
echo $options->domain; // "site1.com"
```

```

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

### add protected method override

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Pushes AddSupervisor onto the HorizonCommandQueue for MasterSupervisor::commandQueueFor($this->master) with $options->toArray().

```php
protected function add(BaseSupervisorOptions $options)
```

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

### Package config file shape (config/domain.php)

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/types.md

Default configuration file published by DomainConsoleServiceProvider::boot(). Defines env_stub, storage_dirs, and domains keys consumed by domain:add, domain:remove, and related commands.

```php
return [
    'env_stub' => '.env',
    'storage_dirs' => [
        'app' => ['public' => []],
        'framework' => ['cache' => [], 'testing' => [], 'sessions' => [], 'views' => []],
        'logs' => [],
    ],
    'domains' => [],
];
```

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

### registerListener method override

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/05-queue-integration.md

Binds the queue.listener singleton to a new Listener instance using the application base path.

```php
protected function registerListener()
```

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

### Application::configure()

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/configuration.md

Configures the Laravel application with multidomain support. Accepts an optional domainParams array containing a closure for web domain detection.

```APIDOC
## Application::configure()

### Description
Configures the Laravel application with multidomain support. Accepts an optional `domainParams` array containing a closure for web domain detection.

### Method
`Application::configure`

### Parameters
- **basePath** (string) - Required - The base path of the application.
- **environmentPath** (string|null) - Optional - Path to a dedicated folder for `.env*` files.
- **domainParams** (array) - Optional - Configuration array. Supported key:
  - `domain_detection_function_web` (Closure|null) - Optional - Closure invoked for the web scenario; must return the domain string. Used when `$_SERVER['SERVER_NAME']` is unavailable.

### Example
```php
use Gecche\Multidomain\Foundation\Application;

$domainParams = [
    'domain_detection_function_web' => function () {
        return \Illuminate\Support\Arr::get($_SERVER, 'HTTP_HOST');
    },
];

return Application::configure(
    basePath: dirname(__DIR__),
    environmentPath: null,
    domainParams: $domainParams,
)->withRouting(...)->withMiddleware(...)->withExceptions(...)->create();
```
```

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

### Horizon deployment flow diagram

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Shows the call chain when running `php artisan horizon --domain=site1.com`. The `domain` option is stamped into every supervisor config, and `SupervisorProcess::reprovision()` re-queues `AddSupervisor` to continue the loop.

```text
php artisan horizon --domain=site1.com
  └─ HorizonCommand::handle()
      └─ ProvisioningPlan::get(name, 'site1.com')   # stamps 'domain' into every supervisor config
          └─ deploy(env)
              └─ add(SupervisorOptions ... domain)
                  └─ HorizonCommandQueue::push(..., AddSupervisor::class, $options->toArray())
                      └─ AddSupervisor::process()
                          └─ SupervisorProcess (new SupervisorOptions via fromArray)
                              └─ SupervisorProcess::reprovision() → queue AddSupervisor again
worker commands (QueueCommandString) ... --domain="site1.com"
```

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

### environmentFile

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/01-foundation-application.md

Returns the environment file name to use. If an environment file has been explicitly set, it returns that; otherwise, it resolves the per-domain environment file name.

```APIDOC
## environmentFile

### Description
Returns the environment file name to use. If an environment file has been explicitly set, it returns that; otherwise, it resolves the per-domain environment file name.

### Method
`environmentFile`

### Parameters
None.

### Returns
- **string** - The environment file name (e.g., `.env.site1.com` or `.env`).

### Example
```php
$app->environmentFile(); // ".env.site1.com" or ".env"
```
```

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

### AddSupervisor class declaration

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Declares the AddSupervisor class extending BaseAddSupervisor.

```php
class AddSupervisor extends BaseAddSupervisor
```

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

### Gecche\Multidomain\Horizon\SupervisorOptions class definition

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/types.md

Extends BaseSupervisorOptions with a $domain property defaulting to 'localhost'. Used by ProvisioningPlan, SupervisorCommand, AddSupervisor, and QueueCommandString.

```php
class SupervisorOptions extends BaseSupervisorOptions
{
    public string $domain = 'localhost';
}
```

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

### ListenerOptions class with domain property

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/05-queue-integration.md

Extends BaseListenerOptions and adds a nullable $domain property for the domain under which workers run. Defaults to null, preserving base-environment behavior.

```php
class ListenerOptions extends BaseListenerOptions
{
    public ?string $domain;
}
```

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

### reprovision method signature

Source: https://github.com/gecche/laravel-multidomain/blob/master/_autodocs/api-reference/06-horizon-integration.md

Protected override method that pushes AddSupervisor to MasterSupervisor::commandQueue() with options including the domain.

```php
protected function reprovision()
```
Tokens:
Raw