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 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
| <?php
namespace Entrecore\GTMetrixClient;
/**
* The basic GTMetrix client class.
*
* Usage:
*
* $client = new GTMetrixClient();
* $client->setUsername('your@email.com');
* $client->setAPIKey('your-gtmetrix-api-key');
*
* $client->getLocations();
* $client->getBrowsers();
* $test = $client->startTest();
*
* //Wait for result
* while ($test->getState() != GTMetrixTest::STATE_COMPLETED &&
* $test->getState() != GTMetrixTest::STATE_ERROR) {
* $client->getTestStatus($test);
* sleep(5);
* }
*
*/
class GTMetrixClient {
/**
* API endpoint. Normally you don't need to change this.
*
* @var string
*/
protected $endpoint = 'https://gtmetrix.com/api/0.1'; //L'accès aux éléments protégés est limité à la classe elle-même, ainsi qu'aux classes qui en héritent.
/**
* GTMetrix username
*
* @var string
*/
protected $username = ''; //Mail utilisateur
/**
* GTMetrix API key.
*
* @var string
*
* @see http://gtmetrix.com/api/
*/
protected $apiKey = ''; //Clé de l'API
/**
* @return string
*/
public function getUsername() { //Getter
return $this->username;
}
/**
* @param string $username
*/
public function setUsername($username) { //Setter
$this->username = $username;
}
/**
* @return string
*/
public function getAPIKey() { //Getter
return $this->apiKey;
}
/**
* @param string $url
* @param array $data
* @param bool $json
*
* @return array|string
*
* @throws GTMetrixConfigurationException
* @throws GTMetrixException
*/
protected function apiCall($url, $data = array(), $json = true) {
if (!$this->username || !$this->apiKey) {
throw new GTMetrixConfigurationException('Username and API key must be set up before using API calls!' .
'See setUsername() and setAPIKey() for details.');
}
$ch = curl_init($this->endpoint . $url);
if (!empty($data)) {
curl_setopt($ch, CURLOPT_POST, count($data));
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
}
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); //méthode d'identification HTTP
curl_setopt($ch, CURLOPT_USERPWD, $this->username . ':' . $this->apiKey);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CAINFO, dirname(__DIR__) . '/data/ca-bundle.crt');
$result = curl_exec($ch);
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$curlErrNo = curl_errno($ch);
$curlError = curl_error($ch);
curl_close ($ch);
if (!\preg_match('/^(2|3)/', $statusCode)) {
if ($statusCode == 0) {
throw new GTMetrixException('cURL error ' . $curlErrNo . ': ' . $curlError);
}
throw new GTMetrixException('API error ' . $statusCode . ': ' . $result);
}
if ($json) {
$data = json_decode($result, true);
if (json_last_error()) {
throw new GTMetrixException('Invalid JSON received: ' . json_last_error_msg());
}
} else {
$data = $result;
}
return $data;
}
/**
* @param string $apiKey
*/
public function setAPIKey($apiKey) {
$this->apiKey = $apiKey;
}
/**
* @return GTMetrixLocation[]
*
* @throws GTMetrixConfigurationException
*/
public function getLocations() {
$result = $this->apiCall('/locations');
$locations = array();
foreach ($result as $locationData) {
$location = new GTMetrixLocation();
$location->fromArray($locationData);
$locations[] = $location;
}
return $locations;
}
/**
* @return GTMetrixBrowser[]
*
* @throws GTMetrixConfigurationException
*/
public function getBrowsers() {
$result = $this->apiCall('/browsers');
$browsers = array();
foreach ($result as $browserData) {
$browser = new GTMetrixBrowser();
$browser->fromArray($browserData);
$browsers[] = $browser;
}
return $browsers;
}
/**
* @param string $id
*
* @return GTMetrixBrowser
* @throws GTMetrixConfigurationException
* @throws GTMetrixException
*/
public function getBrowser($id) {
$result = $this->apiCall('/browsers/' . urlencode($id));
$browser = new GTMetrixBrowser();
$browser->fromArray($result);
return $browser;
}
/**
* Start a GTMetrix test
*
* @param string $url
*
* @param null|string $location
* @param null|string $browser
* @param null|string $httpUser
* @param null|string $httpPassword
*
* @return GTMetrixTest
* @throws GTMetrixConfigurationException
* @throws GTMetrixException
*/
public function startTest($url, $location = null, $browser = null, $httpUser = null, $httpPassword = null) {
$data = array();
$data['url'] = $url;
if ($location) {
$data['location'] = $location;
}
if ($browser) {
$data['browser'] = $browser;
}
if ($httpUser) {
$data['login-user'] = $httpUser;
}
if ($httpPassword) {
$data['login-pass'] = $httpPassword;
}
$result = $this->apiCall('/test', $data);
$test = new GTMetrixTest();
$test->setId($result['test_id']);
$test->setPollStateUrl($result['poll_state_url']);
return $test;
}
/**
* @param GTMetrixTest|string $test GTMetrixTest or test ID. This object will be updated
*
* @return GTMetrixTest
*/
public function getTestStatus($test) {
if ($test instanceof GTMetrixTest) {
$testId = $test->getId();
} else {
$testId = $test;
$test = new GTMetrixTest();
$test->setId($testId);
}
$testStatus = $this->apiCall('/test/' . urlencode($testId));
$test->setState($testStatus['state']);
$test->setError($testStatus['error']);
if ($test->getState() == GTMetrixTest::STATE_COMPLETED) {
$test->setReportUrl($testStatus['results']['report_url']);
$test->setPagespeedScore($testStatus['results']['pagespeed_score']);
$test->setYslowScore($testStatus['results']['yslow_score']);
$test->setHtmlBytes($testStatus['results']['html_bytes']);
$test->setHtmlLoadTime($testStatus['results']['html_load_time']);
$test->setPageBytes($testStatus['results']['page_bytes']);
$test->setPageLoadTime($testStatus['results']['page_load_time']);
$test->setPageElements($testStatus['results']['page_elements']);
$test->setRedirectDuration($testStatus['results']['redirect_duration']);
$test->setConnectDuration($testStatus['results']['connect_duration']);
$test->setBackendDuration($testStatus['results']['backend_duration']);
$test->setFirstPaintTime($testStatus['results']['first_paint_time']);
$test->setDomInteractiveTime($testStatus['results']['dom_interactive_time']);
$test->setDomContentLoadedTime($testStatus['results']['dom_content_loaded_time']);
$test->setDomContentLoadedDuration($testStatus['results']['dom_content_loaded_duration']);
$test->setOnloadTime($testStatus['results']['onload_time']);
$test->setOnloadDuration($testStatus['results']['onload_duration']);
$test->setFullyLoadedTime($testStatus['results']['fully_loaded_time']);
$test->setRumSpeedIndex($testStatus['results']['rum_speed_index']);
$test->setResources($testStatus['resources']);
}
return $test;
}
} |
Partager