GenerateSpfRecordOptions
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
GenerateSpfRecordOptions Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- ALL_POLICY_FAIL = 'FAIL'
- ALL_POLICY_NEUTRAL = 'NEUTRAL'
- ALL_POLICY_SOFTFAIL = 'SOFTFAIL'
- 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
- getA() : bool
- Gets a
- getAllPolicy() : string
- Gets all_policy
- getAllPolicyAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getDomain() : string
- Gets domain
- getIncludeDomains() : array<string|int, string>|null
- Gets include_domains
- getIp4() : array<string|int, string>|null
- Gets ip4
- getIp6() : array<string|int, string>|null
- Gets ip6
- getModelName() : string
- The original name of the model.
- getMx() : bool
- Gets mx
- 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
- setA() : self
- Sets a
- setAllPolicy() : self
- Sets all_policy
- setDomain() : self
- Sets domain
- setIncludeDomains() : self
- Sets include_domains
- setIp4() : self
- Sets ip4
- setIp6() : self
- Sets ip6
- setMx() : self
- Sets mx
- 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
ALL_POLICY_FAIL
public
mixed
ALL_POLICY_FAIL
= 'FAIL'
ALL_POLICY_NEUTRAL
public
mixed
ALL_POLICY_NEUTRAL
= 'NEUTRAL'
ALL_POLICY_SOFTFAIL
public
mixed
ALL_POLICY_SOFTFAIL
= 'SOFTFAIL'
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
= ['domain' => 'domain', 'include_domains' => 'includeDomains', 'ip4' => 'ip4', 'ip6' => 'ip6', 'mx' => 'mx', 'a' => 'a', 'all_policy' => 'allPolicy']
$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
= ['domain' => 'getDomain', 'include_domains' => 'getIncludeDomains', 'ip4' => 'getIp4', 'ip6' => 'getIp6', 'mx' => 'getMx', 'a' => 'getA', 'all_policy' => 'getAllPolicy']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['domain' => null, 'include_domains' => null, 'ip4' => null, 'ip6' => null, 'mx' => null, 'a' => null, 'all_policy' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'GenerateSpfRecordOptions'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['domain' => false, 'include_domains' => true, 'ip4' => true, 'ip6' => true, 'mx' => false, 'a' => false, 'all_policy' => 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
= ['domain' => 'string', 'include_domains' => 'string[]', 'ip4' => 'string[]', 'ip6' => 'string[]', 'mx' => 'bool', 'a' => 'bool', 'all_policy' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['domain' => 'setDomain', 'include_domains' => 'setIncludeDomains', 'ip4' => 'setIp4', 'ip6' => 'setIp6', 'mx' => 'setMx', 'a' => 'setA', 'all_policy' => 'setAllPolicy']
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> —getA()
Gets a
public
getA() : bool
Return values
bool —getAllPolicy()
Gets all_policy
public
getAllPolicy() : string
Return values
string —getAllPolicyAllowableValues()
Gets allowable values of the enum
public
getAllPolicyAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getDomain()
Gets domain
public
getDomain() : string
Return values
string —getIncludeDomains()
Gets include_domains
public
getIncludeDomains() : array<string|int, string>|null
Return values
array<string|int, string>|null —getIp4()
Gets ip4
public
getIp4() : array<string|int, string>|null
Return values
array<string|int, string>|null —getIp6()
Gets ip6
public
getIp6() : array<string|int, string>|null
Return values
array<string|int, string>|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getMx()
Gets mx
public
getMx() : bool
Return values
bool —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> —setA()
Sets a
public
setA(bool $a) : self
Parameters
- $a : bool
-
Whether to include the A mechanism
Return values
self —setAllPolicy()
Sets all_policy
public
setAllPolicy(string $all_policy) : self
Parameters
- $all_policy : string
-
all_policy
Return values
self —setDomain()
Sets domain
public
setDomain(string $domain) : self
Parameters
- $domain : string
-
Domain the SPF record applies to
Return values
self —setIncludeDomains()
Sets include_domains
public
setIncludeDomains(array<string|int, string>|null $include_domains) : self
Parameters
- $include_domains : array<string|int, string>|null
-
Optional include domains
Return values
self —setIp4()
Sets ip4
public
setIp4(array<string|int, string>|null $ip4) : self
Parameters
- $ip4 : array<string|int, string>|null
-
Optional IPv4 CIDRs or hosts
Return values
self —setIp6()
Sets ip6
public
setIp6(array<string|int, string>|null $ip6) : self
Parameters
- $ip6 : array<string|int, string>|null
-
Optional IPv6 CIDRs or hosts
Return values
self —setMx()
Sets mx
public
setMx(bool $mx) : self
Parameters
- $mx : bool
-
Whether to include the MX mechanism
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>