archtechx/tenancy
1
0
Fork 0
mirror of https://github.com/archtechx/tenancy.git synced 2025-12-12 19:54:03 +00:00
Code Activity

Clarify bootstrapper comments

Browse source
This commit is contained in:
lukinovec 2025-07-31 15:30:14 +02:00
parent bd44036a9f
commit 63bf4bf80e
1 changed files with 14 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

27
src/Bootstrappers/LogTenancyBootstrapper.php
View file

@ -11,12 +11,14 @@ use Stancl\Tenancy\Contracts\TenancyBootstrapper;
use Stancl\Tenancy\Contracts\Tenant; use Stancl\Tenancy\Contracts\Tenant;
/** /**
* Bootstrapper for tenant-specific logging configuration. * This bootstrapper makes it possible to configure tenant-specific logging.
* *
* Automatically configures storage path channels (single, daily) to use tenant storage directories. * By default, the storage path channels ('single' and 'daily' by default, feel free to configure that using the $storagePathChannels property)
* Supports custom channel overrides via the $channelOverrides property. * are configured to use tenant storage directories. For this to work correctly,
* this bootstrapper must run *after* FilesystemTenancyBootstrapper.
*
* The bootstrapper also supports custom channel overrides via the $channelOverrides property (see the ).
* *
* Note: Must run after FilesystemTenancyBootstrapper for storage path channels to work correctly.
* *
* @see Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper * @see Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper
*/ */
@ -28,8 +30,8 @@ class LogTenancyBootstrapper implements TenancyBootstrapper
protected array $channels = []; protected array $channels = [];
/** /**
* Log channels that use storage paths for storing the logs. * Log channels that use the storage_path() helper for storing the logs.
* Requires FilesystemTenancyBootstrapper to run first. * Requires FilesystemTenancyBootstrapper to run before this bootstrapper.
*/ */
public static array $storagePathChannels = ['single', 'daily']; public static array $storagePathChannels = ['single', 'daily'];
@ -37,7 +39,7 @@ class LogTenancyBootstrapper implements TenancyBootstrapper
* Custom channel configuration overrides. * Custom channel configuration overrides.
* *
* Examples: * Examples:
* - Array mapping: ['slack' => ['url' => 'webhookUrl']] maps $tenant->webhookUrl to slack.url * - Array mapping: ['slack' => ['url' => 'webhookUrl']] maps $tenant->webhookUrl to slack.url (if $tenant->webhookUrl is set, otherwise, the override is ignored)
* - Closure: ['slack' => fn ($config, $tenant) => $config->set('logging.channels.slack.url', $tenant->slackUrl)] * - Closure: ['slack' => fn ($config, $tenant) => $config->set('logging.channels.slack.url', $tenant->slackUrl)]
*/ */
public static array $channelOverrides = []; public static array $channelOverrides = [];
@ -65,9 +67,10 @@ class LogTenancyBootstrapper implements TenancyBootstrapper
$this->channels = []; $this->channels = [];
} }
/** Get all channels that need to be configured, including channels in the log stack. */ /** Channels to configure (including the channels in the log stack). */
protected function getChannels(): array protected function getChannels(): array
{ {
// Get the currently used (default) logging channel
$channels = [$this->config->get('logging.default')]; $channels = [$this->config->get('logging.default')];
// If the default channel is stack, also get all the channels it contains // If the default channel is stack, also get all the channels it contains
@ -92,20 +95,18 @@ class LogTenancyBootstrapper implements TenancyBootstrapper
} }
} }
/**
* Apply channel override configuration.
*/
protected function overrideChannelConfig(string $channel, array|Closure $override, Tenant $tenant): void protected function overrideChannelConfig(string $channel, array|Closure $override, Tenant $tenant): void
{ {
if (is_array($override)) { if (is_array($override)) {
// Map tenant properties to channel config keys // Map tenant properties to channel config keys.
// If the tenant property is not set,
// the override is ignored and the channel config key's value remains unchanged.
foreach ($override as $configKey => $tenantProperty) { foreach ($override as $configKey => $tenantProperty) {
if ($tenant->$tenantProperty) { if ($tenant->$tenantProperty) {
$this->config->set("logging.channels.{$channel}.{$configKey}", $tenant->$tenantProperty); $this->config->set("logging.channels.{$channel}.{$configKey}", $tenant->$tenantProperty);
} }
} }
} elseif ($override instanceof Closure) { } elseif ($override instanceof Closure) {
// Execute custom configuration closure
$override($this->config, $tenant); $override($this->config, $tenant);
} }
} }