mirror of
https://github.com/archtechx/tenancy.git
synced 2025-12-13 21:04:03 +00:00
Docblocks
This commit is contained in:
parent
51fc3c7706
commit
39503fe76b
2 changed files with 16 additions and 3 deletions
|
|
@ -5,6 +5,7 @@ declare(strict_types=1);
|
||||||
namespace Stancl\Tenancy\Contracts;
|
namespace Stancl\Tenancy\Contracts;
|
||||||
|
|
||||||
use Stancl\Tenancy\Tenant;
|
use Stancl\Tenancy\Tenant;
|
||||||
|
use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedException;
|
||||||
|
|
||||||
interface StorageDriver
|
interface StorageDriver
|
||||||
{
|
{
|
||||||
|
|
@ -12,7 +13,19 @@ interface StorageDriver
|
||||||
|
|
||||||
public function updateTenant(Tenant $tenant): bool; // todo return type
|
public function updateTenant(Tenant $tenant): bool; // todo return type
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find a tenant using an id.
|
||||||
|
*
|
||||||
|
* @param string $id
|
||||||
|
* @return Tenant
|
||||||
|
* @throws TenantCouldNotBeIdentifiedException
|
||||||
|
*/
|
||||||
public function findById(string $id): Tenant;
|
public function findById(string $id): Tenant;
|
||||||
|
/**
|
||||||
|
* Find a tenant using a domain name.
|
||||||
|
*
|
||||||
|
* @param string $domain
|
||||||
|
* @return Tenant
|
||||||
|
*/
|
||||||
public function findByDomain(string $domain): Tenant;
|
public function findByDomain(string $domain): Tenant;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -66,7 +66,7 @@ class TenantManagerv2
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Identify a tenant using id.
|
* Find a tenant using an id.
|
||||||
*
|
*
|
||||||
* @param string $id
|
* @param string $id
|
||||||
* @return Tenant
|
* @return Tenant
|
||||||
|
|
@ -78,7 +78,7 @@ class TenantManagerv2
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Identify a tenant using id.
|
* Find a tenant using a domain name.
|
||||||
*
|
*
|
||||||
* @param string $id
|
* @param string $id
|
||||||
* @return Tenant
|
* @return Tenant
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue