Deploy SerpApi PHP library by Alaa-abdulridha · Pull Request #1 · serpapi/serpapi-php

Alaa-abdulridha · 2022-11-23T20:37:40Z

WIP

add badge update header

…, classes and files to look like our Ruby library

Freaky · 2024-04-09T15:27:13Z

@Alaa-abdulridha I had a thought recently about how we go to the effort to create links back to the API, for example for pagination:

 "next": "https://serpapi.com/search.json?device=desktop&engine=google&gl=us&google_domain=google.com&hl=en&location=Austin%2C+Texas%2C+United+States&q=Coffee&start=10",

What do you think about our clients having direct support for these? A function that tacks on the API key, validates the endpoint and handles the request for you.

…egrate easily to the new one

…brary

Alaa-abdulridha · 2024-04-09T22:14:07Z

@Alaa-abdulridha I had a thought recently about how we go to the effort to create links back to the API, for example for pagination:
 "next": "https://serpapi.com/search.json?device=desktop&engine=google&gl=us&google_domain=google.com&hl=en&location=Austin%2C+Texas%2C+United+States&q=Coffee&start=10",
What do you think about our clients having direct support for these? A function that tacks on the API key, validates the endpoint and handles the request for you.

Thank you @Freaky , Good idea need more discussing, let's open an issue for it to address it later after deploying the library 👍

@jvmvik Sorry this took long 😞

Freaky

Thanks @Alaa-abdulridha, just one or two comments! My PHP's pretty rusty, I need to catch up on modern best-practices.

Might be nice to have some phpdoc API docs?

Freaky · 2024-04-09T23:56:20Z

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+


The MIT license is supposed to have a copyright notice here, or it's a bit difficult to comply with the bit that starts "The above copyright notice".

Suggested change

Copyright 2024 SerpApi, LLC

Freaky · 2024-04-09T23:57:21Z

+  "engine" => "naver",
+  "query" => "paris",


Doesn't match the following text.

Suggested change

"engine" => "naver",

"query" => "paris",

"engine" => "google",

"q" => "coffee",

Freaky · 2024-04-12T19:04:44Z

@@ -0,0 +1,167 @@
+<?php
+


It was introduced after my PHP time, but I wonder if users generally expect libraries to be in their own namespaces these days?

Copilot

Pull request overview

Copilot reviewed 34 out of 35 changed files in this pull request and generated 4 comments.

+# Default target
+all: install readme test


+  public function test_throws_when_api_key_invalid() {
+    $this->expectException(SerpApiException::class);
+    $this->expectExceptionMessageMatches('/Invalid API key/i');
+    $client = new Client('not_valid_key');
+    $client->search(['q' => 'Coffee']);
+  }


Copilot

Pull request overview

Copilot reviewed 34 out of 35 changed files in this pull request and generated 2 comments.

galetahub · 2026-07-01T11:10:18Z

+    } finally {
+      if (PHP_VERSION_ID < 80500) {
+        curl_close($ch);
+      }
+
+      $ch = null;
+    }


curl_close() is deprecated as of PHP 8.5, so we intentionally avoid calling it on 8.5+.
The handle lifecycle is still bounded by try/finally, and we explicitly release the reference $ch = null to support long-running processes.
For legacy runtimes, we keep curl_close() behind PHP_VERSION_ID < 80500.”

+    - name: Run test suite
+      run: composer run-script test
+      env:
+        API_KEY: ${{ secrets.API_KEY }}


aciddjus · 2026-07-14T10:42:03Z

@galetahub Is this ready for review?

galetahub · 2026-07-14T12:16:10Z

@aciddjus, yes, it's ready for review.
Looks like copilot keeps generating the same comments each review cycle, so I've stopped fighting with it.
I've already asked @Alaa-abdulridha to review this PR.

strzibny · 2026-08-12T13:04:54Z

Since we are building the client using classes, should we use camelCase? e.g. getApiKey()?

galetahub · 2026-08-12T13:17:46Z

Good call, @strzibny! That's actually codified in PSR-1 (PHP Standard Recommendation). I'll fix the method names. I think we should also set up a linter for this.

strzibny · 2026-08-12T13:35:32Z

We can also consider matching https://www.php-fig.org/psr/psr-12/

galetahub · 2026-08-12T14:53:55Z

@strzibny, thanks for looking into it!

The latest updates:

Renamed methods and properties to camelCase for PSR-1 consistency
Set up a linter with extended coding style https://www.php-fig.org/psr/psr-12/
Added badges to the readme
Temporarily skip Google events test due to its unavailability.

strzibny · 2026-08-13T08:08:12Z

Things generally work for me, I haven't faced a major issue in writing and testing different scripts.

Some other things we could consider.

1, Adding PHPStan (we would need to stay on 1.x because of our PHP 7.2support)

2, Extend scripts and remove vendor/bin as it's automatically added by Composer

"scripts": {
        "test": "vendor/bin/phpunit -c phpunit.xml",
        "lint": "vendor/bin/phpcs",
        "analyse": "phpstan analyse src tests",
        "check": [
                "@lint",
                "@analyse",
                "@test"
            ]
    }

3, Extend support fields

"support": {
    "issues": "https://github.com/serpapi/serpapi-php/issues",
    "source": "https://github.com/serpapi/serpapi-php",
    "docs": "https://serpapi.com/integrations/php"
}

4,

Personally I love being able to test libraries offline and I also dislike project README badges (they are native GitHub features for most, they add the issue of not being always loaded, they scream RED and therefore are offputting to users), but I understand this is the case for our other libraries to and it's just a matter of taste.

aciddjus · 2026-08-13T09:07:56Z

@strzibny, can you approve the PR or request changes so that @galetahub knows what the next steps should be?

I would rather release this sooner than later if stable, because we have known issues with the current library that are preventing users from using it efficiently.

galetahub · 2026-08-13T12:54:09Z

Thanks for your comment, @strzibny!

Adding PHPStan (we would need to stay on 1.x because of our PHP 7.2support)

Currently, this library has a small src/ surface (mainly two classes), and we already cover style with PHPCS and behavior with PHPUnit. Happy to revisit if the codebase grows or we want stricter static analysis later.

Extend scripts and remove vendor/bin as it's automatically added by Composer

Agree with you. I removed vendor/bin as it's automatically added.

Extend support fields

Done.

Personally I love being able to test libraries offline and I also dislike project README badges (they are native GitHub features for most, they add the issue of not being always loaded, they scream RED and therefore are offputting to users), but I understand this is the case for our other libraries to and it's just a matter of taste.

According to the badges we use in other integration libraries, I think it makes sense to keep them here as well. For me, badges add a bit more trust to the library 😃.

galetahub · 2026-08-13T14:52:38Z

After discussing it with @strzibny, we concluded that we should remove the CI badge and package downloads counter. The CI badge duplicates a native GitHub feature, sometimes badge won't load or shows a failed build.

strzibny

Approved.

aciddjus · 2026-08-14T11:44:37Z

Thank you, @galetahub 👍

Can you please open a follow-up PR to replace the old version with the new on the website?

Similar to: https://github.com/serpapi/SerpApi/pull/9618

BTW, there is a package badge seam to be broken.

galetahub · 2026-08-14T12:03:23Z

@aciddjus, thanks for pointing it out.
I’ll create a follow-up PR

The package hasn’t been published yet, so the package badge is broken. I'm going to do it via GitHub actions.
BTW, the package version will be 1.0.0.

aciddjus · 2026-08-14T12:07:48Z

Got it. Thank you, sounds good!

Initial

a0f355d

Alaa-abdulridha added the WIP Work in progress label Nov 23, 2022

Alaa-abdulridha self-assigned this Nov 23, 2022

Alaa-abdulridha and others added 16 commits November 23, 2022 21:43

test php version on ci #1

ed7197e

test php version on ci #2

9cd7283

Update serpapiTest.php

00fed51

test api key

8c286d3

Check env

ec39ccb

TEST CI

b75e224

add license and some improvements

a8369b8

Fix failing test

a653e36

Disable SSL Verification & change library user agent

26d248a

Examples

fef54a4

Update readme

13b3803

Makefile & Readme update

1ac5cb9

Update readme

045d308

Update README.md

44a0b71

add badge update header

Update tests, documentation and composer, improve naming of variables…

fb0fc9e

…, classes and files to look like our Ruby library

Improve naming

b19444f

Alaa-abdulridha added 3 commits April 9, 2024 20:57

Improve naming, improve tests, make sure users of old library can int…

ef1b0ad

…egrate easily to the new one

Forgotten var_dump remove and fix test

6d14a94

Fix typos, separate tests, make it more compatible to the new Ruby li…

b07dfd3

…brary

Alaa-abdulridha removed the WIP Work in progress label Apr 9, 2024

Alaa-abdulridha requested review from Freaky and jvmvik April 9, 2024 22:13

Test if engine parameter is empty

b467a2d

Alaa-abdulridha requested a review from aciddjus April 11, 2024 00:18

Freaky suggested changes Apr 12, 2024

View reviewed changes

galetahub requested a review from Copilot June 30, 2026 17:05

Copilot started reviewing on behalf of galetahub June 30, 2026 17:05 View session

Copilot AI reviewed Jun 30, 2026

View reviewed changes

galetahub added 2 commits July 1, 2026 13:57

Handle curl init failures via centralized request helper

65f58ed

Avoid logging response body in JSON parser errors

e7693aa

galetahub requested a review from Copilot July 1, 2026 11:04

Copilot started reviewing on behalf of galetahub July 1, 2026 11:04 View session

Copilot AI reviewed Jul 1, 2026

View reviewed changes

Rename methods and properties to camelCase for PSR-1 consistency

99f8a4e

galetahub added 4 commits August 12, 2026 16:58

Add PHP_CodeSniffer with PSR-12 linting in CI

6ed3e8f

docs: add license badges to README

e9baaf4

tests: temporary skip google_events engine while it's unavailable

6761d79

tests: fix empty results

d7d763a

chore: expand composer support links and drop vendor/bin from scripts

af8d301

docs: removed unnecessary badges

9bdc318

strzibny approved these changes Aug 13, 2026

View reviewed changes

galetahub merged commit 7bdd8b7 into master Aug 14, 2026
2 of 10 checks passed

Uh oh!

Conversation

Alaa-abdulridha commented Nov 23, 2022

Uh oh!

Freaky commented Apr 9, 2024

Uh oh!

Alaa-abdulridha commented Apr 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Freaky left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Freaky Apr 9, 2024

Choose a reason for hiding this comment

Uh oh!

Freaky Apr 9, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Freaky Apr 12, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

galetahub Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

aciddjus commented Jul 14, 2026

Uh oh!

galetahub commented Jul 14, 2026

Uh oh!

strzibny commented Aug 12, 2026

Uh oh!

galetahub commented Aug 12, 2026

Uh oh!

strzibny commented Aug 12, 2026

Uh oh!

galetahub commented Aug 12, 2026

Uh oh!

strzibny commented Aug 13, 2026

Uh oh!

aciddjus commented Aug 13, 2026

Uh oh!

galetahub commented Aug 13, 2026

Uh oh!

galetahub commented Aug 13, 2026

Uh oh!

strzibny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aciddjus commented Aug 14, 2026

Uh oh!

galetahub commented Aug 14, 2026

Uh oh!

aciddjus commented Aug 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Alaa-abdulridha commented Apr 9, 2024 •

edited

Loading