summaryrefslogtreecommitdiffstats
path: root/src/Objects/Info.php
blob: bd7149ce914f965e256c1efac0885004b7794de7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
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);
	}
}