Merge branch 'master' into 515-complete

assets/config.php

@@ -4,6 +4,8 @@ declare(strict_types=1);
 
 use Stancl\Tenancy\Database\Models\Domain;
 use Stancl\Tenancy\Database\Models\Tenant;
+use Stancl\Tenancy\Middleware;
+use Stancl\Tenancy\Resolvers;
 
 return [
     'tenant_model' => Tenant::class,
@@ -21,6 +23,56 @@ return [
         'localhost',
     ],
 
+    'identification' => [
+        /**
+         * The default middleware used for tenant identification.
+         *
+         * If you use multiple forms of identification, you can set this to the "main" approach you use.
+         */
+        'default_middleware' => Middleware\InitializeTenancyByDomain::class,// todo@identification add this to a 'tenancy' mw group
+
+        /**
+         * All of the identification middleware used by the package.
+         *
+         * If you write your own, make sure to add them to this array.
+         */
+        'middleware' => [
+            Middleware\InitializeTenancyByDomain::class,
+            Middleware\InitializeTenancyBySubdomain::class,
+            Middleware\InitializeTenancyByDomainOrSubdomain::class,
+            Middleware\InitializeTenancyByPath::class,
+            Middleware\InitializeTenancyByRequestData::class,
+        ],
+
+        /**
+         * Tenant resolvers used by the package.
+         *
+         * Resolvers which implement the CachedTenantResolver contract have options for configuring the caching details.
+         * If you add your own resolvers, do not add the 'cache' key unless your resolver is based on CachedTenantResolver.
+         */
+        'resolvers' => [
+            Resolvers\DomainTenantResolver::class => [
+                'cache' => false,
+                'cache_ttl' => 3600, // seconds
+                'cache_store' => null, // default
+            ],
+            Resolvers\PathTenantResolver::class => [
+                'tenant_parameter_name' => 'tenant',
+
+                'cache' => false,
+                'cache_ttl' => 3600, // seconds
+                'cache_store' => null, // default
+            ],
+            Resolvers\RequestDataTenantResolver::class => [
+                'cache' => false,
+                'cache_ttl' => 3600, // seconds
+                'cache_store' => null, // default
+            ],
+        ],
+
+        // todo@docs update integration guides to use Stancl\Tenancy::defaultMiddleware()
+    ],
+
     /**
      * Tenancy bootstrappers are executed when tenancy is initialized.
      * Their responsibility is making Laravel features tenant-aware.
@@ -32,6 +84,7 @@ return [
         Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper::class,
         Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper::class,
         Stancl\Tenancy\Bootstrappers\QueueTenancyBootstrapper::class,
+        Stancl\Tenancy\Bootstrappers\BatchTenancyBootstrapper::class,
         // Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper::class, // Note: phpredis is needed
     ],
 
@@ -123,6 +176,24 @@ return [
             'public' => '%storage_path%/app/public/',
         ],
 
+        /*
+         * Tenant-aware Storage::disk()->url() can be enabled for specific local disks here
+         * by mapping the disk's name to a name with '%tenant_id%' (this will be used as the public name of the disk).
+         * Doing that will override the disk's default URL with a URL containing the current tenant's key.
+         *
+         * For example, Storage::disk('public')->url('') will return https://your-app.test/storage/ by default.
+         * After adding 'public' => 'public-%tenant_id%' to 'url_override',
+         * the returned URL will be https://your-app.test/public-1/ (%tenant_id% gets substitued by the current tenant's ID).
+         *
+         * Use `php artisan tenants:link` to create a symbolic link from the tenant's storage to its public directory.
+         */
+        'url_override' => [
+            // Note that the local disk you add must exist in the tenancy.filesystem.root_override config
+            // todo@v4 Rename %tenant_id% to %tenant_key%
+            // todo@v4 Rename url_override to something that describes the config key better
+            'public' => 'public-%tenant_id%',
+        ],
+
         /**
          * Should storage_path() be suffixed.
          *
@@ -201,4 +272,12 @@ return [
         '--class' => 'DatabaseSeeder', // root seeder class
         // '--force' => true,
     ],
+
+    /**
+     * Single-database tenancy config.
+     */
+    'single_db' => [
+        /** The name of the column used by models with the BelongsToTenant trait. */
+        'tenant_id_column' => 'tenant_id',
+    ],
 ];