feat(php): add bridge to transformation on search

Author: shortcuts

scripts/cts/runCts.ts

@@ -158,7 +158,7 @@ export async function runCts(
     assertValidReplaceAllObjectsFailed(languages.length - skip('dart'));
     assertValidReplaceAllObjectsScopes(languages.length - skip('dart'));
     assertValidWaitForApiKey(languages.length - skip('dart'));
-    assertPushMockValid(only('javascript') + only('go') + only('python') + only('java'));
+    assertPushMockValid(only('javascript') + only('go') + only('python') + only('java') + only('php'));
   }
   if (withBenchmarkServer) {
     printBenchmarkReport();

specs/search/helpers/partialUpdateObjectsWithTransformation.yml

@@ -2,10 +2,11 @@ method:
   post:
     x-helper: true
     x-available-languages:
-      - javascript
       - go
-      - python
       - java
+      - javascript
+      - php
+      - python
     tags:
       - Records
     operationId: partialUpdateObjectsWithTransformation

specs/search/helpers/saveObjectsWithTransformation.yml

@@ -2,10 +2,11 @@ method:
   get:
     x-helper: true
     x-available-languages:
-      - javascript
       - go
-      - python
       - java
+      - javascript
+      - php
+      - python
     tags:
       - Records
     operationId: saveObjectsWithTransformation

templates/java/api.mustache

@@ -56,6 +56,11 @@ public class {{classname}} extends ApiClient {
     {{#isSearchClient}}
     private IngestionClient ingestionTransporter;
 
+    /**
+     * Sets the region of the current algolia application to the configuration, this is required to be called if you wish to leverage the transformation pipeline (via the *WithTransformation methods).
+     *
+     * @param region (required)
+     */
     public void setTransformationRegion(String region) {
       this.ingestionTransporter = new IngestionClient(this.authInterceptor.getApplicationId(), this.authInterceptor.getApiKey(), region, this.clientOptions);
     }

templates/php/api.mustache

@@ -34,6 +34,11 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
      */
     protected $api;
 
+    /**
+     * @var IngestionClient
+     */
+    protected $ingestionTransporter;
+
     /**
      * @var {{configClassname}}
      */
@@ -93,6 +98,16 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
             self::getClusterHosts($config)
         );
 
+        if (null !== $config->getTransformationRegion()) {
+          $ingestionConfig = IngestionConfig::create($appId, $apiKey, $config->getTransformationRegion());
+
+          if (isset($config->hosts)) {
+            $ingestionConfig['hosts'] = $config->hosts;
+          }
+
+            $this->ingestionTransporter = new IngestionClient($config->appId, $config->apiKey, $config->getTransformationRegion(), $ingestionConfig);
+        }
+
         return new static($apiWrapper, $config);
     }
 
@@ -514,6 +529,23 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
       return $this->chunkedBatch($indexName, $objects, 'addObject', $waitForTasks, $batchSize, $requestOptions);
     }
 
+    /**
+     * Helper: Similar to the `saveObjects` method but requires a Push connector
+     * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+     * to be created first, in order to transform records before indexing them to Algolia. The
+     * `region` must have been passed to the client instantiation method.
+     *
+     * @param string $indexName      the `indexName` to replace `objects` in
+     * @param array  $objects        the array of `objects` to store in the given Algolia `indexName`
+     * @param bool   $waitForTasks   Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable
+     * @param array  $batchSize      The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param array  $requestOptions Request options
+     */
+    public function saveObjectsWithTransformation($indexName, $objects, $waitForTasks = false, $batchSize = 1000, $requestOptions = [])
+    {
+        return $this->ingestionTransporter->push($indexName, 'addObject', $objects, $waitForTasks, $requestOptions);
+    }
+
     /**
     * Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
     *
@@ -548,6 +580,24 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
       return $this->chunkedBatch($indexName, $objects, ($createIfNotExists == TRUE) ? 'partialUpdateObject' : 'partialUpdateObjectNoCreate', $waitForTasks, $batchSize, $requestOptions);
     }
 
+    /**
+     * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector
+     * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+     * to be created first, in order to transform records before indexing them to Algolia. The
+     * `region` must have been passed to the client instantiation method.
+     *
+     * @param string $indexName         the `indexName` to replace `objects` in
+     * @param array  $objects           the array of `objects` to store in the given Algolia `indexName`
+     * @param bool   $createIfNotExists To be provided if non-existing objects are passed, otherwise, the call will fail..
+     * @param bool   $waitForTasks      Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable
+     * @param array  $batchSize         The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param array  $requestOptions    Request options
+     */
+    public function partialUpdateObjectsWithTransformation($indexName, $objects, $createIfNotExists, $waitForTasks = false, $batchSize = 1000, $requestOptions = [])
+    {
+        return $this->ingestionTransporter->push($indexName, (true == $createIfNotExists) ? 'partialUpdateObject' : 'partialUpdateObjectNoCreate', $objects, $waitForTasks, $requestOptions);
+    }
+
     /**
     * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
     *

templates/php/client_config.mustache

@@ -66,6 +66,25 @@ class {{configClassname}} extends {{#hasRegionalHost}}ConfigWithRegion{{/hasRegi
     {
         return $this->config['defaultMaxRetries'];
     }
+
+    /**
+     * Sets the region of the current algolia application to the configuration, this is required to be called if you wish to leverage the transformation pipeline (via the *WithTransformation methods).
+     *
+     * @param string $region the user agent of the api client
+     *
+     * @return $this
+     */
+    public function setTransformationRegion($region)
+    {
+        $this->config['region'] = $region;
+
+        return $this;
+    }
+
+    public function getTransformationRegion()
+    {
+        return $this->config['region'];
+    }
     {{/isSearchClient}}
 
     public function getDefaultConfiguration()