-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathClient.php
More file actions
310 lines (264 loc) · 7.52 KB
/
Copy pathClient.php
File metadata and controls
310 lines (264 loc) · 7.52 KB
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
<?php
namespace SerpApi;
class Client
{
public const VERSION = '1.0.0';
public const BASE_URL = 'https://serpapi.com';
public const DEFAULT_TIMEOUT = 120;
/** @var string */
private $apiKey;
/** @var string */
private $engine;
/** @var int */
private $timeout;
/**
* @param string $apiKey
* @param string $engine
* @param int $timeout Request timeout in seconds
* @throws SerpApiException
*/
public function __construct(string $apiKey = '', string $engine = 'google', int $timeout = self::DEFAULT_TIMEOUT)
{
if (empty($engine)) {
throw new SerpApiException('engine must be present');
}
$this->apiKey = $apiKey;
$this->engine = $engine;
$this->timeout = $timeout;
}
/**
* Set the SerpApi API key.
*
* @param string $apiKey
* @throws SerpApiException
*/
public function setApiKey(string $apiKey): void
{
if (empty($apiKey)) {
throw new SerpApiException('api_key must have a value');
}
$this->apiKey = $apiKey;
}
/**
* Get the current API key.
*/
public function getApiKey(): string
{
return $this->apiKey;
}
/**
* Get the current engine.
*/
public function getEngine(): string
{
return $this->engine;
}
/**
* Run a search and return decoded JSON.
*
* @param array<string, mixed> $params
* @throws SerpApiException
*/
public function search(array $params = []): object
{
return $this->get('/search', 'json', $params);
}
/**
* Run a search and return raw HTML.
*
* @param array<string, mixed> $params
* @throws SerpApiException
*/
public function html(array $params = []): string
{
return $this->get('/search', 'html', $params);
}
/**
* Get account information using Account API.
*
* @throws SerpApiException
*/
public function account(?string $apiKey = null): object
{
$params = empty($apiKey) ? [] : ['api_key' => $apiKey];
return $this->get('/account', 'json', $params);
}
/**
* Get locations using Location API.
*
* @param array<string, mixed> $params
* @return array<int, object>
* @throws SerpApiException
*/
public function location(array $params = []): array
{
return $this->get('/locations.json', 'json', $params);
}
/**
* Retrieve search result from the Search Archive API.
*
* @return object|string
* @throws SerpApiException
*/
public function searchArchive(string $searchId, string $format = 'json')
{
if (empty($searchId)) {
throw new SerpApiException('search_id must be present');
}
if (!in_array($format, ['json', 'html'], true)) {
throw new SerpApiException('format must be json or html');
}
$safeSearchId = rawurlencode($searchId);
return $this->get("/searches/{$safeSearchId}.{$format}", $format, []);
}
/**
* @param array<string, mixed> $params
* @return object|array<int|string, mixed>|string
* @throws SerpApiException
*/
private function get(string $endpoint, string $format = 'json', array $params = [])
{
if (!in_array($format, ['json', 'html'], true)) {
throw new SerpApiException("Unsupported format '$format'. Expected 'html' or 'json'.");
}
$apiKey = $params['api_key'] ?? $this->apiKey;
$requiresKey = strpos($endpoint, '/locations') !== 0;
if ($requiresKey && empty($apiKey)) {
throw new SerpApiException('api_key must be present');
}
$defaultQuery = [
'engine' => $this->engine,
'source' => 'php',
];
if (!empty($apiKey)) {
$defaultQuery['api_key'] = $apiKey;
}
$query = array_merge($defaultQuery, $params);
$query['output'] = $format;
$url = self::BASE_URL . $endpoint . '?' . http_build_query($query);
$requestResult = $this->request($url);
$response = $requestResult['response'];
$httpCode = $requestResult['http_code'];
$curlError = $requestResult['curl_error'];
if ($response === false) {
throw new SerpApiException('cURL error: ' . $curlError);
}
if ($format === 'html') {
if ($httpCode === 200) {
return $response;
}
$this->raiseHttpError($httpCode, $endpoint, $query, null, null, 'html');
}
$decoded = json_decode($response);
if ($decoded === null && json_last_error() !== JSON_ERROR_NONE) {
$this->raiseParserError($httpCode, $endpoint, $query);
}
$serpApiError = (is_object($decoded) && isset($decoded->error)) ? $decoded->error : null;
$searchId = (is_object($decoded) && isset($decoded->search_metadata->id))
? (string) $decoded->search_metadata->id
: null;
if ($httpCode === 200) {
if ($serpApiError !== null) {
$this->raiseHttpError($httpCode, $endpoint, $query, $serpApiError, $searchId, 'json');
}
return $decoded;
}
$this->raiseHttpError($httpCode, $endpoint, $query, $serpApiError, $searchId, 'json');
}
/**
* @return array{response: string|false, http_code: int, curl_error: string}
* @throws SerpApiException
*/
private function request(string $url): array
{
$ch = curl_init();
if ($ch === false) {
throw new SerpApiException('Failed to initialize cURL handle');
}
try {
$isConfigured = curl_setopt_array($ch, [
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERAGENT => 'serpapi-php/' . self::VERSION,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_TIMEOUT => $this->timeout,
]);
if ($isConfigured === false) {
throw new SerpApiException('Failed to configure cURL options: ' . curl_error($ch));
}
$response = curl_exec($ch);
$httpCode = (int) curl_getinfo($ch, CURLINFO_HTTP_CODE);
$curlError = curl_error($ch);
return [
'response' => $response,
'http_code' => $httpCode,
'curl_error' => $curlError,
];
} finally {
if (PHP_VERSION_ID < 80500) {
curl_close($ch);
}
$ch = null;
}
}
/**
* @param array<string, mixed> $searchParams
* @return never
* @throws SerpApiException
*/
private function raiseHttpError(
int $responseStatus,
string $endpoint,
array $searchParams,
?string $serpApiError = null,
?string $searchId = null,
string $decoder = 'json'
): void {
$message = "HTTP request failed with status: {$responseStatus}";
if ($serpApiError !== null) {
$message .= " error: {$serpApiError}";
}
$message .= ' from url: ' . self::BASE_URL . $endpoint;
$sanitizedSearchParams = $this->sanitizeSearchParams($searchParams);
throw new SerpApiException(
$message,
$serpApiError,
$sanitizedSearchParams,
$responseStatus,
$searchId,
$decoder
);
}
/**
* @param array<string, mixed> $searchParams
* @return never
* @throws SerpApiException
*/
private function raiseParserError(
int $responseStatus,
string $endpoint,
array $searchParams
): void {
$sanitizedSearchParams = $this->sanitizeSearchParams($searchParams);
throw new SerpApiException(
'JSON parse error: ' . json_last_error_msg() . ' on get url: ' . self::BASE_URL . $endpoint,
null,
$sanitizedSearchParams,
$responseStatus,
null,
'json'
);
}
/**
* @param array<string, mixed> $searchParams
* @param array<int, string> $keysToRemove
* @return array<string, mixed>
*/
private function sanitizeSearchParams(array $searchParams, array $keysToRemove = ['api_key']): array
{
foreach ($keysToRemove as $key) {
unset($searchParams[$key]);
}
return $searchParams;
}
}