ManagerInterface
- Full name:
\PhalconKit\Identity\ManagerInterface - Parent interfaces:
\PhalconKit\Identity\Traits\Interfaces\AclInterface,\PhalconKit\Identity\Traits\Interfaces\ImpersonationInterface,\PhalconKit\Identity\Traits\Interfaces\JwtInterface,\PhalconKit\Identity\Traits\Interfaces\Oauth2Interface,\PhalconKit\Identity\Traits\Interfaces\RoleInterface,\PhalconKit\Identity\Traits\Interfaces\SessionInterface,\PhalconKit\Identity\Traits\Interfaces\UserInterface
Inherited methods
getUser
public getUser(bool $as = false, ?bool $force = null): ?\PhalconKit\Models\Interfaces\UserInterface
Parameters:
| Parameter | Type | Description |
|---|---|---|
$as | bool | |
$force | ?bool |
setUser
public setUser(?\PhalconKit\Models\Interfaces\UserInterface $user): void
Parameters:
| Parameter | Type | Description |
|---|---|---|
$user | ?\PhalconKit\Models\Interfaces\UserInterface |
getUserAs
public getUserAs(): ?\PhalconKit\Models\Interfaces\UserInterface
setUserAs
public setUserAs(?\PhalconKit\Models\Interfaces\UserInterface $user): void
Parameters:
| Parameter | Type | Description |
|---|---|---|
$user | ?\PhalconKit\Models\Interfaces\UserInterface |
getUserId
public getUserId(bool $as = false): ?int
Parameters:
| Parameter | Type | Description |
|---|---|---|
$as | bool |
getUserAsId
public getUserAsId(): ?int
getRoleList
public getRoleList(): array
getGroupList
public getGroupList(): array
getTypeList
public getTypeList(): array
isLoggedIn
public isLoggedIn(bool $as = false, bool $force = false): bool
Parameters:
| Parameter | Type | Description |
|---|---|---|
$as | bool | |
$force | bool |
isLoggedInAs
public isLoggedInAs(bool $force = false): bool
Parameters:
| Parameter | Type | Description |
|---|---|---|
$force | bool |
findUserById
public findUserById(int $id): ?\PhalconKit\Models\Interfaces\UserInterface
Parameters:
| Parameter | Type | Description |
|---|---|---|
$id | int |
findUserByEmail
public findUserByEmail(string $string): ?\PhalconKit\Models\Interfaces\UserInterface
Parameters:
| Parameter | Type | Description |
|---|---|---|
$string | string |
getSessionKey
public getSessionKey(bool $refresh = false): string
Parameters:
| Parameter | Type | Description |
|---|---|---|
$refresh | bool |
removeSessionIdentity
public removeSessionIdentity(): void
setSessionIdentity
public setSessionIdentity(array $identity): void
Parameters:
| Parameter | Type | Description |
|---|---|---|
$identity | array |
getSessionIdentity
public getSessionIdentity(): array
hasSessionIdentity
public hasSessionIdentity(): bool
getKey
public getKey(): ?string
hasRole
public hasRole(?array $roles = null, bool $or = false, bool $inherit = true): bool
Parameters:
| Parameter | Type | Description |
|---|---|---|
$roles | ?array | |
$or | bool | |
$inherit | bool |
has
public has(array|string|null $needles = null, array $haystack = [], bool $or = false): bool
Parameters:
| Parameter | Type | Description |
|---|---|---|
$needles | array|string|null | |
$haystack | array | |
$or | bool |
getInheritedRoleList
public getInheritedRoleList(array $roleIndexList = []): array
Parameters:
| Parameter | Type | Description |
|---|---|---|
$roleIndexList | array |
oauth2
public oauth2(string $provider, string $providerUuid, string $accessToken, ?string $refreshToken = null, ?array $meta = []): array
Parameters:
| Parameter | Type | Description |
|---|---|---|
$provider | string | |
$providerUuid | string | |
$accessToken | string | |
$refreshToken | ?string | |
$meta | ?array |
getJwt
public getJwt(bool $refresh = false): array
Parameters:
| Parameter | Type | Description |
|---|---|---|
$refresh | bool |
getClaim
public getClaim(bool $refresh = false, bool $force = false): array
Parameters:
| Parameter | Type | Description |
|---|---|---|
$refresh | bool | |
$force | bool |
setClaim
public setClaim(array $claim): void
Parameters:
| Parameter | Type | Description |
|---|---|---|
$claim | array |
getJwtToken
public getJwtToken(string $id, array $data = [], array $options = []): string
Parameters:
| Parameter | Type | Description |
|---|---|---|
$id | string | |
$data | array | |
$options | array |
getClaimFromToken
public getClaimFromToken(string $token, ?string $claim = null): array
Parameters:
| Parameter | Type | Description |
|---|---|---|
$token | string | |
$claim | ?string |
getClaimFromAuthorization
public getClaimFromAuthorization(array $authorization): array
Parameters:
| Parameter | Type | Description |
|---|---|---|
$authorization | array |
loginAs
public loginAs(array $params = []): array
Parameters:
| Parameter | Type | Description |
|---|---|---|
$params | array |
logoutAs
public logoutAs(): array
getAclRoles
public getAclRoles(?array $roleList = null): array
Parameters:
| Parameter | Type | Description |
|---|---|---|
$roleList | ?array |