docs(php): Pierre's review

Author: damcou

clients/algoliasearch-client-php/lib/Support/AlgoliaAgent.php

@@ -19,7 +19,7 @@ public static function get($clientName)
         return self::$value[$clientName];
     }
 
-    public static function addCustomAlgoliaAgent(
+    public static function addAlgoliaAgent(
         $clientName,
         $segment,
         $version

website/docs/clients/guides/copy-or-move-index.mdx

@@ -26,8 +26,8 @@ const client = algoliasearch('<YOUR_APP_ID>', '<YOUR_API_KEY>');
 const { taskID } = await client.operationIndex({
   indexName: '<SOURCE_INDEX_NAME>',
   operationIndexParams: {
-    destination: '<DESTINATION_INDEX_NAME>',
     operation: 'copy',
+    destination: '<DESTINATION_INDEX_NAME>',
   },
 });
 
@@ -65,8 +65,8 @@ import com.algolia.model.search.*;
 UpdatedAtResponse response = client.operationIndex(
   "<SOURCE_INDEX_NAME>",
   new OperationIndexParams()
-    .setDestination("<DESTINATION_INDEX_NAME>")
     .setOperation(OperationType.COPY)
+    .setDestination("<DESTINATION_INDEX_NAME>")
 );
 
 // Poll the task status until it's done
@@ -91,8 +91,8 @@ const client = algoliasearch('<YOUR_APP_ID>', '<YOUR_API_KEY>');
 const { taskID } = await client.operationIndex({
   indexName: '<SOURCE_INDEX_NAME>',
   operationIndexParams: {
-    destination: '<DESTINATION_INDEX_NAME>',
     operation: 'move',
+    destination: '<DESTINATION_INDEX_NAME>',
   },
 });
 
@@ -130,8 +130,8 @@ import com.algolia.model.search.*;
 UpdatedAtResponse response = client.operationIndex(
   "<SOURCE_INDEX_NAME>",
   new OperationIndexParams()
-    .setDestination("<DESTINATION_INDEX_NAME>")
     .setOperation(OperationType.MOVE)
+    .setDestination("<DESTINATION_INDEX_NAME>")
 );
 
 // Poll the task status until it's done
@@ -158,8 +158,8 @@ const client = algoliasearch('<YOUR_APP_ID>', '<YOUR_API_KEY>');
 const { taskID } = await client.operationIndex({
   indexName: '<SOURCE_INDEX_NAME>',
   operationIndexParams: {
-    destination: '<DESTINATION_INDEX_NAME>',
     operation: 'move',
+    destination: '<DESTINATION_INDEX_NAME>',
     scope: ['rules'],
   },
 });
@@ -199,8 +199,8 @@ import com.algolia.model.search.*;
 UpdatedAtResponse response = client.operationIndex(
   "<SOURCE_INDEX_NAME>",
   new OperationIndexParams()
-    .setDestination("<DESTINATION_INDEX_NAME>")
     .setOperation(OperationType.MOVE)
+    .setDestination("<DESTINATION_INDEX_NAME>")
     .addScope(ScopeType.RULES)
 );
 

website/docs/clients/guides/customized-client-usage.mdx

@@ -50,7 +50,7 @@ $client->search(
             [
                 'indexName' => '<YOUR_INDEX_NAME>',
                 'query' => '<YOUR_QUERY>',
-                'facets' => ['author', 'genre'],
+                'hitsPerPage' => 50,
             ],
         ]
     ],
@@ -118,7 +118,7 @@ $client = SearchClient::create(
 );
 
 // This will append `; my user agent (optional version)` to the current value of `x-algolia-agent` for every requests
-Algolia\AlgoliaSearch\Support\AlgoliaAgent::addCustomAlgoliaAgent(
+Algolia\AlgoliaSearch\Support\AlgoliaAgent::addAlgoliaAgent(
     $client->getClientConfig()->getClientName(),
     "my user agent",
     "optional version"

website/docs/clients/migration-guides/index.mdx

@@ -198,9 +198,9 @@ const client = algoliasearch('<YOUR_APP_ID>', '<YOUR_API_KEY>');
 const { taskID } = await client.operationIndex({
   indexName: '<SOURCE_INDEX_NAME>',
   operationIndexParams: {
-    destination: '<DESTINATION_INDEX_NAME>',
     // Enum for either `copy` or `move`
     operation: 'copy', // 'move'
+    destination: '<DESTINATION_INDEX_NAME>',
   },
 });
 
@@ -238,8 +238,8 @@ import com.algolia.model.search.*;
 UpdatedAtResponse response = client.operationIndex(
   "<SOURCE_INDEX_NAME>",
   new OperationIndexParams()
-    .setDestination("<DESTINATION_INDEX_NAME>")
     .setOperation(OperationType.COPY) // or MOVE
+    .setDestination("<DESTINATION_INDEX_NAME>")
 );
 
 // Poll the task status until it's done

website/docs/clients/migration-guides/php.md

@@ -4,7 +4,7 @@ title: PHP
 
 | Previous             | Latest                                 | Description                                                                                                                                                                                                               |
 | -------------------- | :------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `"algolia/algoliasearch-client-php": "^3.2"`           | `"algolia/algoliasearch-client-php": "^4.0"`  | **During the beta phase**, the clients are available under the package 4.x.x-alpha , you can find a full list [here](https://packagist.org/packages/algolia/algoliasearch-client-php).      |
+| `"algolia/algoliasearch-client-php": "^3.2"`           | `"algolia/algoliasearch-client-php": "^4.0@alpha"`  | **During the beta phase**, the clients are available under the package 4.x.x-alpha , you can find a full list [here](https://packagist.org/packages/algolia/algoliasearch-client-php).      |
 | `Algolia\AlgoliaSearch`             | `Algolia\AlgoliaSearch\Api`                         | Exported clients have now the name suffixed by `Api`.                                                                                                                                                                                |
 
 ### Usage
@@ -18,7 +18,7 @@ composer remove algolia/algoliasearch-client-php
 You can now install the `Algoliasearch` clients.
 
 ```bash
-composer require algolia/algoliasearch-client-php "^4.0"
+composer require algolia/algoliasearch-client-php "^4.0@alpha"
 ```
 
 You can continue this guide on [our installation page](/docs/clients/installation).