-
-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #544 from spatie/refactoring-interface
Contract IsTenant replace Tenant uses
- Loading branch information
Showing
51 changed files
with
377 additions
and
324 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
title: Requirements | ||
weight: 3 | ||
weight: 4 | ||
--- | ||
|
||
This package requires **PHP 8.0+** and **Laravel 8.0+**. | ||
This package requires **PHP 8.2+** and **Laravel 11.0+**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
title: Upgrade guide | ||
weight: 2 | ||
--- | ||
|
||
In the `4.x` version, we have introduced the contract concept to the Tenant so that any model could implement the interface. | ||
|
||
The first step to reach our goal is upgrading our package version. | ||
|
||
```bash | ||
composer require spatie/laravel-multitenancy:^4.0 | ||
``` | ||
|
||
### Removed `UsesTenantModel` trait | ||
Remove any reference to our old trait `Spatie\Models\Concerns\UsesTenantModel`, because now the right `Tenant` instance can be resolved using `app(IsTenant::class)`. | ||
|
||
### Tenant finder | ||
If you are using the default finder included in the package, no changes are required by your side. However, when you are using a custom finder, you need to change the returned value in `findForRequest` method to `?IsTenant`. Example: | ||
|
||
```php | ||
use Illuminate\Http\Request; | ||
use Spatie\Multitenancy\Contracts\IsTenant; | ||
|
||
class YourCustomTenantFinder extends TenantFinder | ||
{ | ||
public function findForRequest(Request $request): ?IsTenant | ||
{ | ||
// ... | ||
} | ||
} | ||
``` | ||
|
||
### Custom tasks | ||
As has already been pointed out for the finder, the same change is required for any task because our `SwitchTenantTask` interface now is: | ||
```php | ||
public function makeCurrent(IsTenant $tenant): void; | ||
``` | ||
|
||
So, it requires replacing the method parameter from `Tenant $tenant` to `IsTenant $tenant.` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.