CheckCampaignProbeResults
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CheckCampaignProbeResults Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- STATUS_FAILED = 'FAILED'
- STATUS_HEALTHY = 'HEALTHY'
- STATUS_WARNING = 'WARNING'
- $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
- getAttachmentMentionIssueCount() : int
- Gets attachment_mention_issue_count
- getCheckedImages() : int
- Gets checked_images
- getCheckedLinks() : int
- Gets checked_links
- getCompatibilityNotSupportedCount() : int
- Gets compatibility_not_supported_count
- getCompatibilityUnknownCount() : int
- Gets compatibility_unknown_count
- getCompatibilityWarningCount() : int
- Gets compatibility_warning_count
- getErrorMessage() : string|null
- Gets error_message
- getFailingChecks() : int
- Gets failing_checks
- getHealthScore() : int
- Gets health_score
- getHtmlErrorCount() : int
- Gets html_error_count
- getHtmlInfoCount() : int
- Gets html_info_count
- getHtmlWarningCount() : int
- Gets html_warning_count
- getImageIssueCount() : int
- Gets image_issue_count
- getInsights() : array<string|int, string>
- Gets insights
- getLinkIssueCount() : int
- Gets link_issue_count
- getModelName() : string
- The original name of the model.
- getPassingChecks() : int
- Gets passing_checks
- getStatus() : string
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTotalChecks() : int
- Gets total_checks
- 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
- setAttachmentMentionIssueCount() : self
- Sets attachment_mention_issue_count
- setCheckedImages() : self
- Sets checked_images
- setCheckedLinks() : self
- Sets checked_links
- setCompatibilityNotSupportedCount() : self
- Sets compatibility_not_supported_count
- setCompatibilityUnknownCount() : self
- Sets compatibility_unknown_count
- setCompatibilityWarningCount() : self
- Sets compatibility_warning_count
- setErrorMessage() : self
- Sets error_message
- setFailingChecks() : self
- Sets failing_checks
- setHealthScore() : self
- Sets health_score
- setHtmlErrorCount() : self
- Sets html_error_count
- setHtmlInfoCount() : self
- Sets html_info_count
- setHtmlWarningCount() : self
- Sets html_warning_count
- setImageIssueCount() : self
- Sets image_issue_count
- setInsights() : self
- Sets insights
- setLinkIssueCount() : self
- Sets link_issue_count
- setPassingChecks() : self
- Sets passing_checks
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTotalChecks() : self
- Sets total_checks
- 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
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_HEALTHY
public
mixed
STATUS_HEALTHY
= 'HEALTHY'
STATUS_WARNING
public
mixed
STATUS_WARNING
= 'WARNING'
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
= ['status' => 'status', 'health_score' => 'healthScore', 'total_checks' => 'totalChecks', 'passing_checks' => 'passingChecks', 'failing_checks' => 'failingChecks', 'checked_links' => 'checkedLinks', 'checked_images' => 'checkedImages', 'link_issue_count' => 'linkIssueCount', 'image_issue_count' => 'imageIssueCount', 'compatibility_warning_count' => 'compatibilityWarningCount', 'compatibility_not_supported_count' => 'compatibilityNotSupportedCount', 'compatibility_unknown_count' => 'compatibilityUnknownCount', 'html_error_count' => 'htmlErrorCount', 'html_warning_count' => 'htmlWarningCount', 'html_info_count' => 'htmlInfoCount', 'attachment_mention_issue_count' => 'attachmentMentionIssueCount', 'insights' => 'insights', 'error_message' => 'errorMessage']
$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
= ['status' => 'getStatus', 'health_score' => 'getHealthScore', 'total_checks' => 'getTotalChecks', 'passing_checks' => 'getPassingChecks', 'failing_checks' => 'getFailingChecks', 'checked_links' => 'getCheckedLinks', 'checked_images' => 'getCheckedImages', 'link_issue_count' => 'getLinkIssueCount', 'image_issue_count' => 'getImageIssueCount', 'compatibility_warning_count' => 'getCompatibilityWarningCount', 'compatibility_not_supported_count' => 'getCompatibilityNotSupportedCount', 'compatibility_unknown_count' => 'getCompatibilityUnknownCount', 'html_error_count' => 'getHtmlErrorCount', 'html_warning_count' => 'getHtmlWarningCount', 'html_info_count' => 'getHtmlInfoCount', 'attachment_mention_issue_count' => 'getAttachmentMentionIssueCount', 'insights' => 'getInsights', 'error_message' => 'getErrorMessage']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['status' => null, 'health_score' => 'int32', 'total_checks' => 'int32', 'passing_checks' => 'int32', 'failing_checks' => 'int32', 'checked_links' => 'int32', 'checked_images' => 'int32', 'link_issue_count' => 'int32', 'image_issue_count' => 'int32', 'compatibility_warning_count' => 'int32', 'compatibility_not_supported_count' => 'int32', 'compatibility_unknown_count' => 'int32', 'html_error_count' => 'int32', 'html_warning_count' => 'int32', 'html_info_count' => 'int32', 'attachment_mention_issue_count' => 'int32', 'insights' => null, 'error_message' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CheckCampaignProbeResults'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['status' => false, 'health_score' => false, 'total_checks' => false, 'passing_checks' => false, 'failing_checks' => false, 'checked_links' => false, 'checked_images' => false, 'link_issue_count' => false, 'image_issue_count' => false, 'compatibility_warning_count' => false, 'compatibility_not_supported_count' => false, 'compatibility_unknown_count' => false, 'html_error_count' => false, 'html_warning_count' => false, 'html_info_count' => false, 'attachment_mention_issue_count' => false, 'insights' => false, 'error_message' => 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
= ['status' => 'string', 'health_score' => 'int', 'total_checks' => 'int', 'passing_checks' => 'int', 'failing_checks' => 'int', 'checked_links' => 'int', 'checked_images' => 'int', 'link_issue_count' => 'int', 'image_issue_count' => 'int', 'compatibility_warning_count' => 'int', 'compatibility_not_supported_count' => 'int', 'compatibility_unknown_count' => 'int', 'html_error_count' => 'int', 'html_warning_count' => 'int', 'html_info_count' => 'int', 'attachment_mention_issue_count' => 'int', 'insights' => 'string[]', 'error_message' => 'string']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['status' => 'setStatus', 'health_score' => 'setHealthScore', 'total_checks' => 'setTotalChecks', 'passing_checks' => 'setPassingChecks', 'failing_checks' => 'setFailingChecks', 'checked_links' => 'setCheckedLinks', 'checked_images' => 'setCheckedImages', 'link_issue_count' => 'setLinkIssueCount', 'image_issue_count' => 'setImageIssueCount', 'compatibility_warning_count' => 'setCompatibilityWarningCount', 'compatibility_not_supported_count' => 'setCompatibilityNotSupportedCount', 'compatibility_unknown_count' => 'setCompatibilityUnknownCount', 'html_error_count' => 'setHtmlErrorCount', 'html_warning_count' => 'setHtmlWarningCount', 'html_info_count' => 'setHtmlInfoCount', 'attachment_mention_issue_count' => 'setAttachmentMentionIssueCount', 'insights' => 'setInsights', 'error_message' => 'setErrorMessage']
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> —getAttachmentMentionIssueCount()
Gets attachment_mention_issue_count
public
getAttachmentMentionIssueCount() : int
Return values
int —getCheckedImages()
Gets checked_images
public
getCheckedImages() : int
Return values
int —getCheckedLinks()
Gets checked_links
public
getCheckedLinks() : int
Return values
int —getCompatibilityNotSupportedCount()
Gets compatibility_not_supported_count
public
getCompatibilityNotSupportedCount() : int
Return values
int —getCompatibilityUnknownCount()
Gets compatibility_unknown_count
public
getCompatibilityUnknownCount() : int
Return values
int —getCompatibilityWarningCount()
Gets compatibility_warning_count
public
getCompatibilityWarningCount() : int
Return values
int —getErrorMessage()
Gets error_message
public
getErrorMessage() : string|null
Return values
string|null —getFailingChecks()
Gets failing_checks
public
getFailingChecks() : int
Return values
int —getHealthScore()
Gets health_score
public
getHealthScore() : int
Return values
int —getHtmlErrorCount()
Gets html_error_count
public
getHtmlErrorCount() : int
Return values
int —getHtmlInfoCount()
Gets html_info_count
public
getHtmlInfoCount() : int
Return values
int —getHtmlWarningCount()
Gets html_warning_count
public
getHtmlWarningCount() : int
Return values
int —getImageIssueCount()
Gets image_issue_count
public
getImageIssueCount() : int
Return values
int —getInsights()
Gets insights
public
getInsights() : array<string|int, string>
Return values
array<string|int, string> —getLinkIssueCount()
Gets link_issue_count
public
getLinkIssueCount() : int
Return values
int —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPassingChecks()
Gets passing_checks
public
getPassingChecks() : int
Return values
int —getStatus()
Gets status
public
getStatus() : string
Return values
string —getStatusAllowableValues()
Gets allowable values of the enum
public
getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTotalChecks()
Gets total_checks
public
getTotalChecks() : int
Return values
int —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> —setAttachmentMentionIssueCount()
Sets attachment_mention_issue_count
public
setAttachmentMentionIssueCount(int $attachment_mention_issue_count) : self
Parameters
- $attachment_mention_issue_count : int
-
attachment_mention_issue_count
Return values
self —setCheckedImages()
Sets checked_images
public
setCheckedImages(int $checked_images) : self
Parameters
- $checked_images : int
-
checked_images
Return values
self —setCheckedLinks()
Sets checked_links
public
setCheckedLinks(int $checked_links) : self
Parameters
- $checked_links : int
-
checked_links
Return values
self —setCompatibilityNotSupportedCount()
Sets compatibility_not_supported_count
public
setCompatibilityNotSupportedCount(int $compatibility_not_supported_count) : self
Parameters
- $compatibility_not_supported_count : int
-
compatibility_not_supported_count
Return values
self —setCompatibilityUnknownCount()
Sets compatibility_unknown_count
public
setCompatibilityUnknownCount(int $compatibility_unknown_count) : self
Parameters
- $compatibility_unknown_count : int
-
compatibility_unknown_count
Return values
self —setCompatibilityWarningCount()
Sets compatibility_warning_count
public
setCompatibilityWarningCount(int $compatibility_warning_count) : self
Parameters
- $compatibility_warning_count : int
-
compatibility_warning_count
Return values
self —setErrorMessage()
Sets error_message
public
setErrorMessage(string|null $error_message) : self
Parameters
- $error_message : string|null
-
error_message
Return values
self —setFailingChecks()
Sets failing_checks
public
setFailingChecks(int $failing_checks) : self
Parameters
- $failing_checks : int
-
failing_checks
Return values
self —setHealthScore()
Sets health_score
public
setHealthScore(int $health_score) : self
Parameters
- $health_score : int
-
health_score
Return values
self —setHtmlErrorCount()
Sets html_error_count
public
setHtmlErrorCount(int $html_error_count) : self
Parameters
- $html_error_count : int
-
html_error_count
Return values
self —setHtmlInfoCount()
Sets html_info_count
public
setHtmlInfoCount(int $html_info_count) : self
Parameters
- $html_info_count : int
-
html_info_count
Return values
self —setHtmlWarningCount()
Sets html_warning_count
public
setHtmlWarningCount(int $html_warning_count) : self
Parameters
- $html_warning_count : int
-
html_warning_count
Return values
self —setImageIssueCount()
Sets image_issue_count
public
setImageIssueCount(int $image_issue_count) : self
Parameters
- $image_issue_count : int
-
image_issue_count
Return values
self —setInsights()
Sets insights
public
setInsights(array<string|int, string> $insights) : self
Parameters
- $insights : array<string|int, string>
-
insights
Return values
self —setLinkIssueCount()
Sets link_issue_count
public
setLinkIssueCount(int $link_issue_count) : self
Parameters
- $link_issue_count : int
-
link_issue_count
Return values
self —setPassingChecks()
Sets passing_checks
public
setPassingChecks(int $passing_checks) : self
Parameters
- $passing_checks : int
-
passing_checks
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
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> —setTotalChecks()
Sets total_checks
public
setTotalChecks(int $total_checks) : self
Parameters
- $total_checks : int
-
total_checks
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>