ICredentialsManager
in
Store and retrieve credentials for external services
Tags
Table of Contents
Methods
- delete() : int
- Delete a set of credentials
- erase() : int
- Erase all credentials stored for a user
- retrieve() : mixed
- Retrieve a set of credentials
- store() : void
- Store a set of credentials
Methods
delete()
Delete a set of credentials
public
delete(string $userId, string $identifier) : int
Parameters
- $userId : string
-
empty string for system-wide credentials
- $identifier : string
Tags
Return values
int —rows removed
erase()
Erase all credentials stored for a user
public
erase(string $userId) : int
Parameters
- $userId : string
Tags
Return values
int —rows removed
retrieve()
Retrieve a set of credentials
public
retrieve(string $userId, string $identifier) : mixed
Parameters
- $userId : string
-
empty string for system-wide credentials
- $identifier : string
Tags
store()
Store a set of credentials
public
store(string $userId, string $identifier, mixed $credentials) : void
Parameters
- $userId : string
-
empty string for system-wide credentials
- $identifier : string
- $credentials : mixed