ApiUser
in package
API User service.
Table of Contents
Properties
- $aclService : AclService
- $apiTokenForm : ApiToken
- $apiUserMapper : ApiUser
- $translator : Translator
Methods
- __construct() : mixed
- addToken() : ApiUser
- Add an API token.
- generateToken() : string
- Generate a token.
- getApiTokenForm() : ApiToken
- Get the API token form.
- getToken() : ApiUser|null
- Obtain a token by its ID.
- getTokens() : array<string|int, ApiUser>
- Obtain all tokens.
- getTranslator() : Translator
- Get the translator.
- removeToken() : void
- Remove a token by its ID.
Properties
$aclService read-only
private
AclService
$aclService
$apiTokenForm read-only
private
ApiToken
$apiTokenForm
$apiUserMapper read-only
private
ApiUser
$apiUserMapper
$translator read-only
private
Translator
$translator
Methods
__construct()
public
__construct(AclService $aclService, Translator $translator, ApiUser $apiUserMapper, ApiToken $apiTokenForm) : mixed
Parameters
- $aclService : AclService
- $translator : Translator
- $apiUserMapper : ApiUser
- $apiTokenForm : ApiToken
addToken()
Add an API token.
public
addToken(array<string|int, mixed> $data) : ApiUser
Parameters
- $data : array<string|int, mixed>
Tags
Return values
ApiUsergenerateToken()
Generate a token.
public
static generateToken() : string
Return values
stringgetApiTokenForm()
Get the API token form.
public
getApiTokenForm() : ApiToken
Return values
ApiTokengetToken()
Obtain a token by its ID.
public
getToken(int $id) : ApiUser|null
Parameters
- $id : int
Return values
ApiUser|null —Token
getTokens()
Obtain all tokens.
public
getTokens() : array<string|int, ApiUser>
Return values
array<string|int, ApiUser> —Of tokens
getTranslator()
Get the translator.
public
getTranslator() : Translator
Return values
TranslatorremoveToken()
Remove a token by its ID.
public
removeToken(int $id) : void
Parameters
- $id : int