ProviderSettings
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
ProviderSettings Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- MAIL_PROVIDER_GOOGLE = 'GOOGLE'
- MAIL_PROVIDER_MICROSOFT = 'MICROSOFT'
- $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
- getImapHost() : string
- Gets imap_host
- getImapPort() : int
- Gets imap_port
- getImapSsl() : bool
- Gets imap_ssl
- getImapStartTls() : bool|null
- Gets imap_start_tls
- getMailProvider() : string
- Gets mail_provider
- getMailProviderAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getModelName() : string
- The original name of the model.
- getSmtpHost() : string
- Gets smtp_host
- getSmtpPort() : int
- Gets smtp_port
- getSmtpSsl() : bool
- Gets smtp_ssl
- getSmtpStartTls() : bool|null
- Gets smtp_start_tls
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- 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
- setImapHost() : self
- Sets imap_host
- setImapPort() : self
- Sets imap_port
- setImapSsl() : self
- Sets imap_ssl
- setImapStartTls() : self
- Sets imap_start_tls
- setMailProvider() : self
- Sets mail_provider
- setSmtpHost() : self
- Sets smtp_host
- setSmtpPort() : self
- Sets smtp_port
- setSmtpSsl() : self
- Sets smtp_ssl
- setSmtpStartTls() : self
- Sets smtp_start_tls
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
MAIL_PROVIDER_GOOGLE
public
mixed
MAIL_PROVIDER_GOOGLE
= 'GOOGLE'
MAIL_PROVIDER_MICROSOFT
public
mixed
MAIL_PROVIDER_MICROSOFT
= 'MICROSOFT'
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
= ['mail_provider' => 'mailProvider', 'imap_host' => 'imapHost', 'imap_port' => 'imapPort', 'imap_ssl' => 'imapSsl', 'imap_start_tls' => 'imapStartTls', 'smtp_host' => 'smtpHost', 'smtp_port' => 'smtpPort', 'smtp_ssl' => 'smtpSsl', 'smtp_start_tls' => 'smtpStartTls']
$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
= ['mail_provider' => 'getMailProvider', 'imap_host' => 'getImapHost', 'imap_port' => 'getImapPort', 'imap_ssl' => 'getImapSsl', 'imap_start_tls' => 'getImapStartTls', 'smtp_host' => 'getSmtpHost', 'smtp_port' => 'getSmtpPort', 'smtp_ssl' => 'getSmtpSsl', 'smtp_start_tls' => 'getSmtpStartTls']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['mail_provider' => null, 'imap_host' => null, 'imap_port' => 'int32', 'imap_ssl' => null, 'imap_start_tls' => null, 'smtp_host' => null, 'smtp_port' => 'int32', 'smtp_ssl' => null, 'smtp_start_tls' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'ProviderSettings'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['mail_provider' => false, 'imap_host' => false, 'imap_port' => false, 'imap_ssl' => false, 'imap_start_tls' => false, 'smtp_host' => false, 'smtp_port' => false, 'smtp_ssl' => false, 'smtp_start_tls' => false]
$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
= ['mail_provider' => 'string', 'imap_host' => 'string', 'imap_port' => 'int', 'imap_ssl' => 'bool', 'imap_start_tls' => 'bool', 'smtp_host' => 'string', 'smtp_port' => 'int', 'smtp_ssl' => 'bool', 'smtp_start_tls' => 'bool']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['mail_provider' => 'setMailProvider', 'imap_host' => 'setImapHost', 'imap_port' => 'setImapPort', 'imap_ssl' => 'setImapSsl', 'imap_start_tls' => 'setImapStartTls', 'smtp_host' => 'setSmtpHost', 'smtp_port' => 'setSmtpPort', 'smtp_ssl' => 'setSmtpSsl', 'smtp_start_tls' => 'setSmtpStartTls']
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> —getImapHost()
Gets imap_host
public
getImapHost() : string
Return values
string —getImapPort()
Gets imap_port
public
getImapPort() : int
Return values
int —getImapSsl()
Gets imap_ssl
public
getImapSsl() : bool
Return values
bool —getImapStartTls()
Gets imap_start_tls
public
getImapStartTls() : bool|null
Return values
bool|null —getMailProvider()
Gets mail_provider
public
getMailProvider() : string
Return values
string —getMailProviderAllowableValues()
Gets allowable values of the enum
public
getMailProviderAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getSmtpHost()
Gets smtp_host
public
getSmtpHost() : string
Return values
string —getSmtpPort()
Gets smtp_port
public
getSmtpPort() : int
Return values
int —getSmtpSsl()
Gets smtp_ssl
public
getSmtpSsl() : bool
Return values
bool —getSmtpStartTls()
Gets smtp_start_tls
public
getSmtpStartTls() : bool|null
Return values
bool|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> —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> —setImapHost()
Sets imap_host
public
setImapHost(string $imap_host) : self
Parameters
- $imap_host : string
-
imap_host
Return values
self —setImapPort()
Sets imap_port
public
setImapPort(int $imap_port) : self
Parameters
- $imap_port : int
-
imap_port
Return values
self —setImapSsl()
Sets imap_ssl
public
setImapSsl(bool $imap_ssl) : self
Parameters
- $imap_ssl : bool
-
imap_ssl
Return values
self —setImapStartTls()
Sets imap_start_tls
public
setImapStartTls(bool|null $imap_start_tls) : self
Parameters
- $imap_start_tls : bool|null
-
imap_start_tls
Return values
self —setMailProvider()
Sets mail_provider
public
setMailProvider(string $mail_provider) : self
Parameters
- $mail_provider : string
-
mail_provider
Return values
self —setSmtpHost()
Sets smtp_host
public
setSmtpHost(string $smtp_host) : self
Parameters
- $smtp_host : string
-
smtp_host
Return values
self —setSmtpPort()
Sets smtp_port
public
setSmtpPort(int $smtp_port) : self
Parameters
- $smtp_port : int
-
smtp_port
Return values
self —setSmtpSsl()
Sets smtp_ssl
public
setSmtpSsl(bool $smtp_ssl) : self
Parameters
- $smtp_ssl : bool
-
smtp_ssl
Return values
self —setSmtpStartTls()
Sets smtp_start_tls
public
setSmtpStartTls(bool|null $smtp_start_tls) : self
Parameters
- $smtp_start_tls : bool|null
-
smtp_start_tls
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> —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>