SerpApiSearch::search() - Code Metrics - zanysoft/laravel-serpapi - Measure and Improve Code Quality continuously with Scrutinizer

SerpApiSearch::search() A
last analyzed 2025-02-18 12:04 UTC

↳ Parent: SerpApiSearch

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	3
rs	10

<?php

declare(strict_types=1);

namespace ZanySoft\LaravelSerpApi\Lib;

use RestClient;
filter:
    dependency_paths: ["lib/*"]
use ZanySoft\LaravelSerpApi\Exceptions\SerpApiSearchException;

/**
 * Wrapper around serpapi.com
 */
class SerpApiSearch
{
    protected $options;
    protected $api;
    protected $api_key;
    protected $engine;

    /**
     * @param $api_key
     * @param $engine
     * @throws SerpApiSearchException
     */
    public function __construct($api_key = null, $engine = 'google')
    {
        // register engine
        if ($engine) {
            $this->engine = $engine;
        } else {
            throw new SerpApiSearchException("engine must be defined");
        }

        // register private api key
        if ($api_key) {
            $this->api_key = $api_key;
        }
    }

    /**
     * set serpapi key
     *
     * @param $api_key
     * @return void
     * @throws SerpApiSearchException
     */
    public function set_serp_api_key($api_key)
    {
        if ($api_key == null) {
            throw new SerpApiSearchException("serp_api_key must have a value");
        }
        $this->api_key = $api_key;
    }

    /**
     * get json search result
     *
     * @param array $query
     * @return mixed
     */
    public function get_json(array $query)
    {
        return $this->search('json', $query);
    }

    /**
     * get raw html search result
     *
     * @param array $query
     * @return mixed
     * @throws SerpApiSearchException
     */
    public function get_html(array $query)
    {
        return $this->search('html', $query);
    }

    /**
     * Get location using Location API
     * @param $query
     * @param $limit
     * @return mixed
     * @throws SerpApiSearchException
     */
    public function get_location($query, $limit)
    {
        return $this->query("/locations.json", 'json', [
            'q' => $query,
            'limit' => $limit,
        ]);
    }

    /**
     * Retrieve search result from the Search Archive API
     *
     * @param $search_id
     * @return mixed
     * @throws SerpApiSearchException
     */
    public function get_search_archive($search_id)
    {
        return $this->query("/searches/$search_id.json", 'json', []);
    }

    /**
     * Get account information using Account API
     *
     * @return mixed
     * @throws SerpApiSearchException
     */
    public function get_account()
    {
        return $this->query('/account', 'json', []);
    }

    /**
     * Run a search
     *
     * @param string $output
     * @param array $query
     * @return mixed
     * @throws SerpApiSearchException
     * @throws \RestClientException
     */
    protected function search(string $output, array $query)
    {
        return $this->query('/search', $output, $query);
    }

    /**
     * @param $path
     * @param $output
     * @param $query
     * @return mixed
     * @throws SerpApiSearchException
     * @throws \RestClientException
     */
    protected function query(string $path, string $output, array $query)
    {
        $decode_format = $output == 'json' ? 'json' : 'php';

        if ($this->api_key == null) {
            throw new SerpApiSearchException("serp_api_key must be defined either in the constructor or by the method set_serp_api_key");
        }

        $api = new RestClient([
            'base_url' => "https://serpapi.com",
            'user_agent' => 'google-search-results-php/1.3.0',
            'curl_options' => [
                CURLOPT_SSL_VERIFYHOST => 0,
                CURLOPT_SSL_VERIFYPEER => 0,
            ]
        ]);

        $default_q = [
            'output' => $output,
            'source' => 'php',
            'api_key' => $this->api_key,
            'engine' => $this->engine,
        ];
        $query = array_merge($default_q, $query);
        $result = $api->get($path, $query);

        // GET https://serpapi.com/search?q=Coffee&location=Portland&format=json&source=php&engine=google&serp_api_key=demo
        if ($result->info->http_code == 200) {
            // html response
            if ($decode_format == 'php') {
                return $result->response;
            }
            // json response
            return $result->decode_response();
        }

        if ($result->info->http_code == 400 && $output == 'json') {
            $error = $result->decode_response();
            $msg = $error->error;

            throw new SerpApiSearchException($msg);
        }

        throw new SerpApiSearchException("Unexpected exception: $result->response");
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace ZanySoft\LaravelSerpApi\Lib;
6
7			use RestClient;
			0 ignored issues – show Bug introduced 2023-08-16 07:54 UTC by Report Bug Copy Issue Report The type `RestClient` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history... Bug introduced 2023-08-16 07:54 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `ZanySoft\LaravelSerpApi\Lib\RestClient`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
8			use ZanySoft\LaravelSerpApi\Exceptions\SerpApiSearchException;
9
10			/**
11			* Wrapper around serpapi.com
12			*/
13			class SerpApiSearch
14			{
15			protected $options;
16			protected $api;
17			protected $api_key;
18			protected $engine;
19
20			/**
21			* @param $api_key
22			* @param $engine
23			* @throws SerpApiSearchException
24			*/
25			public function __construct($api_key = null, $engine = 'google')
26			{
27			// register engine
28			if ($engine) {
29			$this->engine = $engine;
30			} else {
31			throw new SerpApiSearchException("engine must be defined");
32			}
33
34			// register private api key
35			if ($api_key) {
36			$this->api_key = $api_key;
37			}
38			}
39
40			/**
41			* set serpapi key
42			*
43			* @param $api_key
44			* @return void
45			* @throws SerpApiSearchException
46			*/
47			public function set_serp_api_key($api_key)
48			{
49			if ($api_key == null) {
50			throw new SerpApiSearchException("serp_api_key must have a value");
51			}
52			$this->api_key = $api_key;
53			}
54
55			/**
56			* get json search result
57			*
58			* @param array $query
59			* @return mixed
60			*/
61			public function get_json(array $query)
62			{
63			return $this->search('json', $query);
64			}
65
66			/**
67			* get raw html search result
68			*
69			* @param array $query
70			* @return mixed
71			* @throws SerpApiSearchException
72			*/
73			public function get_html(array $query)
74			{
75			return $this->search('html', $query);
76			}
77
78			/**
79			* Get location using Location API
80			* @param $query
81			* @param $limit
82			* @return mixed
83			* @throws SerpApiSearchException
84			*/
85			public function get_location($query, $limit)
86			{
87			return $this->query("/locations.json", 'json', [
88			'q' => $query,
89			'limit' => $limit,
90			]);
91			}
92
93			/**
94			* Retrieve search result from the Search Archive API
95			*
96			* @param $search_id
97			* @return mixed
98			* @throws SerpApiSearchException
99			*/
100			public function get_search_archive($search_id)
101			{
102			return $this->query("/searches/$search_id.json", 'json', []);
103			}
104
105			/**
106			* Get account information using Account API
107			*
108			* @return mixed
109			* @throws SerpApiSearchException
110			*/
111			public function get_account()
112			{
113			return $this->query('/account', 'json', []);
114			}
115
116			/**
117			* Run a search
118			*
119			* @param string $output
120			* @param array $query
121			* @return mixed
122			* @throws SerpApiSearchException
123			* @throws \RestClientException
124			*/
125			protected function search(string $output, array $query)
126			{
127			return $this->query('/search', $output, $query);
128			}
129
130			/**
131			* @param $path
132			* @param $output
133			* @param $query
134			* @return mixed
135			* @throws SerpApiSearchException
136			* @throws \RestClientException
137			*/
138			protected function query(string $path, string $output, array $query)
139			{
140			$decode_format = $output == 'json' ? 'json' : 'php';
141
142			if ($this->api_key == null) {
143			throw new SerpApiSearchException("serp_api_key must be defined either in the constructor or by the method set_serp_api_key");
144			}
145
146			$api = new RestClient([
147			'base_url' => "https://serpapi.com",
148			'user_agent' => 'google-search-results-php/1.3.0',
149			'curl_options' => [
150			CURLOPT_SSL_VERIFYHOST => 0,
151			CURLOPT_SSL_VERIFYPEER => 0,
152			]
153			]);
154
155			$default_q = [
156			'output' => $output,
157			'source' => 'php',
158			'api_key' => $this->api_key,
159			'engine' => $this->engine,
160			];
161			$query = array_merge($default_q, $query);
162			$result = $api->get($path, $query);
163
164			// GET https://serpapi.com/search?q=Coffee&location=Portland&format=json&source=php&engine=google&serp_api_key=demo
165			if ($result->info->http_code == 200) {
166			// html response
167			if ($decode_format == 'php') {
168			return $result->response;
169			}
170			// json response
171			return $result->decode_response();
172			}
173
174			if ($result->info->http_code == 400 && $output == 'json') {
175			$error = $result->decode_response();
176			$msg = $error->error;
177
178			throw new SerpApiSearchException($msg);
179			}
180
181			throw new SerpApiSearchException("Unexpected exception: $result->response");
182			}
183			}
184

zanysoft / laravel-serpapi

SerpApiSearch::search() A last analyzed 2025-02-18 12:04 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SerpApiSearch::search() A
last analyzed 2025-02-18 12:04 UTC