CSMemoryDatabaseCredentials
in package
Defines the credentials class for the memory database interface.
The class provides setter & getter method to set & get required credentials for the memory database connection.
Tags
Table of Contents
- __construct() : mixed
- The constructor of the memory database credentials API object.
- getDefinition() : array<string|int, mixed>|string
- Returns various definitions of the defined credentials for a given definition type.
- getToken() : string
- Returns the defined token of the memroy database credentials API object.
- getUserName() : string
- Returns the defined username of the memory database credentials API object.
- setToken() : void
- Sets the token to the memory database credentials API object.
- setUserName() : void
- Sets the username to the memory database credentials API object.
Methods
__construct()
The constructor of the memory database credentials API object.
public
final __construct() : mixed
Tags
Return values
mixed —getDefinition()
Returns various definitions of the defined credentials for a given definition type.
public
getDefinition([int $iDefinitionType = CSMemoryDatabaseConst::DEFINITION_ARRAY ]) : array<string|int, mixed>|string
Possible definition types: CSMemoryDatabaseConst::DEFINITION_*
Parameters
- $iDefinitionType : int = CSMemoryDatabaseConst::DEFINITION_ARRAY
-
The target definition type to receive the expected result.
Tags
Return values
array<string|int, mixed>|string —getToken()
Returns the defined token of the memroy database credentials API object.
public
getToken() : string
Tags
Return values
string —getUserName()
Returns the defined username of the memory database credentials API object.
public
getUserName() : string
Tags
Return values
string —setToken()
Sets the token to the memory database credentials API object.
public
setToken(string $sToken) : void
Parameters
- $sToken : string
-
The required token for the authentication.
Tags
Return values
void —setUserName()
Sets the username to the memory database credentials API object.
public
setUserName(string $sUserName) : void
Parameters
- $sUserName : string
-
The target username.