diff options
Diffstat (limited to 'src/Objects/Info.php')
| -rw-r--r-- | src/Objects/Info.php | 215 |
1 files changed, 215 insertions, 0 deletions
diff --git a/src/Objects/Info.php b/src/Objects/Info.php new file mode 100644 index 0000000..bd7149c --- /dev/null +++ b/src/Objects/Info.php @@ -0,0 +1,215 @@ +<?php +namespace BjoernrDe\SSLLabsApi\Objects; + +/** + * SSLLabs Info object + * + * @author Björn Roland + * @see https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md#info + */ + +class Info implements ApiObject +{ + /** + * API engine version + * @var string + */ + private $version; + + /** + * API criteria version + * @var string $criteriaVersion + */ + private $criteriaVersion; + + /** + * Client max assessments + * @var int + */ + private $clientMaxAssessments; + + /** + * Max assessments + * @var int + */ + private $maxAssessments; + + /** + * Current assessments + * @var int + */ + private $currentAssessments; + + /** + * New assessments cool off time in milliseconds + * @var int + */ + private $newAssessmentCoolOff; + + /** + * API messages + * @var array + */ + private $messages; + + /** + * Get current API engine version + * + * @return string + */ + public function getVersion() + { + return ($this->version); + } + + /** + * Set API engine version + * + * @param string $version + */ + private function setVersion($version) + { + $this->version = (string) $version; + } + + /** + * Get criteria version + * + * @return string + */ + public function getCriteriaVersion() + { + return ($this->criteriaVersion); + } + + /** + * Set criteria version + * + * @param string $criteriaVersion + */ + private function setCriteriaVersion($criteriaVersion) + { + $this->criteriaVersion = (string) $criteriaVersion; + } + + /** + * Get client max assessments + * + * @return int + */ + public function getClientMaxAssessments() + { + return ($this->clientMaxAssessments); + } + + /** + * Set client max assessments + * + * @param int $clientMaxAssessments + */ + private function setClientMaxAssessments($clientMaxAssessments) + { + $this->clientMaxAssessments = (int) $clientMaxAssessments; + } + + /** + * Get max assessments + * + * @return int + */ + public function getMaxAssessments() + { + return ($this->maxAssessments); + } + + /** + * Set max assessments + * + * @param int $maxAssessments + */ + private function setMaxAssessments($maxAssessments) + { + $this->maxAssessments = (int) $maxAssessments; + } + + /** + * Get current assessments + * + * @return int + */ + public function getCurrentAssessments() + { + return ($this->currentAssessments); + } + + /** + * Set current assessments + * + * @param int $currentAssessments + */ + private function setCurrentAssessments($currentAssessments) + { + $this->currentAssessments = (int) $currentAssessments; + } + + /** + * Get new assessments cool off time in milliseconds + * + * @return int + */ + public function getNewAssessmentCoolOff() + { + return ($this->newAssessmentCoolOff); + } + + /** + * Set new assessments cool off time in milliseconds + * + * @param int $newAssessmentCoolOff + */ + private function setNewAssessmentCoolOff($newAssessmentCoolOff) + { + $this->newAssessmentCoolOff = (int) $newAssessmentCoolOff; + } + + /** + * Get messages + * + * @return array + */ + public function getMessages() + { + return ($this->messages); + } + + /** + * Set messages + * + * @param array $messages + */ + private function setMessages($messages) + { + $this->messages = (array) $messages; + } + + /** + * {@inheritDoc} + * + * @return \BjoernrDe\SSLLabsApi\Objects\Info + * @see \BjoernrDe\SSLLabsApi\Objects\ApiObject::populateObjectByApiResponse() + */ + public function populateObjectByApiResponse($jsonString) + { + $response = json_decode($jsonString); + + isset($response->engineVersion) ? $this->setVersion($response->engineVersion) : ''; + isset($response->criteriaVersion) ? $this->setCriteriaVersion($response->criteriaVersion) : ''; + isset($response->clientMaxAssessments) ? $this->setClientMaxAssessments($response->clientMaxAssessments) : ''; + isset($response->maxAssessments) ? $this->setMaxAssessments($response->maxAssessments) : ''; + isset($response->currentAssessments) ? $this->setCurrentAssessments($response->currentAssessments) : ''; + isset($response->newAssessmentCoolOff) ? $this->setNewAssessmentCoolOff($response->newAssessmentCoolOff) : ''; + isset($response->messages) ? $this->setMessages($response->messages) : ''; + + return ($this); + } +}
\ No newline at end of file |