Skip to content

Commit 1b65559

Browse files
arwaawanarwaawan
committed
Laravel wrapper
1 parent f86d488 commit 1b65559

6 files changed

+331
-3
lines changed

‎composer.json

+8-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@
2929
"Tipoff\\LaravelSerpapi\\": "src",
3030
"Tipoff\\LaravelSerpapi\\Database\\Factories\\": "database/factories",
3131
"Tipoff\\LaravelSerpapi\\Database\\Seeders\\": "database/seeders"
32-
}
32+
},
33+
"files": [
34+
"src/Helpers/SerpApiSearch.php"
35+
]
3336
},
3437
"autoload-dev": {
3538
"psr-4": {
@@ -48,7 +51,10 @@
4851
"laravel": {
4952
"providers": [
5053
"Tipoff\\LaravelSerpapi\\LaravelSerpapiServiceProvider"
51-
]
54+
],
55+
"aliases": {
56+
"SerpApiSearch": "Tipoff\\LaravelSerpapi\\Facades\\SerpApiSearchFacade"
57+
}
5258
}
5359
},
5460
"repositories": [

‎config/laravel-serpapi.php

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?php
22

33
return [
4-
4+
'api_key' => env('SERPAPI_API_KEY'),
5+
'search_engine' => env('SERPAPI_ENGINE', 'google')
56
];

‎src/Facades/SerpApiSearchFacade.php

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?php
2+
3+
namespace Tipoff\LaravelSerpapi\Facades;
4+
5+
use Illuminate\Support\Facades\Facade;
6+
7+
/**
8+
* @see \Google_Search
9+
*/
10+
class SerpApiSearchFacade extends Facade {
11+
12+
protected static function getFacadeAccessor() {
13+
return 'serp-api-search';
14+
}
15+
16+
}

‎src/Helpers/SerpApiSearch.php

+276
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,276 @@
1+
<?php
2+
3+
// Exception
4+
class SerpApiSearchException extends Exception {
5+
6+
}
7+
8+
/* * *
9+
* Google search
10+
*/
11+
12+
class GoogleSearch extends SerpApiSearch {
13+
14+
public function __construct($api_key) {
15+
parent::__construct($api_key, 'google');
16+
}
17+
18+
}
19+
20+
/* * *
21+
* Bing search
22+
*/
23+
24+
class BingSearch extends SerpApiSearch {
25+
26+
public function __construct($api_key = NULL) {
27+
parent::__construct($api_key, 'bing');
28+
}
29+
30+
}
31+
32+
/* * *
33+
* Baidu search
34+
*/
35+
36+
class BaiduSearch extends SerpApiSearch {
37+
38+
public function __construct($api_key = NULL) {
39+
parent::__construct($api_key, 'baidu');
40+
}
41+
42+
/* * *
43+
* Method is not supported.
44+
*/
45+
46+
public function get_location($q, $limit) {
47+
throw new SerpApiSearchException("location is not currently supported by Bing");
48+
}
49+
50+
}
51+
52+
/* * *
53+
* Yahoo search
54+
*/
55+
56+
class YahooSearch extends SerpApiSearch {
57+
58+
public function __construct($api_key = NULL) {
59+
parent::__construct($api_key, 'yahoo');
60+
}
61+
62+
/* * *
63+
* Method is not supported.
64+
*/
65+
66+
public function get_location($q, $limit) {
67+
throw new SerpApiSearchException("location is not currently supported by Bing");
68+
}
69+
70+
}
71+
72+
/* * *
73+
* Yandex search
74+
*/
75+
76+
class YandexSearch extends SerpApiSearch {
77+
78+
public function __construct($api_key = NULL) {
79+
parent::__construct($api_key, 'yandex');
80+
}
81+
82+
/* * *
83+
* Method is not supported.
84+
*/
85+
86+
public function get_location($q, $limit) {
87+
throw new SerpApiSearchException("location is not currently supported by Bing");
88+
}
89+
90+
}
91+
92+
/* * *
93+
* Ebay search
94+
*/
95+
96+
class EbaySearch extends SerpApiSearch {
97+
98+
public function __construct($api_key = NULL) {
99+
parent::__construct($api_key, 'ebay');
100+
}
101+
102+
/* * *
103+
* Method is not supported.
104+
*/
105+
106+
public function get_location($q, $limit) {
107+
throw new SerpApiSearchException("location is not currently supported by Bing");
108+
}
109+
110+
}
111+
112+
/* * *
113+
* YouTube search
114+
*/
115+
116+
class YouTubeSearch extends SerpApiSearch {
117+
118+
public function __construct($api_key = NULL) {
119+
parent::__construct($api_key, 'youTube');
120+
}
121+
122+
/* * *
123+
* Method is not supported.
124+
*/
125+
126+
public function get_location($q, $limit) {
127+
throw new SerpApiSearchException("location is not currently supported by Bing");
128+
}
129+
130+
}
131+
132+
/* * *
133+
* WalmartSearch search
134+
*/
135+
136+
class WalmartSearch extends SerpApiSearch {
137+
138+
public function __construct($api_key = NULL) {
139+
parent::__construct($api_key, 'walmart');
140+
}
141+
142+
/* * *
143+
* Method is not supported.
144+
*/
145+
146+
public function get_location($q, $limit) {
147+
throw new SerpApiSearchException("location is not currently supported by Bing");
148+
}
149+
150+
}
151+
152+
/* * *
153+
* Wrapper around serpapi.com
154+
*/
155+
156+
class SerpApiSearch {
157+
158+
public $options;
159+
public $api;
160+
public $api_key;
161+
public $engine;
162+
163+
public function __construct($api_key = NULL, $engine = 'google') {
164+
// register engine
165+
if ($engine) {
166+
$this->engine = $engine;
167+
} else {
168+
throw new SerpApiSearchException("engine must be defined");
169+
}
170+
171+
// register private api key
172+
if ($api_key) {
173+
$this->api_key = $api_key;
174+
}
175+
}
176+
177+
public function set_serp_api_key($api_key) {
178+
if ($api_key == NULL)
179+
throw new SerpApiSearchException("serp_api_key must have a value");
180+
$this->api_key = $api_key;
181+
}
182+
183+
/* * *
184+
* get_json
185+
* @return [Hash] search result "json like"
186+
*/
187+
188+
public function get_json($q) {
189+
return $this->search('json', $q);
190+
}
191+
192+
/* * *
193+
* get_html
194+
* @return [String] raw html search result
195+
*/
196+
197+
public function get_html($q) {
198+
return $this->search('html', $q);
199+
}
200+
201+
/* * *
202+
* Get location using Location API
203+
*/
204+
205+
function get_location($q, $limit) {
206+
$query = [
207+
'q' => $q,
208+
'limit' => $limit
209+
];
210+
return $this->query("/locations.json", 'json', $query);
211+
}
212+
213+
/* * *
214+
* Retrieve search result from the Search Archive API
215+
*/
216+
217+
function get_search_archive($search_id) {
218+
return $this->query("/searches/$search_id.json", 'json', []);
219+
}
220+
221+
/* * *
222+
* Get account information using Account API
223+
*/
224+
225+
function get_account() {
226+
return $this->query('/account', 'json', []);
227+
}
228+
229+
/**
230+
* Run a search
231+
*/
232+
function search($output, $q) {
233+
return $this->query('/search', $output, $q);
234+
}
235+
236+
function query($path, $output, $q) {
237+
$decode_format = $output == 'json' ? 'json' : 'php';
238+
239+
if ($this->api_key == NULL) {
240+
throw new SerpApiSearchException("serp_api_key must be defined either in the constructor or by the method set_serp_api_key");
241+
}
242+
243+
$api = new RestClient([
244+
'base_url' => "https://serpapi.com",
245+
'user_agent' => 'google-search-results-php/1.3.0'
246+
]);
247+
248+
$default_q = [
249+
'output' => $output,
250+
'source' => 'php',
251+
'api_key' => $this->api_key,
252+
'engine' => $this->engine
253+
];
254+
$q = array_merge($default_q, $q);
255+
$result = $api->get($path, $q);
256+
257+
// GET https://serpapi.com/search?q=Coffee&location=Portland&format=json&source=php&engine=google&serp_api_key=demo
258+
if ($result->info->http_code == 200) {
259+
// html response
260+
if ($decode_format == 'php') {
261+
return $result->response;
262+
}
263+
// json response
264+
return $result->decode_response();
265+
}
266+
267+
if ($result->info->http_code == 400 && $output == 'json') {
268+
$error = $result->decode_response();
269+
$msg = $error->error;
270+
throw new SerpApiSearchException($msg);
271+
}
272+
273+
throw new SerpApiSearchException("Unexpected exception: $result->response");
274+
}
275+
276+
}

‎src/LaravelSerpapiServiceProvider.php

+13
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
namespace Tipoff\LaravelSerpapi;
66

7+
use SerpApiSearch;
8+
use Tipoff\LaravelSerpapi\Models\Key;
79
use Tipoff\Support\TipoffPackage;
810
use Tipoff\Support\TipoffServiceProvider;
911

@@ -16,4 +18,15 @@ public function configureTipoffPackage(TipoffPackage $package): void
1618
->hasViews()
1719
->hasConfigFile();
1820
}
21+
22+
public function register()
23+
{
24+
parent::register();
25+
26+
$this->app->bind(SerpApiSearch::class, function () {
27+
$api_key = config('laravel-serpapi.api_key');
28+
$engine = config('laravel-serpapi.search_engine');
29+
return new SerpApiSearch($api_key, $engine);
30+
});
31+
}
1932
}

‎src/Models/Key.php

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?php
2+
3+
declare(strict_types = 1);
4+
5+
namespace Tipoff\LaravelSerpapi\Models;
6+
7+
use Tipoff\Support\Models\BaseModel;
8+
use Tipoff\Support\Traits\HasPackageFactory;
9+
10+
class Key extends BaseModel {
11+
12+
use HasPackageFactory;
13+
14+
protected $casts = [];
15+
16+
}

0 commit comments

Comments
 (0)