PCBC-1063: Testing Docs SDK code samples

.github/workflows/check-examples.yml

@@ -0,0 +1,52 @@
+name: Check Examples
+
+on:
+  pull_request:
+    paths:
+      - 'modules/**/examples/**'
+      - '.github/workflows/check-examples.yml'
+  workflow_dispatch:
+    inputs:
+      sdk_commit_sha:
+        description: 'Commit SHA of couchbase-php-client to use (leave blank for latest main)'
+        required: false
+        default: ''
+
+jobs:
+  check-examples:
+    name: Lint Examples
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout docs-sdk-php
+        uses: actions/checkout@v4
+
+      - name: Checkout couchbase-php-client SDK
+        uses: actions/checkout@v4
+        with:
+          repository: couchbase/couchbase-php-client
+          path: couchbase-php-client
+          ref: ${{ (github.event_name == 'workflow_dispatch' && inputs.sdk_commit_sha != '') && inputs.sdk_commit_sha || 'main' }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          tools: composer, phpstan
+
+      - name: Patch composer.json to use local SDK
+        run: |
+          composer config repositories.couchbase-php-client '{"type": "path", "url": "./couchbase-php-client", "options": {"symlink": false}}'
+          composer require --no-update couchbase/couchbase:@dev
+          composer require --no-update --dev phpstan/phpstan
+          composer update --no-interaction --prefer-dist
+
+      - name: Run PHPStan on examples
+        run: |
+          php -d memory_limit=512M vendor/bin/phpstan analyse \
+            --configuration=phpstan.neon \
+            --no-progress \
+            $(find modules -name "*.php" -path "*/examples/*" | tr '\n' ' ')
+
+
+

composer.json

@@ -1,5 +1,8 @@
 {
     "require": {
         "couchbase/couchbase": "^4.0"
+    },
+    "require-dev": {
+        "phpstan/phpstan": "^2.2"
     }
 }

modules/howtos/examples/kv-crud.php

@@ -8,6 +8,10 @@
 use \Couchbase\GetOptions;
 use \Couchbase\RemoveOptions;
 use \Couchbase\DurabilityLevel;
+use \Couchbase\RangeScan;
+use \Couchbase\PrefixScan;
+use \Couchbase\SamplingScan;
+use \Couchbase\ScanOptions;
 
 $opts = new ClusterOptions();
 $opts->credentials("Administrator", "password");

modules/howtos/examples/search.php

@@ -7,6 +7,9 @@
 use \Couchbase\ConjunctionSearchQuery;
 use \Couchbase\SearchOptions;
 use \Couchbase\MutationState;
+use \Couchbase\SearchRequest;
+use \Couchbase\VectorSearch;
+use \Couchbase\VectorQuery;
 
 /*
  * index definition

modules/howtos/examples/subdoc-mutatein-arrays.php

@@ -23,7 +23,7 @@
 
 // #tag::mutateInArrayPrepend[]
 $result = $collection->MutateIn("customer123", [
-    new \Couchbase\MutateArrayPrependspec("purchases.abandoned", [18])
+    new \Couchbase\MutateArrayPrependSpec("purchases.abandoned", [18])
 ]);
 // purchases.abandoned is now [18, 157, 49, 999]
 // #end::mutateInArrayPrepend[]

modules/howtos/examples/transactions-example.php

@@ -243,6 +243,11 @@ function (TransactionAttemptContext $ctx) use ($collection) {
   // end::insert[]
 }
 
+function calculateLevelForExperience(int $experience): int
+{
+    return (int)floor($experience / 100);
+}
+
 function queryExamples($cluster)
 {
   echo "\nRunning: queryExamplesSelect\n";
@@ -306,12 +311,11 @@ function (TransactionAttemptContext $ctx) use ($hotelChain, $country) {
 
       // This function (not provided here) will use a trained machine learning model to provide a
       // suitable price based on recent customer reviews.
-      function priceFromRecentReviews(Couchbase\QueryResult $qr)
-      {
+      $priceFromRecentReviews = function (\Couchbase\QueryResult $qr): float {
         // this would call a trained ML model to get the best price
         return 99.98;
-      }
-      $updatedPrice = priceFromRecentReviews($qr);
+      };
+      $updatedPrice = $priceFromRecentReviews($qr);
 
       // Set the price of all hotels in the chain
       $ctx->query(
@@ -502,6 +506,7 @@ function (TransactionAttemptContext $ctx) use ($collection, $costOfItem) {
 echo "\nRunning: full-error-handling example\n";
 function completeErrorHandling($cluster, $collection)
 {
+    $costOfItem = 0;
   // tag::full-error-handling[]
   try {
     $result = $cluster->transactions()->run(

modules/howtos/examples/using-cas.php

@@ -4,7 +4,7 @@
 use \Couchbase\Cluster;
 use \Couchbase\Collection;
 use \Couchbase\ReplaceOptions;
-use \Couchbase\CasMismatchError;
+use \Couchbase\Exception\CasMismatchException;
 
 // #tag::increment[]
 function incrementVisitCount(Collection $collection, string $userId) {
@@ -22,7 +22,7 @@ function incrementVisitCount(Collection $collection, string $userId) {
             $opts = new ReplaceOptions();
             $opts->cas($res->cas());
             $collection->replace($userId, $user, $opts);
-        } catch (CasMismatchError $ex) {
+        } catch (CasMismatchException $ex) {
             continue;
         }
 
@@ -62,5 +62,5 @@ function lockingAndCas(Collection $collection, string $userId) {
 
 $collection->upsert("userId", ["visit_count" => 0]);
 
-replaceWithCas($collection, "userId");
+incrementVisitCount($collection, "userId");
 lockingAndCas($collection, "userId");

phpstan.neon

@@ -0,0 +1,2 @@
+parameters:
+    level: 0