DmarcReportMetadata
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DmarcReportMetadata 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
- getAdkim() : string|null
- Gets adkim
- getAspf() : string|null
- Gets aspf
- getDateRangeBegin() : DateTime|null
- Gets date_range_begin
- getDateRangeEnd() : DateTime|null
- Gets date_range_end
- getDomain() : string|null
- Gets domain
- getEmail() : string|null
- Gets email
- getModelName() : string
- The original name of the model.
- getOrgName() : string|null
- Gets org_name
- getPercentage() : int|null
- Gets percentage
- getPolicy() : string|null
- Gets policy
- getReportId() : string|null
- Gets report_id
- getSubdomainPolicy() : string|null
- Gets subdomain_policy
- 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
- setAdkim() : self
- Sets adkim
- setAspf() : self
- Sets aspf
- setDateRangeBegin() : self
- Sets date_range_begin
- setDateRangeEnd() : self
- Sets date_range_end
- setDomain() : self
- Sets domain
- setEmail() : self
- Sets email
- setOrgName() : self
- Sets org_name
- setPercentage() : self
- Sets percentage
- setPolicy() : self
- Sets policy
- setReportId() : self
- Sets report_id
- setSubdomainPolicy() : self
- Sets subdomain_policy
- 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
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
= ['org_name' => 'orgName', 'email' => 'email', 'report_id' => 'reportId', 'domain' => 'domain', 'adkim' => 'adkim', 'aspf' => 'aspf', 'policy' => 'policy', 'subdomain_policy' => 'subdomainPolicy', 'percentage' => 'percentage', 'date_range_begin' => 'dateRangeBegin', 'date_range_end' => 'dateRangeEnd']
$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
= ['org_name' => 'getOrgName', 'email' => 'getEmail', 'report_id' => 'getReportId', 'domain' => 'getDomain', 'adkim' => 'getAdkim', 'aspf' => 'getAspf', 'policy' => 'getPolicy', 'subdomain_policy' => 'getSubdomainPolicy', 'percentage' => 'getPercentage', 'date_range_begin' => 'getDateRangeBegin', 'date_range_end' => 'getDateRangeEnd']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['org_name' => null, 'email' => null, 'report_id' => null, 'domain' => null, 'adkim' => null, 'aspf' => null, 'policy' => null, 'subdomain_policy' => null, 'percentage' => 'int32', 'date_range_begin' => 'date-time', 'date_range_end' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DmarcReportMetadata'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['org_name' => true, 'email' => true, 'report_id' => true, 'domain' => true, 'adkim' => true, 'aspf' => true, 'policy' => true, 'subdomain_policy' => true, 'percentage' => true, 'date_range_begin' => true, 'date_range_end' => 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
= ['org_name' => 'string', 'email' => 'string', 'report_id' => 'string', 'domain' => 'string', 'adkim' => 'string', 'aspf' => 'string', 'policy' => 'string', 'subdomain_policy' => 'string', 'percentage' => 'int', 'date_range_begin' => '\\DateTime', 'date_range_end' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['org_name' => 'setOrgName', 'email' => 'setEmail', 'report_id' => 'setReportId', 'domain' => 'setDomain', 'adkim' => 'setAdkim', 'aspf' => 'setAspf', 'policy' => 'setPolicy', 'subdomain_policy' => 'setSubdomainPolicy', 'percentage' => 'setPercentage', 'date_range_begin' => 'setDateRangeBegin', 'date_range_end' => 'setDateRangeEnd']
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> —getAdkim()
Gets adkim
public
getAdkim() : string|null
Return values
string|null —getAspf()
Gets aspf
public
getAspf() : string|null
Return values
string|null —getDateRangeBegin()
Gets date_range_begin
public
getDateRangeBegin() : DateTime|null
Return values
DateTime|null —getDateRangeEnd()
Gets date_range_end
public
getDateRangeEnd() : DateTime|null
Return values
DateTime|null —getDomain()
Gets domain
public
getDomain() : string|null
Return values
string|null —getEmail()
Gets email
public
getEmail() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getOrgName()
Gets org_name
public
getOrgName() : string|null
Return values
string|null —getPercentage()
Gets percentage
public
getPercentage() : int|null
Return values
int|null —getPolicy()
Gets policy
public
getPolicy() : string|null
Return values
string|null —getReportId()
Gets report_id
public
getReportId() : string|null
Return values
string|null —getSubdomainPolicy()
Gets subdomain_policy
public
getSubdomainPolicy() : string|null
Return values
string|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> —setAdkim()
Sets adkim
public
setAdkim(string|null $adkim) : self
Parameters
- $adkim : string|null
-
adkim
Return values
self —setAspf()
Sets aspf
public
setAspf(string|null $aspf) : self
Parameters
- $aspf : string|null
-
aspf
Return values
self —setDateRangeBegin()
Sets date_range_begin
public
setDateRangeBegin(DateTime|null $date_range_begin) : self
Parameters
- $date_range_begin : DateTime|null
-
date_range_begin
Return values
self —setDateRangeEnd()
Sets date_range_end
public
setDateRangeEnd(DateTime|null $date_range_end) : self
Parameters
- $date_range_end : DateTime|null
-
date_range_end
Return values
self —setDomain()
Sets domain
public
setDomain(string|null $domain) : self
Parameters
- $domain : string|null
-
domain
Return values
self —setEmail()
Sets email
public
setEmail(string|null $email) : self
Parameters
- $email : string|null
-
email
Return values
self —setOrgName()
Sets org_name
public
setOrgName(string|null $org_name) : self
Parameters
- $org_name : string|null
-
org_name
Return values
self —setPercentage()
Sets percentage
public
setPercentage(int|null $percentage) : self
Parameters
- $percentage : int|null
-
percentage
Return values
self —setPolicy()
Sets policy
public
setPolicy(string|null $policy) : self
Parameters
- $policy : string|null
-
policy
Return values
self —setReportId()
Sets report_id
public
setReportId(string|null $report_id) : self
Parameters
- $report_id : string|null
-
report_id
Return values
self —setSubdomainPolicy()
Sets subdomain_policy
public
setSubdomainPolicy(string|null $subdomain_policy) : self
Parameters
- $subdomain_policy : string|null
-
subdomain_policy
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>