Skip to content

Commit 69a5e66

Browse files
alcoholshortcuts
andauthored
fix(php): batchSize docblocks type (#5109)
Co-authored-by: Clément Vannicatte <[email protected]>
1 parent 712cf0b commit 69a5e66

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

templates/php/api.mustache

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -674,7 +674,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
674674
* @param string $indexName The `indexName` to replace `objects` in.
675675
* @param array $objects The array of `objects` to store in the given Algolia `indexName`.
676676
* @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
677-
* @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.
677+
* @param int $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
678678
* @param array $requestOptions Request options
679679
*/
680680
public function saveObjects($indexName, $objects, $waitForTasks = false, $batchSize = 1000, $requestOptions = [])
@@ -691,7 +691,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
691691
* @param string $indexName the `indexName` to replace `objects` in
692692
* @param array $objects the array of `objects` to store in the given Algolia `indexName`
693693
* @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
694-
* @param array $batchSize The size of the chunk of `objects`. The number of `push` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
694+
* @param int $batchSize The size of the chunk of `objects`. The number of `push` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
695695
* @param array $requestOptions Request options
696696
*/
697697
public function saveObjectsWithTransformation($indexName, $objects, $waitForTasks = false, $batchSize = 1000, $requestOptions = [])
@@ -709,7 +709,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
709709
* @param string $indexName The `indexName` to delete `objectIDs` from.
710710
* @param array $objectIDs The `objectIDs` to delete.
711711
* @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
712-
* @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.
712+
* @param int $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
713713
* @param array $requestOptions Request options
714714
*/
715715
public function deleteObjects($indexName, $objectIDs, $waitForTasks = false, $batchSize = 1000, $requestOptions = [])
@@ -730,7 +730,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
730730
* @param array $objects The array of `objects` to store in the given Algolia `indexName`.
731731
* @param bool $createIfNotExists To be provided if non-existing objects are passed, otherwise, the call will fail..
732732
* @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
733-
* @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.
733+
* @param int $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
734734
* @param array $requestOptions Request options
735735
*/
736736
public function partialUpdateObjects($indexName, $objects, $createIfNotExists, $waitForTasks = false, $batchSize = 1000, $requestOptions = []) {
@@ -747,7 +747,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
747747
* @param array $objects the array of `objects` to store in the given Algolia `indexName`
748748
* @param bool $createIfNotExists To be provided if non-existing objects are passed, otherwise, the call will fail..
749749
* @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
750-
* @param array $batchSize The size of the chunk of `objects`. The number of `push` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
750+
* @param int $batchSize The size of the chunk of `objects`. The number of `push` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
751751
* @param array $requestOptions Request options
752752
*/
753753
public function partialUpdateObjectsWithTransformation($indexName, $objects, $createIfNotExists, $waitForTasks = false, $batchSize = 1000, $requestOptions = [])
@@ -766,7 +766,7 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
766766
* @param array $objects the array of `objects` to store in the given Algolia `indexName`
767767
* @param array $action the `batch` `action` to perform on the given array of `objects`, defaults to `addObject`
768768
* @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
769-
* @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.
769+
* @param int $batchSize The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
770770
* @param array $requestOptions Request options
771771
*/
772772
public function chunkedBatch(
@@ -892,4 +892,4 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
892892
);
893893
}
894894
}
895-
{{/operations}}
895+
{{/operations}}

0 commit comments

Comments
 (0)