CreateTotpDeviceBase32SecretKeyOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CreateTotpDeviceBase32SecretKeyOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $openAPIFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string|int, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAlgorithm() : string|null
- Gets algorithm
- getBase32SecretKey() : string
- Gets base32_secret_key
- getDigits() : int|null
- Gets digits
- getIssuer() : string|null
- Gets issuer
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getPeriod() : int|null
- Gets period
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUsername() : string|null
- Gets username
- isNullable() : bool
- Checks if a property is nullable
- isNullableSetToNull() : bool
- Checks if a nullable property is set to null.
- jsonSerialize() : mixed
- Serializes the object to a value that can be serialized natively by json_encode().
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed|null
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- openAPIFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- setAlgorithm() : self
- Sets algorithm
- setBase32SecretKey() : self
- Sets base32_secret_key
- setDigits() : self
- Sets digits
- setIssuer() : self
- Sets issuer
- setName() : self
- Sets name
- setPeriod() : self
- Sets period
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUsername() : self
- Sets username
- toHeaderValue() : string
- Gets a header-safe presentation of the object
- valid() : bool
- Validate all the properties in the model return true if all passed
- openAPINullables() : array<string|int, mixed>
- Array of nullable properties
- getOpenAPINullablesSetToNull() : array<string|int, bool>
- Array of nullable field names deliberately set to null
- setIfExists() : void
- Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['base32_secret_key' => 'base32SecretKey', 'name' => 'name', 'username' => 'username', 'issuer' => 'issuer', 'digits' => 'digits', 'period' => 'period', 'algorithm' => 'algorithm']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['base32_secret_key' => 'getBase32SecretKey', 'name' => 'getName', 'username' => 'getUsername', 'issuer' => 'getIssuer', 'digits' => 'getDigits', 'period' => 'getPeriod', 'algorithm' => 'getAlgorithm']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['base32_secret_key' => null, 'name' => null, 'username' => null, 'issuer' => null, 'digits' => 'int32', 'period' => 'int32', 'algorithm' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CreateTotpDeviceBase32SecretKeyOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['base32_secret_key' => false, 'name' => true, 'username' => true, 'issuer' => true, 'digits' => true, 'period' => true, 'algorithm' => true]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['base32_secret_key' => 'string', 'name' => 'string', 'username' => 'string', 'issuer' => 'string', 'digits' => 'int', 'period' => 'int', 'algorithm' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['base32_secret_key' => 'setBase32SecretKey', 'name' => 'setName', 'username' => 'setUsername', 'issuer' => 'setIssuer', 'digits' => 'setDigits', 'period' => 'setPeriod', 'algorithm' => 'setAlgorithm']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAlgorithm()
Gets algorithm
public
getAlgorithm() : string|null
Return values
string|null —getBase32SecretKey()
Gets base32_secret_key
public
getBase32SecretKey() : string
Return values
string —getDigits()
Gets digits
public
getDigits() : int|null
Return values
int|null —getIssuer()
Gets issuer
public
getIssuer() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getPeriod()
Gets period
public
getPeriod() : int|null
Return values
int|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUsername()
Gets username
public
getUsername() : string|null
Return values
string|null —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setAlgorithm()
Sets algorithm
public
setAlgorithm(string|null $algorithm) : self
Parameters
- $algorithm : string|null
-
Optional algorithm override
Return values
self —setBase32SecretKey()
Sets base32_secret_key
public
setBase32SecretKey(string $base32_secret_key) : self
Parameters
- $base32_secret_key : string
-
Base32 secret key for TOTP device as alternative to OTP Auth URI or QR code.
Return values
self —setDigits()
Sets digits
public
setDigits(int|null $digits) : self
Parameters
- $digits : int|null
-
Optional number of digits in TOTP code
Return values
self —setIssuer()
Sets issuer
public
setIssuer(string|null $issuer) : self
Parameters
- $issuer : string|null
-
Optional issuer override for the TOTP device
Return values
self —setName()
Sets name
public
setName(string|null $name) : self
Parameters
- $name : string|null
-
Name for labeling the TOTP device
Return values
self —setPeriod()
Sets period
public
setPeriod(int|null $period) : self
Parameters
- $period : int|null
-
Optional period in seconds for TOTP code expiration
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setUsername()
Sets username
public
setUsername(string|null $username) : self
Parameters
- $username : string|null
-
Optional username for the TOTP device
Return values
self —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —setIfExists()
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
private
setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed
Return values
void —setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string|int, bool>