1
0
Fork 0
mirror of https://github.com/archtechx/tenancy.git synced 2026-05-06 16:24:03 +00:00

Improve comments

This commit is contained in:
lukinovec 2026-04-02 16:29:03 +02:00
parent 9e9bedc0f2
commit 4b1cc9c84a
2 changed files with 6 additions and 6 deletions

View file

@ -82,7 +82,7 @@ class BroadcastingConfigBootstrapper implements TenancyBootstrapper
// Swap currently bound Broadcaster instance for one that's resolved through the tenant broadcast manager.
// Note that changing tenant's credentials in tenant context doesn't update them in the bound Broadcaster instance.
// If you need to e.g. send a notification in response to changing tenant's broadcasting credentials,
// If you need to e.g. send a notification in response to updating tenant's broadcasting credentials in tenant context,
// it's recommended to use the broadcast() helper which always uses fresh broadcasters with the current credentials.
$this->app->extend(Broadcaster::class, function (Broadcaster $broadcaster) {
return $this->app->make(BroadcastManager::class)->connection();

View file

@ -13,7 +13,7 @@ class TenancyBroadcastManager extends BroadcastManager
/**
* Names of broadcasters that
* - should always be recreated using $this->resolve(), even when they're cached and available
* in $this->drivers (so that e.g. when you update tenant's broadcaster credentials in the tenant context,
* in $this->drivers (so that e.g. when you update broadcasting credentials in the tenant context,
* the updated credentials will be used for broadcasting in the same context)
* - should inherit the original broadcaster's channels (= the channels registered in
* the central context, e.g. in routes/channels.php, before this manager overrides the bound BroadcastManager).
@ -22,7 +22,7 @@ class TenancyBroadcastManager extends BroadcastManager
/**
* Override the get method so that the broadcasters in static::$tenantBroadcasters
* receive the original broadcaster's channels and always get freshly resolved.
* receive the original (central) broadcaster's channels and always get freshly resolved.
*/
protected function get($name)
{
@ -31,7 +31,7 @@ class TenancyBroadcastManager extends BroadcastManager
$originalBroadcaster = $this->app->make(BroadcasterContract::class);
$newBroadcaster = $this->resolve($name);
// Give the channels of the original broadcaster (from the central context) to the newly resolved one.
// Give the channels of the original (central) broadcaster to the newly resolved one.
// Broadcasters only have to implement the Illuminate\Contracts\Broadcasting\Broadcaster contract
// which doesn't require the channels property, so passing the channels is only
// needed for Illuminate\Broadcasting\Broadcasters\Broadcaster instances.
@ -46,8 +46,8 @@ class TenancyBroadcastManager extends BroadcastManager
}
// The newly resolved broadcasters don't automatically receive the channels registered
// in central context (e.g. in routes/channels.php), so we have to obtain the channels from the
// broadcaster used in central context and manually pass them to the new broadcasters
// in central context (e.g. in routes/channels.php), so the channels have to be obtained from the
// broadcaster used in central context and manually passed to the new broadcasters
// (attempting to broadcast using a broadcaster with no channels results in a 403 error).
protected function passChannelsFromOriginalBroadcaster(Broadcaster $originalBroadcaster, Broadcaster $newBroadcaster): void
{