Pass tenant to handle when using TenantAwareCommand trait

[gisostallenberg]

Description

To get the current tenant in handle while using the TenantAwareCommand trait, we need to call

$tenant = tenant();

We could simply pass it using:

--- src/Concerns/TenantAwareCommand.php.orig	2024-04-14 10:12:18.000000000 +0200
+++ src/Concerns/TenantAwareCommand.php	2024-04-26 15:58:19.155120084 +0200
@@ -16,8 +16,8 @@
         $exitCode = 0;
 
         foreach ($tenants as $tenant) {
-            $result = (int) $tenant->run(function () {
-                return $this->laravel->call([$this, 'handle']);
+            $result = (int) $tenant->run(function (Tenant $tenant) {
+                return $this->laravel->call([$this, 'handle'], ['tenant' => $tenant]);
             });
 
             if ($result !== 0) {

An alternative would be to add a handleTenant method and call handle without argument to be 'more BC'

--- src/Concerns/TenantAwareCommand.php.orig	2024-04-14 10:12:18.000000000 +0200
+++ src/Concerns/TenantAwareCommand.php	2024-04-26 16:03:09.585756471 +0200
@@ -16,8 +16,8 @@
         $exitCode = 0;
 
         foreach ($tenants as $tenant) {
-            $result = (int) $tenant->run(function () {
-                return $this->laravel->call([$this, 'handle']);
+            $result = (int) $tenant->run(function (Tenant $tenant) {
+                return $this->laravel->call([$this, 'handleTenant']);
             });
 
             if ($result !== 0) {
@@ -28,6 +28,11 @@
         return $exitCode;
     }
 
+    protected function handleTenant(Tenant $tenant): int
+    {
+        return $this->handle();
+    }
+
     /**
      * Get an array of tenants for which the command should be executed.
      *

Would you be interested in a PR?

[stancl]

Think this should allow it already?

tenancy/src/TenancyServiceProvider.php

Lines 39 to 42 in 4dab0c1

	// Make it possible to inject the current tenant by typehinting the Tenant contract.
	$this->app->bind(Tenant::class, function ($app) {
	return $app[Tenancy::class]->tenant;
	});

[stancl]

I think handle() supports DI and that we have this Tenant binding (note that it's the contract, not your model) already, but haven't tested the combination.