CSCredential
in package
This class defines the concrete Credential API.
It provides multiple methods for the Credential functionality.
Tags
Table of Contents
- __toString() : string
- If used in string context, the CSCredential object returns the underlying token.
- getDescription() : string
- Returns the credential description.
- getId() : int
- Returns the credential id.
- getLabel() : string
- Returns the credential label.
- getLastChange() : string
- Returns the credential last change date.
- getName() : string
- Returns the credential name.
- getTargetModuleName() : string
- Returns the credential module.
- getToken() : string
- Returns the credential token.
- isTokenValid() : string
- Returns the credential token validity.
- setDescription() : void
- Sets the description of the credential.
- setLabel() : void
- Sets the label of the credential.
- setName() : void
- Sets the name of the credential.
- setTargetModuleName() : void
- Sets the module of the credential.
- setToken() : void
- Sets the token of the credential.
- setTokenValid() : void
- Sets the token validity of the credential.
Methods
__toString()
If used in string context, the CSCredential object returns the underlying token.
public
__toString() : string
Tags
Return values
string —The token configured for this credential
getDescription()
Returns the credential description.
public
getDescription() : string
Tags
Return values
string —The credential description
getId()
Returns the credential id.
public
getId() : int
Tags
Return values
int —The credential id
getLabel()
Returns the credential label.
public
getLabel() : string
Tags
Return values
string —The credential label
getLastChange()
Returns the credential last change date.
public
getLastChange() : string
Tags
Return values
string —The credential last change date
getName()
Returns the credential name.
public
getName() : string
Tags
Return values
string —The credential name
getTargetModuleName()
Returns the credential module.
public
getTargetModuleName() : string
Tags
Return values
string —The credential module
getToken()
Returns the credential token.
public
getToken() : string
Tags
Return values
string —The credential token
isTokenValid()
Returns the credential token validity.
public
isTokenValid() : string
Tags
Return values
string —The credential token validity
setDescription()
Sets the description of the credential.
public
setDescription(string $sDescription) : void
Parameters
- $sDescription : string
-
The description to set
Tags
Return values
void —setLabel()
Sets the label of the credential.
public
setLabel(string $sLabel) : void
Parameters
- $sLabel : string
-
The label to set
Tags
Return values
void —setName()
Sets the name of the credential.
public
setName(string $sName) : void
Parameters
- $sName : string
-
The name to set
Tags
Return values
void —setTargetModuleName()
Sets the module of the credential.
public
setTargetModuleName(string $sModuleName) : void
Parameters
- $sModuleName : string
-
The module to set
Tags
Return values
void —setToken()
Sets the token of the credential.
public
setToken(string $sToken) : void
Parameters
- $sToken : string
-
The token to set
Tags
Return values
void —setTokenValid()
Sets the token validity of the credential.
public
setTokenValid(bool $sIsTokenValid) : void
Parameters
- $sIsTokenValid : bool
-
The token validity to set