From e497b54c5f9b1c89a221f7e400226b13e28eb51d Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Wed, 12 Jan 2022 14:57:14 +0100 Subject: [PATCH 01/13] chore: add php_cs --- clients/algoliasearch-client-php/.gitignore | 1 + .../.openapi-generator-ignore | 1 - .../.openapi-generator/FILES | 1 + .../.php-cs-fixer.php | 63 +++++ .../lib/Api/SearchApi.php | 222 +++++++++++------- .../lib/ApiException.php | 3 +- .../lib/Configuration.php | 28 ++- .../lib/HeaderSelector.php | 17 +- .../lib/Model/Action.php | 6 +- .../lib/Model/AddApiKeyResponse.php | 33 ++- .../lib/Model/Anchoring.php | 6 +- .../lib/Model/ApiKey.php | 33 +-- .../lib/Model/AssignUserIdObject.php | 32 +-- .../lib/Model/AutomaticFacetFilter.php | 32 +-- .../lib/Model/BaseBrowseResponse.php | 29 ++- .../lib/Model/BaseIndexSettings.php | 52 ++-- .../lib/Model/BaseSearchParams.php | 90 ++++--- .../lib/Model/BaseSearchResponse.php | 69 +++--- .../Model/BaseSearchResponseFacetsStats.php | 36 ++- .../lib/Model/BatchAssignUserIdsObject.php | 32 +-- .../lib/Model/BatchDictionaryEntries.php | 32 +-- .../Model/BatchDictionaryEntriesRequest.php | 30 +-- .../lib/Model/BatchObject.php | 29 ++- .../lib/Model/BatchResponse.php | 32 ++- .../lib/Model/BatchWriteObject.php | 29 ++- .../lib/Model/BrowseRequest.php | 30 ++- .../lib/Model/BrowseResponse.php | 69 +++--- .../lib/Model/BuildInOperation.php | 33 +-- .../lib/Model/Condition.php | 32 ++- .../lib/Model/Consequence.php | 31 ++- .../lib/Model/ConsequenceHide.php | 32 +-- .../lib/Model/ConsequenceParams.php | 177 +++++++------- .../lib/Model/CreatedAtObject.php | 31 ++- .../lib/Model/CreatedAtResponse.php | 32 +-- .../lib/Model/DeleteApiKeyResponse.php | 31 ++- .../lib/Model/DeleteSourceResponse.php | 31 ++- .../lib/Model/DeletedAtResponse.php | 34 +-- .../lib/Model/DictionaryEntry.php | 38 +-- .../lib/Model/DictionaryLanguage.php | 29 ++- .../lib/Model/DictionarySettingsRequest.php | 30 +-- .../lib/Model/ErrorBase.php | 29 ++- .../Model/GetDictionarySettingsResponse.php | 29 ++- .../lib/Model/GetLogsResponse.php | 29 ++- .../lib/Model/GetLogsResponseInnerQueries.php | 34 ++- .../lib/Model/GetLogsResponseLogs.php | 53 ++--- .../lib/Model/GetObjectsObject.php | 29 ++- .../lib/Model/GetObjectsResponse.php | 30 ++- .../lib/Model/GetTaskResponse.php | 27 +-- .../lib/Model/GetTopUserIdsResponse.php | 32 +-- .../lib/Model/HighlightResult.php | 36 +-- .../lib/Model/Index.php | 39 ++- .../lib/Model/IndexSettings.php | 134 +++++------ .../lib/Model/IndexSettingsAsSearchParams.php | 109 +++++---- .../lib/Model/KeyObject.php | 34 +-- .../lib/Model/Languages.php | 30 +-- .../lib/Model/ListApiKeysResponse.php | 31 ++- .../lib/Model/ListClustersResponse.php | 32 +-- .../lib/Model/ListIndicesResponse.php | 32 ++- .../lib/Model/ListUserIdsResponse.php | 32 +-- .../lib/Model/MultipleBatchResponse.php | 32 ++- .../lib/Model/MultipleGetObjectsObject.php | 34 +-- .../lib/Model/MultipleQueries.php | 37 ++- .../lib/Model/MultipleQueriesObject.php | 27 +-- .../lib/Model/MultipleQueriesResponse.php | 28 +-- .../lib/Model/Operation.php | 32 ++- .../lib/Model/OperationIndexObject.php | 32 +-- .../lib/Model/Params.php | 35 ++- .../lib/Model/Promote.php | 34 +-- .../lib/Model/RankingInfo.php | 48 ++-- .../Model/RankingInfoMatchedGeoLocation.php | 38 ++- .../lib/Model/Record.php | 32 +-- .../lib/Model/RemoveUserIdResponse.php | 31 ++- .../lib/Model/ReplaceSourceResponse.php | 31 ++- .../lib/Model/RequiredSearchParams.php | 31 ++- .../lib/Model/Rule.php | 32 +-- .../lib/Model/SaveObjectResponse.php | 32 ++- .../lib/Model/SaveSynonymResponse.php | 35 ++- .../lib/Model/SearchDictionaryEntries.php | 36 +-- .../lib/Model/SearchForFacetValuesRequest.php | 32 ++- .../Model/SearchForFacetValuesResponse.php | 29 ++- .../SearchForFacetValuesResponseFacetHits.php | 33 ++- .../lib/Model/SearchHits.php | 28 +-- .../lib/Model/SearchParams.php | 175 +++++++------- .../lib/Model/SearchParamsObject.php | 173 +++++++------- .../lib/Model/SearchParamsString.php | 30 ++- .../lib/Model/SearchResponse.php | 69 +++--- .../lib/Model/SearchRulesParams.php | 37 ++- .../lib/Model/SearchRulesResponse.php | 37 ++- .../lib/Model/SearchSynonymsResponse.php | 33 ++- .../lib/Model/SearchUserIdsObject.php | 36 +-- .../lib/Model/SearchUserIdsResponse.php | 38 +-- .../SearchUserIdsResponseHighlightResult.php | 29 ++- .../lib/Model/SearchUserIdsResponseHits.php | 35 ++- .../lib/Model/SnippetResult.php | 31 ++- .../lib/Model/Source.php | 34 +-- .../lib/Model/StandardEntries.php | 35 ++- .../lib/Model/SynonymHit.php | 44 ++-- .../lib/Model/SynonymHitHighlightResult.php | 29 ++- .../lib/Model/TimeRange.php | 33 ++- .../lib/Model/UpdateApiKeyResponse.php | 33 ++- .../lib/Model/UpdatedAtResponse.php | 34 +-- .../Model/UpdatedAtWithObjectIdResponse.php | 35 ++- .../lib/Model/UpdatedRuleResponse.php | 35 ++- .../lib/Model/UserId.php | 38 +-- .../lib/ObjectSerializer.php | 52 ++-- templates/php/.php-cs-fixer.php | 59 +++++ templates/php/.php_cs | 23 -- templates/php/gitignore | 1 + 108 files changed, 2239 insertions(+), 2127 deletions(-) create mode 100644 clients/algoliasearch-client-php/.php-cs-fixer.php create mode 100644 templates/php/.php-cs-fixer.php delete mode 100644 templates/php/.php_cs diff --git a/clients/algoliasearch-client-php/.gitignore b/clients/algoliasearch-client-php/.gitignore index 3d513912a6..aa44c17b5e 100644 --- a/clients/algoliasearch-client-php/.gitignore +++ b/clients/algoliasearch-client-php/.gitignore @@ -10,3 +10,4 @@ composer.phar .phpunit.result.cache .openapi-generator/ +composer.lock diff --git a/clients/algoliasearch-client-php/.openapi-generator-ignore b/clients/algoliasearch-client-php/.openapi-generator-ignore index d8c3ddaef1..d526d59ea0 100644 --- a/clients/algoliasearch-client-php/.openapi-generator-ignore +++ b/clients/algoliasearch-client-php/.openapi-generator-ignore @@ -8,7 +8,6 @@ docs/** test/** .travis.yml -.php_cs phpunit.xml.dist README.md git_push.sh diff --git a/clients/algoliasearch-client-php/.openapi-generator/FILES b/clients/algoliasearch-client-php/.openapi-generator/FILES index 83e22b9826..2fd6346ca8 100644 --- a/clients/algoliasearch-client-php/.openapi-generator/FILES +++ b/clients/algoliasearch-client-php/.openapi-generator/FILES @@ -1,4 +1,5 @@ .gitignore +.php_cs composer.json lib/Api/SearchApi.php lib/ApiException.php diff --git a/clients/algoliasearch-client-php/.php-cs-fixer.php b/clients/algoliasearch-client-php/.php-cs-fixer.php new file mode 100644 index 0000000000..e54be96e8c --- /dev/null +++ b/clients/algoliasearch-client-php/.php-cs-fixer.php @@ -0,0 +1,63 @@ +setUsingCache(true) + ->setRules([ + 'array_syntax' => [ 'syntax' => 'short' ], + 'blank_line_after_namespace' => false, + 'blank_line_after_opening_tag' => true, + 'blank_line_before_statement' => true, + 'braces' => false, + 'cast_spaces' => true, + 'combine_consecutive_unsets' => true, + 'echo_tag_syntax' => true, + 'general_phpdoc_tag_rename' => true, + 'mb_str_functions' => true, + 'no_blank_lines_after_class_opening' => true, + 'no_empty_phpdoc' => true, + 'no_empty_statement' => true, + 'no_extra_blank_lines' => true, + 'no_multiline_whitespace_around_double_arrow' => true, + 'no_short_bool_cast' => true, + 'no_trailing_whitespace' => false, + 'no_trailing_whitespace_in_comment' => false, + 'no_unneeded_control_parentheses' => true, + 'no_unreachable_default_argument_value' => true, + 'no_unused_imports' => true, + 'no_useless_else' => true, + 'no_useless_return' => true, + 'no_whitespace_before_comma_in_array' => true, + 'no_whitespace_in_blank_line' => true, + 'normalize_index_brace' => true, + 'not_operator_with_space' => false, + 'object_operator_without_whitespace' => true, + 'ordered_imports' => true, + 'phpdoc_annotation_without_dot' => true, + 'phpdoc_inline_tag_normalizer' => true, + 'phpdoc_order' => true, + 'phpdoc_scalar' => true, + 'phpdoc_separation' => true, + 'phpdoc_single_line_var_spacing' => true, + 'phpdoc_tag_type' => true, + 'protected_to_private' => true, + 'psr_autoloading' => true, + 'short_scalar_cast' => true, + 'single_blank_line_at_eof' => false, + 'single_blank_line_before_namespace' => true, + 'single_quote' => true, + 'space_after_semicolon' => true, + 'standardize_not_equals' => true, + 'strict_comparison' => true, + 'strict_param' => true, + 'ternary_operator_spaces' => true, + 'trailing_comma_in_multiline' => true, + 'trim_array_spaces' => true, + ]) + ->setFinder( + PhpCsFixer\Finder::create() + ->exclude('test') + ->exclude('tests') + ->in(__DIR__) + ); diff --git a/clients/algoliasearch-client-php/lib/Api/SearchApi.php b/clients/algoliasearch-client-php/lib/Api/SearchApi.php index 9491959484..0af73c90fc 100644 --- a/clients/algoliasearch-client-php/lib/Api/SearchApi.php +++ b/clients/algoliasearch-client-php/lib/Api/SearchApi.php @@ -2,17 +2,16 @@ namespace Algolia\AlgoliaSearch\Api; +use Algolia\AlgoliaSearch\ApiException; +use Algolia\AlgoliaSearch\Configuration; +use Algolia\AlgoliaSearch\HeaderSelector; +use Algolia\AlgoliaSearch\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; -use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Exception\ConnectException; -use GuzzleHttp\Psr7\MultipartStream; +use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Algolia\AlgoliaSearch\ApiException; -use Algolia\AlgoliaSearch\Configuration; -use Algolia\AlgoliaSearch\HeaderSelector; -use Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchApi Class Doc Comment @@ -91,6 +90,7 @@ public function getConfig() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\AddApiKeyResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function addApiKey($apiKey) @@ -142,7 +142,7 @@ public function addApiKey($apiKey) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\AddApiKeyResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -160,6 +160,7 @@ public function addApiKey($apiKey) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtWithObjectIdResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function addOrUpdateObject($indexName, $objectID, $body) @@ -239,7 +240,7 @@ public function addOrUpdateObject($indexName, $objectID, $body) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtWithObjectIdResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -253,6 +254,7 @@ public function addOrUpdateObject($indexName, $objectID, $body) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\CreatedAtResponse */ public function appendSource($source) @@ -304,7 +306,7 @@ public function appendSource($source) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\CreatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -321,6 +323,7 @@ public function appendSource($source) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\CreatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) @@ -331,8 +334,8 @@ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) 'Missing the required parameter $xAlgoliaUserID when calling assignUserId' ); } - if (!preg_match("/^[a-zA-Z0-9 \\-*.]+$/", $xAlgoliaUserID)) { - throw new \InvalidArgumentException("invalid value for \"xAlgoliaUserID\" when calling SearchApi.assignUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/."); + if (!preg_match('/^[a-zA-Z0-9 \\-*.]+$/', $xAlgoliaUserID)) { + throw new \InvalidArgumentException('invalid value for "xAlgoliaUserID" when calling SearchApi.assignUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/.'); } // verify the required parameter 'assignUserIdObject' is set @@ -389,7 +392,7 @@ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\CreatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -404,6 +407,7 @@ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\BatchResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function batch($indexName, $batchWriteObject) @@ -469,7 +473,7 @@ public function batch($indexName, $batchWriteObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\BatchResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -486,6 +490,7 @@ public function batch($indexName, $batchWriteObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\CreatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) @@ -496,8 +501,8 @@ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) 'Missing the required parameter $xAlgoliaUserID when calling batchAssignUserIds' ); } - if (!preg_match("/^[a-zA-Z0-9 \\-*.]+$/", $xAlgoliaUserID)) { - throw new \InvalidArgumentException("invalid value for \"xAlgoliaUserID\" when calling SearchApi.batchAssignUserIds, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/."); + if (!preg_match('/^[a-zA-Z0-9 \\-*.]+$/', $xAlgoliaUserID)) { + throw new \InvalidArgumentException('invalid value for "xAlgoliaUserID" when calling SearchApi.batchAssignUserIds, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/.'); } // verify the required parameter 'batchAssignUserIdsObject' is set @@ -554,7 +559,7 @@ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\CreatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -571,6 +576,7 @@ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) @@ -636,7 +642,7 @@ public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -655,6 +661,7 @@ public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function batchRules($indexName, $rule, $forwardToReplicas = null, $clearExistingRules = null) @@ -734,7 +741,7 @@ public function batchRules($indexName, $rule, $forwardToReplicas = null, $clearE $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -751,6 +758,7 @@ public function batchRules($indexName, $rule, $forwardToReplicas = null, $clearE * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\BrowseResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function browse($indexName, $browseRequest = null) @@ -810,7 +818,7 @@ public function browse($indexName, $browseRequest = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\BrowseResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -827,6 +835,7 @@ public function browse($indexName, $browseRequest = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function clearAllSynonyms($indexName, $forwardToReplicas = null) @@ -890,7 +899,7 @@ public function clearAllSynonyms($indexName, $forwardToReplicas = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -906,6 +915,7 @@ public function clearAllSynonyms($indexName, $forwardToReplicas = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function clearObjects($indexName) @@ -962,7 +972,7 @@ public function clearObjects($indexName) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -979,6 +989,7 @@ public function clearObjects($indexName) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function clearRules($indexName, $forwardToReplicas = null) @@ -1042,7 +1053,7 @@ public function clearRules($indexName, $forwardToReplicas = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1058,6 +1069,7 @@ public function clearRules($indexName, $forwardToReplicas = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\DeleteApiKeyResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteApiKey($key) @@ -1114,7 +1126,7 @@ public function deleteApiKey($key) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeleteApiKeyResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1131,6 +1143,7 @@ public function deleteApiKey($key) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\DeletedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteBy($indexName, $searchParams) @@ -1196,7 +1209,7 @@ public function deleteBy($indexName, $searchParams) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeletedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1212,6 +1225,7 @@ public function deleteBy($indexName, $searchParams) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\DeletedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteIndex($indexName) @@ -1268,7 +1282,7 @@ public function deleteIndex($indexName) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeletedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1285,6 +1299,7 @@ public function deleteIndex($indexName) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\DeletedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteObject($indexName, $objectID) @@ -1355,7 +1370,7 @@ public function deleteObject($indexName, $objectID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeletedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1373,6 +1388,7 @@ public function deleteObject($indexName, $objectID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteRule($indexName, $objectID, $forwardToReplicas = null) @@ -1450,7 +1466,7 @@ public function deleteRule($indexName, $objectID, $forwardToReplicas = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1464,6 +1480,7 @@ public function deleteRule($indexName, $objectID, $forwardToReplicas = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\DeleteSourceResponse */ public function deleteSource($source) @@ -1520,7 +1537,7 @@ public function deleteSource($source) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeleteSourceResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1538,6 +1555,7 @@ public function deleteSource($source) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\DeletedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteSynonym($indexName, $objectID, $forwardToReplicas = null) @@ -1615,7 +1633,7 @@ public function deleteSynonym($indexName, $objectID, $forwardToReplicas = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeletedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1631,6 +1649,7 @@ public function deleteSynonym($indexName, $objectID, $forwardToReplicas = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\KeyObject|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getApiKey($key) @@ -1687,7 +1706,7 @@ public function getApiKey($key) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\KeyObject'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1702,6 +1721,7 @@ public function getApiKey($key) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return array|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getDictionaryLanguages() @@ -1744,7 +1764,7 @@ public function getDictionaryLanguages() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = 'array<string,\Algolia\AlgoliaSearch\Model\Languages>'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1759,6 +1779,7 @@ public function getDictionaryLanguages() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\GetDictionarySettingsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getDictionarySettings() @@ -1801,7 +1822,7 @@ public function getDictionarySettings() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetDictionarySettingsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1818,6 +1839,7 @@ public function getDictionarySettings() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\GetLogsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getLogs($offset = 0, $length = 10, $indexName = null, $type = 'all') @@ -1826,7 +1848,6 @@ public function getLogs($offset = 0, $length = 10, $indexName = null, $type = 'a throw new \InvalidArgumentException('invalid value for "$length" when calling SearchApi.getLogs, must be smaller than or equal to 1000.'); } - $resourcePath = '/1/logs'; $queryParams = []; $headerParams = []; @@ -1892,7 +1913,7 @@ public function getLogs($offset = 0, $length = 10, $indexName = null, $type = 'a $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetLogsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1910,6 +1931,7 @@ public function getLogs($offset = 0, $length = 10, $indexName = null, $type = 'a * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return array|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getObject($indexName, $objectID, $attributesToRetrieve = null) @@ -1987,7 +2009,7 @@ public function getObject($indexName, $objectID, $attributesToRetrieve = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = 'array<string,string>'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2003,6 +2025,7 @@ public function getObject($indexName, $objectID, $attributesToRetrieve = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\GetObjectsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getObjects($getObjectsObject) @@ -2054,7 +2077,7 @@ public function getObjects($getObjectsObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetObjectsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2071,6 +2094,7 @@ public function getObjects($getObjectsObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\Rule|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getRule($indexName, $objectID) @@ -2141,7 +2165,7 @@ public function getRule($indexName, $objectID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\Rule'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2155,6 +2179,7 @@ public function getRule($indexName, $objectID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\IndexSettings|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getSettings($indexName) @@ -2211,7 +2236,7 @@ public function getSettings($indexName) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\IndexSettings'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2224,6 +2249,7 @@ public function getSettings($indexName) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\Source[] */ public function getSources() @@ -2266,7 +2292,7 @@ public function getSources() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\Source[]'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2283,6 +2309,7 @@ public function getSources() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SynonymHit|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getSynonym($indexName, $objectID) @@ -2353,7 +2380,7 @@ public function getSynonym($indexName, $objectID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SynonymHit'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2368,6 +2395,7 @@ public function getSynonym($indexName, $objectID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\GetTaskResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getTask($indexName, $taskID) @@ -2438,7 +2466,7 @@ public function getTask($indexName, $taskID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetTaskResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2453,6 +2481,7 @@ public function getTask($indexName, $taskID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\GetTopUserIdsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getTopUserIds() @@ -2495,7 +2524,7 @@ public function getTopUserIds() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetTopUserIdsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2511,6 +2540,7 @@ public function getTopUserIds() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UserId|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getUserId($userID) @@ -2521,11 +2551,10 @@ public function getUserId($userID) 'Missing the required parameter $userID when calling getUserId' ); } - if (!preg_match("/^[a-zA-Z0-9 \\-*.]+$/", $userID)) { - throw new \InvalidArgumentException("invalid value for \"userID\" when calling SearchApi.getUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/."); + if (!preg_match('/^[a-zA-Z0-9 \\-*.]+$/', $userID)) { + throw new \InvalidArgumentException('invalid value for "userID" when calling SearchApi.getUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/.'); } - $resourcePath = '/1/clusters/mapping/{userID}'; $queryParams = []; $headerParams = []; @@ -2571,7 +2600,7 @@ public function getUserId($userID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UserId'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2587,6 +2616,7 @@ public function getUserId($userID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\CreatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function hasPendingMappings($getClusters = null) @@ -2636,7 +2666,7 @@ public function hasPendingMappings($getClusters = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\CreatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2651,6 +2681,7 @@ public function hasPendingMappings($getClusters = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\ListApiKeysResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function listApiKeys() @@ -2693,7 +2724,7 @@ public function listApiKeys() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ListApiKeysResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2708,6 +2739,7 @@ public function listApiKeys() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\ListClustersResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function listClusters() @@ -2750,7 +2782,7 @@ public function listClusters() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ListClustersResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2766,6 +2798,7 @@ public function listClusters() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\ListIndicesResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function listIndices($page = null) @@ -2815,7 +2848,7 @@ public function listIndices($page = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ListIndicesResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2832,6 +2865,7 @@ public function listIndices($page = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\ListUserIdsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function listUserIds($page = null, $hitsPerPage = 100) @@ -2888,7 +2922,7 @@ public function listUserIds($page = null, $hitsPerPage = 100) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ListUserIdsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2902,6 +2936,7 @@ public function listUserIds($page = null, $hitsPerPage = 100) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\MultipleBatchResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function multipleBatch($batchObject) @@ -2953,7 +2988,7 @@ public function multipleBatch($batchObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\MultipleBatchResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2967,6 +3002,7 @@ public function multipleBatch($batchObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\MultipleQueriesResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function multipleQueries($multipleQueriesObject) @@ -3018,7 +3054,7 @@ public function multipleQueries($multipleQueriesObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\MultipleQueriesResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3035,6 +3071,7 @@ public function multipleQueries($multipleQueriesObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function operationIndex($indexName, $operationIndexObject) @@ -3100,7 +3137,7 @@ public function operationIndex($indexName, $operationIndexObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3119,6 +3156,7 @@ public function operationIndex($indexName, $operationIndexObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtWithObjectIdResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function partialUpdateObject($indexName, $objectID, $oneOfStringBuildInOperation, $createIfNotExists = true) @@ -3205,7 +3243,7 @@ public function partialUpdateObject($indexName, $objectID, $oneOfStringBuildInOp $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtWithObjectIdResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3221,6 +3259,7 @@ public function partialUpdateObject($indexName, $objectID, $oneOfStringBuildInOp * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\RemoveUserIdResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function removeUserId($userID) @@ -3231,11 +3270,10 @@ public function removeUserId($userID) 'Missing the required parameter $userID when calling removeUserId' ); } - if (!preg_match("/^[a-zA-Z0-9 \\-*.]+$/", $userID)) { - throw new \InvalidArgumentException("invalid value for \"userID\" when calling SearchApi.removeUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/."); + if (!preg_match('/^[a-zA-Z0-9 \\-*.]+$/', $userID)) { + throw new \InvalidArgumentException('invalid value for "userID" when calling SearchApi.removeUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/.'); } - $resourcePath = '/1/clusters/mapping/{userID}'; $queryParams = []; $headerParams = []; @@ -3281,7 +3319,7 @@ public function removeUserId($userID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\RemoveUserIdResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3295,6 +3333,7 @@ public function removeUserId($userID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\ReplaceSourceResponse */ public function replaceSources($source) @@ -3346,7 +3385,7 @@ public function replaceSources($source) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ReplaceSourceResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3362,6 +3401,7 @@ public function replaceSources($source) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\AddApiKeyResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function restoreApiKey($key) @@ -3418,7 +3458,7 @@ public function restoreApiKey($key) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\AddApiKeyResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3433,6 +3473,7 @@ public function restoreApiKey($key) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SaveObjectResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function saveObject($indexName, $body) @@ -3498,7 +3539,7 @@ public function saveObject($indexName, $body) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SaveObjectResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3517,6 +3558,7 @@ public function saveObject($indexName, $body) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedRuleResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function saveRule($indexName, $objectID, $rule, $forwardToReplicas = null) @@ -3603,7 +3645,7 @@ public function saveRule($indexName, $objectID, $rule, $forwardToReplicas = null $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedRuleResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3622,6 +3664,7 @@ public function saveRule($indexName, $objectID, $rule, $forwardToReplicas = null * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SaveSynonymResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function saveSynonym($indexName, $objectID, $synonymHit, $forwardToReplicas = null) @@ -3708,7 +3751,7 @@ public function saveSynonym($indexName, $objectID, $synonymHit, $forwardToReplic $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SaveSynonymResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3727,6 +3770,7 @@ public function saveSynonym($indexName, $objectID, $synonymHit, $forwardToReplic * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function saveSynonyms($indexName, $synonymHit, $forwardToReplicas = null, $replaceExistingSynonyms = null) @@ -3806,7 +3850,7 @@ public function saveSynonyms($indexName, $synonymHit, $forwardToReplicas = null, $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3821,6 +3865,7 @@ public function saveSynonyms($indexName, $synonymHit, $forwardToReplicas = null, * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SearchResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function search($indexName, $searchParams) @@ -3886,7 +3931,7 @@ public function search($indexName, $searchParams) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3903,6 +3948,7 @@ public function search($indexName, $searchParams) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntries) @@ -3968,7 +4014,7 @@ public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntrie $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3986,6 +4032,7 @@ public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntrie * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SearchForFacetValuesResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchForFacetValues($indexName, $facetName, $searchForFacetValuesRequest = null) @@ -4059,7 +4106,7 @@ public function searchForFacetValues($indexName, $facetName, $searchForFacetValu $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchForFacetValuesResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4076,6 +4123,7 @@ public function searchForFacetValues($indexName, $facetName, $searchForFacetValu * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SearchRulesResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchRules($indexName, $searchRulesParams) @@ -4141,7 +4189,7 @@ public function searchRules($indexName, $searchRulesParams) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchRulesResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4161,6 +4209,7 @@ public function searchRules($indexName, $searchRulesParams) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SearchSynonymsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchSynonyms($indexName, $query = '', $type = null, $page = 0, $hitsPerPage = 100) @@ -4245,7 +4294,7 @@ public function searchSynonyms($indexName, $query = '', $type = null, $page = 0, $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchSynonymsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4261,6 +4310,7 @@ public function searchSynonyms($indexName, $query = '', $type = null, $page = 0, * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SearchUserIdsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchUserIds($searchUserIdsObject) @@ -4312,7 +4362,7 @@ public function searchUserIds($searchUserIdsObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchUserIdsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4328,6 +4378,7 @@ public function searchUserIds($searchUserIdsObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function setDictionarySettings($dictionarySettingsRequest) @@ -4379,7 +4430,7 @@ public function setDictionarySettings($dictionarySettingsRequest) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4395,6 +4446,7 @@ public function setDictionarySettings($dictionarySettingsRequest) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function setSettings($indexName, $indexSettings, $forwardToReplicas = null) @@ -4467,7 +4519,7 @@ public function setSettings($indexName, $indexSettings, $forwardToReplicas = nul $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4484,6 +4536,7 @@ public function setSettings($indexName, $indexSettings, $forwardToReplicas = nul * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdateApiKeyResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function updateApiKey($key, $apiKey) @@ -4549,7 +4602,7 @@ public function updateApiKey($key, $apiKey) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdateApiKeyResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4560,6 +4613,7 @@ public function updateApiKey($key, $apiKey) * Create http client option * * @throws \RuntimeException on file opening failure + * * @return array of http client options */ protected function createHttpClientOption() @@ -4579,12 +4633,14 @@ protected function createHttpClientOption() * Send the request and handle the response * * @throws \RuntimeException on file opening failure + * * @return array */ protected function sendRequest($request, $expectedResponse) { try { $options = $this->createHttpClientOption(); + try { $response = $this->client->send($request, $options); } catch (RequestException $e) { @@ -4629,7 +4685,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, $expectedResponse, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; case 400: if ('\Algolia\AlgoliaSearch\Model\ErrorBase' === '\SplFileObject') { @@ -4641,7 +4697,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, '\Algolia\AlgoliaSearch\Model\ErrorBase', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; case 402: if ('\Algolia\AlgoliaSearch\Model\ErrorBase' === '\SplFileObject') { @@ -4653,7 +4709,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, '\Algolia\AlgoliaSearch\Model\ErrorBase', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; case 403: if ('\Algolia\AlgoliaSearch\Model\ErrorBase' === '\SplFileObject') { @@ -4665,7 +4721,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, '\Algolia\AlgoliaSearch\Model\ErrorBase', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; case 404: if ('\Algolia\AlgoliaSearch\Model\ErrorBase' === '\SplFileObject') { @@ -4677,7 +4733,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, '\Algolia\AlgoliaSearch\Model\ErrorBase', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; } @@ -4692,7 +4748,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; } catch (ApiException $e) { @@ -4704,6 +4760,7 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); + break; case 400: $data = ObjectSerializer::deserialize( @@ -4712,6 +4769,7 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); + break; case 402: $data = ObjectSerializer::deserialize( @@ -4720,6 +4778,7 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); + break; case 403: $data = ObjectSerializer::deserialize( @@ -4728,6 +4787,7 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); + break; case 404: $data = ObjectSerializer::deserialize( @@ -4736,8 +4796,10 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); + break; } + throw $e; } } diff --git a/clients/algoliasearch-client-php/lib/ApiException.php b/clients/algoliasearch-client-php/lib/ApiException.php index 0f80549494..d484a88eb5 100644 --- a/clients/algoliasearch-client-php/lib/ApiException.php +++ b/clients/algoliasearch-client-php/lib/ApiException.php @@ -12,7 +12,6 @@ */ class ApiException extends Exception { - /** * The HTTP body of the server response either as Json or string. * @@ -42,7 +41,7 @@ class ApiException extends Exception * @param string[]|null $responseHeaders HTTP response header * @param \stdClass|string|null $responseBody HTTP decoded body of the server response either as \stdClass or string */ - public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null) + public function __construct($message = '', $code = 0, $responseHeaders = [], $responseBody = null) { parent::__construct($message, $code); $this->responseHeaders = $responseHeaders; diff --git a/clients/algoliasearch-client-php/lib/Configuration.php b/clients/algoliasearch-client-php/lib/Configuration.php index 30f2a5e7aa..b7d8ebacb9 100644 --- a/clients/algoliasearch-client-php/lib/Configuration.php +++ b/clients/algoliasearch-client-php/lib/Configuration.php @@ -113,6 +113,7 @@ public function __construct(string $appId, string $algoliaApiKey = null) public function setApiKey($apiKeyIdentifier, $key) { $this->apiKeys[$apiKeyIdentifier] = $key; + return $this; } @@ -139,6 +140,7 @@ public function getApiKey($apiKeyIdentifier) public function setApiKeyPrefix($apiKeyIdentifier, $prefix) { $this->apiKeyPrefixes[$apiKeyIdentifier] = $prefix; + return $this; } @@ -164,6 +166,7 @@ public function getApiKeyPrefix($apiKeyIdentifier) public function setAccessToken($accessToken) { $this->accessToken = $accessToken; + return $this; } @@ -231,6 +234,7 @@ public function getAlgoliaApiKey() public function setHost($host) { $this->host = $host; + return $this; } @@ -250,6 +254,7 @@ public function getHost() * @param string $userAgent the user agent of the api client * * @throws \InvalidArgumentException + * * @return $this */ public function setUserAgent($userAgent) @@ -259,6 +264,7 @@ public function setUserAgent($userAgent) } $this->userAgent = $userAgent; + return $this; } @@ -282,6 +288,7 @@ public function getUserAgent() public function setDebug($debug) { $this->debug = $debug; + return $this; } @@ -305,6 +312,7 @@ public function getDebug() public function setDebugFile($debugFile) { $this->debugFile = $debugFile; + return $this; } @@ -328,6 +336,7 @@ public function getDebugFile() public function setTempFolderPath($tempFolderPath) { $this->tempFolderPath = $tempFolderPath; + return $this; } @@ -417,9 +426,9 @@ public function getHostSettings() { return [ [ - "url" => "", - "description" => "No description provided", - ] + 'url' => '', + 'description' => 'No description provided', + ], ]; } @@ -428,6 +437,7 @@ public function getHostSettings() * * @param int $index index of the host settings * @param array|null $variables hash of variable and the corresponding value (optional) + * * @return string URL based on host settings */ public function getHostFromSettings($index, $variables = null) @@ -444,19 +454,19 @@ public function getHostFromSettings($index, $variables = null) } $host = $hosts[$index]; - $url = $host["url"]; + $url = $host['url']; // go through variable and assign a value - foreach ($host["variables"] ?? [] as $name => $variable) { + foreach ($host['variables'] ?? [] as $name => $variable) { if (array_key_exists($name, $variables)) { // check to see if it's in the variables provided by the user - if (in_array($variables[$name], $variable["enum_values"], true)) { // check to see if the value is in the enum - $url = str_replace("{".$name."}", $variables[$name], $url); + if (in_array($variables[$name], $variable['enum_values'], true)) { // check to see if the value is in the enum + $url = str_replace('{'.$name.'}', $variables[$name], $url); } else { - throw new \InvalidArgumentException("The variable `$name` in the host URL has invalid value ".$variables[$name].". Must be ".join(',', $variable["enum_values"])."."); + throw new \InvalidArgumentException("The variable `$name` in the host URL has invalid value ".$variables[$name].'. Must be '.join(',', $variable['enum_values']).'.'); } } else { // use default value - $url = str_replace("{".$name."}", $variable["default_value"], $url); + $url = str_replace('{'.$name.'}', $variable['default_value'], $url); } } diff --git a/clients/algoliasearch-client-php/lib/HeaderSelector.php b/clients/algoliasearch-client-php/lib/HeaderSelector.php index 7d68b37a53..eda65ab64a 100644 --- a/clients/algoliasearch-client-php/lib/HeaderSelector.php +++ b/clients/algoliasearch-client-php/lib/HeaderSelector.php @@ -2,8 +2,6 @@ namespace Algolia\AlgoliaSearch; -use \Exception; - /** * ApiException Class Doc Comment * @@ -12,10 +10,10 @@ */ class HeaderSelector { - /** * @param string[] $accept * @param string[] $contentTypes + * * @return array */ public function selectHeaders($accept, $contentTypes) @@ -28,11 +26,13 @@ public function selectHeaders($accept, $contentTypes) } $headers['Content-Type'] = $this->selectContentTypeHeader($contentTypes); + return $headers; } /** * @param string[] $accept + * * @return array */ public function selectHeadersForMultipart($accept) @@ -40,6 +40,7 @@ public function selectHeadersForMultipart($accept) $headers = $this->selectHeaders($accept, []); unset($headers['Content-Type']); + return $headers; } @@ -56,9 +57,10 @@ private function selectAcceptHeader($accept) return null; } elseif ($jsonAccept = preg_grep('~(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$~', $accept)) { return implode(',', $jsonAccept); - } else { - return implode(',', $accept); } + + return implode(',', $accept); + } /** @@ -74,8 +76,9 @@ private function selectContentTypeHeader($contentType) return 'application/json'; } elseif (preg_grep("/application\/json/i", $contentType)) { return 'application/json'; - } else { - return implode(',', $contentType); } + + return implode(',', $contentType); + } } diff --git a/clients/algoliasearch-client-php/lib/Model/Action.php b/clients/algoliasearch-client-php/lib/Model/Action.php index 8781092a8c..0296001727 100644 --- a/clients/algoliasearch-client-php/lib/Model/Action.php +++ b/clients/algoliasearch-client-php/lib/Model/Action.php @@ -1,13 +1,13 @@ 'string', - 'createdAt' => '\DateTime' + 'createdAt' => '\DateTime', ]; /** @@ -44,7 +44,7 @@ class AddApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPIFormats = [ 'key' => null, - 'createdAt' => 'date-time' + 'createdAt' => 'date-time', ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'key' => 'key', - 'createdAt' => 'createdAt' + 'createdAt' => 'createdAt', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'key' => 'setKey', - 'createdAt' => 'setCreatedAt' + 'createdAt' => 'setCreatedAt', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'key' => 'getKey', - 'createdAt' => 'getCreatedAt' + 'createdAt' => 'getCreatedAt', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -174,6 +173,7 @@ public function listInvalidProperties() if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } + return $invalidProperties; } @@ -188,7 +188,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets key * @@ -202,7 +201,7 @@ public function getKey() /** * Sets key * - * @param string $key Key string. + * @param string $key key string * * @return self */ @@ -226,7 +225,7 @@ public function getCreatedAt() /** * Sets createdAt * - * @param \DateTime $createdAt Date of creation (ISO-8601 format). + * @param \DateTime $createdAt date of creation (ISO-8601 format) * * @return self */ @@ -239,9 +238,9 @@ public function setCreatedAt($createdAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -251,7 +250,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -280,7 +279,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -291,10 +290,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -325,4 +325,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Anchoring.php b/clients/algoliasearch-client-php/lib/Model/Anchoring.php index 7760ddb377..031df08b5e 100644 --- a/clients/algoliasearch-client-php/lib/Model/Anchoring.php +++ b/clients/algoliasearch-client-php/lib/Model/Anchoring.php @@ -1,13 +1,13 @@ * @template TKey int|null @@ -39,7 +40,7 @@ class ApiKey implements ModelInterface, ArrayAccess, \JsonSerializable 'maxQueriesPerIPPerHour' => 'int', 'queryParameters' => 'string', 'referers' => 'string[]', - 'validity' => 'int' + 'validity' => 'int', ]; /** @@ -57,7 +58,7 @@ class ApiKey implements ModelInterface, ArrayAccess, \JsonSerializable 'maxQueriesPerIPPerHour' => null, 'queryParameters' => null, 'referers' => null, - 'validity' => null + 'validity' => null, ]; /** @@ -94,7 +95,7 @@ public static function openAPIFormats() 'maxQueriesPerIPPerHour' => 'maxQueriesPerIPPerHour', 'queryParameters' => 'queryParameters', 'referers' => 'referers', - 'validity' => 'validity' + 'validity' => 'validity', ]; /** @@ -110,7 +111,7 @@ public static function openAPIFormats() 'maxQueriesPerIPPerHour' => 'setMaxQueriesPerIPPerHour', 'queryParameters' => 'setQueryParameters', 'referers' => 'setReferers', - 'validity' => 'setValidity' + 'validity' => 'setValidity', ]; /** @@ -126,7 +127,7 @@ public static function openAPIFormats() 'maxQueriesPerIPPerHour' => 'getMaxQueriesPerIPPerHour', 'queryParameters' => 'getQueryParameters', 'referers' => 'getReferers', - 'validity' => 'getValidity' + 'validity' => 'getValidity', ]; /** @@ -247,6 +248,7 @@ public function listInvalidProperties() if ($this->container['acl'] === null) { $invalidProperties[] = "'acl' can't be null"; } + return $invalidProperties; } @@ -261,7 +263,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets acl * @@ -275,7 +276,7 @@ public function getAcl() /** * Sets acl * - * @param string[] $acl Set of permissions associated with the key. + * @param string[] $acl set of permissions associated with the key * * @return self */ @@ -380,7 +381,7 @@ public function getMaxQueriesPerIPPerHour() /** * Sets maxQueriesPerIPPerHour * - * @param int|null $maxQueriesPerIPPerHour Maximum number of API calls per hour allowed from a given IP address or a user token. + * @param int|null $maxQueriesPerIPPerHour maximum number of API calls per hour allowed from a given IP address or a user token * * @return self */ @@ -465,9 +466,9 @@ public function setValidity($validity) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -477,7 +478,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -506,7 +507,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -517,10 +518,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -551,4 +553,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php b/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php index d46ef38fc3..913125bbde 100644 --- a/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php +++ b/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * AssignUserIdObject Class Doc Comment * * @category Class * @description Assign userID object. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class AssignUserIdObject implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'cluster' => 'string' + 'cluster' => 'string', ]; /** @@ -43,7 +44,7 @@ class AssignUserIdObject implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'cluster' => null + 'cluster' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'cluster' => 'cluster' + 'cluster' => 'cluster', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'cluster' => 'setCluster' + 'cluster' => 'setCluster', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'cluster' => 'getCluster' + 'cluster' => 'getCluster', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['cluster'] === null) { $invalidProperties[] = "'cluster' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets cluster * @@ -194,7 +194,7 @@ public function getCluster() /** * Sets cluster * - * @param string $cluster Name of the cluster. + * @param string $cluster name of the cluster * * @return self */ @@ -207,9 +207,9 @@ public function setCluster($cluster) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php b/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php index 9f4acf5062..0a63d8cdab 100644 --- a/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php +++ b/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * AutomaticFacetFilter Class Doc Comment * * @category Class * @description Automatic facet Filter. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class AutomaticFacetFilter implements ModelInterface, ArrayAccess, \JsonSerializ protected static $openAPITypes = [ 'facet' => 'string', 'score' => 'int', - 'disjunctive' => 'bool' + 'disjunctive' => 'bool', ]; /** @@ -47,7 +48,7 @@ class AutomaticFacetFilter implements ModelInterface, ArrayAccess, \JsonSerializ protected static $openAPIFormats = [ 'facet' => null, 'score' => null, - 'disjunctive' => null + 'disjunctive' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'facet' => 'facet', 'score' => 'score', - 'disjunctive' => 'disjunctive' + 'disjunctive' => 'disjunctive', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'facet' => 'setFacet', 'score' => 'setScore', - 'disjunctive' => 'setDisjunctive' + 'disjunctive' => 'setDisjunctive', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'facet' => 'getFacet', 'score' => 'getScore', - 'disjunctive' => 'getDisjunctive' + 'disjunctive' => 'getDisjunctive', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -178,6 +178,7 @@ public function listInvalidProperties() if ($this->container['facet'] === null) { $invalidProperties[] = "'facet' can't be null"; } + return $invalidProperties; } @@ -192,7 +193,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets facet * @@ -254,7 +254,7 @@ public function getDisjunctive() /** * Sets disjunctive * - * @param bool|null $disjunctive Whether the filter is disjunctive (true) or conjunctive (false). + * @param bool|null $disjunctive whether the filter is disjunctive (true) or conjunctive (false) * * @return self */ @@ -267,9 +267,9 @@ public function setDisjunctive($disjunctive) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -279,7 +279,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -308,7 +308,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -319,10 +319,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -353,4 +354,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php b/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php index fead53a789..e9f60b9c9a 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BaseBrowseResponse Class Doc Comment @@ -31,7 +31,7 @@ class BaseBrowseResponse implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'cursor' => 'string' + 'cursor' => 'string', ]; /** @@ -42,7 +42,7 @@ class BaseBrowseResponse implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'cursor' => null + 'cursor' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'cursor' => 'cursor' + 'cursor' => 'cursor', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'cursor' => 'setCursor' + 'cursor' => 'setCursor', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'cursor' => 'getCursor' + 'cursor' => 'getCursor', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['cursor'] === null) { $invalidProperties[] = "'cursor' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets cursor * @@ -206,9 +205,9 @@ public function setCursor($cursor) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php b/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php index 80195a5625..dbbc448b75 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BaseIndexSettings Class Doc Comment @@ -42,7 +42,7 @@ class BaseIndexSettings implements ModelInterface, ArrayAccess, \JsonSerializabl 'disablePrefixOnAttributes' => 'string[]', 'allowCompressionOfIntegerArray' => 'bool', 'numericAttributesForFiltering' => 'string[]', - 'userData' => 'object' + 'userData' => 'object', ]; /** @@ -64,7 +64,7 @@ class BaseIndexSettings implements ModelInterface, ArrayAccess, \JsonSerializabl 'disablePrefixOnAttributes' => null, 'allowCompressionOfIntegerArray' => null, 'numericAttributesForFiltering' => null, - 'userData' => null + 'userData' => null, ]; /** @@ -105,7 +105,7 @@ public static function openAPIFormats() 'disablePrefixOnAttributes' => 'disablePrefixOnAttributes', 'allowCompressionOfIntegerArray' => 'allowCompressionOfIntegerArray', 'numericAttributesForFiltering' => 'numericAttributesForFiltering', - 'userData' => 'userData' + 'userData' => 'userData', ]; /** @@ -125,7 +125,7 @@ public static function openAPIFormats() 'disablePrefixOnAttributes' => 'setDisablePrefixOnAttributes', 'allowCompressionOfIntegerArray' => 'setAllowCompressionOfIntegerArray', 'numericAttributesForFiltering' => 'setNumericAttributesForFiltering', - 'userData' => 'setUserData' + 'userData' => 'setUserData', ]; /** @@ -145,7 +145,7 @@ public static function openAPIFormats() 'disablePrefixOnAttributes' => 'getDisablePrefixOnAttributes', 'allowCompressionOfIntegerArray' => 'getAllowCompressionOfIntegerArray', 'numericAttributesForFiltering' => 'getNumericAttributesForFiltering', - 'userData' => 'getUserData' + 'userData' => 'getUserData', ]; /** @@ -189,7 +189,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -242,7 +241,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets replicas * @@ -256,7 +254,7 @@ public function getReplicas() /** * Sets replicas * - * @param string[]|null $replicas Creates replicas, exact copies of an index. + * @param string[]|null $replicas creates replicas, exact copies of an index * * @return self */ @@ -280,7 +278,7 @@ public function getPaginationLimitedTo() /** * Sets paginationLimitedTo * - * @param int|null $paginationLimitedTo Set the maximum number of hits accessible via pagination. + * @param int|null $paginationLimitedTo set the maximum number of hits accessible via pagination * * @return self */ @@ -304,7 +302,7 @@ public function getDisableTypoToleranceOnWords() /** * Sets disableTypoToleranceOnWords * - * @param string[]|null $disableTypoToleranceOnWords A list of words for which you want to turn off typo tolerance. + * @param string[]|null $disableTypoToleranceOnWords a list of words for which you want to turn off typo tolerance * * @return self */ @@ -328,7 +326,7 @@ public function getAttributesToTransliterate() /** * Sets attributesToTransliterate * - * @param string[]|null $attributesToTransliterate Specify on which attributes to apply transliteration. + * @param string[]|null $attributesToTransliterate specify on which attributes to apply transliteration * * @return self */ @@ -352,7 +350,7 @@ public function getCamelCaseAttributes() /** * Sets camelCaseAttributes * - * @param string[]|null $camelCaseAttributes List of attributes on which to do a decomposition of camel case words. + * @param string[]|null $camelCaseAttributes list of attributes on which to do a decomposition of camel case words * * @return self */ @@ -376,7 +374,7 @@ public function getDecompoundedAttributes() /** * Sets decompoundedAttributes * - * @param object|null $decompoundedAttributes Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding. + * @param object|null $decompoundedAttributes specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding * * @return self */ @@ -400,7 +398,7 @@ public function getIndexLanguages() /** * Sets indexLanguages * - * @param string[]|null $indexLanguages Sets the languages at the index level for language-specific processing such as tokenization and normalization. + * @param string[]|null $indexLanguages sets the languages at the index level for language-specific processing such as tokenization and normalization * * @return self */ @@ -424,7 +422,7 @@ public function getFilterPromotes() /** * Sets filterPromotes * - * @param bool|null $filterPromotes Whether promoted results should match the filters of the current search, except for geographic filters. + * @param bool|null $filterPromotes whether promoted results should match the filters of the current search, except for geographic filters * * @return self */ @@ -448,7 +446,7 @@ public function getDisablePrefixOnAttributes() /** * Sets disablePrefixOnAttributes * - * @param string[]|null $disablePrefixOnAttributes List of attributes on which you want to disable prefix matching. + * @param string[]|null $disablePrefixOnAttributes list of attributes on which you want to disable prefix matching * * @return self */ @@ -472,7 +470,7 @@ public function getAllowCompressionOfIntegerArray() /** * Sets allowCompressionOfIntegerArray * - * @param bool|null $allowCompressionOfIntegerArray Enables compression of large integer arrays. + * @param bool|null $allowCompressionOfIntegerArray enables compression of large integer arrays * * @return self */ @@ -496,7 +494,7 @@ public function getNumericAttributesForFiltering() /** * Sets numericAttributesForFiltering * - * @param string[]|null $numericAttributesForFiltering List of numeric attributes that can be used as numerical filters. + * @param string[]|null $numericAttributesForFiltering list of numeric attributes that can be used as numerical filters * * @return self */ @@ -520,7 +518,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData Lets you store custom data in your indices. + * @param object|null $userData lets you store custom data in your indices * * @return self */ @@ -533,9 +531,9 @@ public function setUserData($userData) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -545,7 +543,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -574,7 +572,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -585,10 +583,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -619,4 +618,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php b/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php index bf573dc75a..6aafbea93e 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BaseSearchParams Class Doc Comment @@ -62,7 +62,7 @@ class BaseSearchParams implements ModelInterface, ArrayAccess, \JsonSerializable 'analyticsTags' => 'string[]', 'percentileComputation' => 'bool', 'enableABTest' => 'bool', - 'enableReRanking' => 'bool' + 'enableReRanking' => 'bool', ]; /** @@ -104,7 +104,7 @@ class BaseSearchParams implements ModelInterface, ArrayAccess, \JsonSerializable 'analyticsTags' => null, 'percentileComputation' => null, 'enableABTest' => null, - 'enableReRanking' => null + 'enableReRanking' => null, ]; /** @@ -165,7 +165,7 @@ public static function openAPIFormats() 'analyticsTags' => 'analyticsTags', 'percentileComputation' => 'percentileComputation', 'enableABTest' => 'enableABTest', - 'enableReRanking' => 'enableReRanking' + 'enableReRanking' => 'enableReRanking', ]; /** @@ -205,7 +205,7 @@ public static function openAPIFormats() 'analyticsTags' => 'setAnalyticsTags', 'percentileComputation' => 'setPercentileComputation', 'enableABTest' => 'setEnableABTest', - 'enableReRanking' => 'setEnableReRanking' + 'enableReRanking' => 'setEnableReRanking', ]; /** @@ -245,7 +245,7 @@ public static function openAPIFormats() 'analyticsTags' => 'getAnalyticsTags', 'percentileComputation' => 'getPercentileComputation', 'enableABTest' => 'getEnableABTest', - 'enableReRanking' => 'getEnableReRanking' + 'enableReRanking' => 'getEnableReRanking', ]; /** @@ -289,7 +289,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -374,7 +373,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets similarQuery * @@ -388,7 +386,7 @@ public function getSimilarQuery() /** * Sets similarQuery * - * @param string|null $similarQuery Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results. + * @param string|null $similarQuery overrides the query parameter and performs a more generic search that can be used to find \"similar\" results * * @return self */ @@ -412,7 +410,7 @@ public function getFilters() /** * Sets filters * - * @param string|null $filters Filter the query with numeric, facet and/or tag filters. + * @param string|null $filters filter the query with numeric, facet and/or tag filters * * @return self */ @@ -436,7 +434,7 @@ public function getFacetFilters() /** * Sets facetFilters * - * @param string[]|null $facetFilters Filter hits by facet value. + * @param string[]|null $facetFilters filter hits by facet value * * @return self */ @@ -460,7 +458,7 @@ public function getOptionalFilters() /** * Sets optionalFilters * - * @param string[]|null $optionalFilters Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. + * @param string[]|null $optionalFilters create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter * * @return self */ @@ -484,7 +482,7 @@ public function getNumericFilters() /** * Sets numericFilters * - * @param string[]|null $numericFilters Filter on numeric attributes. + * @param string[]|null $numericFilters filter on numeric attributes * * @return self */ @@ -508,7 +506,7 @@ public function getTagFilters() /** * Sets tagFilters * - * @param string[]|null $tagFilters Filter hits by tags. + * @param string[]|null $tagFilters filter hits by tags * * @return self */ @@ -532,7 +530,7 @@ public function getSumOrFiltersScores() /** * Sets sumOrFiltersScores * - * @param bool|null $sumOrFiltersScores Determines how to calculate the total score for filtering. + * @param bool|null $sumOrFiltersScores determines how to calculate the total score for filtering * * @return self */ @@ -556,7 +554,7 @@ public function getFacets() /** * Sets facets * - * @param string[]|null $facets Retrieve facets and their facet values. + * @param string[]|null $facets retrieve facets and their facet values * * @return self */ @@ -580,7 +578,7 @@ public function getMaxValuesPerFacet() /** * Sets maxValuesPerFacet * - * @param int|null $maxValuesPerFacet Maximum number of facet values to return for each facet during a regular search. + * @param int|null $maxValuesPerFacet maximum number of facet values to return for each facet during a regular search * * @return self */ @@ -604,7 +602,7 @@ public function getFacetingAfterDistinct() /** * Sets facetingAfterDistinct * - * @param bool|null $facetingAfterDistinct Force faceting to be applied after de-duplication (via the Distinct setting). + * @param bool|null $facetingAfterDistinct force faceting to be applied after de-duplication (via the Distinct setting) * * @return self */ @@ -628,7 +626,7 @@ public function getSortFacetValuesBy() /** * Sets sortFacetValuesBy * - * @param string|null $sortFacetValuesBy Controls how facet values are fetched. + * @param string|null $sortFacetValuesBy controls how facet values are fetched * * @return self */ @@ -652,7 +650,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Specify the page to retrieve. + * @param int|null $page specify the page to retrieve * * @return self */ @@ -676,7 +674,7 @@ public function getOffset() /** * Sets offset * - * @param int|null $offset Specify the offset of the first hit to return. + * @param int|null $offset specify the offset of the first hit to return * * @return self */ @@ -700,7 +698,7 @@ public function getLength() /** * Sets length * - * @param int|null $length Set the number of hits to retrieve (used only with offset). + * @param int|null $length set the number of hits to retrieve (used only with offset) * * @return self */ @@ -732,7 +730,7 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng Search for entries around a central geolocation, enabling a geo search within a circular area. + * @param string|null $aroundLatLng search for entries around a central geolocation, enabling a geo search within a circular area * * @return self */ @@ -756,7 +754,7 @@ public function getAroundLatLngViaIP() /** * Sets aroundLatLngViaIP * - * @param bool|null $aroundLatLngViaIP Search for entries around a given location automatically computed from the requester's IP address. + * @param bool|null $aroundLatLngViaIP search for entries around a given location automatically computed from the requester's IP address * * @return self */ @@ -780,7 +778,7 @@ public function getAroundRadius() /** * Sets aroundRadius * - * @param OneOfIntegerString|null $aroundRadius Define the maximum radius for a geo search (in meters). + * @param OneOfIntegerString|null $aroundRadius define the maximum radius for a geo search (in meters) * * @return self */ @@ -804,7 +802,7 @@ public function getAroundPrecision() /** * Sets aroundPrecision * - * @param int|null $aroundPrecision Precision of geo search (in meters), to add grouping by geo location to the ranking formula. + * @param int|null $aroundPrecision precision of geo search (in meters), to add grouping by geo location to the ranking formula * * @return self */ @@ -828,7 +826,7 @@ public function getMinimumAroundRadius() /** * Sets minimumAroundRadius * - * @param int|null $minimumAroundRadius Minimum radius (in meters) used for a geo search when aroundRadius is not set. + * @param int|null $minimumAroundRadius minimum radius (in meters) used for a geo search when aroundRadius is not set * * @return self */ @@ -857,7 +855,7 @@ public function getInsideBoundingBox() /** * Sets insideBoundingBox * - * @param float[]|null $insideBoundingBox Search inside a rectangular area (in geo coordinates). + * @param float[]|null $insideBoundingBox search inside a rectangular area (in geo coordinates) * * @return self */ @@ -881,7 +879,7 @@ public function getInsidePolygon() /** * Sets insidePolygon * - * @param float[]|null $insidePolygon Search inside a polygon (in geo coordinates). + * @param float[]|null $insidePolygon search inside a polygon (in geo coordinates) * * @return self */ @@ -929,7 +927,7 @@ public function getRuleContexts() /** * Sets ruleContexts * - * @param string[]|null $ruleContexts Enables contextual rules. + * @param string[]|null $ruleContexts enables contextual rules * * @return self */ @@ -953,7 +951,7 @@ public function getPersonalizationImpact() /** * Sets personalizationImpact * - * @param int|null $personalizationImpact Define the impact of the Personalization feature. + * @param int|null $personalizationImpact define the impact of the Personalization feature * * @return self */ @@ -977,7 +975,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken Associates a certain user token with the current search. + * @param string|null $userToken associates a certain user token with the current search * * @return self */ @@ -1001,7 +999,7 @@ public function getGetRankingInfo() /** * Sets getRankingInfo * - * @param bool|null $getRankingInfo Retrieve detailed ranking information. + * @param bool|null $getRankingInfo retrieve detailed ranking information * * @return self */ @@ -1025,7 +1023,7 @@ public function getClickAnalytics() /** * Sets clickAnalytics * - * @param bool|null $clickAnalytics Enable the Click Analytics feature. + * @param bool|null $clickAnalytics enable the Click Analytics feature * * @return self */ @@ -1049,7 +1047,7 @@ public function getAnalytics() /** * Sets analytics * - * @param bool|null $analytics Whether the current query will be taken into account in the Analytics. + * @param bool|null $analytics whether the current query will be taken into account in the Analytics * * @return self */ @@ -1073,7 +1071,7 @@ public function getAnalyticsTags() /** * Sets analyticsTags * - * @param string[]|null $analyticsTags List of tags to apply to the query for analytics purposes. + * @param string[]|null $analyticsTags list of tags to apply to the query for analytics purposes * * @return self */ @@ -1097,7 +1095,7 @@ public function getPercentileComputation() /** * Sets percentileComputation * - * @param bool|null $percentileComputation Whether to include or exclude a query from the processing-time percentile computation. + * @param bool|null $percentileComputation whether to include or exclude a query from the processing-time percentile computation * * @return self */ @@ -1121,7 +1119,7 @@ public function getEnableABTest() /** * Sets enableABTest * - * @param bool|null $enableABTest Whether this search should participate in running AB tests. + * @param bool|null $enableABTest whether this search should participate in running AB tests * * @return self */ @@ -1145,7 +1143,7 @@ public function getEnableReRanking() /** * Sets enableReRanking * - * @param bool|null $enableReRanking Whether this search should use AI Re-Ranking. + * @param bool|null $enableReRanking whether this search should use AI Re-Ranking * * @return self */ @@ -1158,9 +1156,9 @@ public function setEnableReRanking($enableReRanking) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -1170,7 +1168,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -1199,7 +1197,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -1210,10 +1208,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -1244,4 +1243,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php index 37b4705831..5d758f3f99 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BaseSearchResponse Class Doc Comment @@ -54,7 +54,7 @@ class BaseSearchResponse implements ModelInterface, ArrayAccess, \JsonSerializab 'query' => 'string', 'queryAfterRemoval' => 'string', 'serverUsed' => 'string', - 'userData' => 'object' + 'userData' => 'object', ]; /** @@ -88,7 +88,7 @@ class BaseSearchResponse implements ModelInterface, ArrayAccess, \JsonSerializab 'query' => null, 'queryAfterRemoval' => null, 'serverUsed' => null, - 'userData' => null + 'userData' => null, ]; /** @@ -141,7 +141,7 @@ public static function openAPIFormats() 'query' => 'query', 'queryAfterRemoval' => 'queryAfterRemoval', 'serverUsed' => 'serverUsed', - 'userData' => 'userData' + 'userData' => 'userData', ]; /** @@ -173,7 +173,7 @@ public static function openAPIFormats() 'query' => 'setQuery', 'queryAfterRemoval' => 'setQueryAfterRemoval', 'serverUsed' => 'setServerUsed', - 'userData' => 'setUserData' + 'userData' => 'setUserData', ]; /** @@ -205,7 +205,7 @@ public static function openAPIFormats() 'query' => 'getQuery', 'queryAfterRemoval' => 'getQueryAfterRemoval', 'serverUsed' => 'getServerUsed', - 'userData' => 'getUserData' + 'userData' => 'getUserData', ]; /** @@ -249,7 +249,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -300,7 +299,7 @@ public function listInvalidProperties() { $invalidProperties = []; - if (!is_null($this->container['aroundLatLng']) && !preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $this->container['aroundLatLng'])) { + if (!is_null($this->container['aroundLatLng']) && !preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $this->container['aroundLatLng'])) { $invalidProperties[] = "invalid value for 'aroundLatLng', must be conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."; } @@ -331,6 +330,7 @@ public function listInvalidProperties() if ($this->container['query'] === null) { $invalidProperties[] = "'query' can't be null"; } + return $invalidProperties; } @@ -345,7 +345,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets abTestID * @@ -359,7 +358,7 @@ public function getAbTestID() /** * Sets abTestID * - * @param int|null $abTestID If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID. + * @param int|null $abTestID if a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID * * @return self */ @@ -383,7 +382,7 @@ public function getAbTestVariantID() /** * Sets abTestVariantID * - * @param int|null $abTestVariantID If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used. + * @param int|null $abTestVariantID if a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used * * @return self */ @@ -407,14 +406,14 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng The computed geo location. + * @param string|null $aroundLatLng the computed geo location * * @return self */ public function setAroundLatLng($aroundLatLng) { - if (!is_null($aroundLatLng) && (!preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $aroundLatLng))) { + if (!is_null($aroundLatLng) && (!preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $aroundLatLng))) { throw new \InvalidArgumentException("invalid value for $aroundLatLng when calling BaseSearchResponse., must conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."); } @@ -460,7 +459,7 @@ public function getExhaustiveFacetsCount() /** * Sets exhaustiveFacetsCount * - * @param bool|null $exhaustiveFacetsCount Whether the facet count is exhaustive or approximate. + * @param bool|null $exhaustiveFacetsCount whether the facet count is exhaustive or approximate * * @return self */ @@ -532,7 +531,7 @@ public function getFacets() /** * Sets facets * - * @param array>|null $facets A mapping of each facet name to the corresponding facet counts. + * @param array>|null $facets a mapping of each facet name to the corresponding facet counts * * @return self */ @@ -556,7 +555,7 @@ public function getFacetsStats() /** * Sets facetsStats * - * @param array|null $facetsStats Statistics for numerical facets. + * @param array|null $facetsStats statistics for numerical facets * * @return self */ @@ -580,7 +579,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int $hitsPerPage Set the number of hits per page. + * @param int $hitsPerPage set the number of hits per page * * @return self */ @@ -604,7 +603,7 @@ public function getIndex() /** * Sets index * - * @param string|null $index Index name used for the query. + * @param string|null $index index name used for the query * * @return self */ @@ -652,7 +651,7 @@ public function getMessage() /** * Sets message * - * @param string|null $message Used to return warnings about the query. + * @param string|null $message used to return warnings about the query * * @return self */ @@ -676,7 +675,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits Number of hits that the search query matched. + * @param int $nbHits number of hits that the search query matched * * @return self */ @@ -748,7 +747,7 @@ public function getPage() /** * Sets page * - * @param int $page Specify the page to retrieve. + * @param int $page specify the page to retrieve * * @return self */ @@ -772,7 +771,7 @@ public function getParams() /** * Sets params * - * @param string $params A url-encoded string of all search parameters. + * @param string $params a url-encoded string of all search parameters * * @return self */ @@ -796,7 +795,7 @@ public function getParsedQuery() /** * Sets parsedQuery * - * @param string|null $parsedQuery The query string that will be searched, after normalization. + * @param string|null $parsedQuery the query string that will be searched, after normalization * * @return self */ @@ -820,7 +819,7 @@ public function getProcessingTimeMS() /** * Sets processingTimeMS * - * @param int $processingTimeMS Time the server took to process the request, in milliseconds. + * @param int $processingTimeMS time the server took to process the request, in milliseconds * * @return self */ @@ -844,7 +843,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -868,7 +867,7 @@ public function getQueryAfterRemoval() /** * Sets queryAfterRemoval * - * @param string|null $queryAfterRemoval A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. + * @param string|null $queryAfterRemoval a markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set * * @return self */ @@ -892,7 +891,7 @@ public function getServerUsed() /** * Sets serverUsed * - * @param string|null $serverUsed Actual host name of the server that processed the request. + * @param string|null $serverUsed actual host name of the server that processed the request * * @return self */ @@ -916,7 +915,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData Lets you store custom data in your indices. + * @param object|null $userData lets you store custom data in your indices * * @return self */ @@ -929,9 +928,9 @@ public function setUserData($userData) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -941,7 +940,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -970,7 +969,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -981,10 +980,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -1015,4 +1015,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php index 2d97e8e94b..f260c78f71 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BaseSearchResponseFacetsStats Class Doc Comment @@ -34,7 +34,7 @@ class BaseSearchResponseFacetsStats implements ModelInterface, ArrayAccess, \Jso 'min' => 'int', 'max' => 'int', 'avg' => 'int', - 'sum' => 'int' + 'sum' => 'int', ]; /** @@ -48,7 +48,7 @@ class BaseSearchResponseFacetsStats implements ModelInterface, ArrayAccess, \Jso 'min' => null, 'max' => null, 'avg' => null, - 'sum' => null + 'sum' => null, ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() 'min' => 'min', 'max' => 'max', 'avg' => 'avg', - 'sum' => 'sum' + 'sum' => 'sum', ]; /** @@ -93,7 +93,7 @@ public static function openAPIFormats() 'min' => 'setMin', 'max' => 'setMax', 'avg' => 'setAvg', - 'sum' => 'setSum' + 'sum' => 'setSum', ]; /** @@ -105,7 +105,7 @@ public static function openAPIFormats() 'min' => 'getMin', 'max' => 'getMax', 'avg' => 'getAvg', - 'sum' => 'getSum' + 'sum' => 'getSum', ]; /** @@ -149,7 +149,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -194,7 +193,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets min * @@ -208,7 +206,7 @@ public function getMin() /** * Sets min * - * @param int|null $min The minimum value in the result set. + * @param int|null $min the minimum value in the result set * * @return self */ @@ -232,7 +230,7 @@ public function getMax() /** * Sets max * - * @param int|null $max The maximum value in the result set. + * @param int|null $max the maximum value in the result set * * @return self */ @@ -256,7 +254,7 @@ public function getAvg() /** * Sets avg * - * @param int|null $avg The average facet value in the result set. + * @param int|null $avg the average facet value in the result set * * @return self */ @@ -280,7 +278,7 @@ public function getSum() /** * Sets sum * - * @param int|null $sum The sum of all values in the result set. + * @param int|null $sum the sum of all values in the result set * * @return self */ @@ -293,9 +291,9 @@ public function setSum($sum) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -305,7 +303,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -334,7 +332,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -345,10 +343,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -379,4 +378,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php b/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php index 43c76dd3dd..60ad6bd7ef 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BatchAssignUserIdsObject Class Doc Comment * * @category Class * @description Assign userID object. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class BatchAssignUserIdsObject implements ModelInterface, ArrayAccess, \JsonSeri */ protected static $openAPITypes = [ 'cluster' => 'string', - 'users' => 'string[]' + 'users' => 'string[]', ]; /** @@ -45,7 +46,7 @@ class BatchAssignUserIdsObject implements ModelInterface, ArrayAccess, \JsonSeri */ protected static $openAPIFormats = [ 'cluster' => null, - 'users' => null + 'users' => null, ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'cluster' => 'cluster', - 'users' => 'users' + 'users' => 'users', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'cluster' => 'setCluster', - 'users' => 'setUsers' + 'users' => 'setUsers', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'cluster' => 'getCluster', - 'users' => 'getUsers' + 'users' => 'getUsers', ]; /** @@ -140,7 +141,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -175,6 +175,7 @@ public function listInvalidProperties() if ($this->container['users'] === null) { $invalidProperties[] = "'users' can't be null"; } + return $invalidProperties; } @@ -189,7 +190,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets cluster * @@ -203,7 +203,7 @@ public function getCluster() /** * Sets cluster * - * @param string $cluster Name of the cluster. + * @param string $cluster name of the cluster * * @return self */ @@ -240,9 +240,9 @@ public function setUsers($users) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -252,7 +252,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -281,7 +281,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -292,10 +292,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -326,4 +327,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php index 8c5a853c0e..d0ba7be83a 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BatchDictionaryEntries Class Doc Comment * * @category Class * @description The `batchDictionaryEntries` requests. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class BatchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSerial */ protected static $openAPITypes = [ 'clearExistingDictionaryEntries' => 'bool', - 'requests' => '\Algolia\AlgoliaSearch\Model\BatchDictionaryEntriesRequest[]' + 'requests' => '\Algolia\AlgoliaSearch\Model\BatchDictionaryEntriesRequest[]', ]; /** @@ -45,7 +46,7 @@ class BatchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSerial */ protected static $openAPIFormats = [ 'clearExistingDictionaryEntries' => null, - 'requests' => null + 'requests' => null, ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'clearExistingDictionaryEntries' => 'clearExistingDictionaryEntries', - 'requests' => 'requests' + 'requests' => 'requests', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'clearExistingDictionaryEntries' => 'setClearExistingDictionaryEntries', - 'requests' => 'setRequests' + 'requests' => 'setRequests', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'clearExistingDictionaryEntries' => 'getClearExistingDictionaryEntries', - 'requests' => 'getRequests' + 'requests' => 'getRequests', ]; /** @@ -140,7 +141,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -172,6 +172,7 @@ public function listInvalidProperties() if ($this->container['requests'] === null) { $invalidProperties[] = "'requests' can't be null"; } + return $invalidProperties; } @@ -186,7 +187,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets clearExistingDictionaryEntries * @@ -200,7 +200,7 @@ public function getClearExistingDictionaryEntries() /** * Sets clearExistingDictionaryEntries * - * @param bool|null $clearExistingDictionaryEntries When `true`, start the batch by removing all the custom entries from the dictionary. + * @param bool|null $clearExistingDictionaryEntries when `true`, start the batch by removing all the custom entries from the dictionary * * @return self */ @@ -237,9 +237,9 @@ public function setRequests($requests) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -249,7 +249,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -278,7 +278,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -289,10 +289,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -323,4 +324,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php index 073e38595f..e74c45c010 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BatchDictionaryEntriesRequest Class Doc Comment @@ -32,7 +32,7 @@ class BatchDictionaryEntriesRequest implements ModelInterface, ArrayAccess, \Jso */ protected static $openAPITypes = [ 'action' => 'string', - 'body' => '\Algolia\AlgoliaSearch\Model\DictionaryEntry' + 'body' => '\Algolia\AlgoliaSearch\Model\DictionaryEntry', ]; /** @@ -44,7 +44,7 @@ class BatchDictionaryEntriesRequest implements ModelInterface, ArrayAccess, \Jso */ protected static $openAPIFormats = [ 'action' => null, - 'body' => null + 'body' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'action' => 'action', - 'body' => 'body' + 'body' => 'body', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'action' => 'setAction', - 'body' => 'setBody' + 'body' => 'setBody', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'action' => 'getAction', - 'body' => 'getBody' + 'body' => 'getBody', ]; /** @@ -198,6 +198,7 @@ public function listInvalidProperties() if ($this->container['body'] === null) { $invalidProperties[] = "'body' can't be null"; } + return $invalidProperties; } @@ -212,7 +213,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets action * @@ -226,7 +226,7 @@ public function getAction() /** * Sets action * - * @param string $action Actions to perform. + * @param string $action actions to perform * * @return self */ @@ -273,9 +273,9 @@ public function setBody($body) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -285,7 +285,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -314,7 +314,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -325,10 +325,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -359,4 +360,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BatchObject.php b/clients/algoliasearch-client-php/lib/Model/BatchObject.php index 815e85b5cb..11b433c681 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchObject.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BatchObject Class Doc Comment * * @category Class * @description The `batch` requests. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class BatchObject implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'requests' => '\Algolia\AlgoliaSearch\Model\Operation[]' + 'requests' => '\Algolia\AlgoliaSearch\Model\Operation[]', ]; /** @@ -43,7 +44,7 @@ class BatchObject implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'requests' => null + 'requests' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'requests' => 'requests' + 'requests' => 'requests', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'requests' => 'setRequests' + 'requests' => 'setRequests', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'requests' => 'getRequests' + 'requests' => 'getRequests', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -177,7 +177,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets requests * @@ -204,9 +203,9 @@ public function setRequests($requests) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -216,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -245,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -256,10 +255,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -290,4 +290,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BatchResponse.php b/clients/algoliasearch-client-php/lib/Model/BatchResponse.php index ad20982c93..149eae702c 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BatchResponse Class Doc Comment @@ -32,7 +32,7 @@ class BatchResponse implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'taskID' => 'int', - 'objectIDs' => 'string[]' + 'objectIDs' => 'string[]', ]; /** @@ -44,7 +44,7 @@ class BatchResponse implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'taskID' => null, - 'objectIDs' => null + 'objectIDs' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'taskID' => 'taskID', - 'objectIDs' => 'objectIDs' + 'objectIDs' => 'objectIDs', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'taskID' => 'setTaskID', - 'objectIDs' => 'setObjectIDs' + 'objectIDs' => 'setObjectIDs', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'taskID' => 'getTaskID', - 'objectIDs' => 'getObjectIDs' + 'objectIDs' => 'getObjectIDs', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -182,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets taskID * @@ -196,7 +194,7 @@ public function getTaskID() /** * Sets taskID * - * @param int|null $taskID taskID of the indexing task to wait for. + * @param int|null $taskID taskID of the indexing task to wait for * * @return self */ @@ -220,7 +218,7 @@ public function getObjectIDs() /** * Sets objectIDs * - * @param string[]|null $objectIDs List of objectID. + * @param string[]|null $objectIDs list of objectID * * @return self */ @@ -233,9 +231,9 @@ public function setObjectIDs($objectIDs) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -245,7 +243,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -274,7 +272,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -285,10 +283,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -319,4 +318,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php b/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php index 896d0c3b8f..9b61babd79 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BatchWriteObject Class Doc Comment * * @category Class * @description The `batch` requests. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class BatchWriteObject implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'requests' => '\Algolia\AlgoliaSearch\Model\Operation[]' + 'requests' => '\Algolia\AlgoliaSearch\Model\Operation[]', ]; /** @@ -43,7 +44,7 @@ class BatchWriteObject implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'requests' => null + 'requests' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'requests' => 'requests' + 'requests' => 'requests', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'requests' => 'setRequests' + 'requests' => 'setRequests', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'requests' => 'getRequests' + 'requests' => 'getRequests', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -177,7 +177,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets requests * @@ -204,9 +203,9 @@ public function setRequests($requests) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -216,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -245,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -256,10 +255,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -290,4 +290,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php b/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php index 8c2728944a..1f2fe9ca43 100644 --- a/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BrowseRequest Class Doc Comment @@ -32,7 +32,7 @@ class BrowseRequest implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'params' => 'string', - 'cursor' => 'string' + 'cursor' => 'string', ]; /** @@ -44,7 +44,7 @@ class BrowseRequest implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'params' => null, - 'cursor' => null + 'cursor' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'params' => 'params', - 'cursor' => 'cursor' + 'cursor' => 'cursor', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'params' => 'setParams', - 'cursor' => 'setCursor' + 'cursor' => 'setCursor', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'params' => 'getParams', - 'cursor' => 'getCursor' + 'cursor' => 'getCursor', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -182,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets params * @@ -196,7 +194,7 @@ public function getParams() /** * Sets params * - * @param string|null $params Search parameters as URL-encoded query string. + * @param string|null $params search parameters as URL-encoded query string * * @return self */ @@ -233,9 +231,9 @@ public function setCursor($cursor) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -245,7 +243,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -274,7 +272,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -285,10 +283,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -319,4 +318,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php b/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php index 389fa30b65..a42ad93b22 100644 --- a/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BrowseResponse Class Doc Comment @@ -56,7 +56,7 @@ class BrowseResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'serverUsed' => 'string', 'userData' => 'object', 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]', - 'cursor' => 'string' + 'cursor' => 'string', ]; /** @@ -92,7 +92,7 @@ class BrowseResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'serverUsed' => null, 'userData' => null, 'hits' => null, - 'cursor' => null + 'cursor' => null, ]; /** @@ -147,7 +147,7 @@ public static function openAPIFormats() 'serverUsed' => 'serverUsed', 'userData' => 'userData', 'hits' => 'hits', - 'cursor' => 'cursor' + 'cursor' => 'cursor', ]; /** @@ -181,7 +181,7 @@ public static function openAPIFormats() 'serverUsed' => 'setServerUsed', 'userData' => 'setUserData', 'hits' => 'setHits', - 'cursor' => 'setCursor' + 'cursor' => 'setCursor', ]; /** @@ -215,7 +215,7 @@ public static function openAPIFormats() 'serverUsed' => 'getServerUsed', 'userData' => 'getUserData', 'hits' => 'getHits', - 'cursor' => 'getCursor' + 'cursor' => 'getCursor', ]; /** @@ -259,7 +259,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -312,7 +311,7 @@ public function listInvalidProperties() { $invalidProperties = []; - if (!is_null($this->container['aroundLatLng']) && !preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $this->container['aroundLatLng'])) { + if (!is_null($this->container['aroundLatLng']) && !preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $this->container['aroundLatLng'])) { $invalidProperties[] = "invalid value for 'aroundLatLng', must be conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."; } @@ -349,6 +348,7 @@ public function listInvalidProperties() if ($this->container['cursor'] === null) { $invalidProperties[] = "'cursor' can't be null"; } + return $invalidProperties; } @@ -363,7 +363,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets abTestID * @@ -377,7 +376,7 @@ public function getAbTestID() /** * Sets abTestID * - * @param int|null $abTestID If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID. + * @param int|null $abTestID if a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID * * @return self */ @@ -401,7 +400,7 @@ public function getAbTestVariantID() /** * Sets abTestVariantID * - * @param int|null $abTestVariantID If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used. + * @param int|null $abTestVariantID if a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used * * @return self */ @@ -425,14 +424,14 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng The computed geo location. + * @param string|null $aroundLatLng the computed geo location * * @return self */ public function setAroundLatLng($aroundLatLng) { - if (!is_null($aroundLatLng) && (!preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $aroundLatLng))) { + if (!is_null($aroundLatLng) && (!preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $aroundLatLng))) { throw new \InvalidArgumentException("invalid value for $aroundLatLng when calling BrowseResponse., must conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."); } @@ -478,7 +477,7 @@ public function getExhaustiveFacetsCount() /** * Sets exhaustiveFacetsCount * - * @param bool|null $exhaustiveFacetsCount Whether the facet count is exhaustive or approximate. + * @param bool|null $exhaustiveFacetsCount whether the facet count is exhaustive or approximate * * @return self */ @@ -550,7 +549,7 @@ public function getFacets() /** * Sets facets * - * @param array>|null $facets A mapping of each facet name to the corresponding facet counts. + * @param array>|null $facets a mapping of each facet name to the corresponding facet counts * * @return self */ @@ -574,7 +573,7 @@ public function getFacetsStats() /** * Sets facetsStats * - * @param array|null $facetsStats Statistics for numerical facets. + * @param array|null $facetsStats statistics for numerical facets * * @return self */ @@ -598,7 +597,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int $hitsPerPage Set the number of hits per page. + * @param int $hitsPerPage set the number of hits per page * * @return self */ @@ -622,7 +621,7 @@ public function getIndex() /** * Sets index * - * @param string|null $index Index name used for the query. + * @param string|null $index index name used for the query * * @return self */ @@ -670,7 +669,7 @@ public function getMessage() /** * Sets message * - * @param string|null $message Used to return warnings about the query. + * @param string|null $message used to return warnings about the query * * @return self */ @@ -694,7 +693,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits Number of hits that the search query matched. + * @param int $nbHits number of hits that the search query matched * * @return self */ @@ -766,7 +765,7 @@ public function getPage() /** * Sets page * - * @param int $page Specify the page to retrieve. + * @param int $page specify the page to retrieve * * @return self */ @@ -790,7 +789,7 @@ public function getParams() /** * Sets params * - * @param string $params A url-encoded string of all search parameters. + * @param string $params a url-encoded string of all search parameters * * @return self */ @@ -814,7 +813,7 @@ public function getParsedQuery() /** * Sets parsedQuery * - * @param string|null $parsedQuery The query string that will be searched, after normalization. + * @param string|null $parsedQuery the query string that will be searched, after normalization * * @return self */ @@ -838,7 +837,7 @@ public function getProcessingTimeMS() /** * Sets processingTimeMS * - * @param int $processingTimeMS Time the server took to process the request, in milliseconds. + * @param int $processingTimeMS time the server took to process the request, in milliseconds * * @return self */ @@ -862,7 +861,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -886,7 +885,7 @@ public function getQueryAfterRemoval() /** * Sets queryAfterRemoval * - * @param string|null $queryAfterRemoval A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. + * @param string|null $queryAfterRemoval a markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set * * @return self */ @@ -910,7 +909,7 @@ public function getServerUsed() /** * Sets serverUsed * - * @param string|null $serverUsed Actual host name of the server that processed the request. + * @param string|null $serverUsed actual host name of the server that processed the request * * @return self */ @@ -934,7 +933,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData Lets you store custom data in your indices. + * @param object|null $userData lets you store custom data in your indices * * @return self */ @@ -995,9 +994,9 @@ public function setCursor($cursor) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -1007,7 +1006,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -1036,7 +1035,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -1047,10 +1046,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -1081,4 +1081,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php b/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php index 3812d64acb..0b47b91e5e 100644 --- a/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php +++ b/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BuildInOperation Class Doc Comment * * @category Class * @description To update an attribute without pushing the entire record, you can use these built-in operations. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class BuildInOperation implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'operation' => 'string', - 'value' => 'string' + 'value' => 'string', ]; /** @@ -45,7 +46,7 @@ class BuildInOperation implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'operation' => null, - 'value' => null + 'value' => null, ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'operation' => '_operation', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'operation' => 'setOperation', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'operation' => 'getOperation', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -209,6 +210,7 @@ public function listInvalidProperties() if ($this->container['value'] === null) { $invalidProperties[] = "'value' can't be null"; } + return $invalidProperties; } @@ -223,7 +225,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets operation * @@ -237,7 +238,7 @@ public function getOperation() /** * Sets operation * - * @param string $operation The operation to apply on the attribute. + * @param string $operation the operation to apply on the attribute * * @return self */ @@ -271,7 +272,7 @@ public function getValue() /** * Sets value * - * @param string $value the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove. + * @param string $value the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove * * @return self */ @@ -284,9 +285,9 @@ public function setValue($value) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -296,7 +297,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -325,7 +326,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -336,10 +337,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -370,4 +372,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Condition.php b/clients/algoliasearch-client-php/lib/Model/Condition.php index 56abe62cb6..df2723672e 100644 --- a/clients/algoliasearch-client-php/lib/Model/Condition.php +++ b/clients/algoliasearch-client-php/lib/Model/Condition.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Condition Class Doc Comment @@ -34,7 +34,7 @@ class Condition implements ModelInterface, ArrayAccess, \JsonSerializable 'pattern' => 'string', 'anchoring' => '\Algolia\AlgoliaSearch\Model\Anchoring', 'alternatives' => 'bool', - 'context' => 'string' + 'context' => 'string', ]; /** @@ -48,7 +48,7 @@ class Condition implements ModelInterface, ArrayAccess, \JsonSerializable 'pattern' => null, 'anchoring' => null, 'alternatives' => null, - 'context' => null + 'context' => null, ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() 'pattern' => 'pattern', 'anchoring' => 'anchoring', 'alternatives' => 'alternatives', - 'context' => 'context' + 'context' => 'context', ]; /** @@ -93,7 +93,7 @@ public static function openAPIFormats() 'pattern' => 'setPattern', 'anchoring' => 'setAnchoring', 'alternatives' => 'setAlternatives', - 'context' => 'setContext' + 'context' => 'setContext', ]; /** @@ -105,7 +105,7 @@ public static function openAPIFormats() 'pattern' => 'getPattern', 'anchoring' => 'getAnchoring', 'alternatives' => 'getAlternatives', - 'context' => 'getContext' + 'context' => 'getContext', ]; /** @@ -149,7 +149,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -194,7 +193,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets pattern * @@ -256,7 +254,7 @@ public function getAlternatives() /** * Sets alternatives * - * @param bool|null $alternatives Whether the pattern matches on plurals, synonyms, and typos. + * @param bool|null $alternatives whether the pattern matches on plurals, synonyms, and typos * * @return self */ @@ -280,7 +278,7 @@ public function getContext() /** * Sets context * - * @param string|null $context Rule context format: [A-Za-z0-9_-]+). + * @param string|null $context rule context format: [A-Za-z0-9_-]+) * * @return self */ @@ -293,9 +291,9 @@ public function setContext($context) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -305,7 +303,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -334,7 +332,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -345,10 +343,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -379,4 +378,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Consequence.php b/clients/algoliasearch-client-php/lib/Model/Consequence.php index 5399db7de5..d3d51ae219 100644 --- a/clients/algoliasearch-client-php/lib/Model/Consequence.php +++ b/clients/algoliasearch-client-php/lib/Model/Consequence.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Consequence Class Doc Comment * * @category Class * @description Consequence of the Rule. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -36,7 +37,7 @@ class Consequence implements ModelInterface, ArrayAccess, \JsonSerializable 'promote' => '\Algolia\AlgoliaSearch\Model\Promote[]', 'filterPromotes' => 'bool', 'hide' => '\Algolia\AlgoliaSearch\Model\ConsequenceHide[]', - 'userData' => 'object' + 'userData' => 'object', ]; /** @@ -51,7 +52,7 @@ class Consequence implements ModelInterface, ArrayAccess, \JsonSerializable 'promote' => null, 'filterPromotes' => null, 'hide' => null, - 'userData' => null + 'userData' => null, ]; /** @@ -85,7 +86,7 @@ public static function openAPIFormats() 'promote' => 'promote', 'filterPromotes' => 'filterPromotes', 'hide' => 'hide', - 'userData' => 'userData' + 'userData' => 'userData', ]; /** @@ -98,7 +99,7 @@ public static function openAPIFormats() 'promote' => 'setPromote', 'filterPromotes' => 'setFilterPromotes', 'hide' => 'setHide', - 'userData' => 'setUserData' + 'userData' => 'setUserData', ]; /** @@ -111,7 +112,7 @@ public static function openAPIFormats() 'promote' => 'getPromote', 'filterPromotes' => 'getFilterPromotes', 'hide' => 'getHide', - 'userData' => 'getUserData' + 'userData' => 'getUserData', ]; /** @@ -155,7 +156,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -201,7 +201,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets params * @@ -239,7 +238,7 @@ public function getPromote() /** * Sets promote * - * @param \Algolia\AlgoliaSearch\Model\Promote[]|null $promote Objects to promote as hits. + * @param \Algolia\AlgoliaSearch\Model\Promote[]|null $promote objects to promote as hits * * @return self */ @@ -324,9 +323,9 @@ public function setUserData($userData) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -336,7 +335,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -365,7 +364,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -376,10 +375,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -410,4 +410,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php b/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php index 35fcc49b7b..8a5716ca77 100644 --- a/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php +++ b/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ConsequenceHide Class Doc Comment * * @category Class * @description Unique identifier of the object to hide. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class ConsequenceHide implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'objectID' => 'string' + 'objectID' => 'string', ]; /** @@ -43,7 +44,7 @@ class ConsequenceHide implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'objectID' => null + 'objectID' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'objectID' => 'objectID' + 'objectID' => 'objectID', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'objectID' => 'setObjectID' + 'objectID' => 'setObjectID', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'objectID' => 'getObjectID' + 'objectID' => 'getObjectID', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['objectID'] === null) { $invalidProperties[] = "'objectID' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -194,7 +194,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID Unique identifier of the object. + * @param string $objectID unique identifier of the object * * @return self */ @@ -207,9 +207,9 @@ public function setObjectID($objectID) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php b/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php index 1d45a92a8a..2851a1ea17 100644 --- a/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php +++ b/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ConsequenceParams Class Doc Comment @@ -109,7 +109,7 @@ class ConsequenceParams implements ModelInterface, ArrayAccess, \JsonSerializabl 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object' + 'renderingContent' => 'object', ]; /** @@ -198,7 +198,7 @@ class ConsequenceParams implements ModelInterface, ArrayAccess, \JsonSerializabl 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null + 'renderingContent' => null, ]; /** @@ -306,7 +306,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent' + 'renderingContent' => 'renderingContent', ]; /** @@ -393,7 +393,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent' + 'renderingContent' => 'setRenderingContent', ]; /** @@ -480,7 +480,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent' + 'renderingContent' => 'getRenderingContent', ]; /** @@ -816,7 +816,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets query * @@ -830,7 +829,7 @@ public function getQuery() /** * Sets query * - * @param string|null $query Query string. + * @param string|null $query query string * * @return self */ @@ -854,7 +853,7 @@ public function getAutomaticFacetFilters() /** * Sets automaticFacetFilters * - * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticFacetFilters Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern. + * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticFacetFilters names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern * * @return self */ @@ -878,7 +877,7 @@ public function getAutomaticOptionalFacetFilters() /** * Sets automaticOptionalFacetFilters * - * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticOptionalFacetFilters Same syntax as automaticFacetFilters, but the engine treats the filters as optional. + * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticOptionalFacetFilters same syntax as automaticFacetFilters, but the engine treats the filters as optional * * @return self */ @@ -902,7 +901,7 @@ public function getSimilarQuery() /** * Sets similarQuery * - * @param string|null $similarQuery Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results. + * @param string|null $similarQuery overrides the query parameter and performs a more generic search that can be used to find \"similar\" results * * @return self */ @@ -926,7 +925,7 @@ public function getFilters() /** * Sets filters * - * @param string|null $filters Filter the query with numeric, facet and/or tag filters. + * @param string|null $filters filter the query with numeric, facet and/or tag filters * * @return self */ @@ -950,7 +949,7 @@ public function getFacetFilters() /** * Sets facetFilters * - * @param string[]|null $facetFilters Filter hits by facet value. + * @param string[]|null $facetFilters filter hits by facet value * * @return self */ @@ -974,7 +973,7 @@ public function getOptionalFilters() /** * Sets optionalFilters * - * @param string[]|null $optionalFilters Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. + * @param string[]|null $optionalFilters create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter * * @return self */ @@ -998,7 +997,7 @@ public function getNumericFilters() /** * Sets numericFilters * - * @param string[]|null $numericFilters Filter on numeric attributes. + * @param string[]|null $numericFilters filter on numeric attributes * * @return self */ @@ -1022,7 +1021,7 @@ public function getTagFilters() /** * Sets tagFilters * - * @param string[]|null $tagFilters Filter hits by tags. + * @param string[]|null $tagFilters filter hits by tags * * @return self */ @@ -1046,7 +1045,7 @@ public function getSumOrFiltersScores() /** * Sets sumOrFiltersScores * - * @param bool|null $sumOrFiltersScores Determines how to calculate the total score for filtering. + * @param bool|null $sumOrFiltersScores determines how to calculate the total score for filtering * * @return self */ @@ -1070,7 +1069,7 @@ public function getFacets() /** * Sets facets * - * @param string[]|null $facets Retrieve facets and their facet values. + * @param string[]|null $facets retrieve facets and their facet values * * @return self */ @@ -1094,7 +1093,7 @@ public function getMaxValuesPerFacet() /** * Sets maxValuesPerFacet * - * @param int|null $maxValuesPerFacet Maximum number of facet values to return for each facet during a regular search. + * @param int|null $maxValuesPerFacet maximum number of facet values to return for each facet during a regular search * * @return self */ @@ -1118,7 +1117,7 @@ public function getFacetingAfterDistinct() /** * Sets facetingAfterDistinct * - * @param bool|null $facetingAfterDistinct Force faceting to be applied after de-duplication (via the Distinct setting). + * @param bool|null $facetingAfterDistinct force faceting to be applied after de-duplication (via the Distinct setting) * * @return self */ @@ -1142,7 +1141,7 @@ public function getSortFacetValuesBy() /** * Sets sortFacetValuesBy * - * @param string|null $sortFacetValuesBy Controls how facet values are fetched. + * @param string|null $sortFacetValuesBy controls how facet values are fetched * * @return self */ @@ -1166,7 +1165,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Specify the page to retrieve. + * @param int|null $page specify the page to retrieve * * @return self */ @@ -1190,7 +1189,7 @@ public function getOffset() /** * Sets offset * - * @param int|null $offset Specify the offset of the first hit to return. + * @param int|null $offset specify the offset of the first hit to return * * @return self */ @@ -1214,7 +1213,7 @@ public function getLength() /** * Sets length * - * @param int|null $length Set the number of hits to retrieve (used only with offset). + * @param int|null $length set the number of hits to retrieve (used only with offset) * * @return self */ @@ -1246,7 +1245,7 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng Search for entries around a central geolocation, enabling a geo search within a circular area. + * @param string|null $aroundLatLng search for entries around a central geolocation, enabling a geo search within a circular area * * @return self */ @@ -1270,7 +1269,7 @@ public function getAroundLatLngViaIP() /** * Sets aroundLatLngViaIP * - * @param bool|null $aroundLatLngViaIP Search for entries around a given location automatically computed from the requester's IP address. + * @param bool|null $aroundLatLngViaIP search for entries around a given location automatically computed from the requester's IP address * * @return self */ @@ -1294,7 +1293,7 @@ public function getAroundRadius() /** * Sets aroundRadius * - * @param OneOfIntegerString|null $aroundRadius Define the maximum radius for a geo search (in meters). + * @param OneOfIntegerString|null $aroundRadius define the maximum radius for a geo search (in meters) * * @return self */ @@ -1318,7 +1317,7 @@ public function getAroundPrecision() /** * Sets aroundPrecision * - * @param int|null $aroundPrecision Precision of geo search (in meters), to add grouping by geo location to the ranking formula. + * @param int|null $aroundPrecision precision of geo search (in meters), to add grouping by geo location to the ranking formula * * @return self */ @@ -1342,7 +1341,7 @@ public function getMinimumAroundRadius() /** * Sets minimumAroundRadius * - * @param int|null $minimumAroundRadius Minimum radius (in meters) used for a geo search when aroundRadius is not set. + * @param int|null $minimumAroundRadius minimum radius (in meters) used for a geo search when aroundRadius is not set * * @return self */ @@ -1371,7 +1370,7 @@ public function getInsideBoundingBox() /** * Sets insideBoundingBox * - * @param float[]|null $insideBoundingBox Search inside a rectangular area (in geo coordinates). + * @param float[]|null $insideBoundingBox search inside a rectangular area (in geo coordinates) * * @return self */ @@ -1395,7 +1394,7 @@ public function getInsidePolygon() /** * Sets insidePolygon * - * @param float[]|null $insidePolygon Search inside a polygon (in geo coordinates). + * @param float[]|null $insidePolygon search inside a polygon (in geo coordinates) * * @return self */ @@ -1443,7 +1442,7 @@ public function getRuleContexts() /** * Sets ruleContexts * - * @param string[]|null $ruleContexts Enables contextual rules. + * @param string[]|null $ruleContexts enables contextual rules * * @return self */ @@ -1467,7 +1466,7 @@ public function getPersonalizationImpact() /** * Sets personalizationImpact * - * @param int|null $personalizationImpact Define the impact of the Personalization feature. + * @param int|null $personalizationImpact define the impact of the Personalization feature * * @return self */ @@ -1491,7 +1490,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken Associates a certain user token with the current search. + * @param string|null $userToken associates a certain user token with the current search * * @return self */ @@ -1515,7 +1514,7 @@ public function getGetRankingInfo() /** * Sets getRankingInfo * - * @param bool|null $getRankingInfo Retrieve detailed ranking information. + * @param bool|null $getRankingInfo retrieve detailed ranking information * * @return self */ @@ -1539,7 +1538,7 @@ public function getClickAnalytics() /** * Sets clickAnalytics * - * @param bool|null $clickAnalytics Enable the Click Analytics feature. + * @param bool|null $clickAnalytics enable the Click Analytics feature * * @return self */ @@ -1563,7 +1562,7 @@ public function getAnalytics() /** * Sets analytics * - * @param bool|null $analytics Whether the current query will be taken into account in the Analytics. + * @param bool|null $analytics whether the current query will be taken into account in the Analytics * * @return self */ @@ -1587,7 +1586,7 @@ public function getAnalyticsTags() /** * Sets analyticsTags * - * @param string[]|null $analyticsTags List of tags to apply to the query for analytics purposes. + * @param string[]|null $analyticsTags list of tags to apply to the query for analytics purposes * * @return self */ @@ -1611,7 +1610,7 @@ public function getPercentileComputation() /** * Sets percentileComputation * - * @param bool|null $percentileComputation Whether to include or exclude a query from the processing-time percentile computation. + * @param bool|null $percentileComputation whether to include or exclude a query from the processing-time percentile computation * * @return self */ @@ -1635,7 +1634,7 @@ public function getEnableABTest() /** * Sets enableABTest * - * @param bool|null $enableABTest Whether this search should participate in running AB tests. + * @param bool|null $enableABTest whether this search should participate in running AB tests * * @return self */ @@ -1659,7 +1658,7 @@ public function getEnableReRanking() /** * Sets enableReRanking * - * @param bool|null $enableReRanking Whether this search should use AI Re-Ranking. + * @param bool|null $enableReRanking whether this search should use AI Re-Ranking * * @return self */ @@ -1683,7 +1682,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes The complete list of attributes used for searching. + * @param string[]|null $searchableAttributes the complete list of attributes used for searching * * @return self */ @@ -1707,7 +1706,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. + * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting * * @return self */ @@ -1731,7 +1730,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. + * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time * * @return self */ @@ -1755,7 +1754,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. + * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve * * @return self */ @@ -1779,7 +1778,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. + * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes * * @return self */ @@ -1803,7 +1802,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking Controls how Algolia should sort your results. + * @param string[]|null $ranking controls how Algolia should sort your results * * @return self */ @@ -1827,7 +1826,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking Specifies the custom ranking criterion. + * @param string[]|null $customRanking specifies the custom ranking criterion * * @return self */ @@ -1851,7 +1850,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. + * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results * * @return self */ @@ -1875,7 +1874,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight List of attributes to highlight. + * @param string[]|null $attributesToHighlight list of attributes to highlight * * @return self */ @@ -1899,7 +1898,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. + * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet * * @return self */ @@ -1923,7 +1922,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results * * @return self */ @@ -1947,7 +1946,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results * * @return self */ @@ -1971,7 +1970,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. + * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated * * @return self */ @@ -1995,7 +1994,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. + * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query * * @return self */ @@ -2019,7 +2018,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -2043,7 +2042,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. + * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo * * @return self */ @@ -2067,7 +2066,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. + * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos * * @return self */ @@ -2091,7 +2090,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. + * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied * * @return self */ @@ -2125,7 +2124,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. + * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string * * @return self */ @@ -2149,7 +2148,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. + * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance * * @return self */ @@ -2173,7 +2172,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex Control which separators are indexed. + * @param string|null $separatorsToIndex control which separators are indexed * * @return self */ @@ -2197,7 +2196,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. + * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms * * @return self */ @@ -2221,7 +2220,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. + * @param string|null $removeStopWords removes stop (common) words from the query before executing it * * @return self */ @@ -2245,7 +2244,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. + * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize * * @return self */ @@ -2269,7 +2268,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. + * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection * * @return self */ @@ -2293,7 +2292,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. + * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query * * @return self */ @@ -2317,7 +2316,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules Whether Rules should be globally enabled. + * @param bool|null $enableRules whether Rules should be globally enabled * * @return self */ @@ -2341,7 +2340,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization Enable the Personalization feature. + * @param bool|null $enablePersonalization enable the Personalization feature * * @return self */ @@ -2365,7 +2364,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType Controls if and how query words are interpreted as prefixes. + * @param string|null $queryType controls if and how query words are interpreted as prefixes * * @return self */ @@ -2399,7 +2398,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. + * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits * * @return self */ @@ -2433,7 +2432,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax Enables the advanced query syntax. + * @param bool|null $advancedSyntax enables the advanced query syntax * * @return self */ @@ -2457,7 +2456,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. + * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query * * @return self */ @@ -2481,7 +2480,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. + * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion * * @return self */ @@ -2505,7 +2504,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. + * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word * * @return self */ @@ -2539,7 +2538,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. + * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion * * @return self */ @@ -2572,7 +2571,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. + * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled * * @return self */ @@ -2605,7 +2604,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct Enables de-duplication or grouping of results. + * @param int|null $distinct enables de-duplication or grouping of results * * @return self */ @@ -2637,7 +2636,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. + * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search * * @return self */ @@ -2661,7 +2660,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. + * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself * * @return self */ @@ -2685,7 +2684,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity Precision of the proximity ranking criterion. + * @param int|null $minProximity precision of the proximity ranking criterion * * @return self */ @@ -2770,7 +2769,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. + * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage * * @return self */ @@ -2807,9 +2806,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -2819,7 +2818,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -2848,7 +2847,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -2859,10 +2858,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -2893,4 +2893,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php b/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php index 0aa84a34c1..05b718c055 100644 --- a/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php +++ b/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * CreatedAtObject Class Doc Comment @@ -31,7 +31,7 @@ class CreatedAtObject implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'createdAt' => '\DateTime' + 'createdAt' => '\DateTime', ]; /** @@ -42,7 +42,7 @@ class CreatedAtObject implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'createdAt' => 'date-time' + 'createdAt' => 'date-time', ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'createdAt' => 'createdAt' + 'createdAt' => 'createdAt', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'createdAt' => 'setCreatedAt' + 'createdAt' => 'setCreatedAt', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'createdAt' => 'getCreatedAt' + 'createdAt' => 'getCreatedAt', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets createdAt * @@ -193,7 +192,7 @@ public function getCreatedAt() /** * Sets createdAt * - * @param \DateTime $createdAt Date of creation (ISO-8601 format). + * @param \DateTime $createdAt date of creation (ISO-8601 format) * * @return self */ @@ -206,9 +205,9 @@ public function setCreatedAt($createdAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php b/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php index 315a5ae358..0161cef372 100644 --- a/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * CreatedAtResponse Class Doc Comment * * @category Class * @description The response with a createdAt timestamp. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class CreatedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl * @var string[] */ protected static $openAPITypes = [ - 'createdAt' => '\DateTime' + 'createdAt' => '\DateTime', ]; /** @@ -43,7 +44,7 @@ class CreatedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl * @psalm-var array */ protected static $openAPIFormats = [ - 'createdAt' => 'date-time' + 'createdAt' => 'date-time', ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'createdAt' => 'createdAt' + 'createdAt' => 'createdAt', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'createdAt' => 'setCreatedAt' + 'createdAt' => 'setCreatedAt', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'createdAt' => 'getCreatedAt' + 'createdAt' => 'getCreatedAt', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets createdAt * @@ -194,7 +194,7 @@ public function getCreatedAt() /** * Sets createdAt * - * @param \DateTime $createdAt Date of creation (ISO-8601 format). + * @param \DateTime $createdAt date of creation (ISO-8601 format) * * @return self */ @@ -207,9 +207,9 @@ public function setCreatedAt($createdAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php b/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php index 91a0261797..46eeb200e3 100644 --- a/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * DeleteApiKeyResponse Class Doc Comment @@ -31,7 +31,7 @@ class DeleteApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'deletedAt' => '\DateTime' + 'deletedAt' => '\DateTime', ]; /** @@ -42,7 +42,7 @@ class DeleteApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'deletedAt' => 'date-time' + 'deletedAt' => 'date-time', ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'deletedAt' => 'deletedAt' + 'deletedAt' => 'deletedAt', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'deletedAt' => 'setDeletedAt' + 'deletedAt' => 'setDeletedAt', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'deletedAt' => 'getDeletedAt' + 'deletedAt' => 'getDeletedAt', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['deletedAt'] === null) { $invalidProperties[] = "'deletedAt' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets deletedAt * @@ -193,7 +192,7 @@ public function getDeletedAt() /** * Sets deletedAt * - * @param \DateTime $deletedAt Date of deletion (ISO-8601 format). + * @param \DateTime $deletedAt date of deletion (ISO-8601 format) * * @return self */ @@ -206,9 +205,9 @@ public function setDeletedAt($deletedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php b/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php index 0d93123442..32b42cf4da 100644 --- a/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * DeleteSourceResponse Class Doc Comment @@ -31,7 +31,7 @@ class DeleteSourceResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'deletedAt' => '\DateTime' + 'deletedAt' => '\DateTime', ]; /** @@ -42,7 +42,7 @@ class DeleteSourceResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'deletedAt' => 'date-time' + 'deletedAt' => 'date-time', ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'deletedAt' => 'deletedAt' + 'deletedAt' => 'deletedAt', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'deletedAt' => 'setDeletedAt' + 'deletedAt' => 'setDeletedAt', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'deletedAt' => 'getDeletedAt' + 'deletedAt' => 'getDeletedAt', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['deletedAt'] === null) { $invalidProperties[] = "'deletedAt' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets deletedAt * @@ -193,7 +192,7 @@ public function getDeletedAt() /** * Sets deletedAt * - * @param \DateTime $deletedAt Date of deletion (ISO-8601 format). + * @param \DateTime $deletedAt date of deletion (ISO-8601 format) * * @return self */ @@ -206,9 +205,9 @@ public function setDeletedAt($deletedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php b/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php index 7877e7405a..6890a73dec 100644 --- a/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * DeletedAtResponse Class Doc Comment * * @category Class * @description The response with a taskID and a deletedAt timestamp. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class DeletedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPITypes = [ 'taskID' => 'int', - 'deletedAt' => '\DateTime' + 'deletedAt' => '\DateTime', ]; /** @@ -45,7 +46,7 @@ class DeletedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPIFormats = [ 'taskID' => null, - 'deletedAt' => 'date-time' + 'deletedAt' => 'date-time', ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'taskID' => 'taskID', - 'deletedAt' => 'deletedAt' + 'deletedAt' => 'deletedAt', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'taskID' => 'setTaskID', - 'deletedAt' => 'setDeletedAt' + 'deletedAt' => 'setDeletedAt', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'taskID' => 'getTaskID', - 'deletedAt' => 'getDeletedAt' + 'deletedAt' => 'getDeletedAt', ]; /** @@ -140,7 +141,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -175,6 +175,7 @@ public function listInvalidProperties() if ($this->container['deletedAt'] === null) { $invalidProperties[] = "'deletedAt' can't be null"; } + return $invalidProperties; } @@ -189,7 +190,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets taskID * @@ -203,7 +203,7 @@ public function getTaskID() /** * Sets taskID * - * @param int $taskID taskID of the indexing task to wait for. + * @param int $taskID taskID of the indexing task to wait for * * @return self */ @@ -227,7 +227,7 @@ public function getDeletedAt() /** * Sets deletedAt * - * @param \DateTime $deletedAt Date of deletion (ISO-8601 format). + * @param \DateTime $deletedAt date of deletion (ISO-8601 format) * * @return self */ @@ -240,9 +240,9 @@ public function setDeletedAt($deletedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -252,7 +252,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -281,7 +281,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -292,10 +292,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -326,4 +327,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php b/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php index 5f82ce427d..f889b32a35 100644 --- a/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php +++ b/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * DictionaryEntry Class Doc Comment * * @category Class * @description A dictionary entry. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -37,7 +38,7 @@ class DictionaryEntry implements ModelInterface, ArrayAccess, \JsonSerializable 'word' => 'string', 'words' => 'string[]', 'decomposition' => 'string[]', - 'state' => 'string' + 'state' => 'string', ]; /** @@ -53,7 +54,7 @@ class DictionaryEntry implements ModelInterface, ArrayAccess, \JsonSerializable 'word' => null, 'words' => null, 'decomposition' => null, - 'state' => null + 'state' => null, ]; /** @@ -88,7 +89,7 @@ public static function openAPIFormats() 'word' => 'word', 'words' => 'words', 'decomposition' => 'decomposition', - 'state' => 'state' + 'state' => 'state', ]; /** @@ -102,7 +103,7 @@ public static function openAPIFormats() 'word' => 'setWord', 'words' => 'setWords', 'decomposition' => 'setDecomposition', - 'state' => 'setState' + 'state' => 'setState', ]; /** @@ -116,7 +117,7 @@ public static function openAPIFormats() 'word' => 'getWord', 'words' => 'getWords', 'decomposition' => 'getDecomposition', - 'state' => 'getState' + 'state' => 'getState', ]; /** @@ -237,7 +238,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -251,7 +251,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID Unique identifier of the object. + * @param string $objectID unique identifier of the object * * @return self */ @@ -299,7 +299,7 @@ public function getWord() /** * Sets word * - * @param string|null $word The word of the dictionary entry. + * @param string|null $word the word of the dictionary entry * * @return self */ @@ -323,7 +323,7 @@ public function getWords() /** * Sets words * - * @param string[]|null $words The words of the dictionary entry. + * @param string[]|null $words the words of the dictionary entry * * @return self */ @@ -347,7 +347,7 @@ public function getDecomposition() /** * Sets decomposition * - * @param string[]|null $decomposition A decomposition of the word of the dictionary entry. + * @param string[]|null $decomposition a decomposition of the word of the dictionary entry * * @return self */ @@ -371,7 +371,7 @@ public function getState() /** * Sets state * - * @param string|null $state The state of the dictionary entry. + * @param string|null $state the state of the dictionary entry * * @return self */ @@ -394,9 +394,9 @@ public function setState($state) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -406,7 +406,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -435,7 +435,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -446,10 +446,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -480,4 +481,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php b/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php index fca61ce2e7..7f857ed561 100644 --- a/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php +++ b/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * DictionaryLanguage Class Doc Comment * * @category Class * @description Custom entries for a dictionary + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class DictionaryLanguage implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'nbCustomEntires' => 'int' + 'nbCustomEntires' => 'int', ]; /** @@ -43,7 +44,7 @@ class DictionaryLanguage implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'nbCustomEntires' => null + 'nbCustomEntires' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'nbCustomEntires' => 'nbCustomEntires' + 'nbCustomEntires' => 'nbCustomEntires', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'nbCustomEntires' => 'setNbCustomEntires' + 'nbCustomEntires' => 'setNbCustomEntires', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'nbCustomEntires' => 'getNbCustomEntires' + 'nbCustomEntires' => 'getNbCustomEntires', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -177,7 +177,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets nbCustomEntires * @@ -204,9 +203,9 @@ public function setNbCustomEntires($nbCustomEntires) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -216,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -245,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -256,10 +255,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -290,4 +290,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php b/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php index 598f8285e6..3d42992725 100644 --- a/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * DictionarySettingsRequest Class Doc Comment * * @category Class * @description Disable the builtin Algolia entries for a type of dictionary per language. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class DictionarySettingsRequest implements ModelInterface, ArrayAccess, \JsonSer * @var string[] */ protected static $openAPITypes = [ - 'disableStandardEntries' => '\Algolia\AlgoliaSearch\Model\StandardEntries' + 'disableStandardEntries' => '\Algolia\AlgoliaSearch\Model\StandardEntries', ]; /** @@ -43,7 +44,7 @@ class DictionarySettingsRequest implements ModelInterface, ArrayAccess, \JsonSer * @psalm-var array */ protected static $openAPIFormats = [ - 'disableStandardEntries' => null + 'disableStandardEntries' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'disableStandardEntries' => 'disableStandardEntries' + 'disableStandardEntries' => 'disableStandardEntries', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'disableStandardEntries' => 'setDisableStandardEntries' + 'disableStandardEntries' => 'setDisableStandardEntries', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'disableStandardEntries' => 'getDisableStandardEntries' + 'disableStandardEntries' => 'getDisableStandardEntries', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['disableStandardEntries'] === null) { $invalidProperties[] = "'disableStandardEntries' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets disableStandardEntries * @@ -207,9 +207,9 @@ public function setDisableStandardEntries($disableStandardEntries) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ErrorBase.php b/clients/algoliasearch-client-php/lib/Model/ErrorBase.php index 53696972f2..48b357631f 100644 --- a/clients/algoliasearch-client-php/lib/Model/ErrorBase.php +++ b/clients/algoliasearch-client-php/lib/Model/ErrorBase.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ErrorBase Class Doc Comment * * @category Class * @description Error. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class ErrorBase implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'message' => 'string' + 'message' => 'string', ]; /** @@ -43,7 +44,7 @@ class ErrorBase implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'message' => null + 'message' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'message' => 'message' + 'message' => 'message', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'message' => 'setMessage' + 'message' => 'setMessage', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'message' => 'getMessage' + 'message' => 'getMessage', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -177,7 +177,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets message * @@ -204,9 +203,9 @@ public function setMessage($message) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -216,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -245,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -256,10 +255,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -290,4 +290,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php index d946c1d7b9..e76e778e39 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetDictionarySettingsResponse Class Doc Comment @@ -31,7 +31,7 @@ class GetDictionarySettingsResponse implements ModelInterface, ArrayAccess, \Jso * @var string[] */ protected static $openAPITypes = [ - 'disableStandardEntries' => '\Algolia\AlgoliaSearch\Model\StandardEntries' + 'disableStandardEntries' => '\Algolia\AlgoliaSearch\Model\StandardEntries', ]; /** @@ -42,7 +42,7 @@ class GetDictionarySettingsResponse implements ModelInterface, ArrayAccess, \Jso * @psalm-var array */ protected static $openAPIFormats = [ - 'disableStandardEntries' => null + 'disableStandardEntries' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'disableStandardEntries' => 'disableStandardEntries' + 'disableStandardEntries' => 'disableStandardEntries', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'disableStandardEntries' => 'setDisableStandardEntries' + 'disableStandardEntries' => 'setDisableStandardEntries', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'disableStandardEntries' => 'getDisableStandardEntries' + 'disableStandardEntries' => 'getDisableStandardEntries', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['disableStandardEntries'] === null) { $invalidProperties[] = "'disableStandardEntries' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets disableStandardEntries * @@ -206,9 +205,9 @@ public function setDisableStandardEntries($disableStandardEntries) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php index c2e0033e7d..4f45944265 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetLogsResponse Class Doc Comment @@ -31,7 +31,7 @@ class GetLogsResponse implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'logs' => '\Algolia\AlgoliaSearch\Model\GetLogsResponseLogs[]' + 'logs' => '\Algolia\AlgoliaSearch\Model\GetLogsResponseLogs[]', ]; /** @@ -42,7 +42,7 @@ class GetLogsResponse implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'logs' => null + 'logs' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'logs' => 'logs' + 'logs' => 'logs', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'logs' => 'setLogs' + 'logs' => 'setLogs', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'logs' => 'getLogs' + 'logs' => 'getLogs', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['logs'] === null) { $invalidProperties[] = "'logs' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets logs * @@ -206,9 +205,9 @@ public function setLogs($logs) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php index a895461a73..8ae96c2c9f 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php +++ b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetLogsResponseInnerQueries Class Doc Comment @@ -33,7 +33,7 @@ class GetLogsResponseInnerQueries implements ModelInterface, ArrayAccess, \JsonS protected static $openAPITypes = [ 'indexName' => 'string', 'userToken' => 'string', - 'queryId' => 'string' + 'queryId' => 'string', ]; /** @@ -46,7 +46,7 @@ class GetLogsResponseInnerQueries implements ModelInterface, ArrayAccess, \JsonS protected static $openAPIFormats = [ 'indexName' => null, 'userToken' => null, - 'queryId' => null + 'queryId' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'indexName' => 'index_name', 'userToken' => 'user_token', - 'queryId' => 'query_id' + 'queryId' => 'query_id', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'indexName' => 'setIndexName', 'userToken' => 'setUserToken', - 'queryId' => 'setQueryId' + 'queryId' => 'setQueryId', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'indexName' => 'getIndexName', 'userToken' => 'getUserToken', - 'queryId' => 'getQueryId' + 'queryId' => 'getQueryId', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -188,7 +187,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets indexName * @@ -202,7 +200,7 @@ public function getIndexName() /** * Sets indexName * - * @param string|null $indexName Index targeted by the query. + * @param string|null $indexName index targeted by the query * * @return self */ @@ -226,7 +224,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken User identifier. + * @param string|null $userToken user identifier * * @return self */ @@ -250,7 +248,7 @@ public function getQueryId() /** * Sets queryId * - * @param string|null $queryId QueryID for the given query. + * @param string|null $queryId queryID for the given query * * @return self */ @@ -263,9 +261,9 @@ public function setQueryId($queryId) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -275,7 +273,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -304,7 +302,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -315,10 +313,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -349,4 +348,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php index 1c30d989b3..20a071dbf4 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php +++ b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetLogsResponseLogs Class Doc Comment @@ -45,7 +45,7 @@ class GetLogsResponseLogs implements ModelInterface, ArrayAccess, \JsonSerializa 'index' => 'string', 'queryParams' => 'string', 'queryNbHits' => 'string', - 'innerQueries' => '\Algolia\AlgoliaSearch\Model\GetLogsResponseInnerQueries[]' + 'innerQueries' => '\Algolia\AlgoliaSearch\Model\GetLogsResponseInnerQueries[]', ]; /** @@ -70,7 +70,7 @@ class GetLogsResponseLogs implements ModelInterface, ArrayAccess, \JsonSerializa 'index' => null, 'queryParams' => null, 'queryNbHits' => null, - 'innerQueries' => null + 'innerQueries' => null, ]; /** @@ -114,7 +114,7 @@ public static function openAPIFormats() 'index' => 'index', 'queryParams' => 'query_params', 'queryNbHits' => 'query_nb_hits', - 'innerQueries' => 'inner_queries' + 'innerQueries' => 'inner_queries', ]; /** @@ -137,7 +137,7 @@ public static function openAPIFormats() 'index' => 'setIndex', 'queryParams' => 'setQueryParams', 'queryNbHits' => 'setQueryNbHits', - 'innerQueries' => 'setInnerQueries' + 'innerQueries' => 'setInnerQueries', ]; /** @@ -160,7 +160,7 @@ public static function openAPIFormats() 'index' => 'getIndex', 'queryParams' => 'getQueryParams', 'queryNbHits' => 'getQueryNbHits', - 'innerQueries' => 'getInnerQueries' + 'innerQueries' => 'getInnerQueries', ]; /** @@ -204,7 +204,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -279,6 +278,7 @@ public function listInvalidProperties() if ($this->container['processingTimeMs'] === null) { $invalidProperties[] = "'processingTimeMs' can't be null"; } + return $invalidProperties; } @@ -293,7 +293,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets timestamp * @@ -307,7 +306,7 @@ public function getTimestamp() /** * Sets timestamp * - * @param string $timestamp Timestamp in ISO-8601 format. + * @param string $timestamp timestamp in ISO-8601 format * * @return self */ @@ -331,7 +330,7 @@ public function getMethod() /** * Sets method * - * @param string $method HTTP method of the perfomed request. + * @param string $method HTTP method of the perfomed request * * @return self */ @@ -355,7 +354,7 @@ public function getAnswerCode() /** * Sets answerCode * - * @param string $answerCode HTTP response code. + * @param string $answerCode HTTP response code * * @return self */ @@ -427,7 +426,7 @@ public function getUrl() /** * Sets url * - * @param string $url Request URL. + * @param string $url request URL * * @return self */ @@ -451,7 +450,7 @@ public function getIp() /** * Sets ip * - * @param string $ip IP of the client which perfomed the request. + * @param string $ip IP of the client which perfomed the request * * @return self */ @@ -475,7 +474,7 @@ public function getQueryHeaders() /** * Sets queryHeaders * - * @param string $queryHeaders Request Headers (API Key is obfuscated). + * @param string $queryHeaders request Headers (API Key is obfuscated) * * @return self */ @@ -499,7 +498,7 @@ public function getSha1() /** * Sets sha1 * - * @param string $sha1 SHA1 signature of the log entry. + * @param string $sha1 SHA1 signature of the log entry * * @return self */ @@ -523,7 +522,7 @@ public function getNbApiCalls() /** * Sets nbApiCalls * - * @param string $nbApiCalls Number of API calls. + * @param string $nbApiCalls number of API calls * * @return self */ @@ -571,7 +570,7 @@ public function getIndex() /** * Sets index * - * @param string|null $index Index targeted by the query. + * @param string|null $index index targeted by the query * * @return self */ @@ -595,7 +594,7 @@ public function getQueryParams() /** * Sets queryParams * - * @param string|null $queryParams Query parameters sent with the request. + * @param string|null $queryParams query parameters sent with the request * * @return self */ @@ -619,7 +618,7 @@ public function getQueryNbHits() /** * Sets queryNbHits * - * @param string|null $queryNbHits Number of hits returned for the query. + * @param string|null $queryNbHits number of hits returned for the query * * @return self */ @@ -643,7 +642,7 @@ public function getInnerQueries() /** * Sets innerQueries * - * @param \Algolia\AlgoliaSearch\Model\GetLogsResponseInnerQueries[]|null $innerQueries Array of all performed queries for the given request. + * @param \Algolia\AlgoliaSearch\Model\GetLogsResponseInnerQueries[]|null $innerQueries array of all performed queries for the given request * * @return self */ @@ -656,9 +655,9 @@ public function setInnerQueries($innerQueries) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -668,7 +667,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -697,7 +696,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -708,10 +707,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -742,4 +742,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php b/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php index 7e4184184d..7d36088284 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetObjectsObject Class Doc Comment * * @category Class * @description The `getObjects` requests. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class GetObjectsObject implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'requests' => '\Algolia\AlgoliaSearch\Model\MultipleGetObjectsObject[]' + 'requests' => '\Algolia\AlgoliaSearch\Model\MultipleGetObjectsObject[]', ]; /** @@ -43,7 +44,7 @@ class GetObjectsObject implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'requests' => null + 'requests' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'requests' => 'requests' + 'requests' => 'requests', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'requests' => 'setRequests' + 'requests' => 'setRequests', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'requests' => 'getRequests' + 'requests' => 'getRequests', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -177,7 +177,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets requests * @@ -204,9 +203,9 @@ public function setRequests($requests) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -216,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -245,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -256,10 +255,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -290,4 +290,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php index 3e54417691..fb8d8fcba6 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetObjectsResponse Class Doc Comment @@ -31,7 +31,7 @@ class GetObjectsResponse implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'results' => 'object[]' + 'results' => 'object[]', ]; /** @@ -42,7 +42,7 @@ class GetObjectsResponse implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'results' => null + 'results' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'results' => 'results' + 'results' => 'results', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'results' => 'setResults' + 'results' => 'setResults', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'results' => 'getResults' + 'results' => 'getResults', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -176,7 +175,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets results * @@ -190,7 +188,7 @@ public function getResults() /** * Sets results * - * @param object[]|null $results List of results fetched. + * @param object[]|null $results list of results fetched * * @return self */ @@ -203,9 +201,9 @@ public function setResults($results) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -215,7 +213,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -244,7 +242,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -255,10 +253,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -289,4 +288,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php b/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php index 5f11816c35..ae9e7c2f3c 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetTaskResponse Class Doc Comment @@ -31,7 +31,7 @@ class GetTaskResponse implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'status' => 'string' + 'status' => 'string', ]; /** @@ -42,7 +42,7 @@ class GetTaskResponse implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'status' => null + 'status' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'status' => 'status' + 'status' => 'status', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'status' => 'setStatus' + 'status' => 'setStatus', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'status' => 'getStatus' + 'status' => 'getStatus', ]; /** @@ -203,7 +203,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets status * @@ -240,9 +239,9 @@ public function setStatus($status) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -252,7 +251,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -281,7 +280,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -292,10 +291,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -326,4 +326,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php index 138d5abf2f..0c381becc3 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetTopUserIdsResponse Class Doc Comment * * @category Class * @description Array of userIDs and clusters. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class GetTopUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSeriali * @var string[] */ protected static $openAPITypes = [ - 'topUsers' => 'array[]' + 'topUsers' => 'array[]', ]; /** @@ -43,7 +44,7 @@ class GetTopUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSeriali * @psalm-var array */ protected static $openAPIFormats = [ - 'topUsers' => null + 'topUsers' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'topUsers' => 'topUsers' + 'topUsers' => 'topUsers', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'topUsers' => 'setTopUsers' + 'topUsers' => 'setTopUsers', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'topUsers' => 'getTopUsers' + 'topUsers' => 'getTopUsers', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['topUsers'] === null) { $invalidProperties[] = "'topUsers' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets topUsers * @@ -194,7 +194,7 @@ public function getTopUsers() /** * Sets topUsers * - * @param array[] $topUsers Mapping of cluster names to top users. + * @param array[] $topUsers Mapping of cluster names to top users * * @return self */ @@ -207,9 +207,9 @@ public function setTopUsers($topUsers) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/HighlightResult.php b/clients/algoliasearch-client-php/lib/Model/HighlightResult.php index 129b4740ed..5fc77c2e70 100644 --- a/clients/algoliasearch-client-php/lib/Model/HighlightResult.php +++ b/clients/algoliasearch-client-php/lib/Model/HighlightResult.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * HighlightResult Class Doc Comment * * @category Class * @description Highlighted attributes. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +36,7 @@ class HighlightResult implements ModelInterface, ArrayAccess, \JsonSerializable 'value' => 'string', 'matchLevel' => 'string', 'matchedWords' => 'string[]', - 'fullyHighlighted' => 'bool' + 'fullyHighlighted' => 'bool', ]; /** @@ -49,7 +50,7 @@ class HighlightResult implements ModelInterface, ArrayAccess, \JsonSerializable 'value' => null, 'matchLevel' => null, 'matchedWords' => null, - 'fullyHighlighted' => null + 'fullyHighlighted' => null, ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() 'value' => 'value', 'matchLevel' => 'matchLevel', 'matchedWords' => 'matchedWords', - 'fullyHighlighted' => 'fullyHighlighted' + 'fullyHighlighted' => 'fullyHighlighted', ]; /** @@ -94,7 +95,7 @@ public static function openAPIFormats() 'value' => 'setValue', 'matchLevel' => 'setMatchLevel', 'matchedWords' => 'setMatchedWords', - 'fullyHighlighted' => 'setFullyHighlighted' + 'fullyHighlighted' => 'setFullyHighlighted', ]; /** @@ -106,7 +107,7 @@ public static function openAPIFormats() 'value' => 'getValue', 'matchLevel' => 'getMatchLevel', 'matchedWords' => 'getMatchedWords', - 'fullyHighlighted' => 'getFullyHighlighted' + 'fullyHighlighted' => 'getFullyHighlighted', ]; /** @@ -221,7 +222,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets value * @@ -235,7 +235,7 @@ public function getValue() /** * Sets value * - * @param string|null $value Markup text with occurrences highlighted. + * @param string|null $value markup text with occurrences highlighted * * @return self */ @@ -259,7 +259,7 @@ public function getMatchLevel() /** * Sets matchLevel * - * @param string|null $matchLevel Indicates how well the attribute matched the search query. + * @param string|null $matchLevel indicates how well the attribute matched the search query * * @return self */ @@ -293,7 +293,7 @@ public function getMatchedWords() /** * Sets matchedWords * - * @param string[]|null $matchedWords List of words from the query that matched the object. + * @param string[]|null $matchedWords list of words from the query that matched the object * * @return self */ @@ -317,7 +317,7 @@ public function getFullyHighlighted() /** * Sets fullyHighlighted * - * @param bool|null $fullyHighlighted Whether the entire attribute value is highlighted. + * @param bool|null $fullyHighlighted whether the entire attribute value is highlighted * * @return self */ @@ -330,9 +330,9 @@ public function setFullyHighlighted($fullyHighlighted) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -342,7 +342,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -371,7 +371,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -382,10 +382,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -416,4 +417,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Index.php b/clients/algoliasearch-client-php/lib/Model/Index.php index 03a2871dcd..aa437874bf 100644 --- a/clients/algoliasearch-client-php/lib/Model/Index.php +++ b/clients/algoliasearch-client-php/lib/Model/Index.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Index Class Doc Comment @@ -41,7 +41,7 @@ class Index implements ModelInterface, ArrayAccess, \JsonSerializable 'numberOfPendingTask' => 'int', 'pendingTask' => 'bool', 'primary' => 'string', - 'replicas' => 'string[]' + 'replicas' => 'string[]', ]; /** @@ -62,7 +62,7 @@ class Index implements ModelInterface, ArrayAccess, \JsonSerializable 'numberOfPendingTask' => null, 'pendingTask' => null, 'primary' => null, - 'replicas' => null + 'replicas' => null, ]; /** @@ -102,7 +102,7 @@ public static function openAPIFormats() 'numberOfPendingTask' => 'numberOfPendingTask', 'pendingTask' => 'pendingTask', 'primary' => 'primary', - 'replicas' => 'replicas' + 'replicas' => 'replicas', ]; /** @@ -121,7 +121,7 @@ public static function openAPIFormats() 'numberOfPendingTask' => 'setNumberOfPendingTask', 'pendingTask' => 'setPendingTask', 'primary' => 'setPrimary', - 'replicas' => 'setReplicas' + 'replicas' => 'setReplicas', ]; /** @@ -140,7 +140,7 @@ public static function openAPIFormats() 'numberOfPendingTask' => 'getNumberOfPendingTask', 'pendingTask' => 'getPendingTask', 'primary' => 'getPrimary', - 'replicas' => 'getReplicas' + 'replicas' => 'getReplicas', ]; /** @@ -184,7 +184,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -246,6 +245,7 @@ public function listInvalidProperties() if ($this->container['pendingTask'] === null) { $invalidProperties[] = "'pendingTask' can't be null"; } + return $invalidProperties; } @@ -260,7 +260,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -274,7 +273,7 @@ public function getName() /** * Sets name * - * @param string $name Index name. + * @param string $name index name * * @return self */ @@ -322,7 +321,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -346,7 +345,7 @@ public function getEntries() /** * Sets entries * - * @param int $entries Number of records contained in the index. + * @param int $entries number of records contained in the index * * @return self */ @@ -370,7 +369,7 @@ public function getDataSize() /** * Sets dataSize * - * @param int $dataSize Number of bytes of the index in minified format. + * @param int $dataSize number of bytes of the index in minified format * * @return self */ @@ -394,7 +393,7 @@ public function getFileSize() /** * Sets fileSize * - * @param int $fileSize Number of bytes of the index binary file. + * @param int $fileSize number of bytes of the index binary file * * @return self */ @@ -527,9 +526,9 @@ public function setReplicas($replicas) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -539,7 +538,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -568,7 +567,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -579,10 +578,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -613,4 +613,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/IndexSettings.php b/clients/algoliasearch-client-php/lib/Model/IndexSettings.php index 01ea27278c..c409228d27 100644 --- a/clients/algoliasearch-client-php/lib/Model/IndexSettings.php +++ b/clients/algoliasearch-client-php/lib/Model/IndexSettings.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * IndexSettings Class Doc Comment * * @category Class * @description The Algolia index settings. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -87,7 +88,7 @@ class IndexSettings implements ModelInterface, ArrayAccess, \JsonSerializable 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object' + 'renderingContent' => 'object', ]; /** @@ -153,7 +154,7 @@ class IndexSettings implements ModelInterface, ArrayAccess, \JsonSerializable 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null + 'renderingContent' => null, ]; /** @@ -238,7 +239,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent' + 'renderingContent' => 'renderingContent', ]; /** @@ -302,7 +303,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent' + 'renderingContent' => 'setRenderingContent', ]; /** @@ -366,7 +367,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent' + 'renderingContent' => 'getRenderingContent', ]; /** @@ -667,7 +668,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets replicas * @@ -681,7 +681,7 @@ public function getReplicas() /** * Sets replicas * - * @param string[]|null $replicas Creates replicas, exact copies of an index. + * @param string[]|null $replicas creates replicas, exact copies of an index * * @return self */ @@ -705,7 +705,7 @@ public function getPaginationLimitedTo() /** * Sets paginationLimitedTo * - * @param int|null $paginationLimitedTo Set the maximum number of hits accessible via pagination. + * @param int|null $paginationLimitedTo set the maximum number of hits accessible via pagination * * @return self */ @@ -729,7 +729,7 @@ public function getDisableTypoToleranceOnWords() /** * Sets disableTypoToleranceOnWords * - * @param string[]|null $disableTypoToleranceOnWords A list of words for which you want to turn off typo tolerance. + * @param string[]|null $disableTypoToleranceOnWords a list of words for which you want to turn off typo tolerance * * @return self */ @@ -753,7 +753,7 @@ public function getAttributesToTransliterate() /** * Sets attributesToTransliterate * - * @param string[]|null $attributesToTransliterate Specify on which attributes to apply transliteration. + * @param string[]|null $attributesToTransliterate specify on which attributes to apply transliteration * * @return self */ @@ -777,7 +777,7 @@ public function getCamelCaseAttributes() /** * Sets camelCaseAttributes * - * @param string[]|null $camelCaseAttributes List of attributes on which to do a decomposition of camel case words. + * @param string[]|null $camelCaseAttributes list of attributes on which to do a decomposition of camel case words * * @return self */ @@ -801,7 +801,7 @@ public function getDecompoundedAttributes() /** * Sets decompoundedAttributes * - * @param object|null $decompoundedAttributes Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding. + * @param object|null $decompoundedAttributes specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding * * @return self */ @@ -825,7 +825,7 @@ public function getIndexLanguages() /** * Sets indexLanguages * - * @param string[]|null $indexLanguages Sets the languages at the index level for language-specific processing such as tokenization and normalization. + * @param string[]|null $indexLanguages sets the languages at the index level for language-specific processing such as tokenization and normalization * * @return self */ @@ -849,7 +849,7 @@ public function getFilterPromotes() /** * Sets filterPromotes * - * @param bool|null $filterPromotes Whether promoted results should match the filters of the current search, except for geographic filters. + * @param bool|null $filterPromotes whether promoted results should match the filters of the current search, except for geographic filters * * @return self */ @@ -873,7 +873,7 @@ public function getDisablePrefixOnAttributes() /** * Sets disablePrefixOnAttributes * - * @param string[]|null $disablePrefixOnAttributes List of attributes on which you want to disable prefix matching. + * @param string[]|null $disablePrefixOnAttributes list of attributes on which you want to disable prefix matching * * @return self */ @@ -897,7 +897,7 @@ public function getAllowCompressionOfIntegerArray() /** * Sets allowCompressionOfIntegerArray * - * @param bool|null $allowCompressionOfIntegerArray Enables compression of large integer arrays. + * @param bool|null $allowCompressionOfIntegerArray enables compression of large integer arrays * * @return self */ @@ -921,7 +921,7 @@ public function getNumericAttributesForFiltering() /** * Sets numericAttributesForFiltering * - * @param string[]|null $numericAttributesForFiltering List of numeric attributes that can be used as numerical filters. + * @param string[]|null $numericAttributesForFiltering list of numeric attributes that can be used as numerical filters * * @return self */ @@ -945,7 +945,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData Lets you store custom data in your indices. + * @param object|null $userData lets you store custom data in your indices * * @return self */ @@ -969,7 +969,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes The complete list of attributes used for searching. + * @param string[]|null $searchableAttributes the complete list of attributes used for searching * * @return self */ @@ -993,7 +993,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. + * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting * * @return self */ @@ -1017,7 +1017,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. + * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time * * @return self */ @@ -1041,7 +1041,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. + * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve * * @return self */ @@ -1065,7 +1065,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. + * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes * * @return self */ @@ -1089,7 +1089,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking Controls how Algolia should sort your results. + * @param string[]|null $ranking controls how Algolia should sort your results * * @return self */ @@ -1113,7 +1113,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking Specifies the custom ranking criterion. + * @param string[]|null $customRanking specifies the custom ranking criterion * * @return self */ @@ -1137,7 +1137,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. + * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results * * @return self */ @@ -1161,7 +1161,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight List of attributes to highlight. + * @param string[]|null $attributesToHighlight list of attributes to highlight * * @return self */ @@ -1185,7 +1185,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. + * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet * * @return self */ @@ -1209,7 +1209,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results * * @return self */ @@ -1233,7 +1233,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results * * @return self */ @@ -1257,7 +1257,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. + * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated * * @return self */ @@ -1281,7 +1281,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. + * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query * * @return self */ @@ -1305,7 +1305,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -1329,7 +1329,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. + * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo * * @return self */ @@ -1353,7 +1353,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. + * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos * * @return self */ @@ -1377,7 +1377,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. + * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied * * @return self */ @@ -1411,7 +1411,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. + * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string * * @return self */ @@ -1435,7 +1435,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. + * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance * * @return self */ @@ -1459,7 +1459,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex Control which separators are indexed. + * @param string|null $separatorsToIndex control which separators are indexed * * @return self */ @@ -1483,7 +1483,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. + * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms * * @return self */ @@ -1507,7 +1507,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. + * @param string|null $removeStopWords removes stop (common) words from the query before executing it * * @return self */ @@ -1531,7 +1531,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. + * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize * * @return self */ @@ -1555,7 +1555,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. + * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection * * @return self */ @@ -1579,7 +1579,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. + * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query * * @return self */ @@ -1603,7 +1603,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules Whether Rules should be globally enabled. + * @param bool|null $enableRules whether Rules should be globally enabled * * @return self */ @@ -1627,7 +1627,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization Enable the Personalization feature. + * @param bool|null $enablePersonalization enable the Personalization feature * * @return self */ @@ -1651,7 +1651,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType Controls if and how query words are interpreted as prefixes. + * @param string|null $queryType controls if and how query words are interpreted as prefixes * * @return self */ @@ -1685,7 +1685,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. + * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits * * @return self */ @@ -1719,7 +1719,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax Enables the advanced query syntax. + * @param bool|null $advancedSyntax enables the advanced query syntax * * @return self */ @@ -1743,7 +1743,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. + * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query * * @return self */ @@ -1767,7 +1767,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. + * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion * * @return self */ @@ -1791,7 +1791,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. + * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word * * @return self */ @@ -1825,7 +1825,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. + * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion * * @return self */ @@ -1858,7 +1858,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. + * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled * * @return self */ @@ -1891,7 +1891,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct Enables de-duplication or grouping of results. + * @param int|null $distinct enables de-duplication or grouping of results * * @return self */ @@ -1923,7 +1923,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. + * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search * * @return self */ @@ -1947,7 +1947,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. + * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself * * @return self */ @@ -1971,7 +1971,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity Precision of the proximity ranking criterion. + * @param int|null $minProximity precision of the proximity ranking criterion * * @return self */ @@ -2056,7 +2056,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. + * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage * * @return self */ @@ -2093,9 +2093,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -2105,7 +2105,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -2134,7 +2134,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -2145,10 +2145,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -2179,4 +2180,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php b/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php index 1672b402c3..7b3c52043e 100644 --- a/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * IndexSettingsAsSearchParams Class Doc Comment @@ -74,7 +74,7 @@ class IndexSettingsAsSearchParams implements ModelInterface, ArrayAccess, \JsonS 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object' + 'renderingContent' => 'object', ]; /** @@ -128,7 +128,7 @@ class IndexSettingsAsSearchParams implements ModelInterface, ArrayAccess, \JsonS 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null + 'renderingContent' => null, ]; /** @@ -201,7 +201,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent' + 'renderingContent' => 'renderingContent', ]; /** @@ -253,7 +253,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent' + 'renderingContent' => 'setRenderingContent', ]; /** @@ -305,7 +305,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent' + 'renderingContent' => 'getRenderingContent', ]; /** @@ -594,7 +594,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets searchableAttributes * @@ -608,7 +607,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes The complete list of attributes used for searching. + * @param string[]|null $searchableAttributes the complete list of attributes used for searching * * @return self */ @@ -632,7 +631,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. + * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting * * @return self */ @@ -656,7 +655,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. + * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time * * @return self */ @@ -680,7 +679,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. + * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve * * @return self */ @@ -704,7 +703,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. + * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes * * @return self */ @@ -728,7 +727,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking Controls how Algolia should sort your results. + * @param string[]|null $ranking controls how Algolia should sort your results * * @return self */ @@ -752,7 +751,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking Specifies the custom ranking criterion. + * @param string[]|null $customRanking specifies the custom ranking criterion * * @return self */ @@ -776,7 +775,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. + * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results * * @return self */ @@ -800,7 +799,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight List of attributes to highlight. + * @param string[]|null $attributesToHighlight list of attributes to highlight * * @return self */ @@ -824,7 +823,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. + * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet * * @return self */ @@ -848,7 +847,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results * * @return self */ @@ -872,7 +871,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results * * @return self */ @@ -896,7 +895,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. + * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated * * @return self */ @@ -920,7 +919,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. + * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query * * @return self */ @@ -944,7 +943,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -968,7 +967,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. + * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo * * @return self */ @@ -992,7 +991,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. + * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos * * @return self */ @@ -1016,7 +1015,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. + * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied * * @return self */ @@ -1050,7 +1049,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. + * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string * * @return self */ @@ -1074,7 +1073,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. + * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance * * @return self */ @@ -1098,7 +1097,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex Control which separators are indexed. + * @param string|null $separatorsToIndex control which separators are indexed * * @return self */ @@ -1122,7 +1121,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. + * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms * * @return self */ @@ -1146,7 +1145,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. + * @param string|null $removeStopWords removes stop (common) words from the query before executing it * * @return self */ @@ -1170,7 +1169,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. + * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize * * @return self */ @@ -1194,7 +1193,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. + * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection * * @return self */ @@ -1218,7 +1217,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. + * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query * * @return self */ @@ -1242,7 +1241,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules Whether Rules should be globally enabled. + * @param bool|null $enableRules whether Rules should be globally enabled * * @return self */ @@ -1266,7 +1265,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization Enable the Personalization feature. + * @param bool|null $enablePersonalization enable the Personalization feature * * @return self */ @@ -1290,7 +1289,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType Controls if and how query words are interpreted as prefixes. + * @param string|null $queryType controls if and how query words are interpreted as prefixes * * @return self */ @@ -1324,7 +1323,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. + * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits * * @return self */ @@ -1358,7 +1357,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax Enables the advanced query syntax. + * @param bool|null $advancedSyntax enables the advanced query syntax * * @return self */ @@ -1382,7 +1381,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. + * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query * * @return self */ @@ -1406,7 +1405,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. + * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion * * @return self */ @@ -1430,7 +1429,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. + * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word * * @return self */ @@ -1464,7 +1463,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. + * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion * * @return self */ @@ -1497,7 +1496,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. + * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled * * @return self */ @@ -1530,7 +1529,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct Enables de-duplication or grouping of results. + * @param int|null $distinct enables de-duplication or grouping of results * * @return self */ @@ -1562,7 +1561,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. + * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search * * @return self */ @@ -1586,7 +1585,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. + * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself * * @return self */ @@ -1610,7 +1609,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity Precision of the proximity ranking criterion. + * @param int|null $minProximity precision of the proximity ranking criterion * * @return self */ @@ -1695,7 +1694,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. + * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage * * @return self */ @@ -1732,9 +1731,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -1744,7 +1743,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -1773,7 +1772,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -1784,10 +1783,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -1818,4 +1818,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/KeyObject.php b/clients/algoliasearch-client-php/lib/Model/KeyObject.php index 68429a2485..1cbaf863a3 100644 --- a/clients/algoliasearch-client-php/lib/Model/KeyObject.php +++ b/clients/algoliasearch-client-php/lib/Model/KeyObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * KeyObject Class Doc Comment @@ -39,7 +39,7 @@ class KeyObject implements ModelInterface, ArrayAccess, \JsonSerializable 'queryParameters' => 'string', 'referers' => 'string[]', 'validity' => 'int', - 'createdAt' => '\DateTime' + 'createdAt' => '\DateTime', ]; /** @@ -58,7 +58,7 @@ class KeyObject implements ModelInterface, ArrayAccess, \JsonSerializable 'queryParameters' => null, 'referers' => null, 'validity' => null, - 'createdAt' => 'date-time' + 'createdAt' => 'date-time', ]; /** @@ -96,7 +96,7 @@ public static function openAPIFormats() 'queryParameters' => 'queryParameters', 'referers' => 'referers', 'validity' => 'validity', - 'createdAt' => 'createdAt' + 'createdAt' => 'createdAt', ]; /** @@ -113,7 +113,7 @@ public static function openAPIFormats() 'queryParameters' => 'setQueryParameters', 'referers' => 'setReferers', 'validity' => 'setValidity', - 'createdAt' => 'setCreatedAt' + 'createdAt' => 'setCreatedAt', ]; /** @@ -130,7 +130,7 @@ public static function openAPIFormats() 'queryParameters' => 'getQueryParameters', 'referers' => 'getReferers', 'validity' => 'getValidity', - 'createdAt' => 'getCreatedAt' + 'createdAt' => 'getCreatedAt', ]; /** @@ -255,6 +255,7 @@ public function listInvalidProperties() if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } + return $invalidProperties; } @@ -269,7 +270,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets acl * @@ -283,7 +283,7 @@ public function getAcl() /** * Sets acl * - * @param string[] $acl Set of permissions associated with the key. + * @param string[] $acl set of permissions associated with the key * * @return self */ @@ -388,7 +388,7 @@ public function getMaxQueriesPerIPPerHour() /** * Sets maxQueriesPerIPPerHour * - * @param int|null $maxQueriesPerIPPerHour Maximum number of API calls per hour allowed from a given IP address or a user token. + * @param int|null $maxQueriesPerIPPerHour maximum number of API calls per hour allowed from a given IP address or a user token * * @return self */ @@ -484,7 +484,7 @@ public function getCreatedAt() /** * Sets createdAt * - * @param \DateTime $createdAt Date of creation (ISO-8601 format). + * @param \DateTime $createdAt date of creation (ISO-8601 format) * * @return self */ @@ -497,9 +497,9 @@ public function setCreatedAt($createdAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -509,7 +509,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -538,7 +538,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -549,10 +549,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -583,4 +584,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Languages.php b/clients/algoliasearch-client-php/lib/Model/Languages.php index 373bef4ce2..da2866454c 100644 --- a/clients/algoliasearch-client-php/lib/Model/Languages.php +++ b/clients/algoliasearch-client-php/lib/Model/Languages.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Languages Class Doc Comment * * @category Class * @description A dictionary language. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class Languages implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'plurals' => '\Algolia\AlgoliaSearch\Model\DictionaryLanguage', 'stopwords' => '\Algolia\AlgoliaSearch\Model\DictionaryLanguage', - 'compounds' => '\Algolia\AlgoliaSearch\Model\DictionaryLanguage' + 'compounds' => '\Algolia\AlgoliaSearch\Model\DictionaryLanguage', ]; /** @@ -47,7 +48,7 @@ class Languages implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'plurals' => null, 'stopwords' => null, - 'compounds' => null + 'compounds' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'plurals' => 'plurals', 'stopwords' => 'stopwords', - 'compounds' => 'compounds' + 'compounds' => 'compounds', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'plurals' => 'setPlurals', 'stopwords' => 'setStopwords', - 'compounds' => 'setCompounds' + 'compounds' => 'setCompounds', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'plurals' => 'getPlurals', 'stopwords' => 'getStopwords', - 'compounds' => 'getCompounds' + 'compounds' => 'getCompounds', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -184,6 +184,7 @@ public function listInvalidProperties() if ($this->container['compounds'] === null) { $invalidProperties[] = "'compounds' can't be null"; } + return $invalidProperties; } @@ -198,7 +199,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets plurals * @@ -273,9 +273,9 @@ public function setCompounds($compounds) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -285,7 +285,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -314,7 +314,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -325,10 +325,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -359,4 +360,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php b/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php index 6ffa69ff60..217841d9e2 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ListApiKeysResponse Class Doc Comment @@ -31,7 +31,7 @@ class ListApiKeysResponse implements ModelInterface, ArrayAccess, \JsonSerializa * @var string[] */ protected static $openAPITypes = [ - 'keys' => '\Algolia\AlgoliaSearch\Model\KeyObject[]' + 'keys' => '\Algolia\AlgoliaSearch\Model\KeyObject[]', ]; /** @@ -42,7 +42,7 @@ class ListApiKeysResponse implements ModelInterface, ArrayAccess, \JsonSerializa * @psalm-var array */ protected static $openAPIFormats = [ - 'keys' => null + 'keys' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'keys' => 'keys' + 'keys' => 'keys', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'keys' => 'setKeys' + 'keys' => 'setKeys', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'keys' => 'getKeys' + 'keys' => 'getKeys', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['keys'] === null) { $invalidProperties[] = "'keys' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets keys * @@ -193,7 +192,7 @@ public function getKeys() /** * Sets keys * - * @param \Algolia\AlgoliaSearch\Model\KeyObject[] $keys List of api keys. + * @param \Algolia\AlgoliaSearch\Model\KeyObject[] $keys list of api keys * * @return self */ @@ -206,9 +205,9 @@ public function setKeys($keys) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php b/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php index da37124416..32e7515265 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ListClustersResponse Class Doc Comment * * @category Class * @description Array of clusters. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class ListClustersResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'topUsers' => 'string[]' + 'topUsers' => 'string[]', ]; /** @@ -43,7 +44,7 @@ class ListClustersResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'topUsers' => null + 'topUsers' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'topUsers' => 'topUsers' + 'topUsers' => 'topUsers', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'topUsers' => 'setTopUsers' + 'topUsers' => 'setTopUsers', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'topUsers' => 'getTopUsers' + 'topUsers' => 'getTopUsers', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['topUsers'] === null) { $invalidProperties[] = "'topUsers' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets topUsers * @@ -194,7 +194,7 @@ public function getTopUsers() /** * Sets topUsers * - * @param string[] $topUsers Mapping of cluster names to top users. + * @param string[] $topUsers mapping of cluster names to top users * * @return self */ @@ -207,9 +207,9 @@ public function setTopUsers($topUsers) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php b/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php index 2177f69f96..984b0f060d 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ListIndicesResponse Class Doc Comment @@ -32,7 +32,7 @@ class ListIndicesResponse implements ModelInterface, ArrayAccess, \JsonSerializa */ protected static $openAPITypes = [ 'items' => '\Algolia\AlgoliaSearch\Model\Index[]', - 'nbPages' => 'int' + 'nbPages' => 'int', ]; /** @@ -44,7 +44,7 @@ class ListIndicesResponse implements ModelInterface, ArrayAccess, \JsonSerializa */ protected static $openAPIFormats = [ 'items' => null, - 'nbPages' => null + 'nbPages' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'items' => 'items', - 'nbPages' => 'nbPages' + 'nbPages' => 'nbPages', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'items' => 'setItems', - 'nbPages' => 'setNbPages' + 'nbPages' => 'setNbPages', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'items' => 'getItems', - 'nbPages' => 'getNbPages' + 'nbPages' => 'getNbPages', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -182,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets items * @@ -196,7 +194,7 @@ public function getItems() /** * Sets items * - * @param \Algolia\AlgoliaSearch\Model\Index[]|null $items List of the fetched indices. + * @param \Algolia\AlgoliaSearch\Model\Index[]|null $items list of the fetched indices * * @return self */ @@ -220,7 +218,7 @@ public function getNbPages() /** * Sets nbPages * - * @param int|null $nbPages Number of pages. + * @param int|null $nbPages number of pages * * @return self */ @@ -233,9 +231,9 @@ public function setNbPages($nbPages) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -245,7 +243,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -274,7 +272,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -285,10 +283,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -319,4 +318,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php index 64b26c1d72..0030ae0d27 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ListUserIdsResponse Class Doc Comment * * @category Class * @description UserIDs data. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class ListUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSerializa * @var string[] */ protected static $openAPITypes = [ - 'userIDs' => '\Algolia\AlgoliaSearch\Model\UserId[]' + 'userIDs' => '\Algolia\AlgoliaSearch\Model\UserId[]', ]; /** @@ -43,7 +44,7 @@ class ListUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSerializa * @psalm-var array */ protected static $openAPIFormats = [ - 'userIDs' => null + 'userIDs' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'userIDs' => 'userIDs' + 'userIDs' => 'userIDs', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'userIDs' => 'setUserIDs' + 'userIDs' => 'setUserIDs', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'userIDs' => 'getUserIDs' + 'userIDs' => 'getUserIDs', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['userIDs'] === null) { $invalidProperties[] = "'userIDs' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets userIDs * @@ -194,7 +194,7 @@ public function getUserIDs() /** * Sets userIDs * - * @param \Algolia\AlgoliaSearch\Model\UserId[] $userIDs List of userIDs. + * @param \Algolia\AlgoliaSearch\Model\UserId[] $userIDs list of userIDs * * @return self */ @@ -207,9 +207,9 @@ public function setUserIDs($userIDs) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php b/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php index 605c71b9d8..338e9fcd9f 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * MultipleBatchResponse Class Doc Comment @@ -32,7 +32,7 @@ class MultipleBatchResponse implements ModelInterface, ArrayAccess, \JsonSeriali */ protected static $openAPITypes = [ 'taskID' => 'object', - 'objectIDs' => 'string[]' + 'objectIDs' => 'string[]', ]; /** @@ -44,7 +44,7 @@ class MultipleBatchResponse implements ModelInterface, ArrayAccess, \JsonSeriali */ protected static $openAPIFormats = [ 'taskID' => null, - 'objectIDs' => null + 'objectIDs' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'taskID' => 'taskID', - 'objectIDs' => 'objectIDs' + 'objectIDs' => 'objectIDs', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'taskID' => 'setTaskID', - 'objectIDs' => 'setObjectIDs' + 'objectIDs' => 'setObjectIDs', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'taskID' => 'getTaskID', - 'objectIDs' => 'getObjectIDs' + 'objectIDs' => 'getObjectIDs', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -182,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets taskID * @@ -196,7 +194,7 @@ public function getTaskID() /** * Sets taskID * - * @param object|null $taskID List of tasksIDs per index. + * @param object|null $taskID list of tasksIDs per index * * @return self */ @@ -220,7 +218,7 @@ public function getObjectIDs() /** * Sets objectIDs * - * @param string[]|null $objectIDs List of objectID. + * @param string[]|null $objectIDs list of objectID * * @return self */ @@ -233,9 +231,9 @@ public function setObjectIDs($objectIDs) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -245,7 +243,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -274,7 +272,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -285,10 +283,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -319,4 +318,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php b/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php index ab47ce8284..d96e1b9763 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * MultipleGetObjectsObject Class Doc Comment * * @category Class * @description GetObject operation on an index. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class MultipleGetObjectsObject implements ModelInterface, ArrayAccess, \JsonSeri protected static $openAPITypes = [ 'attributesToRetrieve' => 'string[]', 'objectID' => 'string', - 'indexName' => 'string' + 'indexName' => 'string', ]; /** @@ -47,7 +48,7 @@ class MultipleGetObjectsObject implements ModelInterface, ArrayAccess, \JsonSeri protected static $openAPIFormats = [ 'attributesToRetrieve' => null, 'objectID' => null, - 'indexName' => null + 'indexName' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'attributesToRetrieve' => 'attributesToRetrieve', 'objectID' => 'objectID', - 'indexName' => 'indexName' + 'indexName' => 'indexName', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'attributesToRetrieve' => 'setAttributesToRetrieve', 'objectID' => 'setObjectID', - 'indexName' => 'setIndexName' + 'indexName' => 'setIndexName', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'attributesToRetrieve' => 'getAttributesToRetrieve', 'objectID' => 'getObjectID', - 'indexName' => 'getIndexName' + 'indexName' => 'getIndexName', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -181,6 +181,7 @@ public function listInvalidProperties() if ($this->container['indexName'] === null) { $invalidProperties[] = "'indexName' can't be null"; } + return $invalidProperties; } @@ -195,7 +196,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets attributesToRetrieve * @@ -233,7 +233,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID ID of the object within that index. + * @param string $objectID ID of the object within that index * * @return self */ @@ -257,7 +257,7 @@ public function getIndexName() /** * Sets indexName * - * @param string $indexName name of the index containing the object. + * @param string $indexName name of the index containing the object * * @return self */ @@ -270,9 +270,9 @@ public function setIndexName($indexName) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -282,7 +282,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -311,7 +311,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -322,10 +322,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -356,4 +357,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php b/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php index f29705e627..95669603ef 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * MultipleQueries Class Doc Comment @@ -35,7 +35,7 @@ class MultipleQueries implements ModelInterface, ArrayAccess, \JsonSerializable 'query' => 'string', 'type' => 'string', 'facet' => 'string', - 'params' => 'string' + 'params' => 'string', ]; /** @@ -50,7 +50,7 @@ class MultipleQueries implements ModelInterface, ArrayAccess, \JsonSerializable 'query' => null, 'type' => null, 'facet' => null, - 'params' => null + 'params' => null, ]; /** @@ -84,7 +84,7 @@ public static function openAPIFormats() 'query' => 'query', 'type' => 'type', 'facet' => 'facet', - 'params' => 'params' + 'params' => 'params', ]; /** @@ -97,7 +97,7 @@ public static function openAPIFormats() 'query' => 'setQuery', 'type' => 'setType', 'facet' => 'setFacet', - 'params' => 'setParams' + 'params' => 'setParams', ]; /** @@ -110,7 +110,7 @@ public static function openAPIFormats() 'query' => 'getQuery', 'type' => 'getType', 'facet' => 'getFacet', - 'params' => 'getParams' + 'params' => 'getParams', ]; /** @@ -227,7 +227,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets indexName * @@ -241,7 +240,7 @@ public function getIndexName() /** * Sets indexName * - * @param string $indexName The Algolia index name. + * @param string $indexName the Algolia index name * * @return self */ @@ -265,7 +264,7 @@ public function getQuery() /** * Sets query * - * @param string|null $query The text to search in the index. + * @param string|null $query the text to search in the index * * @return self */ @@ -289,7 +288,7 @@ public function getType() /** * Sets type * - * @param string|null $type Perform a search query with `default`, will search for facet values if `facet` is given. + * @param string|null $type perform a search query with `default`, will search for facet values if `facet` is given * * @return self */ @@ -323,7 +322,7 @@ public function getFacet() /** * Sets facet * - * @param string|null $facet The `facet` name. + * @param string|null $facet the `facet` name * * @return self */ @@ -347,7 +346,7 @@ public function getParams() /** * Sets params * - * @param string|null $params A query string of search parameters. + * @param string|null $params a query string of search parameters * * @return self */ @@ -360,9 +359,9 @@ public function setParams($params) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -372,7 +371,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -401,7 +400,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -412,10 +411,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -446,4 +446,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php index 448a05f979..5c1571c58f 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * MultipleQueriesObject Class Doc Comment @@ -32,7 +32,7 @@ class MultipleQueriesObject implements ModelInterface, ArrayAccess, \JsonSeriali */ protected static $openAPITypes = [ 'requests' => '\Algolia\AlgoliaSearch\Model\MultipleQueries[]', - 'strategy' => 'string' + 'strategy' => 'string', ]; /** @@ -44,7 +44,7 @@ class MultipleQueriesObject implements ModelInterface, ArrayAccess, \JsonSeriali */ protected static $openAPIFormats = [ 'requests' => null, - 'strategy' => null + 'strategy' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'requests' => 'requests', - 'strategy' => 'strategy' + 'strategy' => 'strategy', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'requests' => 'setRequests', - 'strategy' => 'setStrategy' + 'strategy' => 'setStrategy', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'requests' => 'getRequests', - 'strategy' => 'getStrategy' + 'strategy' => 'getStrategy', ]; /** @@ -209,7 +209,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets requests * @@ -270,9 +269,9 @@ public function setStrategy($strategy) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -282,7 +281,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -311,7 +310,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -322,10 +321,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -356,4 +356,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php index a5109a497d..d441ad8268 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * MultipleQueriesResponse Class Doc Comment @@ -31,7 +31,7 @@ class MultipleQueriesResponse implements ModelInterface, ArrayAccess, \JsonSeria * @var string[] */ protected static $openAPITypes = [ - 'results' => '\Algolia\AlgoliaSearch\Model\SearchResponse[]' + 'results' => '\Algolia\AlgoliaSearch\Model\SearchResponse[]', ]; /** @@ -42,7 +42,7 @@ class MultipleQueriesResponse implements ModelInterface, ArrayAccess, \JsonSeria * @psalm-var array */ protected static $openAPIFormats = [ - 'results' => null + 'results' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'results' => 'results' + 'results' => 'results', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'results' => 'setResults' + 'results' => 'setResults', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'results' => 'getResults' + 'results' => 'getResults', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -176,7 +175,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets results * @@ -203,9 +201,9 @@ public function setResults($results) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -215,7 +213,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -244,7 +242,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -255,10 +253,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -289,4 +288,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Operation.php b/clients/algoliasearch-client-php/lib/Model/Operation.php index 8683c73b1b..49f65a5711 100644 --- a/clients/algoliasearch-client-php/lib/Model/Operation.php +++ b/clients/algoliasearch-client-php/lib/Model/Operation.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Operation Class Doc Comment @@ -33,7 +33,7 @@ class Operation implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'action' => '\Algolia\AlgoliaSearch\Model\Action', 'body' => 'object', - 'indexName' => 'string' + 'indexName' => 'string', ]; /** @@ -46,7 +46,7 @@ class Operation implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'action' => null, 'body' => null, - 'indexName' => null + 'indexName' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'action' => 'action', 'body' => 'body', - 'indexName' => 'indexName' + 'indexName' => 'indexName', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'action' => 'setAction', 'body' => 'setBody', - 'indexName' => 'setIndexName' + 'indexName' => 'setIndexName', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'action' => 'getAction', 'body' => 'getBody', - 'indexName' => 'getIndexName' + 'indexName' => 'getIndexName', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -188,7 +187,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets action * @@ -226,7 +224,7 @@ public function getBody() /** * Sets body * - * @param object|null $body arguments to the operation (depends on the type of the operation). + * @param object|null $body arguments to the operation (depends on the type of the operation) * * @return self */ @@ -250,7 +248,7 @@ public function getIndexName() /** * Sets indexName * - * @param string|null $indexName Index to target for this operation. + * @param string|null $indexName index to target for this operation * * @return self */ @@ -263,9 +261,9 @@ public function setIndexName($indexName) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -275,7 +273,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -304,7 +302,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -315,10 +313,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -349,4 +348,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php b/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php index 6ce1064869..c6122908e0 100644 --- a/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php +++ b/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * OperationIndexObject Class Doc Comment @@ -33,7 +33,7 @@ class OperationIndexObject implements ModelInterface, ArrayAccess, \JsonSerializ protected static $openAPITypes = [ 'operation' => 'string', 'destination' => 'string', - 'scope' => 'string[]' + 'scope' => 'string[]', ]; /** @@ -46,7 +46,7 @@ class OperationIndexObject implements ModelInterface, ArrayAccess, \JsonSerializ protected static $openAPIFormats = [ 'operation' => null, 'destination' => null, - 'scope' => null + 'scope' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'operation' => 'operation', 'destination' => 'destination', - 'scope' => 'scope' + 'scope' => 'scope', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'operation' => 'setOperation', 'destination' => 'setDestination', - 'scope' => 'setScope' + 'scope' => 'setScope', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'operation' => 'getOperation', 'destination' => 'getDestination', - 'scope' => 'getScope' + 'scope' => 'getScope', ]; /** @@ -221,6 +221,7 @@ public function listInvalidProperties() if ($this->container['destination'] === null) { $invalidProperties[] = "'destination' can't be null"; } + return $invalidProperties; } @@ -235,7 +236,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets operation * @@ -249,7 +249,7 @@ public function getOperation() /** * Sets operation * - * @param string $operation Type of operation to perform (move or copy). + * @param string $operation type of operation to perform (move or copy) * * @return self */ @@ -283,7 +283,7 @@ public function getDestination() /** * Sets destination * - * @param string $destination The Algolia index name. + * @param string $destination the Algolia index name * * @return self */ @@ -329,9 +329,9 @@ public function setScope($scope) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -341,7 +341,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -370,7 +370,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -381,10 +381,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -415,4 +416,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Params.php b/clients/algoliasearch-client-php/lib/Model/Params.php index 91841228dc..7dc71a62fd 100644 --- a/clients/algoliasearch-client-php/lib/Model/Params.php +++ b/clients/algoliasearch-client-php/lib/Model/Params.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Params Class Doc Comment * * @category Class * @description Additional search parameters. Any valid search parameter is allowed. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class Params implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'query' => 'string', 'automaticFacetFilters' => '\Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]', - 'automaticOptionalFacetFilters' => '\Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]' + 'automaticOptionalFacetFilters' => '\Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]', ]; /** @@ -47,7 +48,7 @@ class Params implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'query' => null, 'automaticFacetFilters' => null, - 'automaticOptionalFacetFilters' => null + 'automaticOptionalFacetFilters' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'query' => 'query', 'automaticFacetFilters' => 'automaticFacetFilters', - 'automaticOptionalFacetFilters' => 'automaticOptionalFacetFilters' + 'automaticOptionalFacetFilters' => 'automaticOptionalFacetFilters', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'query' => 'setQuery', 'automaticFacetFilters' => 'setAutomaticFacetFilters', - 'automaticOptionalFacetFilters' => 'setAutomaticOptionalFacetFilters' + 'automaticOptionalFacetFilters' => 'setAutomaticOptionalFacetFilters', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'query' => 'getQuery', 'automaticFacetFilters' => 'getAutomaticFacetFilters', - 'automaticOptionalFacetFilters' => 'getAutomaticOptionalFacetFilters' + 'automaticOptionalFacetFilters' => 'getAutomaticOptionalFacetFilters', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -189,7 +189,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets query * @@ -203,7 +202,7 @@ public function getQuery() /** * Sets query * - * @param string|null $query Query string. + * @param string|null $query query string * * @return self */ @@ -227,7 +226,7 @@ public function getAutomaticFacetFilters() /** * Sets automaticFacetFilters * - * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticFacetFilters Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern. + * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticFacetFilters names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern * * @return self */ @@ -251,7 +250,7 @@ public function getAutomaticOptionalFacetFilters() /** * Sets automaticOptionalFacetFilters * - * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticOptionalFacetFilters Same syntax as automaticFacetFilters, but the engine treats the filters as optional. + * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticOptionalFacetFilters same syntax as automaticFacetFilters, but the engine treats the filters as optional * * @return self */ @@ -264,9 +263,9 @@ public function setAutomaticOptionalFacetFilters($automaticOptionalFacetFilters) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -276,7 +275,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -305,7 +304,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -316,10 +315,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -350,4 +350,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Promote.php b/clients/algoliasearch-client-php/lib/Model/Promote.php index 14718b1d2c..25d29916ee 100644 --- a/clients/algoliasearch-client-php/lib/Model/Promote.php +++ b/clients/algoliasearch-client-php/lib/Model/Promote.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Promote Class Doc Comment * * @category Class * @description Object to promote as hits. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class Promote implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'objectID' => 'string', 'objectIDs' => 'string[]', - 'position' => 'int' + 'position' => 'int', ]; /** @@ -47,7 +48,7 @@ class Promote implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'objectID' => null, 'objectIDs' => null, - 'position' => null + 'position' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'objectID' => 'objectID', 'objectIDs' => 'objectIDs', - 'position' => 'position' + 'position' => 'position', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'objectID' => 'setObjectID', 'objectIDs' => 'setObjectIDs', - 'position' => 'setPosition' + 'position' => 'setPosition', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'objectID' => 'getObjectID', 'objectIDs' => 'getObjectIDs', - 'position' => 'getPosition' + 'position' => 'getPosition', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -178,6 +178,7 @@ public function listInvalidProperties() if ($this->container['position'] === null) { $invalidProperties[] = "'position' can't be null"; } + return $invalidProperties; } @@ -192,7 +193,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -206,7 +206,7 @@ public function getObjectID() /** * Sets objectID * - * @param string|null $objectID Unique identifier of the object to promote. + * @param string|null $objectID unique identifier of the object to promote * * @return self */ @@ -230,7 +230,7 @@ public function getObjectIDs() /** * Sets objectIDs * - * @param string[]|null $objectIDs Array of unique identifiers of the objects to promote. + * @param string[]|null $objectIDs array of unique identifiers of the objects to promote * * @return self */ @@ -267,9 +267,9 @@ public function setPosition($position) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -279,7 +279,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -308,7 +308,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -319,10 +319,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -353,4 +354,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/RankingInfo.php b/clients/algoliasearch-client-php/lib/Model/RankingInfo.php index 03196a4eb5..ecdde9adf6 100644 --- a/clients/algoliasearch-client-php/lib/Model/RankingInfo.php +++ b/clients/algoliasearch-client-php/lib/Model/RankingInfo.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * RankingInfo Class Doc Comment @@ -41,7 +41,7 @@ class RankingInfo implements ModelInterface, ArrayAccess, \JsonSerializable 'promoted' => 'bool', 'proximityDistance' => 'int', 'userScore' => 'int', - 'word' => 'int' + 'word' => 'int', ]; /** @@ -62,7 +62,7 @@ class RankingInfo implements ModelInterface, ArrayAccess, \JsonSerializable 'promoted' => null, 'proximityDistance' => null, 'userScore' => null, - 'word' => null + 'word' => null, ]; /** @@ -102,7 +102,7 @@ public static function openAPIFormats() 'promoted' => 'promoted', 'proximityDistance' => 'proximityDistance', 'userScore' => 'userScore', - 'word' => 'word' + 'word' => 'word', ]; /** @@ -121,7 +121,7 @@ public static function openAPIFormats() 'promoted' => 'setPromoted', 'proximityDistance' => 'setProximityDistance', 'userScore' => 'setUserScore', - 'word' => 'setWord' + 'word' => 'setWord', ]; /** @@ -140,7 +140,7 @@ public static function openAPIFormats() 'promoted' => 'getPromoted', 'proximityDistance' => 'getProximityDistance', 'userScore' => 'getUserScore', - 'word' => 'getWord' + 'word' => 'getWord', ]; /** @@ -184,7 +184,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -236,7 +235,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets filters * @@ -250,7 +248,7 @@ public function getFilters() /** * Sets filters * - * @param int|null $filters This field is reserved for advanced usage. + * @param int|null $filters this field is reserved for advanced usage * * @return self */ @@ -274,7 +272,7 @@ public function getFirstMatchedWord() /** * Sets firstMatchedWord * - * @param int|null $firstMatchedWord Position of the most important matched attribute in the attributes to index list. + * @param int|null $firstMatchedWord position of the most important matched attribute in the attributes to index list * * @return self */ @@ -298,7 +296,7 @@ public function getGeoDistance() /** * Sets geoDistance * - * @param int|null $geoDistance Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters). + * @param int|null $geoDistance distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters) * * @return self */ @@ -322,7 +320,7 @@ public function getGeoPrecision() /** * Sets geoPrecision * - * @param int|null $geoPrecision Precision used when computing the geo distance, in meters. + * @param int|null $geoPrecision precision used when computing the geo distance, in meters * * @return self */ @@ -370,7 +368,7 @@ public function getNbExactWords() /** * Sets nbExactWords * - * @param int|null $nbExactWords Number of exactly matched words. + * @param int|null $nbExactWords number of exactly matched words * * @return self */ @@ -394,7 +392,7 @@ public function getNbTypos() /** * Sets nbTypos * - * @param int|null $nbTypos Number of typos encountered when matching the record. + * @param int|null $nbTypos number of typos encountered when matching the record * * @return self */ @@ -418,7 +416,7 @@ public function getPromoted() /** * Sets promoted * - * @param bool|null $promoted Present and set to true if a Rule promoted the hit. + * @param bool|null $promoted present and set to true if a Rule promoted the hit * * @return self */ @@ -442,7 +440,7 @@ public function getProximityDistance() /** * Sets proximityDistance * - * @param int|null $proximityDistance When the query contains more than one word, the sum of the distances between matched words (in meters). + * @param int|null $proximityDistance when the query contains more than one word, the sum of the distances between matched words (in meters) * * @return self */ @@ -466,7 +464,7 @@ public function getUserScore() /** * Sets userScore * - * @param int|null $userScore Custom ranking for the object, expressed as a single integer value. + * @param int|null $userScore custom ranking for the object, expressed as a single integer value * * @return self */ @@ -490,7 +488,7 @@ public function getWord() /** * Sets word * - * @param int|null $word Number of matched words, including prefixes and typos. + * @param int|null $word number of matched words, including prefixes and typos * * @return self */ @@ -503,9 +501,9 @@ public function setWord($word) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -515,7 +513,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -544,7 +542,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -555,10 +553,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -589,4 +588,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php b/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php index 40e0ff224f..089130d225 100644 --- a/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php +++ b/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * RankingInfoMatchedGeoLocation Class Doc Comment @@ -33,7 +33,7 @@ class RankingInfoMatchedGeoLocation implements ModelInterface, ArrayAccess, \Jso protected static $openAPITypes = [ 'lat' => 'double', 'lng' => 'double', - 'distance' => 'int' + 'distance' => 'int', ]; /** @@ -46,7 +46,7 @@ class RankingInfoMatchedGeoLocation implements ModelInterface, ArrayAccess, \Jso protected static $openAPIFormats = [ 'lat' => 'double', 'lng' => 'double', - 'distance' => null + 'distance' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'lat' => 'lat', 'lng' => 'lng', - 'distance' => 'distance' + 'distance' => 'distance', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'lat' => 'setLat', 'lng' => 'setLng', - 'distance' => 'setDistance' + 'distance' => 'setDistance', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'lat' => 'getLat', 'lng' => 'getLng', - 'distance' => 'getDistance' + 'distance' => 'getDistance', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -188,11 +187,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets lat * - * @return double|null + * @return float|null */ public function getLat() { @@ -202,7 +200,7 @@ public function getLat() /** * Sets lat * - * @param double|null $lat Latitude of the matched location. + * @param float|null $lat latitude of the matched location * * @return self */ @@ -216,7 +214,7 @@ public function setLat($lat) /** * Gets lng * - * @return double|null + * @return float|null */ public function getLng() { @@ -226,7 +224,7 @@ public function getLng() /** * Sets lng * - * @param double|null $lng Longitude of the matched location. + * @param float|null $lng longitude of the matched location * * @return self */ @@ -250,7 +248,7 @@ public function getDistance() /** * Sets distance * - * @param int|null $distance Distance between the matched location and the search location (in meters). + * @param int|null $distance distance between the matched location and the search location (in meters) * * @return self */ @@ -263,9 +261,9 @@ public function setDistance($distance) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -275,7 +273,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -304,7 +302,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -315,10 +313,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -349,4 +348,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Record.php b/clients/algoliasearch-client-php/lib/Model/Record.php index cc58da5171..345113fad0 100644 --- a/clients/algoliasearch-client-php/lib/Model/Record.php +++ b/clients/algoliasearch-client-php/lib/Model/Record.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Record Class Doc Comment * * @category Class * @description A single record. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -36,7 +37,7 @@ class Record implements ModelInterface, ArrayAccess, \JsonSerializable 'highlightResult' => '\Algolia\AlgoliaSearch\Model\HighlightResult', 'snippetResult' => '\Algolia\AlgoliaSearch\Model\SnippetResult', 'rankingInfo' => '\Algolia\AlgoliaSearch\Model\RankingInfo', - 'distinctSeqID' => 'int' + 'distinctSeqID' => 'int', ]; /** @@ -51,7 +52,7 @@ class Record implements ModelInterface, ArrayAccess, \JsonSerializable 'highlightResult' => null, 'snippetResult' => null, 'rankingInfo' => null, - 'distinctSeqID' => null + 'distinctSeqID' => null, ]; /** @@ -85,7 +86,7 @@ public static function openAPIFormats() 'highlightResult' => '_highlightResult', 'snippetResult' => '_snippetResult', 'rankingInfo' => '_rankingInfo', - 'distinctSeqID' => '_distinctSeqID' + 'distinctSeqID' => '_distinctSeqID', ]; /** @@ -98,7 +99,7 @@ public static function openAPIFormats() 'highlightResult' => 'setHighlightResult', 'snippetResult' => 'setSnippetResult', 'rankingInfo' => 'setRankingInfo', - 'distinctSeqID' => 'setDistinctSeqID' + 'distinctSeqID' => 'setDistinctSeqID', ]; /** @@ -111,7 +112,7 @@ public static function openAPIFormats() 'highlightResult' => 'getHighlightResult', 'snippetResult' => 'getSnippetResult', 'rankingInfo' => 'getRankingInfo', - 'distinctSeqID' => 'getDistinctSeqID' + 'distinctSeqID' => 'getDistinctSeqID', ]; /** @@ -155,7 +156,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -190,6 +190,7 @@ public function listInvalidProperties() if ($this->container['objectID'] === null) { $invalidProperties[] = "'objectID' can't be null"; } + return $invalidProperties; } @@ -204,7 +205,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -218,7 +218,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID Unique identifier of the object. + * @param string $objectID unique identifier of the object * * @return self */ @@ -327,9 +327,9 @@ public function setDistinctSeqID($distinctSeqID) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -339,7 +339,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -368,7 +368,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -379,10 +379,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -413,4 +414,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php b/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php index 0c70495abb..74761cee9e 100644 --- a/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * RemoveUserIdResponse Class Doc Comment @@ -31,7 +31,7 @@ class RemoveUserIdResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'deletedAt' => '\DateTime' + 'deletedAt' => '\DateTime', ]; /** @@ -42,7 +42,7 @@ class RemoveUserIdResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'deletedAt' => 'date-time' + 'deletedAt' => 'date-time', ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'deletedAt' => 'deletedAt' + 'deletedAt' => 'deletedAt', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'deletedAt' => 'setDeletedAt' + 'deletedAt' => 'setDeletedAt', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'deletedAt' => 'getDeletedAt' + 'deletedAt' => 'getDeletedAt', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['deletedAt'] === null) { $invalidProperties[] = "'deletedAt' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets deletedAt * @@ -193,7 +192,7 @@ public function getDeletedAt() /** * Sets deletedAt * - * @param \DateTime $deletedAt Date of deletion (ISO-8601 format). + * @param \DateTime $deletedAt date of deletion (ISO-8601 format) * * @return self */ @@ -206,9 +205,9 @@ public function setDeletedAt($deletedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php b/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php index 2b7487736e..b8c981e0f0 100644 --- a/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ReplaceSourceResponse Class Doc Comment @@ -31,7 +31,7 @@ class ReplaceSourceResponse implements ModelInterface, ArrayAccess, \JsonSeriali * @var string[] */ protected static $openAPITypes = [ - 'updatedAt' => '\DateTime' + 'updatedAt' => '\DateTime', ]; /** @@ -42,7 +42,7 @@ class ReplaceSourceResponse implements ModelInterface, ArrayAccess, \JsonSeriali * @psalm-var array */ protected static $openAPIFormats = [ - 'updatedAt' => 'date-time' + 'updatedAt' => 'date-time', ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'updatedAt' => 'updatedAt' + 'updatedAt' => 'updatedAt', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'updatedAt' => 'setUpdatedAt' + 'updatedAt' => 'setUpdatedAt', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'updatedAt' => 'getUpdatedAt' + 'updatedAt' => 'getUpdatedAt', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets updatedAt * @@ -193,7 +192,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -206,9 +205,9 @@ public function setUpdatedAt($updatedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php b/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php index 180e14b0cd..fea07393c7 100644 --- a/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * RequiredSearchParams Class Doc Comment @@ -31,7 +31,7 @@ class RequiredSearchParams implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'query' => 'string' + 'query' => 'string', ]; /** @@ -42,7 +42,7 @@ class RequiredSearchParams implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'query' => null + 'query' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'query' => 'query' + 'query' => 'query', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'query' => 'setQuery' + 'query' => 'setQuery', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'query' => 'getQuery' + 'query' => 'getQuery', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['query'] === null) { $invalidProperties[] = "'query' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets query * @@ -193,7 +192,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -206,9 +205,9 @@ public function setQuery($query) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Rule.php b/clients/algoliasearch-client-php/lib/Model/Rule.php index ff0c3fb926..646596e102 100644 --- a/clients/algoliasearch-client-php/lib/Model/Rule.php +++ b/clients/algoliasearch-client-php/lib/Model/Rule.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Rule Class Doc Comment * * @category Class * @description Rule object. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -37,7 +38,7 @@ class Rule implements ModelInterface, ArrayAccess, \JsonSerializable 'consequence' => '\Algolia\AlgoliaSearch\Model\Consequence', 'description' => 'string', 'enabled' => 'bool', - 'validity' => '\Algolia\AlgoliaSearch\Model\TimeRange[]' + 'validity' => '\Algolia\AlgoliaSearch\Model\TimeRange[]', ]; /** @@ -53,7 +54,7 @@ class Rule implements ModelInterface, ArrayAccess, \JsonSerializable 'consequence' => null, 'description' => null, 'enabled' => null, - 'validity' => null + 'validity' => null, ]; /** @@ -88,7 +89,7 @@ public static function openAPIFormats() 'consequence' => 'consequence', 'description' => 'description', 'enabled' => 'enabled', - 'validity' => 'validity' + 'validity' => 'validity', ]; /** @@ -102,7 +103,7 @@ public static function openAPIFormats() 'consequence' => 'setConsequence', 'description' => 'setDescription', 'enabled' => 'setEnabled', - 'validity' => 'setValidity' + 'validity' => 'setValidity', ]; /** @@ -116,7 +117,7 @@ public static function openAPIFormats() 'consequence' => 'getConsequence', 'description' => 'getDescription', 'enabled' => 'getEnabled', - 'validity' => 'getValidity' + 'validity' => 'getValidity', ]; /** @@ -160,7 +161,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -199,6 +199,7 @@ public function listInvalidProperties() if ($this->container['consequence'] === null) { $invalidProperties[] = "'consequence' can't be null"; } + return $invalidProperties; } @@ -213,7 +214,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -227,7 +227,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID Unique identifier of the object. + * @param string $objectID unique identifier of the object * * @return self */ @@ -360,9 +360,9 @@ public function setValidity($validity) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -372,7 +372,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -401,7 +401,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -412,10 +412,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -446,4 +447,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php b/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php index 4b894609d1..1512d4260c 100644 --- a/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SaveObjectResponse Class Doc Comment @@ -33,7 +33,7 @@ class SaveObjectResponse implements ModelInterface, ArrayAccess, \JsonSerializab protected static $openAPITypes = [ 'createdAt' => 'string', 'taskID' => 'int', - 'objectID' => 'string' + 'objectID' => 'string', ]; /** @@ -46,7 +46,7 @@ class SaveObjectResponse implements ModelInterface, ArrayAccess, \JsonSerializab protected static $openAPIFormats = [ 'createdAt' => null, 'taskID' => null, - 'objectID' => null + 'objectID' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'createdAt' => 'createdAt', 'taskID' => 'taskID', - 'objectID' => 'objectID' + 'objectID' => 'objectID', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'createdAt' => 'setCreatedAt', 'taskID' => 'setTaskID', - 'objectID' => 'setObjectID' + 'objectID' => 'setObjectID', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'createdAt' => 'getCreatedAt', 'taskID' => 'getTaskID', - 'objectID' => 'getObjectID' + 'objectID' => 'getObjectID', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -188,7 +187,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets createdAt * @@ -226,7 +224,7 @@ public function getTaskID() /** * Sets taskID * - * @param int|null $taskID taskID of the indexing task to wait for. + * @param int|null $taskID taskID of the indexing task to wait for * * @return self */ @@ -250,7 +248,7 @@ public function getObjectID() /** * Sets objectID * - * @param string|null $objectID Unique identifier of the object. + * @param string|null $objectID unique identifier of the object * * @return self */ @@ -263,9 +261,9 @@ public function setObjectID($objectID) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -275,7 +273,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -304,7 +302,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -315,10 +313,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -349,4 +348,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php b/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php index 5781c715c7..56a5f1ab5a 100644 --- a/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SaveSynonymResponse Class Doc Comment @@ -33,7 +33,7 @@ class SaveSynonymResponse implements ModelInterface, ArrayAccess, \JsonSerializa protected static $openAPITypes = [ 'taskID' => 'int', 'updatedAt' => '\DateTime', - 'id' => 'string' + 'id' => 'string', ]; /** @@ -46,7 +46,7 @@ class SaveSynonymResponse implements ModelInterface, ArrayAccess, \JsonSerializa protected static $openAPIFormats = [ 'taskID' => null, 'updatedAt' => 'date-time', - 'id' => null + 'id' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'taskID' => 'taskID', 'updatedAt' => 'updatedAt', - 'id' => 'id' + 'id' => 'id', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'taskID' => 'setTaskID', 'updatedAt' => 'setUpdatedAt', - 'id' => 'setId' + 'id' => 'setId', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'taskID' => 'getTaskID', 'updatedAt' => 'getUpdatedAt', - 'id' => 'getId' + 'id' => 'getId', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -183,6 +182,7 @@ public function listInvalidProperties() if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } + return $invalidProperties; } @@ -197,7 +197,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets taskID * @@ -211,7 +210,7 @@ public function getTaskID() /** * Sets taskID * - * @param int $taskID taskID of the indexing task to wait for. + * @param int $taskID taskID of the indexing task to wait for * * @return self */ @@ -235,7 +234,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -259,7 +258,7 @@ public function getId() /** * Sets id * - * @param string $id objectID of the inserted object. + * @param string $id objectID of the inserted object * * @return self */ @@ -272,9 +271,9 @@ public function setId($id) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -284,7 +283,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -313,7 +312,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -324,10 +323,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -358,4 +358,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php b/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php index 1db78c1742..9ec71bf9f3 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchDictionaryEntries Class Doc Comment * * @category Class * @description The `searchDictionaryEntries` request. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +36,7 @@ class SearchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSeria 'query' => 'string', 'page' => 'int', 'hitsPerPage' => 'int', - 'language' => 'string' + 'language' => 'string', ]; /** @@ -49,7 +50,7 @@ class SearchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSeria 'query' => null, 'page' => null, 'hitsPerPage' => null, - 'language' => null + 'language' => null, ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() 'query' => 'query', 'page' => 'page', 'hitsPerPage' => 'hitsPerPage', - 'language' => 'language' + 'language' => 'language', ]; /** @@ -94,7 +95,7 @@ public static function openAPIFormats() 'query' => 'setQuery', 'page' => 'setPage', 'hitsPerPage' => 'setHitsPerPage', - 'language' => 'setLanguage' + 'language' => 'setLanguage', ]; /** @@ -106,7 +107,7 @@ public static function openAPIFormats() 'query' => 'getQuery', 'page' => 'getPage', 'hitsPerPage' => 'getHitsPerPage', - 'language' => 'getLanguage' + 'language' => 'getLanguage', ]; /** @@ -150,7 +151,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -184,6 +184,7 @@ public function listInvalidProperties() if ($this->container['query'] === null) { $invalidProperties[] = "'query' can't be null"; } + return $invalidProperties; } @@ -198,7 +199,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets query * @@ -212,7 +212,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -236,7 +236,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Specify the page to retrieve. + * @param int|null $page specify the page to retrieve * * @return self */ @@ -260,7 +260,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -297,9 +297,9 @@ public function setLanguage($language) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -309,7 +309,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -338,7 +338,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -349,10 +349,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -383,4 +384,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php index 9ab47c9980..29d33c4a97 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchForFacetValuesRequest Class Doc Comment @@ -33,7 +33,7 @@ class SearchForFacetValuesRequest implements ModelInterface, ArrayAccess, \JsonS protected static $openAPITypes = [ 'params' => 'string', 'facetQuery' => 'string', - 'maxFacetHits' => 'int' + 'maxFacetHits' => 'int', ]; /** @@ -46,7 +46,7 @@ class SearchForFacetValuesRequest implements ModelInterface, ArrayAccess, \JsonS protected static $openAPIFormats = [ 'params' => null, 'facetQuery' => null, - 'maxFacetHits' => null + 'maxFacetHits' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'params' => 'params', 'facetQuery' => 'facetQuery', - 'maxFacetHits' => 'maxFacetHits' + 'maxFacetHits' => 'maxFacetHits', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'params' => 'setParams', 'facetQuery' => 'setFacetQuery', - 'maxFacetHits' => 'setMaxFacetHits' + 'maxFacetHits' => 'setMaxFacetHits', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'params' => 'getParams', 'facetQuery' => 'getFacetQuery', - 'maxFacetHits' => 'getMaxFacetHits' + 'maxFacetHits' => 'getMaxFacetHits', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -192,7 +191,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets params * @@ -206,7 +204,7 @@ public function getParams() /** * Sets params * - * @param string|null $params Search parameters as URL-encoded query string. + * @param string|null $params search parameters as URL-encoded query string * * @return self */ @@ -230,7 +228,7 @@ public function getFacetQuery() /** * Sets facetQuery * - * @param string|null $facetQuery Text to search inside the facet's values. + * @param string|null $facetQuery text to search inside the facet's values * * @return self */ @@ -272,9 +270,9 @@ public function setMaxFacetHits($maxFacetHits) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -284,7 +282,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -313,7 +311,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -324,10 +322,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -358,4 +357,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php index 7f1bfa58fa..3e5bdb2eeb 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchForFacetValuesResponse Class Doc Comment @@ -31,7 +31,7 @@ class SearchForFacetValuesResponse implements ModelInterface, ArrayAccess, \Json * @var string[] */ protected static $openAPITypes = [ - 'facetHits' => '\Algolia\AlgoliaSearch\Model\SearchForFacetValuesResponseFacetHits[]' + 'facetHits' => '\Algolia\AlgoliaSearch\Model\SearchForFacetValuesResponseFacetHits[]', ]; /** @@ -42,7 +42,7 @@ class SearchForFacetValuesResponse implements ModelInterface, ArrayAccess, \Json * @psalm-var array */ protected static $openAPIFormats = [ - 'facetHits' => null + 'facetHits' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'facetHits' => 'facetHits' + 'facetHits' => 'facetHits', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'facetHits' => 'setFacetHits' + 'facetHits' => 'setFacetHits', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'facetHits' => 'getFacetHits' + 'facetHits' => 'getFacetHits', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['facetHits'] === null) { $invalidProperties[] = "'facetHits' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets facetHits * @@ -206,9 +205,9 @@ public function setFacetHits($facetHits) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php index 0b4efb1a49..071e8412fc 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchForFacetValuesResponseFacetHits Class Doc Comment @@ -33,7 +33,7 @@ class SearchForFacetValuesResponseFacetHits implements ModelInterface, ArrayAcce protected static $openAPITypes = [ 'value' => 'string', 'highlighted' => 'string', - 'count' => 'int' + 'count' => 'int', ]; /** @@ -46,7 +46,7 @@ class SearchForFacetValuesResponseFacetHits implements ModelInterface, ArrayAcce protected static $openAPIFormats = [ 'value' => null, 'highlighted' => null, - 'count' => null + 'count' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'value' => 'value', 'highlighted' => 'highlighted', - 'count' => 'count' + 'count' => 'count', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'value' => 'setValue', 'highlighted' => 'setHighlighted', - 'count' => 'setCount' + 'count' => 'setCount', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'value' => 'getValue', 'highlighted' => 'getHighlighted', - 'count' => 'getCount' + 'count' => 'getCount', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -183,6 +182,7 @@ public function listInvalidProperties() if ($this->container['count'] === null) { $invalidProperties[] = "'count' can't be null"; } + return $invalidProperties; } @@ -197,7 +197,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets value * @@ -211,7 +210,7 @@ public function getValue() /** * Sets value * - * @param string $value Raw value of the facet. + * @param string $value raw value of the facet * * @return self */ @@ -235,7 +234,7 @@ public function getHighlighted() /** * Sets highlighted * - * @param string $highlighted Markup text with occurrences highlighted. + * @param string $highlighted markup text with occurrences highlighted * * @return self */ @@ -272,9 +271,9 @@ public function setCount($count) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -284,7 +283,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -313,7 +312,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -324,10 +323,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -358,4 +358,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchHits.php b/clients/algoliasearch-client-php/lib/Model/SearchHits.php index 98d474deaf..dcce6cb2d2 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchHits.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchHits.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchHits Class Doc Comment @@ -31,7 +31,7 @@ class SearchHits implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]' + 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]', ]; /** @@ -42,7 +42,7 @@ class SearchHits implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'hits' => null + 'hits' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'hits' => 'hits' + 'hits' => 'hits', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'hits' => 'setHits' + 'hits' => 'setHits', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'hits' => 'getHits' + 'hits' => 'getHits', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -176,7 +175,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets hits * @@ -203,9 +201,9 @@ public function setHits($hits) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -215,7 +213,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -244,7 +242,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -255,10 +253,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -289,4 +288,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchParams.php b/clients/algoliasearch-client-php/lib/Model/SearchParams.php index 184d6356e4..bdde27f975 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchParams Class Doc Comment @@ -108,7 +108,7 @@ class SearchParams implements ModelInterface, ArrayAccess, \JsonSerializable 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object' + 'renderingContent' => 'object', ]; /** @@ -196,7 +196,7 @@ class SearchParams implements ModelInterface, ArrayAccess, \JsonSerializable 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null + 'renderingContent' => null, ]; /** @@ -303,7 +303,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent' + 'renderingContent' => 'renderingContent', ]; /** @@ -389,7 +389,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent' + 'renderingContent' => 'setRenderingContent', ]; /** @@ -475,7 +475,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent' + 'renderingContent' => 'getRenderingContent', ]; /** @@ -813,7 +813,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets params * @@ -827,7 +826,7 @@ public function getParams() /** * Sets params * - * @param string|null $params Search parameters as URL-encoded query string. + * @param string|null $params search parameters as URL-encoded query string * * @return self */ @@ -851,7 +850,7 @@ public function getSimilarQuery() /** * Sets similarQuery * - * @param string|null $similarQuery Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results. + * @param string|null $similarQuery overrides the query parameter and performs a more generic search that can be used to find \"similar\" results * * @return self */ @@ -875,7 +874,7 @@ public function getFilters() /** * Sets filters * - * @param string|null $filters Filter the query with numeric, facet and/or tag filters. + * @param string|null $filters filter the query with numeric, facet and/or tag filters * * @return self */ @@ -899,7 +898,7 @@ public function getFacetFilters() /** * Sets facetFilters * - * @param string[]|null $facetFilters Filter hits by facet value. + * @param string[]|null $facetFilters filter hits by facet value * * @return self */ @@ -923,7 +922,7 @@ public function getOptionalFilters() /** * Sets optionalFilters * - * @param string[]|null $optionalFilters Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. + * @param string[]|null $optionalFilters create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter * * @return self */ @@ -947,7 +946,7 @@ public function getNumericFilters() /** * Sets numericFilters * - * @param string[]|null $numericFilters Filter on numeric attributes. + * @param string[]|null $numericFilters filter on numeric attributes * * @return self */ @@ -971,7 +970,7 @@ public function getTagFilters() /** * Sets tagFilters * - * @param string[]|null $tagFilters Filter hits by tags. + * @param string[]|null $tagFilters filter hits by tags * * @return self */ @@ -995,7 +994,7 @@ public function getSumOrFiltersScores() /** * Sets sumOrFiltersScores * - * @param bool|null $sumOrFiltersScores Determines how to calculate the total score for filtering. + * @param bool|null $sumOrFiltersScores determines how to calculate the total score for filtering * * @return self */ @@ -1019,7 +1018,7 @@ public function getFacets() /** * Sets facets * - * @param string[]|null $facets Retrieve facets and their facet values. + * @param string[]|null $facets retrieve facets and their facet values * * @return self */ @@ -1043,7 +1042,7 @@ public function getMaxValuesPerFacet() /** * Sets maxValuesPerFacet * - * @param int|null $maxValuesPerFacet Maximum number of facet values to return for each facet during a regular search. + * @param int|null $maxValuesPerFacet maximum number of facet values to return for each facet during a regular search * * @return self */ @@ -1067,7 +1066,7 @@ public function getFacetingAfterDistinct() /** * Sets facetingAfterDistinct * - * @param bool|null $facetingAfterDistinct Force faceting to be applied after de-duplication (via the Distinct setting). + * @param bool|null $facetingAfterDistinct force faceting to be applied after de-duplication (via the Distinct setting) * * @return self */ @@ -1091,7 +1090,7 @@ public function getSortFacetValuesBy() /** * Sets sortFacetValuesBy * - * @param string|null $sortFacetValuesBy Controls how facet values are fetched. + * @param string|null $sortFacetValuesBy controls how facet values are fetched * * @return self */ @@ -1115,7 +1114,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Specify the page to retrieve. + * @param int|null $page specify the page to retrieve * * @return self */ @@ -1139,7 +1138,7 @@ public function getOffset() /** * Sets offset * - * @param int|null $offset Specify the offset of the first hit to return. + * @param int|null $offset specify the offset of the first hit to return * * @return self */ @@ -1163,7 +1162,7 @@ public function getLength() /** * Sets length * - * @param int|null $length Set the number of hits to retrieve (used only with offset). + * @param int|null $length set the number of hits to retrieve (used only with offset) * * @return self */ @@ -1195,7 +1194,7 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng Search for entries around a central geolocation, enabling a geo search within a circular area. + * @param string|null $aroundLatLng search for entries around a central geolocation, enabling a geo search within a circular area * * @return self */ @@ -1219,7 +1218,7 @@ public function getAroundLatLngViaIP() /** * Sets aroundLatLngViaIP * - * @param bool|null $aroundLatLngViaIP Search for entries around a given location automatically computed from the requester's IP address. + * @param bool|null $aroundLatLngViaIP search for entries around a given location automatically computed from the requester's IP address * * @return self */ @@ -1243,7 +1242,7 @@ public function getAroundRadius() /** * Sets aroundRadius * - * @param OneOfIntegerString|null $aroundRadius Define the maximum radius for a geo search (in meters). + * @param OneOfIntegerString|null $aroundRadius define the maximum radius for a geo search (in meters) * * @return self */ @@ -1267,7 +1266,7 @@ public function getAroundPrecision() /** * Sets aroundPrecision * - * @param int|null $aroundPrecision Precision of geo search (in meters), to add grouping by geo location to the ranking formula. + * @param int|null $aroundPrecision precision of geo search (in meters), to add grouping by geo location to the ranking formula * * @return self */ @@ -1291,7 +1290,7 @@ public function getMinimumAroundRadius() /** * Sets minimumAroundRadius * - * @param int|null $minimumAroundRadius Minimum radius (in meters) used for a geo search when aroundRadius is not set. + * @param int|null $minimumAroundRadius minimum radius (in meters) used for a geo search when aroundRadius is not set * * @return self */ @@ -1320,7 +1319,7 @@ public function getInsideBoundingBox() /** * Sets insideBoundingBox * - * @param float[]|null $insideBoundingBox Search inside a rectangular area (in geo coordinates). + * @param float[]|null $insideBoundingBox search inside a rectangular area (in geo coordinates) * * @return self */ @@ -1344,7 +1343,7 @@ public function getInsidePolygon() /** * Sets insidePolygon * - * @param float[]|null $insidePolygon Search inside a polygon (in geo coordinates). + * @param float[]|null $insidePolygon search inside a polygon (in geo coordinates) * * @return self */ @@ -1392,7 +1391,7 @@ public function getRuleContexts() /** * Sets ruleContexts * - * @param string[]|null $ruleContexts Enables contextual rules. + * @param string[]|null $ruleContexts enables contextual rules * * @return self */ @@ -1416,7 +1415,7 @@ public function getPersonalizationImpact() /** * Sets personalizationImpact * - * @param int|null $personalizationImpact Define the impact of the Personalization feature. + * @param int|null $personalizationImpact define the impact of the Personalization feature * * @return self */ @@ -1440,7 +1439,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken Associates a certain user token with the current search. + * @param string|null $userToken associates a certain user token with the current search * * @return self */ @@ -1464,7 +1463,7 @@ public function getGetRankingInfo() /** * Sets getRankingInfo * - * @param bool|null $getRankingInfo Retrieve detailed ranking information. + * @param bool|null $getRankingInfo retrieve detailed ranking information * * @return self */ @@ -1488,7 +1487,7 @@ public function getClickAnalytics() /** * Sets clickAnalytics * - * @param bool|null $clickAnalytics Enable the Click Analytics feature. + * @param bool|null $clickAnalytics enable the Click Analytics feature * * @return self */ @@ -1512,7 +1511,7 @@ public function getAnalytics() /** * Sets analytics * - * @param bool|null $analytics Whether the current query will be taken into account in the Analytics. + * @param bool|null $analytics whether the current query will be taken into account in the Analytics * * @return self */ @@ -1536,7 +1535,7 @@ public function getAnalyticsTags() /** * Sets analyticsTags * - * @param string[]|null $analyticsTags List of tags to apply to the query for analytics purposes. + * @param string[]|null $analyticsTags list of tags to apply to the query for analytics purposes * * @return self */ @@ -1560,7 +1559,7 @@ public function getPercentileComputation() /** * Sets percentileComputation * - * @param bool|null $percentileComputation Whether to include or exclude a query from the processing-time percentile computation. + * @param bool|null $percentileComputation whether to include or exclude a query from the processing-time percentile computation * * @return self */ @@ -1584,7 +1583,7 @@ public function getEnableABTest() /** * Sets enableABTest * - * @param bool|null $enableABTest Whether this search should participate in running AB tests. + * @param bool|null $enableABTest whether this search should participate in running AB tests * * @return self */ @@ -1608,7 +1607,7 @@ public function getEnableReRanking() /** * Sets enableReRanking * - * @param bool|null $enableReRanking Whether this search should use AI Re-Ranking. + * @param bool|null $enableReRanking whether this search should use AI Re-Ranking * * @return self */ @@ -1632,7 +1631,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -1656,7 +1655,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes The complete list of attributes used for searching. + * @param string[]|null $searchableAttributes the complete list of attributes used for searching * * @return self */ @@ -1680,7 +1679,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. + * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting * * @return self */ @@ -1704,7 +1703,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. + * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time * * @return self */ @@ -1728,7 +1727,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. + * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve * * @return self */ @@ -1752,7 +1751,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. + * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes * * @return self */ @@ -1776,7 +1775,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking Controls how Algolia should sort your results. + * @param string[]|null $ranking controls how Algolia should sort your results * * @return self */ @@ -1800,7 +1799,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking Specifies the custom ranking criterion. + * @param string[]|null $customRanking specifies the custom ranking criterion * * @return self */ @@ -1824,7 +1823,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. + * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results * * @return self */ @@ -1848,7 +1847,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight List of attributes to highlight. + * @param string[]|null $attributesToHighlight list of attributes to highlight * * @return self */ @@ -1872,7 +1871,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. + * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet * * @return self */ @@ -1896,7 +1895,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results * * @return self */ @@ -1920,7 +1919,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results * * @return self */ @@ -1944,7 +1943,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. + * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated * * @return self */ @@ -1968,7 +1967,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. + * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query * * @return self */ @@ -1992,7 +1991,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -2016,7 +2015,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. + * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo * * @return self */ @@ -2040,7 +2039,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. + * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos * * @return self */ @@ -2064,7 +2063,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. + * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied * * @return self */ @@ -2098,7 +2097,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. + * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string * * @return self */ @@ -2122,7 +2121,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. + * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance * * @return self */ @@ -2146,7 +2145,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex Control which separators are indexed. + * @param string|null $separatorsToIndex control which separators are indexed * * @return self */ @@ -2170,7 +2169,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. + * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms * * @return self */ @@ -2194,7 +2193,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. + * @param string|null $removeStopWords removes stop (common) words from the query before executing it * * @return self */ @@ -2218,7 +2217,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. + * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize * * @return self */ @@ -2242,7 +2241,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. + * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection * * @return self */ @@ -2266,7 +2265,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. + * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query * * @return self */ @@ -2290,7 +2289,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules Whether Rules should be globally enabled. + * @param bool|null $enableRules whether Rules should be globally enabled * * @return self */ @@ -2314,7 +2313,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization Enable the Personalization feature. + * @param bool|null $enablePersonalization enable the Personalization feature * * @return self */ @@ -2338,7 +2337,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType Controls if and how query words are interpreted as prefixes. + * @param string|null $queryType controls if and how query words are interpreted as prefixes * * @return self */ @@ -2372,7 +2371,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. + * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits * * @return self */ @@ -2406,7 +2405,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax Enables the advanced query syntax. + * @param bool|null $advancedSyntax enables the advanced query syntax * * @return self */ @@ -2430,7 +2429,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. + * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query * * @return self */ @@ -2454,7 +2453,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. + * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion * * @return self */ @@ -2478,7 +2477,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. + * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word * * @return self */ @@ -2512,7 +2511,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. + * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion * * @return self */ @@ -2545,7 +2544,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. + * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled * * @return self */ @@ -2578,7 +2577,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct Enables de-duplication or grouping of results. + * @param int|null $distinct enables de-duplication or grouping of results * * @return self */ @@ -2610,7 +2609,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. + * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search * * @return self */ @@ -2634,7 +2633,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. + * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself * * @return self */ @@ -2658,7 +2657,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity Precision of the proximity ranking criterion. + * @param int|null $minProximity precision of the proximity ranking criterion * * @return self */ @@ -2743,7 +2742,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. + * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage * * @return self */ @@ -2780,9 +2779,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -2792,7 +2791,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -2821,7 +2820,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -2832,10 +2831,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -2866,4 +2866,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php b/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php index 49956dd09f..e8ff8684b7 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchParamsObject Class Doc Comment @@ -107,7 +107,7 @@ class SearchParamsObject implements ModelInterface, ArrayAccess, \JsonSerializab 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object' + 'renderingContent' => 'object', ]; /** @@ -194,7 +194,7 @@ class SearchParamsObject implements ModelInterface, ArrayAccess, \JsonSerializab 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null + 'renderingContent' => null, ]; /** @@ -300,7 +300,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent' + 'renderingContent' => 'renderingContent', ]; /** @@ -385,7 +385,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent' + 'renderingContent' => 'setRenderingContent', ]; /** @@ -470,7 +470,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent' + 'renderingContent' => 'getRenderingContent', ]; /** @@ -807,7 +807,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets similarQuery * @@ -821,7 +820,7 @@ public function getSimilarQuery() /** * Sets similarQuery * - * @param string|null $similarQuery Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results. + * @param string|null $similarQuery overrides the query parameter and performs a more generic search that can be used to find \"similar\" results * * @return self */ @@ -845,7 +844,7 @@ public function getFilters() /** * Sets filters * - * @param string|null $filters Filter the query with numeric, facet and/or tag filters. + * @param string|null $filters filter the query with numeric, facet and/or tag filters * * @return self */ @@ -869,7 +868,7 @@ public function getFacetFilters() /** * Sets facetFilters * - * @param string[]|null $facetFilters Filter hits by facet value. + * @param string[]|null $facetFilters filter hits by facet value * * @return self */ @@ -893,7 +892,7 @@ public function getOptionalFilters() /** * Sets optionalFilters * - * @param string[]|null $optionalFilters Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. + * @param string[]|null $optionalFilters create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter * * @return self */ @@ -917,7 +916,7 @@ public function getNumericFilters() /** * Sets numericFilters * - * @param string[]|null $numericFilters Filter on numeric attributes. + * @param string[]|null $numericFilters filter on numeric attributes * * @return self */ @@ -941,7 +940,7 @@ public function getTagFilters() /** * Sets tagFilters * - * @param string[]|null $tagFilters Filter hits by tags. + * @param string[]|null $tagFilters filter hits by tags * * @return self */ @@ -965,7 +964,7 @@ public function getSumOrFiltersScores() /** * Sets sumOrFiltersScores * - * @param bool|null $sumOrFiltersScores Determines how to calculate the total score for filtering. + * @param bool|null $sumOrFiltersScores determines how to calculate the total score for filtering * * @return self */ @@ -989,7 +988,7 @@ public function getFacets() /** * Sets facets * - * @param string[]|null $facets Retrieve facets and their facet values. + * @param string[]|null $facets retrieve facets and their facet values * * @return self */ @@ -1013,7 +1012,7 @@ public function getMaxValuesPerFacet() /** * Sets maxValuesPerFacet * - * @param int|null $maxValuesPerFacet Maximum number of facet values to return for each facet during a regular search. + * @param int|null $maxValuesPerFacet maximum number of facet values to return for each facet during a regular search * * @return self */ @@ -1037,7 +1036,7 @@ public function getFacetingAfterDistinct() /** * Sets facetingAfterDistinct * - * @param bool|null $facetingAfterDistinct Force faceting to be applied after de-duplication (via the Distinct setting). + * @param bool|null $facetingAfterDistinct force faceting to be applied after de-duplication (via the Distinct setting) * * @return self */ @@ -1061,7 +1060,7 @@ public function getSortFacetValuesBy() /** * Sets sortFacetValuesBy * - * @param string|null $sortFacetValuesBy Controls how facet values are fetched. + * @param string|null $sortFacetValuesBy controls how facet values are fetched * * @return self */ @@ -1085,7 +1084,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Specify the page to retrieve. + * @param int|null $page specify the page to retrieve * * @return self */ @@ -1109,7 +1108,7 @@ public function getOffset() /** * Sets offset * - * @param int|null $offset Specify the offset of the first hit to return. + * @param int|null $offset specify the offset of the first hit to return * * @return self */ @@ -1133,7 +1132,7 @@ public function getLength() /** * Sets length * - * @param int|null $length Set the number of hits to retrieve (used only with offset). + * @param int|null $length set the number of hits to retrieve (used only with offset) * * @return self */ @@ -1165,7 +1164,7 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng Search for entries around a central geolocation, enabling a geo search within a circular area. + * @param string|null $aroundLatLng search for entries around a central geolocation, enabling a geo search within a circular area * * @return self */ @@ -1189,7 +1188,7 @@ public function getAroundLatLngViaIP() /** * Sets aroundLatLngViaIP * - * @param bool|null $aroundLatLngViaIP Search for entries around a given location automatically computed from the requester's IP address. + * @param bool|null $aroundLatLngViaIP search for entries around a given location automatically computed from the requester's IP address * * @return self */ @@ -1213,7 +1212,7 @@ public function getAroundRadius() /** * Sets aroundRadius * - * @param OneOfIntegerString|null $aroundRadius Define the maximum radius for a geo search (in meters). + * @param OneOfIntegerString|null $aroundRadius define the maximum radius for a geo search (in meters) * * @return self */ @@ -1237,7 +1236,7 @@ public function getAroundPrecision() /** * Sets aroundPrecision * - * @param int|null $aroundPrecision Precision of geo search (in meters), to add grouping by geo location to the ranking formula. + * @param int|null $aroundPrecision precision of geo search (in meters), to add grouping by geo location to the ranking formula * * @return self */ @@ -1261,7 +1260,7 @@ public function getMinimumAroundRadius() /** * Sets minimumAroundRadius * - * @param int|null $minimumAroundRadius Minimum radius (in meters) used for a geo search when aroundRadius is not set. + * @param int|null $minimumAroundRadius minimum radius (in meters) used for a geo search when aroundRadius is not set * * @return self */ @@ -1290,7 +1289,7 @@ public function getInsideBoundingBox() /** * Sets insideBoundingBox * - * @param float[]|null $insideBoundingBox Search inside a rectangular area (in geo coordinates). + * @param float[]|null $insideBoundingBox search inside a rectangular area (in geo coordinates) * * @return self */ @@ -1314,7 +1313,7 @@ public function getInsidePolygon() /** * Sets insidePolygon * - * @param float[]|null $insidePolygon Search inside a polygon (in geo coordinates). + * @param float[]|null $insidePolygon search inside a polygon (in geo coordinates) * * @return self */ @@ -1362,7 +1361,7 @@ public function getRuleContexts() /** * Sets ruleContexts * - * @param string[]|null $ruleContexts Enables contextual rules. + * @param string[]|null $ruleContexts enables contextual rules * * @return self */ @@ -1386,7 +1385,7 @@ public function getPersonalizationImpact() /** * Sets personalizationImpact * - * @param int|null $personalizationImpact Define the impact of the Personalization feature. + * @param int|null $personalizationImpact define the impact of the Personalization feature * * @return self */ @@ -1410,7 +1409,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken Associates a certain user token with the current search. + * @param string|null $userToken associates a certain user token with the current search * * @return self */ @@ -1434,7 +1433,7 @@ public function getGetRankingInfo() /** * Sets getRankingInfo * - * @param bool|null $getRankingInfo Retrieve detailed ranking information. + * @param bool|null $getRankingInfo retrieve detailed ranking information * * @return self */ @@ -1458,7 +1457,7 @@ public function getClickAnalytics() /** * Sets clickAnalytics * - * @param bool|null $clickAnalytics Enable the Click Analytics feature. + * @param bool|null $clickAnalytics enable the Click Analytics feature * * @return self */ @@ -1482,7 +1481,7 @@ public function getAnalytics() /** * Sets analytics * - * @param bool|null $analytics Whether the current query will be taken into account in the Analytics. + * @param bool|null $analytics whether the current query will be taken into account in the Analytics * * @return self */ @@ -1506,7 +1505,7 @@ public function getAnalyticsTags() /** * Sets analyticsTags * - * @param string[]|null $analyticsTags List of tags to apply to the query for analytics purposes. + * @param string[]|null $analyticsTags list of tags to apply to the query for analytics purposes * * @return self */ @@ -1530,7 +1529,7 @@ public function getPercentileComputation() /** * Sets percentileComputation * - * @param bool|null $percentileComputation Whether to include or exclude a query from the processing-time percentile computation. + * @param bool|null $percentileComputation whether to include or exclude a query from the processing-time percentile computation * * @return self */ @@ -1554,7 +1553,7 @@ public function getEnableABTest() /** * Sets enableABTest * - * @param bool|null $enableABTest Whether this search should participate in running AB tests. + * @param bool|null $enableABTest whether this search should participate in running AB tests * * @return self */ @@ -1578,7 +1577,7 @@ public function getEnableReRanking() /** * Sets enableReRanking * - * @param bool|null $enableReRanking Whether this search should use AI Re-Ranking. + * @param bool|null $enableReRanking whether this search should use AI Re-Ranking * * @return self */ @@ -1602,7 +1601,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -1626,7 +1625,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes The complete list of attributes used for searching. + * @param string[]|null $searchableAttributes the complete list of attributes used for searching * * @return self */ @@ -1650,7 +1649,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. + * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting * * @return self */ @@ -1674,7 +1673,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. + * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time * * @return self */ @@ -1698,7 +1697,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. + * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve * * @return self */ @@ -1722,7 +1721,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. + * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes * * @return self */ @@ -1746,7 +1745,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking Controls how Algolia should sort your results. + * @param string[]|null $ranking controls how Algolia should sort your results * * @return self */ @@ -1770,7 +1769,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking Specifies the custom ranking criterion. + * @param string[]|null $customRanking specifies the custom ranking criterion * * @return self */ @@ -1794,7 +1793,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. + * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results * * @return self */ @@ -1818,7 +1817,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight List of attributes to highlight. + * @param string[]|null $attributesToHighlight list of attributes to highlight * * @return self */ @@ -1842,7 +1841,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. + * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet * * @return self */ @@ -1866,7 +1865,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results * * @return self */ @@ -1890,7 +1889,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results * * @return self */ @@ -1914,7 +1913,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. + * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated * * @return self */ @@ -1938,7 +1937,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. + * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query * * @return self */ @@ -1962,7 +1961,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -1986,7 +1985,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. + * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo * * @return self */ @@ -2010,7 +2009,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. + * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos * * @return self */ @@ -2034,7 +2033,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. + * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied * * @return self */ @@ -2068,7 +2067,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. + * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string * * @return self */ @@ -2092,7 +2091,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. + * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance * * @return self */ @@ -2116,7 +2115,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex Control which separators are indexed. + * @param string|null $separatorsToIndex control which separators are indexed * * @return self */ @@ -2140,7 +2139,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. + * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms * * @return self */ @@ -2164,7 +2163,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. + * @param string|null $removeStopWords removes stop (common) words from the query before executing it * * @return self */ @@ -2188,7 +2187,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. + * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize * * @return self */ @@ -2212,7 +2211,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. + * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection * * @return self */ @@ -2236,7 +2235,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. + * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query * * @return self */ @@ -2260,7 +2259,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules Whether Rules should be globally enabled. + * @param bool|null $enableRules whether Rules should be globally enabled * * @return self */ @@ -2284,7 +2283,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization Enable the Personalization feature. + * @param bool|null $enablePersonalization enable the Personalization feature * * @return self */ @@ -2308,7 +2307,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType Controls if and how query words are interpreted as prefixes. + * @param string|null $queryType controls if and how query words are interpreted as prefixes * * @return self */ @@ -2342,7 +2341,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. + * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits * * @return self */ @@ -2376,7 +2375,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax Enables the advanced query syntax. + * @param bool|null $advancedSyntax enables the advanced query syntax * * @return self */ @@ -2400,7 +2399,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. + * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query * * @return self */ @@ -2424,7 +2423,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. + * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion * * @return self */ @@ -2448,7 +2447,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. + * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word * * @return self */ @@ -2482,7 +2481,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. + * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion * * @return self */ @@ -2515,7 +2514,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. + * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled * * @return self */ @@ -2548,7 +2547,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct Enables de-duplication or grouping of results. + * @param int|null $distinct enables de-duplication or grouping of results * * @return self */ @@ -2580,7 +2579,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. + * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search * * @return self */ @@ -2604,7 +2603,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. + * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself * * @return self */ @@ -2628,7 +2627,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity Precision of the proximity ranking criterion. + * @param int|null $minProximity precision of the proximity ranking criterion * * @return self */ @@ -2713,7 +2712,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. + * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage * * @return self */ @@ -2750,9 +2749,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -2762,7 +2761,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -2791,7 +2790,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -2802,10 +2801,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -2836,4 +2836,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php b/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php index ad130c49c8..c8668a3daa 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchParamsString Class Doc Comment @@ -31,7 +31,7 @@ class SearchParamsString implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'params' => 'string' + 'params' => 'string', ]; /** @@ -42,7 +42,7 @@ class SearchParamsString implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'params' => null + 'params' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'params' => 'params' + 'params' => 'params', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'params' => 'setParams' + 'params' => 'setParams', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'params' => 'getParams' + 'params' => 'getParams', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -176,7 +175,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets params * @@ -190,7 +188,7 @@ public function getParams() /** * Sets params * - * @param string|null $params Search parameters as URL-encoded query string. + * @param string|null $params search parameters as URL-encoded query string * * @return self */ @@ -203,9 +201,9 @@ public function setParams($params) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -215,7 +213,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -244,7 +242,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -255,10 +253,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -289,4 +288,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchResponse.php index f5adcaad07..e333813ee1 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchResponse Class Doc Comment @@ -55,7 +55,7 @@ class SearchResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'queryAfterRemoval' => 'string', 'serverUsed' => 'string', 'userData' => 'object', - 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]' + 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]', ]; /** @@ -90,7 +90,7 @@ class SearchResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'queryAfterRemoval' => null, 'serverUsed' => null, 'userData' => null, - 'hits' => null + 'hits' => null, ]; /** @@ -144,7 +144,7 @@ public static function openAPIFormats() 'queryAfterRemoval' => 'queryAfterRemoval', 'serverUsed' => 'serverUsed', 'userData' => 'userData', - 'hits' => 'hits' + 'hits' => 'hits', ]; /** @@ -177,7 +177,7 @@ public static function openAPIFormats() 'queryAfterRemoval' => 'setQueryAfterRemoval', 'serverUsed' => 'setServerUsed', 'userData' => 'setUserData', - 'hits' => 'setHits' + 'hits' => 'setHits', ]; /** @@ -210,7 +210,7 @@ public static function openAPIFormats() 'queryAfterRemoval' => 'getQueryAfterRemoval', 'serverUsed' => 'getServerUsed', 'userData' => 'getUserData', - 'hits' => 'getHits' + 'hits' => 'getHits', ]; /** @@ -254,7 +254,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -306,7 +305,7 @@ public function listInvalidProperties() { $invalidProperties = []; - if (!is_null($this->container['aroundLatLng']) && !preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $this->container['aroundLatLng'])) { + if (!is_null($this->container['aroundLatLng']) && !preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $this->container['aroundLatLng'])) { $invalidProperties[] = "invalid value for 'aroundLatLng', must be conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."; } @@ -340,6 +339,7 @@ public function listInvalidProperties() if ($this->container['hits'] === null) { $invalidProperties[] = "'hits' can't be null"; } + return $invalidProperties; } @@ -354,7 +354,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets abTestID * @@ -368,7 +367,7 @@ public function getAbTestID() /** * Sets abTestID * - * @param int|null $abTestID If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID. + * @param int|null $abTestID if a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID * * @return self */ @@ -392,7 +391,7 @@ public function getAbTestVariantID() /** * Sets abTestVariantID * - * @param int|null $abTestVariantID If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used. + * @param int|null $abTestVariantID if a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used * * @return self */ @@ -416,14 +415,14 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng The computed geo location. + * @param string|null $aroundLatLng the computed geo location * * @return self */ public function setAroundLatLng($aroundLatLng) { - if (!is_null($aroundLatLng) && (!preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $aroundLatLng))) { + if (!is_null($aroundLatLng) && (!preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $aroundLatLng))) { throw new \InvalidArgumentException("invalid value for $aroundLatLng when calling SearchResponse., must conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."); } @@ -469,7 +468,7 @@ public function getExhaustiveFacetsCount() /** * Sets exhaustiveFacetsCount * - * @param bool|null $exhaustiveFacetsCount Whether the facet count is exhaustive or approximate. + * @param bool|null $exhaustiveFacetsCount whether the facet count is exhaustive or approximate * * @return self */ @@ -541,7 +540,7 @@ public function getFacets() /** * Sets facets * - * @param array>|null $facets A mapping of each facet name to the corresponding facet counts. + * @param array>|null $facets a mapping of each facet name to the corresponding facet counts * * @return self */ @@ -565,7 +564,7 @@ public function getFacetsStats() /** * Sets facetsStats * - * @param array|null $facetsStats Statistics for numerical facets. + * @param array|null $facetsStats statistics for numerical facets * * @return self */ @@ -589,7 +588,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int $hitsPerPage Set the number of hits per page. + * @param int $hitsPerPage set the number of hits per page * * @return self */ @@ -613,7 +612,7 @@ public function getIndex() /** * Sets index * - * @param string|null $index Index name used for the query. + * @param string|null $index index name used for the query * * @return self */ @@ -661,7 +660,7 @@ public function getMessage() /** * Sets message * - * @param string|null $message Used to return warnings about the query. + * @param string|null $message used to return warnings about the query * * @return self */ @@ -685,7 +684,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits Number of hits that the search query matched. + * @param int $nbHits number of hits that the search query matched * * @return self */ @@ -757,7 +756,7 @@ public function getPage() /** * Sets page * - * @param int $page Specify the page to retrieve. + * @param int $page specify the page to retrieve * * @return self */ @@ -781,7 +780,7 @@ public function getParams() /** * Sets params * - * @param string $params A url-encoded string of all search parameters. + * @param string $params a url-encoded string of all search parameters * * @return self */ @@ -805,7 +804,7 @@ public function getParsedQuery() /** * Sets parsedQuery * - * @param string|null $parsedQuery The query string that will be searched, after normalization. + * @param string|null $parsedQuery the query string that will be searched, after normalization * * @return self */ @@ -829,7 +828,7 @@ public function getProcessingTimeMS() /** * Sets processingTimeMS * - * @param int $processingTimeMS Time the server took to process the request, in milliseconds. + * @param int $processingTimeMS time the server took to process the request, in milliseconds * * @return self */ @@ -853,7 +852,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -877,7 +876,7 @@ public function getQueryAfterRemoval() /** * Sets queryAfterRemoval * - * @param string|null $queryAfterRemoval A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. + * @param string|null $queryAfterRemoval a markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set * * @return self */ @@ -901,7 +900,7 @@ public function getServerUsed() /** * Sets serverUsed * - * @param string|null $serverUsed Actual host name of the server that processed the request. + * @param string|null $serverUsed actual host name of the server that processed the request * * @return self */ @@ -925,7 +924,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData Lets you store custom data in your indices. + * @param object|null $userData lets you store custom data in your indices * * @return self */ @@ -962,9 +961,9 @@ public function setHits($hits) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -974,7 +973,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -1003,7 +1002,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -1014,10 +1013,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -1048,4 +1048,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php b/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php index 604d9db2ea..e5e167f954 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchRulesParams Class Doc Comment * * @category Class * @description Parameters for the search. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -38,7 +39,7 @@ class SearchRulesParams implements ModelInterface, ArrayAccess, \JsonSerializabl 'page' => 'int', 'hitsPerPage' => 'int', 'enabled' => 'bool', - 'requestOptions' => 'object[]' + 'requestOptions' => 'object[]', ]; /** @@ -55,7 +56,7 @@ class SearchRulesParams implements ModelInterface, ArrayAccess, \JsonSerializabl 'page' => null, 'hitsPerPage' => null, 'enabled' => null, - 'requestOptions' => null + 'requestOptions' => null, ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() 'page' => 'page', 'hitsPerPage' => 'hitsPerPage', 'enabled' => 'enabled', - 'requestOptions' => 'requestOptions' + 'requestOptions' => 'requestOptions', ]; /** @@ -106,7 +107,7 @@ public static function openAPIFormats() 'page' => 'setPage', 'hitsPerPage' => 'setHitsPerPage', 'enabled' => 'setEnabled', - 'requestOptions' => 'setRequestOptions' + 'requestOptions' => 'setRequestOptions', ]; /** @@ -121,7 +122,7 @@ public static function openAPIFormats() 'page' => 'getPage', 'hitsPerPage' => 'getHitsPerPage', 'enabled' => 'getEnabled', - 'requestOptions' => 'getRequestOptions' + 'requestOptions' => 'getRequestOptions', ]; /** @@ -165,7 +166,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -213,7 +213,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets query * @@ -227,7 +226,7 @@ public function getQuery() /** * Sets query * - * @param string|null $query Full text query. + * @param string|null $query full text query * * @return self */ @@ -275,7 +274,7 @@ public function getContext() /** * Sets context * - * @param string|null $context Restricts matches to contextual rules with a specific context (exact match). + * @param string|null $context restricts matches to contextual rules with a specific context (exact match) * * @return self */ @@ -299,7 +298,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Requested page (zero-based). + * @param int|null $page requested page (zero-based) * * @return self */ @@ -371,7 +370,7 @@ public function getRequestOptions() /** * Sets requestOptions * - * @param object[]|null $requestOptions A mapping of requestOptions to send along with the request. + * @param object[]|null $requestOptions a mapping of requestOptions to send along with the request * * @return self */ @@ -384,9 +383,9 @@ public function setRequestOptions($requestOptions) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -396,7 +395,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -425,7 +424,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -436,10 +435,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -470,4 +470,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php index 2bfe6387a8..a77a76adcc 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchRulesResponse Class Doc Comment @@ -34,7 +34,7 @@ class SearchRulesResponse implements ModelInterface, ArrayAccess, \JsonSerializa 'hits' => '\Algolia\AlgoliaSearch\Model\Rule[]', 'nbHits' => 'int', 'page' => 'int', - 'nbPages' => 'int' + 'nbPages' => 'int', ]; /** @@ -48,7 +48,7 @@ class SearchRulesResponse implements ModelInterface, ArrayAccess, \JsonSerializa 'hits' => null, 'nbHits' => null, 'page' => null, - 'nbPages' => null + 'nbPages' => null, ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() 'hits' => 'hits', 'nbHits' => 'nbHits', 'page' => 'page', - 'nbPages' => 'nbPages' + 'nbPages' => 'nbPages', ]; /** @@ -93,7 +93,7 @@ public static function openAPIFormats() 'hits' => 'setHits', 'nbHits' => 'setNbHits', 'page' => 'setPage', - 'nbPages' => 'setNbPages' + 'nbPages' => 'setNbPages', ]; /** @@ -105,7 +105,7 @@ public static function openAPIFormats() 'hits' => 'getHits', 'nbHits' => 'getNbHits', 'page' => 'getPage', - 'nbPages' => 'getNbPages' + 'nbPages' => 'getNbPages', ]; /** @@ -149,7 +149,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -192,6 +191,7 @@ public function listInvalidProperties() if ($this->container['nbPages'] === null) { $invalidProperties[] = "'nbPages' can't be null"; } + return $invalidProperties; } @@ -206,7 +206,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets hits * @@ -220,7 +219,7 @@ public function getHits() /** * Sets hits * - * @param \Algolia\AlgoliaSearch\Model\Rule[] $hits Fetched rules. + * @param \Algolia\AlgoliaSearch\Model\Rule[] $hits fetched rules * * @return self */ @@ -244,7 +243,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits Number of fetched rules. + * @param int $nbHits number of fetched rules * * @return self */ @@ -268,7 +267,7 @@ public function getPage() /** * Sets page * - * @param int $page Current page. + * @param int $page current page * * @return self */ @@ -292,7 +291,7 @@ public function getNbPages() /** * Sets nbPages * - * @param int $nbPages Number of pages. + * @param int $nbPages number of pages * * @return self */ @@ -305,9 +304,9 @@ public function setNbPages($nbPages) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -317,7 +316,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -346,7 +345,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -357,10 +356,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -391,4 +391,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php index 95e04a6329..96ecbda0cc 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchSynonymsResponse Class Doc Comment @@ -32,7 +32,7 @@ class SearchSynonymsResponse implements ModelInterface, ArrayAccess, \JsonSerial */ protected static $openAPITypes = [ 'hits' => '\Algolia\AlgoliaSearch\Model\SynonymHit[]', - 'nbHits' => 'int' + 'nbHits' => 'int', ]; /** @@ -44,7 +44,7 @@ class SearchSynonymsResponse implements ModelInterface, ArrayAccess, \JsonSerial */ protected static $openAPIFormats = [ 'hits' => null, - 'nbHits' => null + 'nbHits' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'hits' => 'hits', - 'nbHits' => 'nbHits' + 'nbHits' => 'nbHits', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'hits' => 'setHits', - 'nbHits' => 'setNbHits' + 'nbHits' => 'setNbHits', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'hits' => 'getHits', - 'nbHits' => 'getNbHits' + 'nbHits' => 'getNbHits', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -174,6 +173,7 @@ public function listInvalidProperties() if ($this->container['nbHits'] === null) { $invalidProperties[] = "'nbHits' can't be null"; } + return $invalidProperties; } @@ -188,7 +188,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets hits * @@ -202,7 +201,7 @@ public function getHits() /** * Sets hits * - * @param \Algolia\AlgoliaSearch\Model\SynonymHit[] $hits Array of synonym objects. + * @param \Algolia\AlgoliaSearch\Model\SynonymHit[] $hits array of synonym objects * * @return self */ @@ -226,7 +225,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits Number of hits that the search query matched. + * @param int $nbHits number of hits that the search query matched * * @return self */ @@ -239,9 +238,9 @@ public function setNbHits($nbHits) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -251,7 +250,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -280,7 +279,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -291,10 +290,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -325,4 +325,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php index 2db6a4eb66..e0d149cc8e 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchUserIdsObject Class Doc Comment * * @category Class * @description OK + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +36,7 @@ class SearchUserIdsObject implements ModelInterface, ArrayAccess, \JsonSerializa 'query' => 'string', 'clusterName' => 'string', 'page' => 'int', - 'hitsPerPage' => 'int' + 'hitsPerPage' => 'int', ]; /** @@ -49,7 +50,7 @@ class SearchUserIdsObject implements ModelInterface, ArrayAccess, \JsonSerializa 'query' => null, 'clusterName' => null, 'page' => null, - 'hitsPerPage' => null + 'hitsPerPage' => null, ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() 'query' => 'query', 'clusterName' => 'clusterName', 'page' => 'page', - 'hitsPerPage' => 'hitsPerPage' + 'hitsPerPage' => 'hitsPerPage', ]; /** @@ -94,7 +95,7 @@ public static function openAPIFormats() 'query' => 'setQuery', 'clusterName' => 'setClusterName', 'page' => 'setPage', - 'hitsPerPage' => 'setHitsPerPage' + 'hitsPerPage' => 'setHitsPerPage', ]; /** @@ -106,7 +107,7 @@ public static function openAPIFormats() 'query' => 'getQuery', 'clusterName' => 'getClusterName', 'page' => 'getPage', - 'hitsPerPage' => 'getHitsPerPage' + 'hitsPerPage' => 'getHitsPerPage', ]; /** @@ -150,7 +151,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -184,6 +184,7 @@ public function listInvalidProperties() if ($this->container['query'] === null) { $invalidProperties[] = "'query' can't be null"; } + return $invalidProperties; } @@ -198,7 +199,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets query * @@ -236,7 +236,7 @@ public function getClusterName() /** * Sets clusterName * - * @param string|null $clusterName Name of the cluster. + * @param string|null $clusterName name of the cluster * * @return self */ @@ -260,7 +260,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Specify the page to retrieve. + * @param int|null $page specify the page to retrieve * * @return self */ @@ -284,7 +284,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -297,9 +297,9 @@ public function setHitsPerPage($hitsPerPage) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -309,7 +309,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -338,7 +338,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -349,10 +349,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -383,4 +384,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php index 3c0a3ddf23..f70343d00e 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchUserIdsResponse Class Doc Comment * * @category Class * @description userIDs data. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -36,7 +37,7 @@ class SearchUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSeriali 'nbHits' => 'int', 'page' => 'int', 'hitsPerPage' => 'int', - 'updatedAt' => '\DateTime' + 'updatedAt' => '\DateTime', ]; /** @@ -51,7 +52,7 @@ class SearchUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSeriali 'nbHits' => null, 'page' => null, 'hitsPerPage' => null, - 'updatedAt' => 'date-time' + 'updatedAt' => 'date-time', ]; /** @@ -85,7 +86,7 @@ public static function openAPIFormats() 'nbHits' => 'nbHits', 'page' => 'page', 'hitsPerPage' => 'hitsPerPage', - 'updatedAt' => 'updatedAt' + 'updatedAt' => 'updatedAt', ]; /** @@ -98,7 +99,7 @@ public static function openAPIFormats() 'nbHits' => 'setNbHits', 'page' => 'setPage', 'hitsPerPage' => 'setHitsPerPage', - 'updatedAt' => 'setUpdatedAt' + 'updatedAt' => 'setUpdatedAt', ]; /** @@ -111,7 +112,7 @@ public static function openAPIFormats() 'nbHits' => 'getNbHits', 'page' => 'getPage', 'hitsPerPage' => 'getHitsPerPage', - 'updatedAt' => 'getUpdatedAt' + 'updatedAt' => 'getUpdatedAt', ]; /** @@ -155,7 +156,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -202,6 +202,7 @@ public function listInvalidProperties() if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } + return $invalidProperties; } @@ -216,7 +217,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets hits * @@ -230,7 +230,7 @@ public function getHits() /** * Sets hits * - * @param \Algolia\AlgoliaSearch\Model\SearchUserIdsResponseHits[] $hits List of user object matching the query. + * @param \Algolia\AlgoliaSearch\Model\SearchUserIdsResponseHits[] $hits list of user object matching the query * * @return self */ @@ -254,7 +254,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits Number of hits that the search query matched. + * @param int $nbHits number of hits that the search query matched * * @return self */ @@ -278,7 +278,7 @@ public function getPage() /** * Sets page * - * @param int $page Specify the page to retrieve. + * @param int $page specify the page to retrieve * * @return self */ @@ -326,7 +326,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -339,9 +339,9 @@ public function setUpdatedAt($updatedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -351,7 +351,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -380,7 +380,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -391,10 +391,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -425,4 +426,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php index c51f5eb88d..60367a5e5e 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchUserIdsResponseHighlightResult Class Doc Comment @@ -32,7 +32,7 @@ class SearchUserIdsResponseHighlightResult implements ModelInterface, ArrayAcces */ protected static $openAPITypes = [ 'userID' => '\Algolia\AlgoliaSearch\Model\HighlightResult', - 'clusterName' => '\Algolia\AlgoliaSearch\Model\HighlightResult' + 'clusterName' => '\Algolia\AlgoliaSearch\Model\HighlightResult', ]; /** @@ -44,7 +44,7 @@ class SearchUserIdsResponseHighlightResult implements ModelInterface, ArrayAcces */ protected static $openAPIFormats = [ 'userID' => null, - 'clusterName' => null + 'clusterName' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'userID' => 'userID', - 'clusterName' => 'clusterName' + 'clusterName' => 'clusterName', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'userID' => 'setUserID', - 'clusterName' => 'setClusterName' + 'clusterName' => 'setClusterName', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'userID' => 'getUserID', - 'clusterName' => 'getClusterName' + 'clusterName' => 'getClusterName', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -174,6 +173,7 @@ public function listInvalidProperties() if ($this->container['clusterName'] === null) { $invalidProperties[] = "'clusterName' can't be null"; } + return $invalidProperties; } @@ -188,7 +188,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets userID * @@ -239,9 +238,9 @@ public function setClusterName($clusterName) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -251,7 +250,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -280,7 +279,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -291,10 +290,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -325,4 +325,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php index 66c19bf600..c95fc5ba92 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchUserIdsResponseHits Class Doc Comment @@ -36,7 +36,7 @@ class SearchUserIdsResponseHits implements ModelInterface, ArrayAccess, \JsonSer 'nbRecords' => 'int', 'dataSize' => 'int', 'objectID' => 'string', - 'highlightResult' => '\Algolia\AlgoliaSearch\Model\SearchUserIdsResponseHighlightResult' + 'highlightResult' => '\Algolia\AlgoliaSearch\Model\SearchUserIdsResponseHighlightResult', ]; /** @@ -52,7 +52,7 @@ class SearchUserIdsResponseHits implements ModelInterface, ArrayAccess, \JsonSer 'nbRecords' => null, 'dataSize' => null, 'objectID' => null, - 'highlightResult' => null + 'highlightResult' => null, ]; /** @@ -87,7 +87,7 @@ public static function openAPIFormats() 'nbRecords' => 'nbRecords', 'dataSize' => 'dataSize', 'objectID' => 'objectID', - 'highlightResult' => '_highlightResult' + 'highlightResult' => '_highlightResult', ]; /** @@ -101,7 +101,7 @@ public static function openAPIFormats() 'nbRecords' => 'setNbRecords', 'dataSize' => 'setDataSize', 'objectID' => 'setObjectID', - 'highlightResult' => 'setHighlightResult' + 'highlightResult' => 'setHighlightResult', ]; /** @@ -115,7 +115,7 @@ public static function openAPIFormats() 'nbRecords' => 'getNbRecords', 'dataSize' => 'getDataSize', 'objectID' => 'getObjectID', - 'highlightResult' => 'getHighlightResult' + 'highlightResult' => 'getHighlightResult', ]; /** @@ -159,7 +159,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -210,6 +209,7 @@ public function listInvalidProperties() if ($this->container['highlightResult'] === null) { $invalidProperties[] = "'highlightResult' can't be null"; } + return $invalidProperties; } @@ -224,7 +224,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets userID * @@ -262,7 +261,7 @@ public function getClusterName() /** * Sets clusterName * - * @param string $clusterName Name of the cluster. + * @param string $clusterName name of the cluster * * @return self */ @@ -286,7 +285,7 @@ public function getNbRecords() /** * Sets nbRecords * - * @param int $nbRecords Number of records in the cluster. + * @param int $nbRecords number of records in the cluster * * @return self */ @@ -310,7 +309,7 @@ public function getDataSize() /** * Sets dataSize * - * @param int $dataSize Data size taken by all the users assigned to the cluster. + * @param int $dataSize data size taken by all the users assigned to the cluster * * @return self */ @@ -371,9 +370,9 @@ public function setHighlightResult($highlightResult) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -383,7 +382,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -412,7 +411,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -423,10 +422,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -457,4 +457,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SnippetResult.php b/clients/algoliasearch-client-php/lib/Model/SnippetResult.php index a508bd46e3..a53c369440 100644 --- a/clients/algoliasearch-client-php/lib/Model/SnippetResult.php +++ b/clients/algoliasearch-client-php/lib/Model/SnippetResult.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SnippetResult Class Doc Comment @@ -32,7 +32,7 @@ class SnippetResult implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'value' => 'string', - 'matchLevel' => 'string' + 'matchLevel' => 'string', ]; /** @@ -44,7 +44,7 @@ class SnippetResult implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'value' => null, - 'matchLevel' => null + 'matchLevel' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'value' => 'value', - 'matchLevel' => 'matchLevel' + 'matchLevel' => 'matchLevel', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'value' => 'setValue', - 'matchLevel' => 'setMatchLevel' + 'matchLevel' => 'setMatchLevel', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'value' => 'getValue', - 'matchLevel' => 'getMatchLevel' + 'matchLevel' => 'getMatchLevel', ]; /** @@ -208,7 +208,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets value * @@ -222,7 +221,7 @@ public function getValue() /** * Sets value * - * @param string|null $value Markup text with occurrences highlighted. + * @param string|null $value markup text with occurrences highlighted * * @return self */ @@ -246,7 +245,7 @@ public function getMatchLevel() /** * Sets matchLevel * - * @param string|null $matchLevel Indicates how well the attribute matched the search query. + * @param string|null $matchLevel indicates how well the attribute matched the search query * * @return self */ @@ -269,9 +268,9 @@ public function setMatchLevel($matchLevel) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -281,7 +280,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -310,7 +309,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -321,10 +320,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -355,4 +355,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Source.php b/clients/algoliasearch-client-php/lib/Model/Source.php index f78c6ba8fe..a366214e5c 100644 --- a/clients/algoliasearch-client-php/lib/Model/Source.php +++ b/clients/algoliasearch-client-php/lib/Model/Source.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Source Class Doc Comment * * @category Class * @description The source. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class Source implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'source' => 'string', - 'description' => 'string' + 'description' => 'string', ]; /** @@ -45,7 +46,7 @@ class Source implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'source' => null, - 'description' => null + 'description' => null, ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'source' => 'source', - 'description' => 'description' + 'description' => 'description', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'source' => 'setSource', - 'description' => 'setDescription' + 'description' => 'setDescription', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'source' => 'getSource', - 'description' => 'getDescription' + 'description' => 'getDescription', ]; /** @@ -140,7 +141,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -172,6 +172,7 @@ public function listInvalidProperties() if ($this->container['source'] === null) { $invalidProperties[] = "'source' can't be null"; } + return $invalidProperties; } @@ -186,7 +187,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets source * @@ -200,7 +200,7 @@ public function getSource() /** * Sets source * - * @param string $source The IP range of the source. + * @param string $source the IP range of the source * * @return self */ @@ -224,7 +224,7 @@ public function getDescription() /** * Sets description * - * @param string|null $description The description of the source. + * @param string|null $description the description of the source * * @return self */ @@ -237,9 +237,9 @@ public function setDescription($description) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -249,7 +249,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -278,7 +278,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -289,10 +289,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -323,4 +324,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/StandardEntries.php b/clients/algoliasearch-client-php/lib/Model/StandardEntries.php index 88e8918f9f..a4725918f6 100644 --- a/clients/algoliasearch-client-php/lib/Model/StandardEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/StandardEntries.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * StandardEntries Class Doc Comment * * @category Class * @description Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class StandardEntries implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'plurals' => 'array', 'stopwords' => 'array', - 'compounds' => 'array' + 'compounds' => 'array', ]; /** @@ -47,7 +48,7 @@ class StandardEntries implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'plurals' => null, 'stopwords' => null, - 'compounds' => null + 'compounds' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'plurals' => 'plurals', 'stopwords' => 'stopwords', - 'compounds' => 'compounds' + 'compounds' => 'compounds', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'plurals' => 'setPlurals', 'stopwords' => 'setStopwords', - 'compounds' => 'setCompounds' + 'compounds' => 'setCompounds', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'plurals' => 'getPlurals', 'stopwords' => 'getStopwords', - 'compounds' => 'getCompounds' + 'compounds' => 'getCompounds', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -189,7 +189,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets plurals * @@ -203,7 +202,7 @@ public function getPlurals() /** * Sets plurals * - * @param array|null $plurals Language ISO code. + * @param array|null $plurals language ISO code * * @return self */ @@ -227,7 +226,7 @@ public function getStopwords() /** * Sets stopwords * - * @param array|null $stopwords Language ISO code. + * @param array|null $stopwords language ISO code * * @return self */ @@ -251,7 +250,7 @@ public function getCompounds() /** * Sets compounds * - * @param array|null $compounds Language ISO code. + * @param array|null $compounds language ISO code * * @return self */ @@ -264,9 +263,9 @@ public function setCompounds($compounds) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -276,7 +275,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -305,7 +304,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -316,10 +315,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -350,4 +350,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SynonymHit.php b/clients/algoliasearch-client-php/lib/Model/SynonymHit.php index cab013367c..dddf6bc20c 100644 --- a/clients/algoliasearch-client-php/lib/Model/SynonymHit.php +++ b/clients/algoliasearch-client-php/lib/Model/SynonymHit.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SynonymHit Class Doc Comment * * @category Class * @description Synonym object. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -40,7 +41,7 @@ class SynonymHit implements ModelInterface, ArrayAccess, \JsonSerializable 'corrections' => 'string[]', 'placeholder' => 'string', 'replacements' => 'string[]', - 'highlightResult' => '\Algolia\AlgoliaSearch\Model\SynonymHitHighlightResult' + 'highlightResult' => '\Algolia\AlgoliaSearch\Model\SynonymHitHighlightResult', ]; /** @@ -59,7 +60,7 @@ class SynonymHit implements ModelInterface, ArrayAccess, \JsonSerializable 'corrections' => null, 'placeholder' => null, 'replacements' => null, - 'highlightResult' => null + 'highlightResult' => null, ]; /** @@ -97,7 +98,7 @@ public static function openAPIFormats() 'corrections' => 'corrections', 'placeholder' => 'placeholder', 'replacements' => 'replacements', - 'highlightResult' => '_highlightResult' + 'highlightResult' => '_highlightResult', ]; /** @@ -114,7 +115,7 @@ public static function openAPIFormats() 'corrections' => 'setCorrections', 'placeholder' => 'setPlaceholder', 'replacements' => 'setReplacements', - 'highlightResult' => 'setHighlightResult' + 'highlightResult' => 'setHighlightResult', ]; /** @@ -131,7 +132,7 @@ public static function openAPIFormats() 'corrections' => 'getCorrections', 'placeholder' => 'getPlaceholder', 'replacements' => 'getReplacements', - 'highlightResult' => 'getHighlightResult' + 'highlightResult' => 'getHighlightResult', ]; /** @@ -261,7 +262,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -275,7 +275,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID Unique identifier of the synonym object to be created or updated. + * @param string $objectID unique identifier of the synonym object to be created or updated * * @return self */ @@ -299,7 +299,7 @@ public function getType() /** * Sets type * - * @param string $type Type of the synonym object. + * @param string $type type of the synonym object * * @return self */ @@ -333,7 +333,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param string[]|null $synonyms Words or phrases to be considered equivalent. + * @param string[]|null $synonyms words or phrases to be considered equivalent * * @return self */ @@ -357,7 +357,7 @@ public function getInput() /** * Sets input * - * @param string|null $input Word or phrase to appear in query strings (for onewaysynonym). + * @param string|null $input word or phrase to appear in query strings (for onewaysynonym) * * @return self */ @@ -381,7 +381,7 @@ public function getWord() /** * Sets word * - * @param string|null $word Word or phrase to appear in query strings (for altcorrection1 and altcorrection2). + * @param string|null $word word or phrase to appear in query strings (for altcorrection1 and altcorrection2) * * @return self */ @@ -405,7 +405,7 @@ public function getCorrections() /** * Sets corrections * - * @param string[]|null $corrections Words to be matched in records. + * @param string[]|null $corrections words to be matched in records * * @return self */ @@ -429,7 +429,7 @@ public function getPlaceholder() /** * Sets placeholder * - * @param string|null $placeholder Token to be put inside records. + * @param string|null $placeholder token to be put inside records * * @return self */ @@ -453,7 +453,7 @@ public function getReplacements() /** * Sets replacements * - * @param string[]|null $replacements List of query words that will match the token. + * @param string[]|null $replacements list of query words that will match the token * * @return self */ @@ -490,9 +490,9 @@ public function setHighlightResult($highlightResult) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -502,7 +502,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -531,7 +531,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -542,10 +542,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -576,4 +577,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php b/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php index 5fc7fac8f2..a87187c8ed 100644 --- a/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php +++ b/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SynonymHitHighlightResult Class Doc Comment * * @category Class * @description Highlighted results + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class SynonymHitHighlightResult implements ModelInterface, ArrayAccess, \JsonSer */ protected static $openAPITypes = [ 'type' => '\Algolia\AlgoliaSearch\Model\HighlightResult', - 'synonyms' => '\Algolia\AlgoliaSearch\Model\HighlightResult[]' + 'synonyms' => '\Algolia\AlgoliaSearch\Model\HighlightResult[]', ]; /** @@ -45,7 +46,7 @@ class SynonymHitHighlightResult implements ModelInterface, ArrayAccess, \JsonSer */ protected static $openAPIFormats = [ 'type' => null, - 'synonyms' => null + 'synonyms' => null, ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'type' => 'type', - 'synonyms' => 'synonyms' + 'synonyms' => 'synonyms', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'type' => 'setType', - 'synonyms' => 'setSynonyms' + 'synonyms' => 'setSynonyms', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'type' => 'getType', - 'synonyms' => 'getSynonyms' + 'synonyms' => 'getSynonyms', ]; /** @@ -140,7 +141,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -183,7 +183,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -234,9 +233,9 @@ public function setSynonyms($synonyms) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -246,7 +245,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -275,7 +274,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -286,10 +285,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -320,4 +320,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/TimeRange.php b/clients/algoliasearch-client-php/lib/Model/TimeRange.php index d9b5b8ff4d..ed041ae6c9 100644 --- a/clients/algoliasearch-client-php/lib/Model/TimeRange.php +++ b/clients/algoliasearch-client-php/lib/Model/TimeRange.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * TimeRange Class Doc Comment @@ -32,7 +32,7 @@ class TimeRange implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'from' => 'int', - 'until' => 'int' + 'until' => 'int', ]; /** @@ -44,7 +44,7 @@ class TimeRange implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'from' => null, - 'until' => null + 'until' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'from' => 'from', - 'until' => 'until' + 'until' => 'until', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'from' => 'setFrom', - 'until' => 'setUntil' + 'until' => 'setUntil', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'from' => 'getFrom', - 'until' => 'getUntil' + 'until' => 'getUntil', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -174,6 +173,7 @@ public function listInvalidProperties() if ($this->container['until'] === null) { $invalidProperties[] = "'until' can't be null"; } + return $invalidProperties; } @@ -188,7 +188,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets from * @@ -202,7 +201,7 @@ public function getFrom() /** * Sets from * - * @param int $from Lower bound of the time range (Unix timestamp). + * @param int $from lower bound of the time range (Unix timestamp) * * @return self */ @@ -226,7 +225,7 @@ public function getUntil() /** * Sets until * - * @param int $until Upper bound of the time range (Unix timestamp). + * @param int $until upper bound of the time range (Unix timestamp) * * @return self */ @@ -239,9 +238,9 @@ public function setUntil($until) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -251,7 +250,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -280,7 +279,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -291,10 +290,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -325,4 +325,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php index 9030ab6488..e5cf8339e9 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * UpdateApiKeyResponse Class Doc Comment @@ -32,7 +32,7 @@ class UpdateApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializ */ protected static $openAPITypes = [ 'key' => 'string', - 'updatedAt' => '\DateTime' + 'updatedAt' => '\DateTime', ]; /** @@ -44,7 +44,7 @@ class UpdateApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializ */ protected static $openAPIFormats = [ 'key' => null, - 'updatedAt' => 'date-time' + 'updatedAt' => 'date-time', ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'key' => 'key', - 'updatedAt' => 'updatedAt' + 'updatedAt' => 'updatedAt', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'key' => 'setKey', - 'updatedAt' => 'setUpdatedAt' + 'updatedAt' => 'setUpdatedAt', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'key' => 'getKey', - 'updatedAt' => 'getUpdatedAt' + 'updatedAt' => 'getUpdatedAt', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -174,6 +173,7 @@ public function listInvalidProperties() if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } + return $invalidProperties; } @@ -188,7 +188,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets key * @@ -202,7 +201,7 @@ public function getKey() /** * Sets key * - * @param string $key Key string. + * @param string $key key string * * @return self */ @@ -226,7 +225,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -239,9 +238,9 @@ public function setUpdatedAt($updatedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -251,7 +250,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -280,7 +279,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -291,10 +290,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -325,4 +325,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php index cc85dcb1ac..00ac404481 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * UpdatedAtResponse Class Doc Comment * * @category Class * @description The response with a taskID and an updatedAt timestamp. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class UpdatedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPITypes = [ 'taskID' => 'int', - 'updatedAt' => '\DateTime' + 'updatedAt' => '\DateTime', ]; /** @@ -45,7 +46,7 @@ class UpdatedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPIFormats = [ 'taskID' => null, - 'updatedAt' => 'date-time' + 'updatedAt' => 'date-time', ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'taskID' => 'taskID', - 'updatedAt' => 'updatedAt' + 'updatedAt' => 'updatedAt', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'taskID' => 'setTaskID', - 'updatedAt' => 'setUpdatedAt' + 'updatedAt' => 'setUpdatedAt', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'taskID' => 'getTaskID', - 'updatedAt' => 'getUpdatedAt' + 'updatedAt' => 'getUpdatedAt', ]; /** @@ -140,7 +141,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -175,6 +175,7 @@ public function listInvalidProperties() if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } + return $invalidProperties; } @@ -189,7 +190,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets taskID * @@ -203,7 +203,7 @@ public function getTaskID() /** * Sets taskID * - * @param int $taskID taskID of the indexing task to wait for. + * @param int $taskID taskID of the indexing task to wait for * * @return self */ @@ -227,7 +227,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -240,9 +240,9 @@ public function setUpdatedAt($updatedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -252,7 +252,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -281,7 +281,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -292,10 +292,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -326,4 +327,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php index 49fafad1cf..c5c6a6920d 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * UpdatedAtWithObjectIdResponse Class Doc Comment * * @category Class * @description The response with a taskID, an objectID and an updatedAt timestamp. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class UpdatedAtWithObjectIdResponse implements ModelInterface, ArrayAccess, \Jso protected static $openAPITypes = [ 'taskID' => 'int', 'updatedAt' => '\DateTime', - 'objectID' => 'string' + 'objectID' => 'string', ]; /** @@ -47,7 +48,7 @@ class UpdatedAtWithObjectIdResponse implements ModelInterface, ArrayAccess, \Jso protected static $openAPIFormats = [ 'taskID' => null, 'updatedAt' => 'date-time', - 'objectID' => null + 'objectID' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'taskID' => 'taskID', 'updatedAt' => 'updatedAt', - 'objectID' => 'objectID' + 'objectID' => 'objectID', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'taskID' => 'setTaskID', 'updatedAt' => 'setUpdatedAt', - 'objectID' => 'setObjectID' + 'objectID' => 'setObjectID', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'taskID' => 'getTaskID', 'updatedAt' => 'getUpdatedAt', - 'objectID' => 'getObjectID' + 'objectID' => 'getObjectID', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -189,7 +189,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets taskID * @@ -203,7 +202,7 @@ public function getTaskID() /** * Sets taskID * - * @param int|null $taskID taskID of the indexing task to wait for. + * @param int|null $taskID taskID of the indexing task to wait for * * @return self */ @@ -227,7 +226,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime|null $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime|null $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -251,7 +250,7 @@ public function getObjectID() /** * Sets objectID * - * @param string|null $objectID Unique identifier of the object. + * @param string|null $objectID unique identifier of the object * * @return self */ @@ -264,9 +263,9 @@ public function setObjectID($objectID) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -276,7 +275,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -305,7 +304,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -316,10 +315,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -350,4 +350,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php index 2cc041c7a4..176d87e459 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * UpdatedRuleResponse Class Doc Comment @@ -33,7 +33,7 @@ class UpdatedRuleResponse implements ModelInterface, ArrayAccess, \JsonSerializa protected static $openAPITypes = [ 'objectID' => 'string', 'updatedAt' => '\DateTime', - 'taskID' => 'int' + 'taskID' => 'int', ]; /** @@ -46,7 +46,7 @@ class UpdatedRuleResponse implements ModelInterface, ArrayAccess, \JsonSerializa protected static $openAPIFormats = [ 'objectID' => null, 'updatedAt' => 'date-time', - 'taskID' => null + 'taskID' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'objectID' => 'objectID', 'updatedAt' => 'updatedAt', - 'taskID' => 'taskID' + 'taskID' => 'taskID', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'objectID' => 'setObjectID', 'updatedAt' => 'setUpdatedAt', - 'taskID' => 'setTaskID' + 'taskID' => 'setTaskID', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'objectID' => 'getObjectID', 'updatedAt' => 'getUpdatedAt', - 'taskID' => 'getTaskID' + 'taskID' => 'getTaskID', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -183,6 +182,7 @@ public function listInvalidProperties() if ($this->container['taskID'] === null) { $invalidProperties[] = "'taskID' can't be null"; } + return $invalidProperties; } @@ -197,7 +197,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -211,7 +210,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID Unique identifier of the object. + * @param string $objectID unique identifier of the object * * @return self */ @@ -235,7 +234,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -259,7 +258,7 @@ public function getTaskID() /** * Sets taskID * - * @param int $taskID taskID of the indexing task to wait for. + * @param int $taskID taskID of the indexing task to wait for * * @return self */ @@ -272,9 +271,9 @@ public function setTaskID($taskID) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -284,7 +283,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -313,7 +312,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -324,10 +323,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -358,4 +358,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/UserId.php b/clients/algoliasearch-client-php/lib/Model/UserId.php index 84d828f010..575f4b4548 100644 --- a/clients/algoliasearch-client-php/lib/Model/UserId.php +++ b/clients/algoliasearch-client-php/lib/Model/UserId.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * UserId Class Doc Comment * * @category Class * @description A userID. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +36,7 @@ class UserId implements ModelInterface, ArrayAccess, \JsonSerializable 'userID' => 'string', 'clusterName' => 'string', 'nbRecords' => 'int', - 'dataSize' => 'int' + 'dataSize' => 'int', ]; /** @@ -49,7 +50,7 @@ class UserId implements ModelInterface, ArrayAccess, \JsonSerializable 'userID' => null, 'clusterName' => null, 'nbRecords' => null, - 'dataSize' => null + 'dataSize' => null, ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() 'userID' => 'userID', 'clusterName' => 'clusterName', 'nbRecords' => 'nbRecords', - 'dataSize' => 'dataSize' + 'dataSize' => 'dataSize', ]; /** @@ -94,7 +95,7 @@ public static function openAPIFormats() 'userID' => 'setUserID', 'clusterName' => 'setClusterName', 'nbRecords' => 'setNbRecords', - 'dataSize' => 'setDataSize' + 'dataSize' => 'setDataSize', ]; /** @@ -106,7 +107,7 @@ public static function openAPIFormats() 'userID' => 'getUserID', 'clusterName' => 'getClusterName', 'nbRecords' => 'getNbRecords', - 'dataSize' => 'getDataSize' + 'dataSize' => 'getDataSize', ]; /** @@ -150,7 +151,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -193,6 +193,7 @@ public function listInvalidProperties() if ($this->container['dataSize'] === null) { $invalidProperties[] = "'dataSize' can't be null"; } + return $invalidProperties; } @@ -207,7 +208,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets userID * @@ -221,7 +221,7 @@ public function getUserID() /** * Sets userID * - * @param string $userID userID of the user. + * @param string $userID userID of the user * * @return self */ @@ -245,7 +245,7 @@ public function getClusterName() /** * Sets clusterName * - * @param string $clusterName Cluster on which the user is assigned. + * @param string $clusterName cluster on which the user is assigned * * @return self */ @@ -269,7 +269,7 @@ public function getNbRecords() /** * Sets nbRecords * - * @param int $nbRecords Number of records belonging to the user. + * @param int $nbRecords number of records belonging to the user * * @return self */ @@ -293,7 +293,7 @@ public function getDataSize() /** * Sets dataSize * - * @param int $dataSize Data size used by the user. + * @param int $dataSize data size used by the user * * @return self */ @@ -306,9 +306,9 @@ public function setDataSize($dataSize) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -318,7 +318,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -347,7 +347,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -358,10 +358,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -392,4 +393,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/ObjectSerializer.php b/clients/algoliasearch-client-php/lib/ObjectSerializer.php index 25900ca3fa..485916ff41 100644 --- a/clients/algoliasearch-client-php/lib/ObjectSerializer.php +++ b/clients/algoliasearch-client-php/lib/ObjectSerializer.php @@ -48,6 +48,7 @@ public static function sanitizeForSerialization($data, $type = null, $format = n foreach ($data as $property => $value) { $data[$property] = self::sanitizeForSerialization($value); } + return $data; } @@ -65,6 +66,7 @@ public static function sanitizeForSerialization($data, $type = null, $format = n $allowedEnumTypes = $callable(); if (!in_array($value, $allowedEnumTypes, true)) { $imploded = implode("', '", $allowedEnumTypes); + throw new \InvalidArgumentException("Invalid value for enum '$openAPIType', must be one of: '$imploded'"); } } @@ -78,10 +80,12 @@ public static function sanitizeForSerialization($data, $type = null, $format = n $values[$property] = self::sanitizeForSerialization($value); } } - return (object)$values; - } else { - return (string)$data; + + return (object) $values; } + + return (string) $data; + } /** @@ -96,9 +100,10 @@ public static function sanitizeFilename($filename) { if (preg_match("/.*[\/\\\\](.*)$/", $filename, $match)) { return $match[1]; - } else { - return $filename; } + + return $filename; + } /** @@ -128,9 +133,10 @@ public static function toQueryValue($object) { if (is_array($object)) { return implode(',', $object); - } else { - return self::toString($object); } + + return self::toString($object); + } /** @@ -165,9 +171,10 @@ public static function toFormValue($value) { if ($value instanceof \SplFileObject) { return $value->getRealPath(); - } else { - return self::toString($value); } + + return self::toString($value); + } /** @@ -186,9 +193,10 @@ public static function toString($value) return $value->format(self::$dateTimeFormat); } elseif (is_bool($value)) { return $value ? 'true' : 'false'; - } else { - return $value; } + + return $value; + } /** @@ -244,41 +252,45 @@ public static function deserialize($data, $class, $httpHeaders = null) return null; } - if (strcasecmp(substr($class, -2), '[]') === 0) { + if (strcasecmp(mb_substr($class, -2), '[]') === 0) { $data = is_string($data) ? json_decode($data) : $data; if (!is_array($data)) { throw new \InvalidArgumentException("Invalid array '$class'"); } - $subClass = substr($class, 0, -2); + $subClass = mb_substr($class, 0, -2); $values = []; foreach ($data as $key => $value) { $values[] = self::deserialize($value, $subClass, null); } + return $values; } if (preg_match('/^(array<|map\[)/', $class)) { // for associative array e.g. array $data = is_string($data) ? json_decode($data) : $data; settype($data, 'array'); - $inner = substr($class, 4, -1); + $inner = mb_substr($class, 4, -1); $deserialized = []; - if (strrpos($inner, ",") !== false) { + if (mb_strrpos($inner, ',') !== false) { $subClass_array = explode(',', $inner, 2); $subClass = $subClass_array[1]; foreach ($data as $key => $value) { $deserialized[$key] = self::deserialize($value, $subClass, null); } } + return $deserialized; } if ($class === 'object') { settype($data, 'array'); + return $data; - } else if ($class === 'mixed') { + } elseif ($class === 'mixed') { settype($data, gettype($data)); + return $data; } @@ -307,6 +319,7 @@ public static function deserialize($data, $class, $httpHeaders = null) /** @psalm-suppress ParadoxicalCondition */ if (in_array($class, ['\DateTime', '\SplFileObject', 'array', 'bool', 'boolean', 'byte', 'double', 'float', 'int', 'integer', 'mixed', 'number', 'object', 'string', 'void'], true)) { settype($data, $class); + return $data; } @@ -331,10 +344,12 @@ public static function deserialize($data, $class, $httpHeaders = null) } elseif (method_exists($class, 'getAllowableEnumValues')) { if (!in_array($data, $class::getAllowableEnumValues(), true)) { $imploded = implode("', '", $class::getAllowableEnumValues()); + throw new \InvalidArgumentException("Invalid value for enum '$class', must be one of: '$imploded'"); } + return $data; - } else { + } $data = is_string($data) ? json_decode($data) : $data; // If a discriminator is defined and points to a valid subclass, use it. $discriminator = $class::DISCRIMINATOR; @@ -359,7 +374,8 @@ public static function deserialize($data, $class, $httpHeaders = null) $instance->$propertySetter(self::deserialize($propertyValue, $type, null)); } } + return $instance; - } + } } diff --git a/templates/php/.php-cs-fixer.php b/templates/php/.php-cs-fixer.php new file mode 100644 index 0000000000..92c5739215 --- /dev/null +++ b/templates/php/.php-cs-fixer.php @@ -0,0 +1,59 @@ +setUsingCache(true) + ->setRules([ + 'array_syntax' => [ 'syntax' => 'short' ], + 'blank_line_after_namespace' => false, + 'blank_line_after_opening_tag' => true, + 'blank_line_before_return' => true, + 'braces' => false, + 'cast_spaces' => true, + 'combine_consecutive_unsets' => true, + 'mb_str_functions' => true, + 'no_blank_lines_after_class_opening' => true, + 'no_empty_phpdoc' => true, + 'no_empty_statement' => true, + 'no_extra_consecutive_blank_lines' => true, + 'no_multiline_whitespace_around_double_arrow' => true, + 'no_short_bool_cast' => true, + 'no_short_echo_tag' => true, + 'no_trailing_whitespace' => false, + 'no_trailing_whitespace_in_comment' => false, + 'no_unneeded_control_parentheses' => true, + 'no_unreachable_default_argument_value' => true, + 'no_unused_imports' => true, + 'no_useless_else' => true, + 'no_useless_return' => true, + 'no_whitespace_before_comma_in_array' => true, + 'no_whitespace_in_blank_line' => true, + 'normalize_index_brace' => true, + 'not_operator_with_space' => false, + 'object_operator_without_whitespace' => true, + 'ordered_imports' => true, + 'phpdoc_annotation_without_dot' => true, + 'phpdoc_inline_tag' => true, + 'phpdoc_order' => true, + 'phpdoc_scalar' => true, + 'phpdoc_separation' => true, + 'phpdoc_single_line_var_spacing' => true, + 'protected_to_private' => true, + 'psr4' => true, + 'short_scalar_cast' => true, + 'single_blank_line_at_eof' => false, + 'single_blank_line_before_namespace' => true, + 'single_quote' => true, + 'space_after_semicolon' => true, + 'standardize_not_equals' => true, + 'strict_comparison' => true, + 'strict_param' => true, + 'ternary_operator_spaces' => true, + 'trailing_comma_in_multiline_array' => true, + 'trim_array_spaces' => true, + ]) + ->setFinder( + PhpCsFixer\Finder::create() + ->exclude('test') + ->exclude('tests') + ->in(__DIR__) + ); diff --git a/templates/php/.php_cs b/templates/php/.php_cs deleted file mode 100644 index 4fbe53ec5f..0000000000 --- a/templates/php/.php_cs +++ /dev/null @@ -1,23 +0,0 @@ -setUsingCache(true) - ->setRules([ - '@PSR2' => true, - 'ordered_imports' => true, - 'phpdoc_order' => true, - 'array_syntax' => [ 'syntax' => 'short' ], - 'strict_comparison' => true, - 'strict_param' => true, - 'no_trailing_whitespace' => false, - 'no_trailing_whitespace_in_comment' => false, - 'braces' => false, - 'single_blank_line_at_eof' => false, - 'blank_line_after_namespace' => false, - ]) - ->setFinder( - PhpCsFixer\Finder::create() - ->exclude('test') - ->exclude('tests') - ->in(__DIR__) - ); diff --git a/templates/php/gitignore b/templates/php/gitignore index 3d513912a6..aa44c17b5e 100644 --- a/templates/php/gitignore +++ b/templates/php/gitignore @@ -10,3 +10,4 @@ composer.phar .phpunit.result.cache .openapi-generator/ +composer.lock From e72c29dd1871309cea484c4f9dc95c4058c8544c Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Wed, 12 Jan 2022 15:54:08 +0100 Subject: [PATCH 02/13] chore: add linter --- clients/algoliasearch-client-php/.php_cs | 23 ++ .../lib/Api/SearchApi.php | 222 +++++++----------- .../lib/ApiException.php | 3 +- .../lib/Configuration.php | 28 +-- .../lib/HeaderSelector.php | 17 +- .../lib/Model/Action.php | 6 +- .../lib/Model/AddApiKeyResponse.php | 33 +-- .../lib/Model/Anchoring.php | 6 +- .../lib/Model/ApiKey.php | 33 ++- .../lib/Model/AssignUserIdObject.php | 32 +-- .../lib/Model/AutomaticFacetFilter.php | 32 +-- .../lib/Model/BaseBrowseResponse.php | 29 +-- .../lib/Model/BaseIndexSettings.php | 52 ++-- .../lib/Model/BaseSearchParams.php | 90 +++---- .../lib/Model/BaseSearchResponse.php | 69 +++--- .../Model/BaseSearchResponseFacetsStats.php | 36 +-- .../lib/Model/BatchAssignUserIdsObject.php | 32 +-- .../lib/Model/BatchDictionaryEntries.php | 32 +-- .../Model/BatchDictionaryEntriesRequest.php | 30 +-- .../lib/Model/BatchObject.php | 29 +-- .../lib/Model/BatchResponse.php | 32 +-- .../lib/Model/BatchWriteObject.php | 29 +-- .../lib/Model/BrowseRequest.php | 30 +-- .../lib/Model/BrowseResponse.php | 69 +++--- .../lib/Model/BuildInOperation.php | 33 ++- .../lib/Model/Condition.php | 32 +-- .../lib/Model/Consequence.php | 31 +-- .../lib/Model/ConsequenceHide.php | 32 +-- .../lib/Model/ConsequenceParams.php | 177 +++++++------- .../lib/Model/CreatedAtObject.php | 31 +-- .../lib/Model/CreatedAtResponse.php | 32 +-- .../lib/Model/DeleteApiKeyResponse.php | 31 +-- .../lib/Model/DeleteSourceResponse.php | 31 +-- .../lib/Model/DeletedAtResponse.php | 34 +-- .../lib/Model/DictionaryEntry.php | 38 +-- .../lib/Model/DictionaryLanguage.php | 29 +-- .../lib/Model/DictionarySettingsRequest.php | 30 +-- .../lib/Model/ErrorBase.php | 29 +-- .../Model/GetDictionarySettingsResponse.php | 29 +-- .../lib/Model/GetLogsResponse.php | 29 +-- .../lib/Model/GetLogsResponseInnerQueries.php | 34 +-- .../lib/Model/GetLogsResponseLogs.php | 53 +++-- .../lib/Model/GetObjectsObject.php | 29 +-- .../lib/Model/GetObjectsResponse.php | 30 +-- .../lib/Model/GetTaskResponse.php | 27 ++- .../lib/Model/GetTopUserIdsResponse.php | 32 +-- .../lib/Model/HighlightResult.php | 36 +-- .../lib/Model/Index.php | 39 +-- .../lib/Model/IndexSettings.php | 134 +++++------ .../lib/Model/IndexSettingsAsSearchParams.php | 109 ++++----- .../lib/Model/KeyObject.php | 34 +-- .../lib/Model/Languages.php | 30 +-- .../lib/Model/ListApiKeysResponse.php | 31 +-- .../lib/Model/ListClustersResponse.php | 32 +-- .../lib/Model/ListIndicesResponse.php | 32 +-- .../lib/Model/ListUserIdsResponse.php | 32 +-- .../lib/Model/MultipleBatchResponse.php | 32 +-- .../lib/Model/MultipleGetObjectsObject.php | 34 +-- .../lib/Model/MultipleQueries.php | 37 +-- .../lib/Model/MultipleQueriesObject.php | 27 ++- .../lib/Model/MultipleQueriesResponse.php | 28 ++- .../lib/Model/Operation.php | 32 +-- .../lib/Model/OperationIndexObject.php | 32 +-- .../lib/Model/Params.php | 35 +-- .../lib/Model/Promote.php | 34 +-- .../lib/Model/RankingInfo.php | 48 ++-- .../Model/RankingInfoMatchedGeoLocation.php | 38 +-- .../lib/Model/Record.php | 32 +-- .../lib/Model/RemoveUserIdResponse.php | 31 +-- .../lib/Model/ReplaceSourceResponse.php | 31 +-- .../lib/Model/RequiredSearchParams.php | 31 +-- .../lib/Model/Rule.php | 32 +-- .../lib/Model/SaveObjectResponse.php | 32 +-- .../lib/Model/SaveSynonymResponse.php | 35 +-- .../lib/Model/SearchDictionaryEntries.php | 36 +-- .../lib/Model/SearchForFacetValuesRequest.php | 32 +-- .../Model/SearchForFacetValuesResponse.php | 29 +-- .../SearchForFacetValuesResponseFacetHits.php | 33 +-- .../lib/Model/SearchHits.php | 28 ++- .../lib/Model/SearchParams.php | 175 +++++++------- .../lib/Model/SearchParamsObject.php | 173 +++++++------- .../lib/Model/SearchParamsString.php | 30 +-- .../lib/Model/SearchResponse.php | 69 +++--- .../lib/Model/SearchRulesParams.php | 37 +-- .../lib/Model/SearchRulesResponse.php | 37 +-- .../lib/Model/SearchSynonymsResponse.php | 33 +-- .../lib/Model/SearchUserIdsObject.php | 36 +-- .../lib/Model/SearchUserIdsResponse.php | 38 +-- .../SearchUserIdsResponseHighlightResult.php | 29 +-- .../lib/Model/SearchUserIdsResponseHits.php | 35 +-- .../lib/Model/SnippetResult.php | 31 +-- .../lib/Model/Source.php | 34 +-- .../lib/Model/StandardEntries.php | 35 +-- .../lib/Model/SynonymHit.php | 44 ++-- .../lib/Model/SynonymHitHighlightResult.php | 29 +-- .../lib/Model/TimeRange.php | 33 +-- .../lib/Model/UpdateApiKeyResponse.php | 33 +-- .../lib/Model/UpdatedAtResponse.php | 34 +-- .../Model/UpdatedAtWithObjectIdResponse.php | 35 +-- .../lib/Model/UpdatedRuleResponse.php | 35 +-- .../lib/Model/UserId.php | 38 +-- .../lib/ObjectSerializer.php | 52 ++-- scripts/post-gen/php.sh | 17 ++ 103 files changed, 2143 insertions(+), 2114 deletions(-) create mode 100644 clients/algoliasearch-client-php/.php_cs create mode 100755 scripts/post-gen/php.sh diff --git a/clients/algoliasearch-client-php/.php_cs b/clients/algoliasearch-client-php/.php_cs new file mode 100644 index 0000000000..4fbe53ec5f --- /dev/null +++ b/clients/algoliasearch-client-php/.php_cs @@ -0,0 +1,23 @@ +setUsingCache(true) + ->setRules([ + '@PSR2' => true, + 'ordered_imports' => true, + 'phpdoc_order' => true, + 'array_syntax' => [ 'syntax' => 'short' ], + 'strict_comparison' => true, + 'strict_param' => true, + 'no_trailing_whitespace' => false, + 'no_trailing_whitespace_in_comment' => false, + 'braces' => false, + 'single_blank_line_at_eof' => false, + 'blank_line_after_namespace' => false, + ]) + ->setFinder( + PhpCsFixer\Finder::create() + ->exclude('test') + ->exclude('tests') + ->in(__DIR__) + ); diff --git a/clients/algoliasearch-client-php/lib/Api/SearchApi.php b/clients/algoliasearch-client-php/lib/Api/SearchApi.php index 0af73c90fc..9491959484 100644 --- a/clients/algoliasearch-client-php/lib/Api/SearchApi.php +++ b/clients/algoliasearch-client-php/lib/Api/SearchApi.php @@ -2,16 +2,17 @@ namespace Algolia\AlgoliaSearch\Api; -use Algolia\AlgoliaSearch\ApiException; -use Algolia\AlgoliaSearch\Configuration; -use Algolia\AlgoliaSearch\HeaderSelector; -use Algolia\AlgoliaSearch\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; -use GuzzleHttp\Exception\ConnectException; use GuzzleHttp\Exception\RequestException; +use GuzzleHttp\Exception\ConnectException; +use GuzzleHttp\Psr7\MultipartStream; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; +use Algolia\AlgoliaSearch\ApiException; +use Algolia\AlgoliaSearch\Configuration; +use Algolia\AlgoliaSearch\HeaderSelector; +use Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchApi Class Doc Comment @@ -90,7 +91,6 @@ public function getConfig() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\AddApiKeyResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function addApiKey($apiKey) @@ -142,7 +142,7 @@ public function addApiKey($apiKey) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\AddApiKeyResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -160,7 +160,6 @@ public function addApiKey($apiKey) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtWithObjectIdResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function addOrUpdateObject($indexName, $objectID, $body) @@ -240,7 +239,7 @@ public function addOrUpdateObject($indexName, $objectID, $body) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtWithObjectIdResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -254,7 +253,6 @@ public function addOrUpdateObject($indexName, $objectID, $body) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\CreatedAtResponse */ public function appendSource($source) @@ -306,7 +304,7 @@ public function appendSource($source) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\CreatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -323,7 +321,6 @@ public function appendSource($source) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\CreatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) @@ -334,8 +331,8 @@ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) 'Missing the required parameter $xAlgoliaUserID when calling assignUserId' ); } - if (!preg_match('/^[a-zA-Z0-9 \\-*.]+$/', $xAlgoliaUserID)) { - throw new \InvalidArgumentException('invalid value for "xAlgoliaUserID" when calling SearchApi.assignUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/.'); + if (!preg_match("/^[a-zA-Z0-9 \\-*.]+$/", $xAlgoliaUserID)) { + throw new \InvalidArgumentException("invalid value for \"xAlgoliaUserID\" when calling SearchApi.assignUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/."); } // verify the required parameter 'assignUserIdObject' is set @@ -392,7 +389,7 @@ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\CreatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -407,7 +404,6 @@ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\BatchResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function batch($indexName, $batchWriteObject) @@ -473,7 +469,7 @@ public function batch($indexName, $batchWriteObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\BatchResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -490,7 +486,6 @@ public function batch($indexName, $batchWriteObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\CreatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) @@ -501,8 +496,8 @@ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) 'Missing the required parameter $xAlgoliaUserID when calling batchAssignUserIds' ); } - if (!preg_match('/^[a-zA-Z0-9 \\-*.]+$/', $xAlgoliaUserID)) { - throw new \InvalidArgumentException('invalid value for "xAlgoliaUserID" when calling SearchApi.batchAssignUserIds, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/.'); + if (!preg_match("/^[a-zA-Z0-9 \\-*.]+$/", $xAlgoliaUserID)) { + throw new \InvalidArgumentException("invalid value for \"xAlgoliaUserID\" when calling SearchApi.batchAssignUserIds, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/."); } // verify the required parameter 'batchAssignUserIdsObject' is set @@ -559,7 +554,7 @@ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\CreatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -576,7 +571,6 @@ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) @@ -642,7 +636,7 @@ public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -661,7 +655,6 @@ public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function batchRules($indexName, $rule, $forwardToReplicas = null, $clearExistingRules = null) @@ -741,7 +734,7 @@ public function batchRules($indexName, $rule, $forwardToReplicas = null, $clearE $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -758,7 +751,6 @@ public function batchRules($indexName, $rule, $forwardToReplicas = null, $clearE * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\BrowseResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function browse($indexName, $browseRequest = null) @@ -818,7 +810,7 @@ public function browse($indexName, $browseRequest = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\BrowseResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -835,7 +827,6 @@ public function browse($indexName, $browseRequest = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function clearAllSynonyms($indexName, $forwardToReplicas = null) @@ -899,7 +890,7 @@ public function clearAllSynonyms($indexName, $forwardToReplicas = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -915,7 +906,6 @@ public function clearAllSynonyms($indexName, $forwardToReplicas = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function clearObjects($indexName) @@ -972,7 +962,7 @@ public function clearObjects($indexName) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -989,7 +979,6 @@ public function clearObjects($indexName) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function clearRules($indexName, $forwardToReplicas = null) @@ -1053,7 +1042,7 @@ public function clearRules($indexName, $forwardToReplicas = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1069,7 +1058,6 @@ public function clearRules($indexName, $forwardToReplicas = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\DeleteApiKeyResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteApiKey($key) @@ -1126,7 +1114,7 @@ public function deleteApiKey($key) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeleteApiKeyResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1143,7 +1131,6 @@ public function deleteApiKey($key) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\DeletedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteBy($indexName, $searchParams) @@ -1209,7 +1196,7 @@ public function deleteBy($indexName, $searchParams) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeletedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1225,7 +1212,6 @@ public function deleteBy($indexName, $searchParams) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\DeletedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteIndex($indexName) @@ -1282,7 +1268,7 @@ public function deleteIndex($indexName) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeletedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1299,7 +1285,6 @@ public function deleteIndex($indexName) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\DeletedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteObject($indexName, $objectID) @@ -1370,7 +1355,7 @@ public function deleteObject($indexName, $objectID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeletedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1388,7 +1373,6 @@ public function deleteObject($indexName, $objectID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteRule($indexName, $objectID, $forwardToReplicas = null) @@ -1466,7 +1450,7 @@ public function deleteRule($indexName, $objectID, $forwardToReplicas = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1480,7 +1464,6 @@ public function deleteRule($indexName, $objectID, $forwardToReplicas = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\DeleteSourceResponse */ public function deleteSource($source) @@ -1537,7 +1520,7 @@ public function deleteSource($source) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeleteSourceResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1555,7 +1538,6 @@ public function deleteSource($source) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\DeletedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteSynonym($indexName, $objectID, $forwardToReplicas = null) @@ -1633,7 +1615,7 @@ public function deleteSynonym($indexName, $objectID, $forwardToReplicas = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeletedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1649,7 +1631,6 @@ public function deleteSynonym($indexName, $objectID, $forwardToReplicas = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\KeyObject|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getApiKey($key) @@ -1706,7 +1687,7 @@ public function getApiKey($key) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\KeyObject'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1721,7 +1702,6 @@ public function getApiKey($key) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return array|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getDictionaryLanguages() @@ -1764,7 +1744,7 @@ public function getDictionaryLanguages() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = 'array<string,\Algolia\AlgoliaSearch\Model\Languages>'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1779,7 +1759,6 @@ public function getDictionaryLanguages() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\GetDictionarySettingsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getDictionarySettings() @@ -1822,7 +1801,7 @@ public function getDictionarySettings() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetDictionarySettingsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1839,7 +1818,6 @@ public function getDictionarySettings() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\GetLogsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getLogs($offset = 0, $length = 10, $indexName = null, $type = 'all') @@ -1848,6 +1826,7 @@ public function getLogs($offset = 0, $length = 10, $indexName = null, $type = 'a throw new \InvalidArgumentException('invalid value for "$length" when calling SearchApi.getLogs, must be smaller than or equal to 1000.'); } + $resourcePath = '/1/logs'; $queryParams = []; $headerParams = []; @@ -1913,7 +1892,7 @@ public function getLogs($offset = 0, $length = 10, $indexName = null, $type = 'a $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetLogsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1931,7 +1910,6 @@ public function getLogs($offset = 0, $length = 10, $indexName = null, $type = 'a * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return array|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getObject($indexName, $objectID, $attributesToRetrieve = null) @@ -2009,7 +1987,7 @@ public function getObject($indexName, $objectID, $attributesToRetrieve = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = 'array<string,string>'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2025,7 +2003,6 @@ public function getObject($indexName, $objectID, $attributesToRetrieve = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\GetObjectsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getObjects($getObjectsObject) @@ -2077,7 +2054,7 @@ public function getObjects($getObjectsObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetObjectsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2094,7 +2071,6 @@ public function getObjects($getObjectsObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\Rule|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getRule($indexName, $objectID) @@ -2165,7 +2141,7 @@ public function getRule($indexName, $objectID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\Rule'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2179,7 +2155,6 @@ public function getRule($indexName, $objectID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\IndexSettings|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getSettings($indexName) @@ -2236,7 +2211,7 @@ public function getSettings($indexName) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\IndexSettings'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2249,7 +2224,6 @@ public function getSettings($indexName) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\Source[] */ public function getSources() @@ -2292,7 +2266,7 @@ public function getSources() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\Source[]'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2309,7 +2283,6 @@ public function getSources() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\SynonymHit|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getSynonym($indexName, $objectID) @@ -2380,7 +2353,7 @@ public function getSynonym($indexName, $objectID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SynonymHit'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2395,7 +2368,6 @@ public function getSynonym($indexName, $objectID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\GetTaskResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getTask($indexName, $taskID) @@ -2466,7 +2438,7 @@ public function getTask($indexName, $taskID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetTaskResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2481,7 +2453,6 @@ public function getTask($indexName, $taskID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\GetTopUserIdsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getTopUserIds() @@ -2524,7 +2495,7 @@ public function getTopUserIds() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetTopUserIdsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2540,7 +2511,6 @@ public function getTopUserIds() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UserId|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getUserId($userID) @@ -2551,10 +2521,11 @@ public function getUserId($userID) 'Missing the required parameter $userID when calling getUserId' ); } - if (!preg_match('/^[a-zA-Z0-9 \\-*.]+$/', $userID)) { - throw new \InvalidArgumentException('invalid value for "userID" when calling SearchApi.getUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/.'); + if (!preg_match("/^[a-zA-Z0-9 \\-*.]+$/", $userID)) { + throw new \InvalidArgumentException("invalid value for \"userID\" when calling SearchApi.getUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/."); } + $resourcePath = '/1/clusters/mapping/{userID}'; $queryParams = []; $headerParams = []; @@ -2600,7 +2571,7 @@ public function getUserId($userID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UserId'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2616,7 +2587,6 @@ public function getUserId($userID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\CreatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function hasPendingMappings($getClusters = null) @@ -2666,7 +2636,7 @@ public function hasPendingMappings($getClusters = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\CreatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2681,7 +2651,6 @@ public function hasPendingMappings($getClusters = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\ListApiKeysResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function listApiKeys() @@ -2724,7 +2693,7 @@ public function listApiKeys() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ListApiKeysResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2739,7 +2708,6 @@ public function listApiKeys() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\ListClustersResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function listClusters() @@ -2782,7 +2750,7 @@ public function listClusters() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ListClustersResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2798,7 +2766,6 @@ public function listClusters() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\ListIndicesResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function listIndices($page = null) @@ -2848,7 +2815,7 @@ public function listIndices($page = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ListIndicesResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2865,7 +2832,6 @@ public function listIndices($page = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\ListUserIdsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function listUserIds($page = null, $hitsPerPage = 100) @@ -2922,7 +2888,7 @@ public function listUserIds($page = null, $hitsPerPage = 100) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ListUserIdsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2936,7 +2902,6 @@ public function listUserIds($page = null, $hitsPerPage = 100) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\MultipleBatchResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function multipleBatch($batchObject) @@ -2988,7 +2953,7 @@ public function multipleBatch($batchObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\MultipleBatchResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3002,7 +2967,6 @@ public function multipleBatch($batchObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\MultipleQueriesResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function multipleQueries($multipleQueriesObject) @@ -3054,7 +3018,7 @@ public function multipleQueries($multipleQueriesObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\MultipleQueriesResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3071,7 +3035,6 @@ public function multipleQueries($multipleQueriesObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function operationIndex($indexName, $operationIndexObject) @@ -3137,7 +3100,7 @@ public function operationIndex($indexName, $operationIndexObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3156,7 +3119,6 @@ public function operationIndex($indexName, $operationIndexObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtWithObjectIdResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function partialUpdateObject($indexName, $objectID, $oneOfStringBuildInOperation, $createIfNotExists = true) @@ -3243,7 +3205,7 @@ public function partialUpdateObject($indexName, $objectID, $oneOfStringBuildInOp $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtWithObjectIdResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3259,7 +3221,6 @@ public function partialUpdateObject($indexName, $objectID, $oneOfStringBuildInOp * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\RemoveUserIdResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function removeUserId($userID) @@ -3270,10 +3231,11 @@ public function removeUserId($userID) 'Missing the required parameter $userID when calling removeUserId' ); } - if (!preg_match('/^[a-zA-Z0-9 \\-*.]+$/', $userID)) { - throw new \InvalidArgumentException('invalid value for "userID" when calling SearchApi.removeUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/.'); + if (!preg_match("/^[a-zA-Z0-9 \\-*.]+$/", $userID)) { + throw new \InvalidArgumentException("invalid value for \"userID\" when calling SearchApi.removeUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/."); } + $resourcePath = '/1/clusters/mapping/{userID}'; $queryParams = []; $headerParams = []; @@ -3319,7 +3281,7 @@ public function removeUserId($userID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\RemoveUserIdResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3333,7 +3295,6 @@ public function removeUserId($userID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\ReplaceSourceResponse */ public function replaceSources($source) @@ -3385,7 +3346,7 @@ public function replaceSources($source) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ReplaceSourceResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3401,7 +3362,6 @@ public function replaceSources($source) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\AddApiKeyResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function restoreApiKey($key) @@ -3458,7 +3418,7 @@ public function restoreApiKey($key) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\AddApiKeyResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3473,7 +3433,6 @@ public function restoreApiKey($key) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\SaveObjectResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function saveObject($indexName, $body) @@ -3539,7 +3498,7 @@ public function saveObject($indexName, $body) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SaveObjectResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3558,7 +3517,6 @@ public function saveObject($indexName, $body) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedRuleResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function saveRule($indexName, $objectID, $rule, $forwardToReplicas = null) @@ -3645,7 +3603,7 @@ public function saveRule($indexName, $objectID, $rule, $forwardToReplicas = null $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedRuleResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3664,7 +3622,6 @@ public function saveRule($indexName, $objectID, $rule, $forwardToReplicas = null * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\SaveSynonymResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function saveSynonym($indexName, $objectID, $synonymHit, $forwardToReplicas = null) @@ -3751,7 +3708,7 @@ public function saveSynonym($indexName, $objectID, $synonymHit, $forwardToReplic $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SaveSynonymResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3770,7 +3727,6 @@ public function saveSynonym($indexName, $objectID, $synonymHit, $forwardToReplic * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function saveSynonyms($indexName, $synonymHit, $forwardToReplicas = null, $replaceExistingSynonyms = null) @@ -3850,7 +3806,7 @@ public function saveSynonyms($indexName, $synonymHit, $forwardToReplicas = null, $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3865,7 +3821,6 @@ public function saveSynonyms($indexName, $synonymHit, $forwardToReplicas = null, * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\SearchResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function search($indexName, $searchParams) @@ -3931,7 +3886,7 @@ public function search($indexName, $searchParams) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3948,7 +3903,6 @@ public function search($indexName, $searchParams) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntries) @@ -4014,7 +3968,7 @@ public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntrie $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4032,7 +3986,6 @@ public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntrie * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\SearchForFacetValuesResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchForFacetValues($indexName, $facetName, $searchForFacetValuesRequest = null) @@ -4106,7 +4059,7 @@ public function searchForFacetValues($indexName, $facetName, $searchForFacetValu $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchForFacetValuesResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4123,7 +4076,6 @@ public function searchForFacetValues($indexName, $facetName, $searchForFacetValu * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\SearchRulesResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchRules($indexName, $searchRulesParams) @@ -4189,7 +4141,7 @@ public function searchRules($indexName, $searchRulesParams) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchRulesResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4209,7 +4161,6 @@ public function searchRules($indexName, $searchRulesParams) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\SearchSynonymsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchSynonyms($indexName, $query = '', $type = null, $page = 0, $hitsPerPage = 100) @@ -4294,7 +4245,7 @@ public function searchSynonyms($indexName, $query = '', $type = null, $page = 0, $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchSynonymsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4310,7 +4261,6 @@ public function searchSynonyms($indexName, $query = '', $type = null, $page = 0, * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\SearchUserIdsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchUserIds($searchUserIdsObject) @@ -4362,7 +4312,7 @@ public function searchUserIds($searchUserIdsObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchUserIdsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4378,7 +4328,6 @@ public function searchUserIds($searchUserIdsObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function setDictionarySettings($dictionarySettingsRequest) @@ -4430,7 +4379,7 @@ public function setDictionarySettings($dictionarySettingsRequest) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4446,7 +4395,6 @@ public function setDictionarySettings($dictionarySettingsRequest) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function setSettings($indexName, $indexSettings, $forwardToReplicas = null) @@ -4519,7 +4467,7 @@ public function setSettings($indexName, $indexSettings, $forwardToReplicas = nul $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4536,7 +4484,6 @@ public function setSettings($indexName, $indexSettings, $forwardToReplicas = nul * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException - * * @return \Algolia\AlgoliaSearch\Model\UpdateApiKeyResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function updateApiKey($key, $apiKey) @@ -4602,7 +4549,7 @@ public function updateApiKey($key, $apiKey) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdateApiKeyResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4613,7 +4560,6 @@ public function updateApiKey($key, $apiKey) * Create http client option * * @throws \RuntimeException on file opening failure - * * @return array of http client options */ protected function createHttpClientOption() @@ -4633,14 +4579,12 @@ protected function createHttpClientOption() * Send the request and handle the response * * @throws \RuntimeException on file opening failure - * * @return array */ protected function sendRequest($request, $expectedResponse) { try { $options = $this->createHttpClientOption(); - try { $response = $this->client->send($request, $options); } catch (RequestException $e) { @@ -4685,7 +4629,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, $expectedResponse, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; case 400: if ('\Algolia\AlgoliaSearch\Model\ErrorBase' === '\SplFileObject') { @@ -4697,7 +4641,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, '\Algolia\AlgoliaSearch\Model\ErrorBase', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; case 402: if ('\Algolia\AlgoliaSearch\Model\ErrorBase' === '\SplFileObject') { @@ -4709,7 +4653,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, '\Algolia\AlgoliaSearch\Model\ErrorBase', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; case 403: if ('\Algolia\AlgoliaSearch\Model\ErrorBase' === '\SplFileObject') { @@ -4721,7 +4665,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, '\Algolia\AlgoliaSearch\Model\ErrorBase', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; case 404: if ('\Algolia\AlgoliaSearch\Model\ErrorBase' === '\SplFileObject') { @@ -4733,7 +4677,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, '\Algolia\AlgoliaSearch\Model\ErrorBase', []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; } @@ -4748,7 +4692,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders(), + $response->getHeaders() ]; } catch (ApiException $e) { @@ -4760,7 +4704,6 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); - break; case 400: $data = ObjectSerializer::deserialize( @@ -4769,7 +4712,6 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); - break; case 402: $data = ObjectSerializer::deserialize( @@ -4778,7 +4720,6 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); - break; case 403: $data = ObjectSerializer::deserialize( @@ -4787,7 +4728,6 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); - break; case 404: $data = ObjectSerializer::deserialize( @@ -4796,10 +4736,8 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); - break; } - throw $e; } } diff --git a/clients/algoliasearch-client-php/lib/ApiException.php b/clients/algoliasearch-client-php/lib/ApiException.php index d484a88eb5..0f80549494 100644 --- a/clients/algoliasearch-client-php/lib/ApiException.php +++ b/clients/algoliasearch-client-php/lib/ApiException.php @@ -12,6 +12,7 @@ */ class ApiException extends Exception { + /** * The HTTP body of the server response either as Json or string. * @@ -41,7 +42,7 @@ class ApiException extends Exception * @param string[]|null $responseHeaders HTTP response header * @param \stdClass|string|null $responseBody HTTP decoded body of the server response either as \stdClass or string */ - public function __construct($message = '', $code = 0, $responseHeaders = [], $responseBody = null) + public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null) { parent::__construct($message, $code); $this->responseHeaders = $responseHeaders; diff --git a/clients/algoliasearch-client-php/lib/Configuration.php b/clients/algoliasearch-client-php/lib/Configuration.php index b7d8ebacb9..30f2a5e7aa 100644 --- a/clients/algoliasearch-client-php/lib/Configuration.php +++ b/clients/algoliasearch-client-php/lib/Configuration.php @@ -113,7 +113,6 @@ public function __construct(string $appId, string $algoliaApiKey = null) public function setApiKey($apiKeyIdentifier, $key) { $this->apiKeys[$apiKeyIdentifier] = $key; - return $this; } @@ -140,7 +139,6 @@ public function getApiKey($apiKeyIdentifier) public function setApiKeyPrefix($apiKeyIdentifier, $prefix) { $this->apiKeyPrefixes[$apiKeyIdentifier] = $prefix; - return $this; } @@ -166,7 +164,6 @@ public function getApiKeyPrefix($apiKeyIdentifier) public function setAccessToken($accessToken) { $this->accessToken = $accessToken; - return $this; } @@ -234,7 +231,6 @@ public function getAlgoliaApiKey() public function setHost($host) { $this->host = $host; - return $this; } @@ -254,7 +250,6 @@ public function getHost() * @param string $userAgent the user agent of the api client * * @throws \InvalidArgumentException - * * @return $this */ public function setUserAgent($userAgent) @@ -264,7 +259,6 @@ public function setUserAgent($userAgent) } $this->userAgent = $userAgent; - return $this; } @@ -288,7 +282,6 @@ public function getUserAgent() public function setDebug($debug) { $this->debug = $debug; - return $this; } @@ -312,7 +305,6 @@ public function getDebug() public function setDebugFile($debugFile) { $this->debugFile = $debugFile; - return $this; } @@ -336,7 +328,6 @@ public function getDebugFile() public function setTempFolderPath($tempFolderPath) { $this->tempFolderPath = $tempFolderPath; - return $this; } @@ -426,9 +417,9 @@ public function getHostSettings() { return [ [ - 'url' => '', - 'description' => 'No description provided', - ], + "url" => "", + "description" => "No description provided", + ] ]; } @@ -437,7 +428,6 @@ public function getHostSettings() * * @param int $index index of the host settings * @param array|null $variables hash of variable and the corresponding value (optional) - * * @return string URL based on host settings */ public function getHostFromSettings($index, $variables = null) @@ -454,19 +444,19 @@ public function getHostFromSettings($index, $variables = null) } $host = $hosts[$index]; - $url = $host['url']; + $url = $host["url"]; // go through variable and assign a value - foreach ($host['variables'] ?? [] as $name => $variable) { + foreach ($host["variables"] ?? [] as $name => $variable) { if (array_key_exists($name, $variables)) { // check to see if it's in the variables provided by the user - if (in_array($variables[$name], $variable['enum_values'], true)) { // check to see if the value is in the enum - $url = str_replace('{'.$name.'}', $variables[$name], $url); + if (in_array($variables[$name], $variable["enum_values"], true)) { // check to see if the value is in the enum + $url = str_replace("{".$name."}", $variables[$name], $url); } else { - throw new \InvalidArgumentException("The variable `$name` in the host URL has invalid value ".$variables[$name].'. Must be '.join(',', $variable['enum_values']).'.'); + throw new \InvalidArgumentException("The variable `$name` in the host URL has invalid value ".$variables[$name].". Must be ".join(',', $variable["enum_values"])."."); } } else { // use default value - $url = str_replace('{'.$name.'}', $variable['default_value'], $url); + $url = str_replace("{".$name."}", $variable["default_value"], $url); } } diff --git a/clients/algoliasearch-client-php/lib/HeaderSelector.php b/clients/algoliasearch-client-php/lib/HeaderSelector.php index eda65ab64a..7d68b37a53 100644 --- a/clients/algoliasearch-client-php/lib/HeaderSelector.php +++ b/clients/algoliasearch-client-php/lib/HeaderSelector.php @@ -2,6 +2,8 @@ namespace Algolia\AlgoliaSearch; +use \Exception; + /** * ApiException Class Doc Comment * @@ -10,10 +12,10 @@ */ class HeaderSelector { + /** * @param string[] $accept * @param string[] $contentTypes - * * @return array */ public function selectHeaders($accept, $contentTypes) @@ -26,13 +28,11 @@ public function selectHeaders($accept, $contentTypes) } $headers['Content-Type'] = $this->selectContentTypeHeader($contentTypes); - return $headers; } /** * @param string[] $accept - * * @return array */ public function selectHeadersForMultipart($accept) @@ -40,7 +40,6 @@ public function selectHeadersForMultipart($accept) $headers = $this->selectHeaders($accept, []); unset($headers['Content-Type']); - return $headers; } @@ -57,10 +56,9 @@ private function selectAcceptHeader($accept) return null; } elseif ($jsonAccept = preg_grep('~(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$~', $accept)) { return implode(',', $jsonAccept); - } - + } else { return implode(',', $accept); - + } } /** @@ -76,9 +74,8 @@ private function selectContentTypeHeader($contentType) return 'application/json'; } elseif (preg_grep("/application\/json/i", $contentType)) { return 'application/json'; - } - + } else { return implode(',', $contentType); - + } } } diff --git a/clients/algoliasearch-client-php/lib/Model/Action.php b/clients/algoliasearch-client-php/lib/Model/Action.php index 0296001727..8781092a8c 100644 --- a/clients/algoliasearch-client-php/lib/Model/Action.php +++ b/clients/algoliasearch-client-php/lib/Model/Action.php @@ -1,13 +1,13 @@ 'string', - 'createdAt' => '\DateTime', + 'createdAt' => '\DateTime' ]; /** @@ -44,7 +44,7 @@ class AddApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPIFormats = [ 'key' => null, - 'createdAt' => 'date-time', + 'createdAt' => 'date-time' ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'key' => 'key', - 'createdAt' => 'createdAt', + 'createdAt' => 'createdAt' ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'key' => 'setKey', - 'createdAt' => 'setCreatedAt', + 'createdAt' => 'setCreatedAt' ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'key' => 'getKey', - 'createdAt' => 'getCreatedAt', + 'createdAt' => 'getCreatedAt' ]; /** @@ -139,6 +139,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -173,7 +174,6 @@ public function listInvalidProperties() if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } - return $invalidProperties; } @@ -188,6 +188,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets key * @@ -201,7 +202,7 @@ public function getKey() /** * Sets key * - * @param string $key key string + * @param string $key Key string. * * @return self */ @@ -225,7 +226,7 @@ public function getCreatedAt() /** * Sets createdAt * - * @param \DateTime $createdAt date of creation (ISO-8601 format) + * @param \DateTime $createdAt Date of creation (ISO-8601 format). * * @return self */ @@ -238,9 +239,9 @@ public function setCreatedAt($createdAt) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -250,7 +251,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -279,7 +280,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -290,11 +291,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -325,3 +325,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/Anchoring.php b/clients/algoliasearch-client-php/lib/Model/Anchoring.php index 031df08b5e..7760ddb377 100644 --- a/clients/algoliasearch-client-php/lib/Model/Anchoring.php +++ b/clients/algoliasearch-client-php/lib/Model/Anchoring.php @@ -1,13 +1,13 @@ * @template TKey int|null @@ -40,7 +39,7 @@ class ApiKey implements ModelInterface, ArrayAccess, \JsonSerializable 'maxQueriesPerIPPerHour' => 'int', 'queryParameters' => 'string', 'referers' => 'string[]', - 'validity' => 'int', + 'validity' => 'int' ]; /** @@ -58,7 +57,7 @@ class ApiKey implements ModelInterface, ArrayAccess, \JsonSerializable 'maxQueriesPerIPPerHour' => null, 'queryParameters' => null, 'referers' => null, - 'validity' => null, + 'validity' => null ]; /** @@ -95,7 +94,7 @@ public static function openAPIFormats() 'maxQueriesPerIPPerHour' => 'maxQueriesPerIPPerHour', 'queryParameters' => 'queryParameters', 'referers' => 'referers', - 'validity' => 'validity', + 'validity' => 'validity' ]; /** @@ -111,7 +110,7 @@ public static function openAPIFormats() 'maxQueriesPerIPPerHour' => 'setMaxQueriesPerIPPerHour', 'queryParameters' => 'setQueryParameters', 'referers' => 'setReferers', - 'validity' => 'setValidity', + 'validity' => 'setValidity' ]; /** @@ -127,7 +126,7 @@ public static function openAPIFormats() 'maxQueriesPerIPPerHour' => 'getMaxQueriesPerIPPerHour', 'queryParameters' => 'getQueryParameters', 'referers' => 'getReferers', - 'validity' => 'getValidity', + 'validity' => 'getValidity' ]; /** @@ -248,7 +247,6 @@ public function listInvalidProperties() if ($this->container['acl'] === null) { $invalidProperties[] = "'acl' can't be null"; } - return $invalidProperties; } @@ -263,6 +261,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets acl * @@ -276,7 +275,7 @@ public function getAcl() /** * Sets acl * - * @param string[] $acl set of permissions associated with the key + * @param string[] $acl Set of permissions associated with the key. * * @return self */ @@ -381,7 +380,7 @@ public function getMaxQueriesPerIPPerHour() /** * Sets maxQueriesPerIPPerHour * - * @param int|null $maxQueriesPerIPPerHour maximum number of API calls per hour allowed from a given IP address or a user token + * @param int|null $maxQueriesPerIPPerHour Maximum number of API calls per hour allowed from a given IP address or a user token. * * @return self */ @@ -466,9 +465,9 @@ public function setValidity($validity) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -478,7 +477,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -507,7 +506,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -518,11 +517,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -553,3 +551,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php b/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php index 913125bbde..d46ef38fc3 100644 --- a/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php +++ b/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * AssignUserIdObject Class Doc Comment * * @category Class * @description Assign userID object. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +32,7 @@ class AssignUserIdObject implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'cluster' => 'string', + 'cluster' => 'string' ]; /** @@ -44,7 +43,7 @@ class AssignUserIdObject implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'cluster' => null, + 'cluster' => null ]; /** @@ -74,7 +73,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'cluster' => 'cluster', + 'cluster' => 'cluster' ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'cluster' => 'setCluster', + 'cluster' => 'setCluster' ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'cluster' => 'getCluster', + 'cluster' => 'getCluster' ]; /** @@ -136,6 +135,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -166,7 +166,6 @@ public function listInvalidProperties() if ($this->container['cluster'] === null) { $invalidProperties[] = "'cluster' can't be null"; } - return $invalidProperties; } @@ -181,6 +180,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets cluster * @@ -194,7 +194,7 @@ public function getCluster() /** * Sets cluster * - * @param string $cluster name of the cluster + * @param string $cluster Name of the cluster. * * @return self */ @@ -207,9 +207,9 @@ public function setCluster($cluster) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -259,11 +259,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -294,3 +293,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php b/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php index 0a63d8cdab..9f4acf5062 100644 --- a/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php +++ b/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * AutomaticFacetFilter Class Doc Comment * * @category Class * @description Automatic facet Filter. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +34,7 @@ class AutomaticFacetFilter implements ModelInterface, ArrayAccess, \JsonSerializ protected static $openAPITypes = [ 'facet' => 'string', 'score' => 'int', - 'disjunctive' => 'bool', + 'disjunctive' => 'bool' ]; /** @@ -48,7 +47,7 @@ class AutomaticFacetFilter implements ModelInterface, ArrayAccess, \JsonSerializ protected static $openAPIFormats = [ 'facet' => null, 'score' => null, - 'disjunctive' => null, + 'disjunctive' => null ]; /** @@ -80,7 +79,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'facet' => 'facet', 'score' => 'score', - 'disjunctive' => 'disjunctive', + 'disjunctive' => 'disjunctive' ]; /** @@ -91,7 +90,7 @@ public static function openAPIFormats() protected static $setters = [ 'facet' => 'setFacet', 'score' => 'setScore', - 'disjunctive' => 'setDisjunctive', + 'disjunctive' => 'setDisjunctive' ]; /** @@ -102,7 +101,7 @@ public static function openAPIFormats() protected static $getters = [ 'facet' => 'getFacet', 'score' => 'getScore', - 'disjunctive' => 'getDisjunctive', + 'disjunctive' => 'getDisjunctive' ]; /** @@ -146,6 +145,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -178,7 +178,6 @@ public function listInvalidProperties() if ($this->container['facet'] === null) { $invalidProperties[] = "'facet' can't be null"; } - return $invalidProperties; } @@ -193,6 +192,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets facet * @@ -254,7 +254,7 @@ public function getDisjunctive() /** * Sets disjunctive * - * @param bool|null $disjunctive whether the filter is disjunctive (true) or conjunctive (false) + * @param bool|null $disjunctive Whether the filter is disjunctive (true) or conjunctive (false). * * @return self */ @@ -267,9 +267,9 @@ public function setDisjunctive($disjunctive) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -279,7 +279,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -308,7 +308,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -319,11 +319,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -354,3 +353,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php b/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php index e9f60b9c9a..fead53a789 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BaseBrowseResponse Class Doc Comment @@ -31,7 +31,7 @@ class BaseBrowseResponse implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'cursor' => 'string', + 'cursor' => 'string' ]; /** @@ -42,7 +42,7 @@ class BaseBrowseResponse implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'cursor' => null, + 'cursor' => null ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'cursor' => 'cursor', + 'cursor' => 'cursor' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'cursor' => 'setCursor', + 'cursor' => 'setCursor' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'cursor' => 'getCursor', + 'cursor' => 'getCursor' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -164,7 +165,6 @@ public function listInvalidProperties() if ($this->container['cursor'] === null) { $invalidProperties[] = "'cursor' can't be null"; } - return $invalidProperties; } @@ -179,6 +179,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets cursor * @@ -205,9 +206,9 @@ public function setCursor($cursor) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -217,7 +218,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -246,7 +247,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -257,11 +258,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -292,3 +292,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php b/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php index dbbc448b75..80195a5625 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BaseIndexSettings Class Doc Comment @@ -42,7 +42,7 @@ class BaseIndexSettings implements ModelInterface, ArrayAccess, \JsonSerializabl 'disablePrefixOnAttributes' => 'string[]', 'allowCompressionOfIntegerArray' => 'bool', 'numericAttributesForFiltering' => 'string[]', - 'userData' => 'object', + 'userData' => 'object' ]; /** @@ -64,7 +64,7 @@ class BaseIndexSettings implements ModelInterface, ArrayAccess, \JsonSerializabl 'disablePrefixOnAttributes' => null, 'allowCompressionOfIntegerArray' => null, 'numericAttributesForFiltering' => null, - 'userData' => null, + 'userData' => null ]; /** @@ -105,7 +105,7 @@ public static function openAPIFormats() 'disablePrefixOnAttributes' => 'disablePrefixOnAttributes', 'allowCompressionOfIntegerArray' => 'allowCompressionOfIntegerArray', 'numericAttributesForFiltering' => 'numericAttributesForFiltering', - 'userData' => 'userData', + 'userData' => 'userData' ]; /** @@ -125,7 +125,7 @@ public static function openAPIFormats() 'disablePrefixOnAttributes' => 'setDisablePrefixOnAttributes', 'allowCompressionOfIntegerArray' => 'setAllowCompressionOfIntegerArray', 'numericAttributesForFiltering' => 'setNumericAttributesForFiltering', - 'userData' => 'setUserData', + 'userData' => 'setUserData' ]; /** @@ -145,7 +145,7 @@ public static function openAPIFormats() 'disablePrefixOnAttributes' => 'getDisablePrefixOnAttributes', 'allowCompressionOfIntegerArray' => 'getAllowCompressionOfIntegerArray', 'numericAttributesForFiltering' => 'getNumericAttributesForFiltering', - 'userData' => 'getUserData', + 'userData' => 'getUserData' ]; /** @@ -189,6 +189,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -241,6 +242,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets replicas * @@ -254,7 +256,7 @@ public function getReplicas() /** * Sets replicas * - * @param string[]|null $replicas creates replicas, exact copies of an index + * @param string[]|null $replicas Creates replicas, exact copies of an index. * * @return self */ @@ -278,7 +280,7 @@ public function getPaginationLimitedTo() /** * Sets paginationLimitedTo * - * @param int|null $paginationLimitedTo set the maximum number of hits accessible via pagination + * @param int|null $paginationLimitedTo Set the maximum number of hits accessible via pagination. * * @return self */ @@ -302,7 +304,7 @@ public function getDisableTypoToleranceOnWords() /** * Sets disableTypoToleranceOnWords * - * @param string[]|null $disableTypoToleranceOnWords a list of words for which you want to turn off typo tolerance + * @param string[]|null $disableTypoToleranceOnWords A list of words for which you want to turn off typo tolerance. * * @return self */ @@ -326,7 +328,7 @@ public function getAttributesToTransliterate() /** * Sets attributesToTransliterate * - * @param string[]|null $attributesToTransliterate specify on which attributes to apply transliteration + * @param string[]|null $attributesToTransliterate Specify on which attributes to apply transliteration. * * @return self */ @@ -350,7 +352,7 @@ public function getCamelCaseAttributes() /** * Sets camelCaseAttributes * - * @param string[]|null $camelCaseAttributes list of attributes on which to do a decomposition of camel case words + * @param string[]|null $camelCaseAttributes List of attributes on which to do a decomposition of camel case words. * * @return self */ @@ -374,7 +376,7 @@ public function getDecompoundedAttributes() /** * Sets decompoundedAttributes * - * @param object|null $decompoundedAttributes specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding + * @param object|null $decompoundedAttributes Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding. * * @return self */ @@ -398,7 +400,7 @@ public function getIndexLanguages() /** * Sets indexLanguages * - * @param string[]|null $indexLanguages sets the languages at the index level for language-specific processing such as tokenization and normalization + * @param string[]|null $indexLanguages Sets the languages at the index level for language-specific processing such as tokenization and normalization. * * @return self */ @@ -422,7 +424,7 @@ public function getFilterPromotes() /** * Sets filterPromotes * - * @param bool|null $filterPromotes whether promoted results should match the filters of the current search, except for geographic filters + * @param bool|null $filterPromotes Whether promoted results should match the filters of the current search, except for geographic filters. * * @return self */ @@ -446,7 +448,7 @@ public function getDisablePrefixOnAttributes() /** * Sets disablePrefixOnAttributes * - * @param string[]|null $disablePrefixOnAttributes list of attributes on which you want to disable prefix matching + * @param string[]|null $disablePrefixOnAttributes List of attributes on which you want to disable prefix matching. * * @return self */ @@ -470,7 +472,7 @@ public function getAllowCompressionOfIntegerArray() /** * Sets allowCompressionOfIntegerArray * - * @param bool|null $allowCompressionOfIntegerArray enables compression of large integer arrays + * @param bool|null $allowCompressionOfIntegerArray Enables compression of large integer arrays. * * @return self */ @@ -494,7 +496,7 @@ public function getNumericAttributesForFiltering() /** * Sets numericAttributesForFiltering * - * @param string[]|null $numericAttributesForFiltering list of numeric attributes that can be used as numerical filters + * @param string[]|null $numericAttributesForFiltering List of numeric attributes that can be used as numerical filters. * * @return self */ @@ -518,7 +520,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData lets you store custom data in your indices + * @param object|null $userData Lets you store custom data in your indices. * * @return self */ @@ -531,9 +533,9 @@ public function setUserData($userData) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -543,7 +545,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -572,7 +574,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -583,11 +585,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -618,3 +619,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php b/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php index 6aafbea93e..bf573dc75a 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BaseSearchParams Class Doc Comment @@ -62,7 +62,7 @@ class BaseSearchParams implements ModelInterface, ArrayAccess, \JsonSerializable 'analyticsTags' => 'string[]', 'percentileComputation' => 'bool', 'enableABTest' => 'bool', - 'enableReRanking' => 'bool', + 'enableReRanking' => 'bool' ]; /** @@ -104,7 +104,7 @@ class BaseSearchParams implements ModelInterface, ArrayAccess, \JsonSerializable 'analyticsTags' => null, 'percentileComputation' => null, 'enableABTest' => null, - 'enableReRanking' => null, + 'enableReRanking' => null ]; /** @@ -165,7 +165,7 @@ public static function openAPIFormats() 'analyticsTags' => 'analyticsTags', 'percentileComputation' => 'percentileComputation', 'enableABTest' => 'enableABTest', - 'enableReRanking' => 'enableReRanking', + 'enableReRanking' => 'enableReRanking' ]; /** @@ -205,7 +205,7 @@ public static function openAPIFormats() 'analyticsTags' => 'setAnalyticsTags', 'percentileComputation' => 'setPercentileComputation', 'enableABTest' => 'setEnableABTest', - 'enableReRanking' => 'setEnableReRanking', + 'enableReRanking' => 'setEnableReRanking' ]; /** @@ -245,7 +245,7 @@ public static function openAPIFormats() 'analyticsTags' => 'getAnalyticsTags', 'percentileComputation' => 'getPercentileComputation', 'enableABTest' => 'getEnableABTest', - 'enableReRanking' => 'getEnableReRanking', + 'enableReRanking' => 'getEnableReRanking' ]; /** @@ -289,6 +289,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -373,6 +374,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets similarQuery * @@ -386,7 +388,7 @@ public function getSimilarQuery() /** * Sets similarQuery * - * @param string|null $similarQuery overrides the query parameter and performs a more generic search that can be used to find \"similar\" results + * @param string|null $similarQuery Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results. * * @return self */ @@ -410,7 +412,7 @@ public function getFilters() /** * Sets filters * - * @param string|null $filters filter the query with numeric, facet and/or tag filters + * @param string|null $filters Filter the query with numeric, facet and/or tag filters. * * @return self */ @@ -434,7 +436,7 @@ public function getFacetFilters() /** * Sets facetFilters * - * @param string[]|null $facetFilters filter hits by facet value + * @param string[]|null $facetFilters Filter hits by facet value. * * @return self */ @@ -458,7 +460,7 @@ public function getOptionalFilters() /** * Sets optionalFilters * - * @param string[]|null $optionalFilters create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter + * @param string[]|null $optionalFilters Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. * * @return self */ @@ -482,7 +484,7 @@ public function getNumericFilters() /** * Sets numericFilters * - * @param string[]|null $numericFilters filter on numeric attributes + * @param string[]|null $numericFilters Filter on numeric attributes. * * @return self */ @@ -506,7 +508,7 @@ public function getTagFilters() /** * Sets tagFilters * - * @param string[]|null $tagFilters filter hits by tags + * @param string[]|null $tagFilters Filter hits by tags. * * @return self */ @@ -530,7 +532,7 @@ public function getSumOrFiltersScores() /** * Sets sumOrFiltersScores * - * @param bool|null $sumOrFiltersScores determines how to calculate the total score for filtering + * @param bool|null $sumOrFiltersScores Determines how to calculate the total score for filtering. * * @return self */ @@ -554,7 +556,7 @@ public function getFacets() /** * Sets facets * - * @param string[]|null $facets retrieve facets and their facet values + * @param string[]|null $facets Retrieve facets and their facet values. * * @return self */ @@ -578,7 +580,7 @@ public function getMaxValuesPerFacet() /** * Sets maxValuesPerFacet * - * @param int|null $maxValuesPerFacet maximum number of facet values to return for each facet during a regular search + * @param int|null $maxValuesPerFacet Maximum number of facet values to return for each facet during a regular search. * * @return self */ @@ -602,7 +604,7 @@ public function getFacetingAfterDistinct() /** * Sets facetingAfterDistinct * - * @param bool|null $facetingAfterDistinct force faceting to be applied after de-duplication (via the Distinct setting) + * @param bool|null $facetingAfterDistinct Force faceting to be applied after de-duplication (via the Distinct setting). * * @return self */ @@ -626,7 +628,7 @@ public function getSortFacetValuesBy() /** * Sets sortFacetValuesBy * - * @param string|null $sortFacetValuesBy controls how facet values are fetched + * @param string|null $sortFacetValuesBy Controls how facet values are fetched. * * @return self */ @@ -650,7 +652,7 @@ public function getPage() /** * Sets page * - * @param int|null $page specify the page to retrieve + * @param int|null $page Specify the page to retrieve. * * @return self */ @@ -674,7 +676,7 @@ public function getOffset() /** * Sets offset * - * @param int|null $offset specify the offset of the first hit to return + * @param int|null $offset Specify the offset of the first hit to return. * * @return self */ @@ -698,7 +700,7 @@ public function getLength() /** * Sets length * - * @param int|null $length set the number of hits to retrieve (used only with offset) + * @param int|null $length Set the number of hits to retrieve (used only with offset). * * @return self */ @@ -730,7 +732,7 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng search for entries around a central geolocation, enabling a geo search within a circular area + * @param string|null $aroundLatLng Search for entries around a central geolocation, enabling a geo search within a circular area. * * @return self */ @@ -754,7 +756,7 @@ public function getAroundLatLngViaIP() /** * Sets aroundLatLngViaIP * - * @param bool|null $aroundLatLngViaIP search for entries around a given location automatically computed from the requester's IP address + * @param bool|null $aroundLatLngViaIP Search for entries around a given location automatically computed from the requester's IP address. * * @return self */ @@ -778,7 +780,7 @@ public function getAroundRadius() /** * Sets aroundRadius * - * @param OneOfIntegerString|null $aroundRadius define the maximum radius for a geo search (in meters) + * @param OneOfIntegerString|null $aroundRadius Define the maximum radius for a geo search (in meters). * * @return self */ @@ -802,7 +804,7 @@ public function getAroundPrecision() /** * Sets aroundPrecision * - * @param int|null $aroundPrecision precision of geo search (in meters), to add grouping by geo location to the ranking formula + * @param int|null $aroundPrecision Precision of geo search (in meters), to add grouping by geo location to the ranking formula. * * @return self */ @@ -826,7 +828,7 @@ public function getMinimumAroundRadius() /** * Sets minimumAroundRadius * - * @param int|null $minimumAroundRadius minimum radius (in meters) used for a geo search when aroundRadius is not set + * @param int|null $minimumAroundRadius Minimum radius (in meters) used for a geo search when aroundRadius is not set. * * @return self */ @@ -855,7 +857,7 @@ public function getInsideBoundingBox() /** * Sets insideBoundingBox * - * @param float[]|null $insideBoundingBox search inside a rectangular area (in geo coordinates) + * @param float[]|null $insideBoundingBox Search inside a rectangular area (in geo coordinates). * * @return self */ @@ -879,7 +881,7 @@ public function getInsidePolygon() /** * Sets insidePolygon * - * @param float[]|null $insidePolygon search inside a polygon (in geo coordinates) + * @param float[]|null $insidePolygon Search inside a polygon (in geo coordinates). * * @return self */ @@ -927,7 +929,7 @@ public function getRuleContexts() /** * Sets ruleContexts * - * @param string[]|null $ruleContexts enables contextual rules + * @param string[]|null $ruleContexts Enables contextual rules. * * @return self */ @@ -951,7 +953,7 @@ public function getPersonalizationImpact() /** * Sets personalizationImpact * - * @param int|null $personalizationImpact define the impact of the Personalization feature + * @param int|null $personalizationImpact Define the impact of the Personalization feature. * * @return self */ @@ -975,7 +977,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken associates a certain user token with the current search + * @param string|null $userToken Associates a certain user token with the current search. * * @return self */ @@ -999,7 +1001,7 @@ public function getGetRankingInfo() /** * Sets getRankingInfo * - * @param bool|null $getRankingInfo retrieve detailed ranking information + * @param bool|null $getRankingInfo Retrieve detailed ranking information. * * @return self */ @@ -1023,7 +1025,7 @@ public function getClickAnalytics() /** * Sets clickAnalytics * - * @param bool|null $clickAnalytics enable the Click Analytics feature + * @param bool|null $clickAnalytics Enable the Click Analytics feature. * * @return self */ @@ -1047,7 +1049,7 @@ public function getAnalytics() /** * Sets analytics * - * @param bool|null $analytics whether the current query will be taken into account in the Analytics + * @param bool|null $analytics Whether the current query will be taken into account in the Analytics. * * @return self */ @@ -1071,7 +1073,7 @@ public function getAnalyticsTags() /** * Sets analyticsTags * - * @param string[]|null $analyticsTags list of tags to apply to the query for analytics purposes + * @param string[]|null $analyticsTags List of tags to apply to the query for analytics purposes. * * @return self */ @@ -1095,7 +1097,7 @@ public function getPercentileComputation() /** * Sets percentileComputation * - * @param bool|null $percentileComputation whether to include or exclude a query from the processing-time percentile computation + * @param bool|null $percentileComputation Whether to include or exclude a query from the processing-time percentile computation. * * @return self */ @@ -1119,7 +1121,7 @@ public function getEnableABTest() /** * Sets enableABTest * - * @param bool|null $enableABTest whether this search should participate in running AB tests + * @param bool|null $enableABTest Whether this search should participate in running AB tests. * * @return self */ @@ -1143,7 +1145,7 @@ public function getEnableReRanking() /** * Sets enableReRanking * - * @param bool|null $enableReRanking whether this search should use AI Re-Ranking + * @param bool|null $enableReRanking Whether this search should use AI Re-Ranking. * * @return self */ @@ -1156,9 +1158,9 @@ public function setEnableReRanking($enableReRanking) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -1168,7 +1170,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -1197,7 +1199,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -1208,11 +1210,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -1243,3 +1244,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php index 5d758f3f99..37b4705831 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BaseSearchResponse Class Doc Comment @@ -54,7 +54,7 @@ class BaseSearchResponse implements ModelInterface, ArrayAccess, \JsonSerializab 'query' => 'string', 'queryAfterRemoval' => 'string', 'serverUsed' => 'string', - 'userData' => 'object', + 'userData' => 'object' ]; /** @@ -88,7 +88,7 @@ class BaseSearchResponse implements ModelInterface, ArrayAccess, \JsonSerializab 'query' => null, 'queryAfterRemoval' => null, 'serverUsed' => null, - 'userData' => null, + 'userData' => null ]; /** @@ -141,7 +141,7 @@ public static function openAPIFormats() 'query' => 'query', 'queryAfterRemoval' => 'queryAfterRemoval', 'serverUsed' => 'serverUsed', - 'userData' => 'userData', + 'userData' => 'userData' ]; /** @@ -173,7 +173,7 @@ public static function openAPIFormats() 'query' => 'setQuery', 'queryAfterRemoval' => 'setQueryAfterRemoval', 'serverUsed' => 'setServerUsed', - 'userData' => 'setUserData', + 'userData' => 'setUserData' ]; /** @@ -205,7 +205,7 @@ public static function openAPIFormats() 'query' => 'getQuery', 'queryAfterRemoval' => 'getQueryAfterRemoval', 'serverUsed' => 'getServerUsed', - 'userData' => 'getUserData', + 'userData' => 'getUserData' ]; /** @@ -249,6 +249,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -299,7 +300,7 @@ public function listInvalidProperties() { $invalidProperties = []; - if (!is_null($this->container['aroundLatLng']) && !preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $this->container['aroundLatLng'])) { + if (!is_null($this->container['aroundLatLng']) && !preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $this->container['aroundLatLng'])) { $invalidProperties[] = "invalid value for 'aroundLatLng', must be conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."; } @@ -330,7 +331,6 @@ public function listInvalidProperties() if ($this->container['query'] === null) { $invalidProperties[] = "'query' can't be null"; } - return $invalidProperties; } @@ -345,6 +345,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets abTestID * @@ -358,7 +359,7 @@ public function getAbTestID() /** * Sets abTestID * - * @param int|null $abTestID if a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID + * @param int|null $abTestID If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID. * * @return self */ @@ -382,7 +383,7 @@ public function getAbTestVariantID() /** * Sets abTestVariantID * - * @param int|null $abTestVariantID if a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used + * @param int|null $abTestVariantID If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used. * * @return self */ @@ -406,14 +407,14 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng the computed geo location + * @param string|null $aroundLatLng The computed geo location. * * @return self */ public function setAroundLatLng($aroundLatLng) { - if (!is_null($aroundLatLng) && (!preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $aroundLatLng))) { + if (!is_null($aroundLatLng) && (!preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $aroundLatLng))) { throw new \InvalidArgumentException("invalid value for $aroundLatLng when calling BaseSearchResponse., must conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."); } @@ -459,7 +460,7 @@ public function getExhaustiveFacetsCount() /** * Sets exhaustiveFacetsCount * - * @param bool|null $exhaustiveFacetsCount whether the facet count is exhaustive or approximate + * @param bool|null $exhaustiveFacetsCount Whether the facet count is exhaustive or approximate. * * @return self */ @@ -531,7 +532,7 @@ public function getFacets() /** * Sets facets * - * @param array>|null $facets a mapping of each facet name to the corresponding facet counts + * @param array>|null $facets A mapping of each facet name to the corresponding facet counts. * * @return self */ @@ -555,7 +556,7 @@ public function getFacetsStats() /** * Sets facetsStats * - * @param array|null $facetsStats statistics for numerical facets + * @param array|null $facetsStats Statistics for numerical facets. * * @return self */ @@ -579,7 +580,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int $hitsPerPage set the number of hits per page + * @param int $hitsPerPage Set the number of hits per page. * * @return self */ @@ -603,7 +604,7 @@ public function getIndex() /** * Sets index * - * @param string|null $index index name used for the query + * @param string|null $index Index name used for the query. * * @return self */ @@ -651,7 +652,7 @@ public function getMessage() /** * Sets message * - * @param string|null $message used to return warnings about the query + * @param string|null $message Used to return warnings about the query. * * @return self */ @@ -675,7 +676,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits number of hits that the search query matched + * @param int $nbHits Number of hits that the search query matched. * * @return self */ @@ -747,7 +748,7 @@ public function getPage() /** * Sets page * - * @param int $page specify the page to retrieve + * @param int $page Specify the page to retrieve. * * @return self */ @@ -771,7 +772,7 @@ public function getParams() /** * Sets params * - * @param string $params a url-encoded string of all search parameters + * @param string $params A url-encoded string of all search parameters. * * @return self */ @@ -795,7 +796,7 @@ public function getParsedQuery() /** * Sets parsedQuery * - * @param string|null $parsedQuery the query string that will be searched, after normalization + * @param string|null $parsedQuery The query string that will be searched, after normalization. * * @return self */ @@ -819,7 +820,7 @@ public function getProcessingTimeMS() /** * Sets processingTimeMS * - * @param int $processingTimeMS time the server took to process the request, in milliseconds + * @param int $processingTimeMS Time the server took to process the request, in milliseconds. * * @return self */ @@ -843,7 +844,7 @@ public function getQuery() /** * Sets query * - * @param string $query the text to search in the index + * @param string $query The text to search in the index. * * @return self */ @@ -867,7 +868,7 @@ public function getQueryAfterRemoval() /** * Sets queryAfterRemoval * - * @param string|null $queryAfterRemoval a markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set + * @param string|null $queryAfterRemoval A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. * * @return self */ @@ -891,7 +892,7 @@ public function getServerUsed() /** * Sets serverUsed * - * @param string|null $serverUsed actual host name of the server that processed the request + * @param string|null $serverUsed Actual host name of the server that processed the request. * * @return self */ @@ -915,7 +916,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData lets you store custom data in your indices + * @param object|null $userData Lets you store custom data in your indices. * * @return self */ @@ -928,9 +929,9 @@ public function setUserData($userData) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -940,7 +941,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -969,7 +970,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -980,11 +981,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -1015,3 +1015,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php index f260c78f71..2d97e8e94b 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BaseSearchResponseFacetsStats Class Doc Comment @@ -34,7 +34,7 @@ class BaseSearchResponseFacetsStats implements ModelInterface, ArrayAccess, \Jso 'min' => 'int', 'max' => 'int', 'avg' => 'int', - 'sum' => 'int', + 'sum' => 'int' ]; /** @@ -48,7 +48,7 @@ class BaseSearchResponseFacetsStats implements ModelInterface, ArrayAccess, \Jso 'min' => null, 'max' => null, 'avg' => null, - 'sum' => null, + 'sum' => null ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() 'min' => 'min', 'max' => 'max', 'avg' => 'avg', - 'sum' => 'sum', + 'sum' => 'sum' ]; /** @@ -93,7 +93,7 @@ public static function openAPIFormats() 'min' => 'setMin', 'max' => 'setMax', 'avg' => 'setAvg', - 'sum' => 'setSum', + 'sum' => 'setSum' ]; /** @@ -105,7 +105,7 @@ public static function openAPIFormats() 'min' => 'getMin', 'max' => 'getMax', 'avg' => 'getAvg', - 'sum' => 'getSum', + 'sum' => 'getSum' ]; /** @@ -149,6 +149,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -193,6 +194,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets min * @@ -206,7 +208,7 @@ public function getMin() /** * Sets min * - * @param int|null $min the minimum value in the result set + * @param int|null $min The minimum value in the result set. * * @return self */ @@ -230,7 +232,7 @@ public function getMax() /** * Sets max * - * @param int|null $max the maximum value in the result set + * @param int|null $max The maximum value in the result set. * * @return self */ @@ -254,7 +256,7 @@ public function getAvg() /** * Sets avg * - * @param int|null $avg the average facet value in the result set + * @param int|null $avg The average facet value in the result set. * * @return self */ @@ -278,7 +280,7 @@ public function getSum() /** * Sets sum * - * @param int|null $sum the sum of all values in the result set + * @param int|null $sum The sum of all values in the result set. * * @return self */ @@ -291,9 +293,9 @@ public function setSum($sum) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -303,7 +305,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -332,7 +334,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -343,11 +345,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -378,3 +379,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php b/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php index 60ad6bd7ef..43c76dd3dd 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BatchAssignUserIdsObject Class Doc Comment * * @category Class * @description Assign userID object. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +33,7 @@ class BatchAssignUserIdsObject implements ModelInterface, ArrayAccess, \JsonSeri */ protected static $openAPITypes = [ 'cluster' => 'string', - 'users' => 'string[]', + 'users' => 'string[]' ]; /** @@ -46,7 +45,7 @@ class BatchAssignUserIdsObject implements ModelInterface, ArrayAccess, \JsonSeri */ protected static $openAPIFormats = [ 'cluster' => null, - 'users' => null, + 'users' => null ]; /** @@ -77,7 +76,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'cluster' => 'cluster', - 'users' => 'users', + 'users' => 'users' ]; /** @@ -87,7 +86,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'cluster' => 'setCluster', - 'users' => 'setUsers', + 'users' => 'setUsers' ]; /** @@ -97,7 +96,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'cluster' => 'getCluster', - 'users' => 'getUsers', + 'users' => 'getUsers' ]; /** @@ -141,6 +140,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -175,7 +175,6 @@ public function listInvalidProperties() if ($this->container['users'] === null) { $invalidProperties[] = "'users' can't be null"; } - return $invalidProperties; } @@ -190,6 +189,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets cluster * @@ -203,7 +203,7 @@ public function getCluster() /** * Sets cluster * - * @param string $cluster name of the cluster + * @param string $cluster Name of the cluster. * * @return self */ @@ -240,9 +240,9 @@ public function setUsers($users) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -252,7 +252,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -281,7 +281,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -292,11 +292,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -327,3 +326,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php index d0ba7be83a..8c5a853c0e 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BatchDictionaryEntries Class Doc Comment * * @category Class * @description The `batchDictionaryEntries` requests. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +33,7 @@ class BatchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSerial */ protected static $openAPITypes = [ 'clearExistingDictionaryEntries' => 'bool', - 'requests' => '\Algolia\AlgoliaSearch\Model\BatchDictionaryEntriesRequest[]', + 'requests' => '\Algolia\AlgoliaSearch\Model\BatchDictionaryEntriesRequest[]' ]; /** @@ -46,7 +45,7 @@ class BatchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSerial */ protected static $openAPIFormats = [ 'clearExistingDictionaryEntries' => null, - 'requests' => null, + 'requests' => null ]; /** @@ -77,7 +76,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'clearExistingDictionaryEntries' => 'clearExistingDictionaryEntries', - 'requests' => 'requests', + 'requests' => 'requests' ]; /** @@ -87,7 +86,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'clearExistingDictionaryEntries' => 'setClearExistingDictionaryEntries', - 'requests' => 'setRequests', + 'requests' => 'setRequests' ]; /** @@ -97,7 +96,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'clearExistingDictionaryEntries' => 'getClearExistingDictionaryEntries', - 'requests' => 'getRequests', + 'requests' => 'getRequests' ]; /** @@ -141,6 +140,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -172,7 +172,6 @@ public function listInvalidProperties() if ($this->container['requests'] === null) { $invalidProperties[] = "'requests' can't be null"; } - return $invalidProperties; } @@ -187,6 +186,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets clearExistingDictionaryEntries * @@ -200,7 +200,7 @@ public function getClearExistingDictionaryEntries() /** * Sets clearExistingDictionaryEntries * - * @param bool|null $clearExistingDictionaryEntries when `true`, start the batch by removing all the custom entries from the dictionary + * @param bool|null $clearExistingDictionaryEntries When `true`, start the batch by removing all the custom entries from the dictionary. * * @return self */ @@ -237,9 +237,9 @@ public function setRequests($requests) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -249,7 +249,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -278,7 +278,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -289,11 +289,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -324,3 +323,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php index e74c45c010..073e38595f 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BatchDictionaryEntriesRequest Class Doc Comment @@ -32,7 +32,7 @@ class BatchDictionaryEntriesRequest implements ModelInterface, ArrayAccess, \Jso */ protected static $openAPITypes = [ 'action' => 'string', - 'body' => '\Algolia\AlgoliaSearch\Model\DictionaryEntry', + 'body' => '\Algolia\AlgoliaSearch\Model\DictionaryEntry' ]; /** @@ -44,7 +44,7 @@ class BatchDictionaryEntriesRequest implements ModelInterface, ArrayAccess, \Jso */ protected static $openAPIFormats = [ 'action' => null, - 'body' => null, + 'body' => null ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'action' => 'action', - 'body' => 'body', + 'body' => 'body' ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'action' => 'setAction', - 'body' => 'setBody', + 'body' => 'setBody' ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'action' => 'getAction', - 'body' => 'getBody', + 'body' => 'getBody' ]; /** @@ -198,7 +198,6 @@ public function listInvalidProperties() if ($this->container['body'] === null) { $invalidProperties[] = "'body' can't be null"; } - return $invalidProperties; } @@ -213,6 +212,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets action * @@ -226,7 +226,7 @@ public function getAction() /** * Sets action * - * @param string $action actions to perform + * @param string $action Actions to perform. * * @return self */ @@ -273,9 +273,9 @@ public function setBody($body) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -285,7 +285,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -314,7 +314,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -325,11 +325,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -360,3 +359,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BatchObject.php b/clients/algoliasearch-client-php/lib/Model/BatchObject.php index 11b433c681..815e85b5cb 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchObject.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchObject.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BatchObject Class Doc Comment * * @category Class * @description The `batch` requests. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +32,7 @@ class BatchObject implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'requests' => '\Algolia\AlgoliaSearch\Model\Operation[]', + 'requests' => '\Algolia\AlgoliaSearch\Model\Operation[]' ]; /** @@ -44,7 +43,7 @@ class BatchObject implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'requests' => null, + 'requests' => null ]; /** @@ -74,7 +73,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'requests' => 'requests', + 'requests' => 'requests' ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'requests' => 'setRequests', + 'requests' => 'setRequests' ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'requests' => 'getRequests', + 'requests' => 'getRequests' ]; /** @@ -136,6 +135,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -177,6 +177,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets requests * @@ -203,9 +204,9 @@ public function setRequests($requests) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -215,7 +216,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -244,7 +245,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -255,11 +256,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -290,3 +290,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BatchResponse.php b/clients/algoliasearch-client-php/lib/Model/BatchResponse.php index 149eae702c..ad20982c93 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BatchResponse Class Doc Comment @@ -32,7 +32,7 @@ class BatchResponse implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'taskID' => 'int', - 'objectIDs' => 'string[]', + 'objectIDs' => 'string[]' ]; /** @@ -44,7 +44,7 @@ class BatchResponse implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'taskID' => null, - 'objectIDs' => null, + 'objectIDs' => null ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'taskID' => 'taskID', - 'objectIDs' => 'objectIDs', + 'objectIDs' => 'objectIDs' ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'taskID' => 'setTaskID', - 'objectIDs' => 'setObjectIDs', + 'objectIDs' => 'setObjectIDs' ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'taskID' => 'getTaskID', - 'objectIDs' => 'getObjectIDs', + 'objectIDs' => 'getObjectIDs' ]; /** @@ -139,6 +139,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -181,6 +182,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets taskID * @@ -194,7 +196,7 @@ public function getTaskID() /** * Sets taskID * - * @param int|null $taskID taskID of the indexing task to wait for + * @param int|null $taskID taskID of the indexing task to wait for. * * @return self */ @@ -218,7 +220,7 @@ public function getObjectIDs() /** * Sets objectIDs * - * @param string[]|null $objectIDs list of objectID + * @param string[]|null $objectIDs List of objectID. * * @return self */ @@ -231,9 +233,9 @@ public function setObjectIDs($objectIDs) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -243,7 +245,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -272,7 +274,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -283,11 +285,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -318,3 +319,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php b/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php index 9b61babd79..896d0c3b8f 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BatchWriteObject Class Doc Comment * * @category Class * @description The `batch` requests. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +32,7 @@ class BatchWriteObject implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'requests' => '\Algolia\AlgoliaSearch\Model\Operation[]', + 'requests' => '\Algolia\AlgoliaSearch\Model\Operation[]' ]; /** @@ -44,7 +43,7 @@ class BatchWriteObject implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'requests' => null, + 'requests' => null ]; /** @@ -74,7 +73,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'requests' => 'requests', + 'requests' => 'requests' ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'requests' => 'setRequests', + 'requests' => 'setRequests' ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'requests' => 'getRequests', + 'requests' => 'getRequests' ]; /** @@ -136,6 +135,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -177,6 +177,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets requests * @@ -203,9 +204,9 @@ public function setRequests($requests) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -215,7 +216,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -244,7 +245,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -255,11 +256,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -290,3 +290,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php b/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php index 1f2fe9ca43..8c2728944a 100644 --- a/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BrowseRequest Class Doc Comment @@ -32,7 +32,7 @@ class BrowseRequest implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'params' => 'string', - 'cursor' => 'string', + 'cursor' => 'string' ]; /** @@ -44,7 +44,7 @@ class BrowseRequest implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'params' => null, - 'cursor' => null, + 'cursor' => null ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'params' => 'params', - 'cursor' => 'cursor', + 'cursor' => 'cursor' ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'params' => 'setParams', - 'cursor' => 'setCursor', + 'cursor' => 'setCursor' ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'params' => 'getParams', - 'cursor' => 'getCursor', + 'cursor' => 'getCursor' ]; /** @@ -139,6 +139,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -181,6 +182,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets params * @@ -194,7 +196,7 @@ public function getParams() /** * Sets params * - * @param string|null $params search parameters as URL-encoded query string + * @param string|null $params Search parameters as URL-encoded query string. * * @return self */ @@ -231,9 +233,9 @@ public function setCursor($cursor) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -243,7 +245,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -272,7 +274,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -283,11 +285,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -318,3 +319,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php b/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php index a42ad93b22..389fa30b65 100644 --- a/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BrowseResponse Class Doc Comment @@ -56,7 +56,7 @@ class BrowseResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'serverUsed' => 'string', 'userData' => 'object', 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]', - 'cursor' => 'string', + 'cursor' => 'string' ]; /** @@ -92,7 +92,7 @@ class BrowseResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'serverUsed' => null, 'userData' => null, 'hits' => null, - 'cursor' => null, + 'cursor' => null ]; /** @@ -147,7 +147,7 @@ public static function openAPIFormats() 'serverUsed' => 'serverUsed', 'userData' => 'userData', 'hits' => 'hits', - 'cursor' => 'cursor', + 'cursor' => 'cursor' ]; /** @@ -181,7 +181,7 @@ public static function openAPIFormats() 'serverUsed' => 'setServerUsed', 'userData' => 'setUserData', 'hits' => 'setHits', - 'cursor' => 'setCursor', + 'cursor' => 'setCursor' ]; /** @@ -215,7 +215,7 @@ public static function openAPIFormats() 'serverUsed' => 'getServerUsed', 'userData' => 'getUserData', 'hits' => 'getHits', - 'cursor' => 'getCursor', + 'cursor' => 'getCursor' ]; /** @@ -259,6 +259,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -311,7 +312,7 @@ public function listInvalidProperties() { $invalidProperties = []; - if (!is_null($this->container['aroundLatLng']) && !preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $this->container['aroundLatLng'])) { + if (!is_null($this->container['aroundLatLng']) && !preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $this->container['aroundLatLng'])) { $invalidProperties[] = "invalid value for 'aroundLatLng', must be conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."; } @@ -348,7 +349,6 @@ public function listInvalidProperties() if ($this->container['cursor'] === null) { $invalidProperties[] = "'cursor' can't be null"; } - return $invalidProperties; } @@ -363,6 +363,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets abTestID * @@ -376,7 +377,7 @@ public function getAbTestID() /** * Sets abTestID * - * @param int|null $abTestID if a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID + * @param int|null $abTestID If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID. * * @return self */ @@ -400,7 +401,7 @@ public function getAbTestVariantID() /** * Sets abTestVariantID * - * @param int|null $abTestVariantID if a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used + * @param int|null $abTestVariantID If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used. * * @return self */ @@ -424,14 +425,14 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng the computed geo location + * @param string|null $aroundLatLng The computed geo location. * * @return self */ public function setAroundLatLng($aroundLatLng) { - if (!is_null($aroundLatLng) && (!preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $aroundLatLng))) { + if (!is_null($aroundLatLng) && (!preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $aroundLatLng))) { throw new \InvalidArgumentException("invalid value for $aroundLatLng when calling BrowseResponse., must conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."); } @@ -477,7 +478,7 @@ public function getExhaustiveFacetsCount() /** * Sets exhaustiveFacetsCount * - * @param bool|null $exhaustiveFacetsCount whether the facet count is exhaustive or approximate + * @param bool|null $exhaustiveFacetsCount Whether the facet count is exhaustive or approximate. * * @return self */ @@ -549,7 +550,7 @@ public function getFacets() /** * Sets facets * - * @param array>|null $facets a mapping of each facet name to the corresponding facet counts + * @param array>|null $facets A mapping of each facet name to the corresponding facet counts. * * @return self */ @@ -573,7 +574,7 @@ public function getFacetsStats() /** * Sets facetsStats * - * @param array|null $facetsStats statistics for numerical facets + * @param array|null $facetsStats Statistics for numerical facets. * * @return self */ @@ -597,7 +598,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int $hitsPerPage set the number of hits per page + * @param int $hitsPerPage Set the number of hits per page. * * @return self */ @@ -621,7 +622,7 @@ public function getIndex() /** * Sets index * - * @param string|null $index index name used for the query + * @param string|null $index Index name used for the query. * * @return self */ @@ -669,7 +670,7 @@ public function getMessage() /** * Sets message * - * @param string|null $message used to return warnings about the query + * @param string|null $message Used to return warnings about the query. * * @return self */ @@ -693,7 +694,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits number of hits that the search query matched + * @param int $nbHits Number of hits that the search query matched. * * @return self */ @@ -765,7 +766,7 @@ public function getPage() /** * Sets page * - * @param int $page specify the page to retrieve + * @param int $page Specify the page to retrieve. * * @return self */ @@ -789,7 +790,7 @@ public function getParams() /** * Sets params * - * @param string $params a url-encoded string of all search parameters + * @param string $params A url-encoded string of all search parameters. * * @return self */ @@ -813,7 +814,7 @@ public function getParsedQuery() /** * Sets parsedQuery * - * @param string|null $parsedQuery the query string that will be searched, after normalization + * @param string|null $parsedQuery The query string that will be searched, after normalization. * * @return self */ @@ -837,7 +838,7 @@ public function getProcessingTimeMS() /** * Sets processingTimeMS * - * @param int $processingTimeMS time the server took to process the request, in milliseconds + * @param int $processingTimeMS Time the server took to process the request, in milliseconds. * * @return self */ @@ -861,7 +862,7 @@ public function getQuery() /** * Sets query * - * @param string $query the text to search in the index + * @param string $query The text to search in the index. * * @return self */ @@ -885,7 +886,7 @@ public function getQueryAfterRemoval() /** * Sets queryAfterRemoval * - * @param string|null $queryAfterRemoval a markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set + * @param string|null $queryAfterRemoval A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. * * @return self */ @@ -909,7 +910,7 @@ public function getServerUsed() /** * Sets serverUsed * - * @param string|null $serverUsed actual host name of the server that processed the request + * @param string|null $serverUsed Actual host name of the server that processed the request. * * @return self */ @@ -933,7 +934,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData lets you store custom data in your indices + * @param object|null $userData Lets you store custom data in your indices. * * @return self */ @@ -994,9 +995,9 @@ public function setCursor($cursor) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -1006,7 +1007,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -1035,7 +1036,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -1046,11 +1047,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -1081,3 +1081,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php b/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php index 0b47b91e5e..3812d64acb 100644 --- a/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php +++ b/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * BuildInOperation Class Doc Comment * * @category Class * @description To update an attribute without pushing the entire record, you can use these built-in operations. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +33,7 @@ class BuildInOperation implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'operation' => 'string', - 'value' => 'string', + 'value' => 'string' ]; /** @@ -46,7 +45,7 @@ class BuildInOperation implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'operation' => null, - 'value' => null, + 'value' => null ]; /** @@ -77,7 +76,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'operation' => '_operation', - 'value' => 'value', + 'value' => 'value' ]; /** @@ -87,7 +86,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'operation' => 'setOperation', - 'value' => 'setValue', + 'value' => 'setValue' ]; /** @@ -97,7 +96,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'operation' => 'getOperation', - 'value' => 'getValue', + 'value' => 'getValue' ]; /** @@ -210,7 +209,6 @@ public function listInvalidProperties() if ($this->container['value'] === null) { $invalidProperties[] = "'value' can't be null"; } - return $invalidProperties; } @@ -225,6 +223,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets operation * @@ -238,7 +237,7 @@ public function getOperation() /** * Sets operation * - * @param string $operation the operation to apply on the attribute + * @param string $operation The operation to apply on the attribute. * * @return self */ @@ -272,7 +271,7 @@ public function getValue() /** * Sets value * - * @param string $value the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove + * @param string $value the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove. * * @return self */ @@ -285,9 +284,9 @@ public function setValue($value) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -297,7 +296,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -326,7 +325,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -337,11 +336,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -372,3 +370,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/Condition.php b/clients/algoliasearch-client-php/lib/Model/Condition.php index df2723672e..56abe62cb6 100644 --- a/clients/algoliasearch-client-php/lib/Model/Condition.php +++ b/clients/algoliasearch-client-php/lib/Model/Condition.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * Condition Class Doc Comment @@ -34,7 +34,7 @@ class Condition implements ModelInterface, ArrayAccess, \JsonSerializable 'pattern' => 'string', 'anchoring' => '\Algolia\AlgoliaSearch\Model\Anchoring', 'alternatives' => 'bool', - 'context' => 'string', + 'context' => 'string' ]; /** @@ -48,7 +48,7 @@ class Condition implements ModelInterface, ArrayAccess, \JsonSerializable 'pattern' => null, 'anchoring' => null, 'alternatives' => null, - 'context' => null, + 'context' => null ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() 'pattern' => 'pattern', 'anchoring' => 'anchoring', 'alternatives' => 'alternatives', - 'context' => 'context', + 'context' => 'context' ]; /** @@ -93,7 +93,7 @@ public static function openAPIFormats() 'pattern' => 'setPattern', 'anchoring' => 'setAnchoring', 'alternatives' => 'setAlternatives', - 'context' => 'setContext', + 'context' => 'setContext' ]; /** @@ -105,7 +105,7 @@ public static function openAPIFormats() 'pattern' => 'getPattern', 'anchoring' => 'getAnchoring', 'alternatives' => 'getAlternatives', - 'context' => 'getContext', + 'context' => 'getContext' ]; /** @@ -149,6 +149,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -193,6 +194,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets pattern * @@ -254,7 +256,7 @@ public function getAlternatives() /** * Sets alternatives * - * @param bool|null $alternatives whether the pattern matches on plurals, synonyms, and typos + * @param bool|null $alternatives Whether the pattern matches on plurals, synonyms, and typos. * * @return self */ @@ -278,7 +280,7 @@ public function getContext() /** * Sets context * - * @param string|null $context rule context format: [A-Za-z0-9_-]+) + * @param string|null $context Rule context format: [A-Za-z0-9_-]+). * * @return self */ @@ -291,9 +293,9 @@ public function setContext($context) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -303,7 +305,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -332,7 +334,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -343,11 +345,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -378,3 +379,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/Consequence.php b/clients/algoliasearch-client-php/lib/Model/Consequence.php index d3d51ae219..5399db7de5 100644 --- a/clients/algoliasearch-client-php/lib/Model/Consequence.php +++ b/clients/algoliasearch-client-php/lib/Model/Consequence.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * Consequence Class Doc Comment * * @category Class * @description Consequence of the Rule. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -37,7 +36,7 @@ class Consequence implements ModelInterface, ArrayAccess, \JsonSerializable 'promote' => '\Algolia\AlgoliaSearch\Model\Promote[]', 'filterPromotes' => 'bool', 'hide' => '\Algolia\AlgoliaSearch\Model\ConsequenceHide[]', - 'userData' => 'object', + 'userData' => 'object' ]; /** @@ -52,7 +51,7 @@ class Consequence implements ModelInterface, ArrayAccess, \JsonSerializable 'promote' => null, 'filterPromotes' => null, 'hide' => null, - 'userData' => null, + 'userData' => null ]; /** @@ -86,7 +85,7 @@ public static function openAPIFormats() 'promote' => 'promote', 'filterPromotes' => 'filterPromotes', 'hide' => 'hide', - 'userData' => 'userData', + 'userData' => 'userData' ]; /** @@ -99,7 +98,7 @@ public static function openAPIFormats() 'promote' => 'setPromote', 'filterPromotes' => 'setFilterPromotes', 'hide' => 'setHide', - 'userData' => 'setUserData', + 'userData' => 'setUserData' ]; /** @@ -112,7 +111,7 @@ public static function openAPIFormats() 'promote' => 'getPromote', 'filterPromotes' => 'getFilterPromotes', 'hide' => 'getHide', - 'userData' => 'getUserData', + 'userData' => 'getUserData' ]; /** @@ -156,6 +155,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -201,6 +201,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets params * @@ -238,7 +239,7 @@ public function getPromote() /** * Sets promote * - * @param \Algolia\AlgoliaSearch\Model\Promote[]|null $promote objects to promote as hits + * @param \Algolia\AlgoliaSearch\Model\Promote[]|null $promote Objects to promote as hits. * * @return self */ @@ -323,9 +324,9 @@ public function setUserData($userData) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -335,7 +336,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -364,7 +365,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -375,11 +376,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -410,3 +410,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php b/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php index 8a5716ca77..35fcc49b7b 100644 --- a/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php +++ b/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * ConsequenceHide Class Doc Comment * * @category Class * @description Unique identifier of the object to hide. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +32,7 @@ class ConsequenceHide implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'objectID' => 'string', + 'objectID' => 'string' ]; /** @@ -44,7 +43,7 @@ class ConsequenceHide implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'objectID' => null, + 'objectID' => null ]; /** @@ -74,7 +73,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'objectID' => 'objectID', + 'objectID' => 'objectID' ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'objectID' => 'setObjectID', + 'objectID' => 'setObjectID' ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'objectID' => 'getObjectID', + 'objectID' => 'getObjectID' ]; /** @@ -136,6 +135,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -166,7 +166,6 @@ public function listInvalidProperties() if ($this->container['objectID'] === null) { $invalidProperties[] = "'objectID' can't be null"; } - return $invalidProperties; } @@ -181,6 +180,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets objectID * @@ -194,7 +194,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID unique identifier of the object + * @param string $objectID Unique identifier of the object. * * @return self */ @@ -207,9 +207,9 @@ public function setObjectID($objectID) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -259,11 +259,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -294,3 +293,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php b/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php index 2851a1ea17..1d45a92a8a 100644 --- a/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php +++ b/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * ConsequenceParams Class Doc Comment @@ -109,7 +109,7 @@ class ConsequenceParams implements ModelInterface, ArrayAccess, \JsonSerializabl 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object', + 'renderingContent' => 'object' ]; /** @@ -198,7 +198,7 @@ class ConsequenceParams implements ModelInterface, ArrayAccess, \JsonSerializabl 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null, + 'renderingContent' => null ]; /** @@ -306,7 +306,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent', + 'renderingContent' => 'renderingContent' ]; /** @@ -393,7 +393,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent', + 'renderingContent' => 'setRenderingContent' ]; /** @@ -480,7 +480,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent', + 'renderingContent' => 'getRenderingContent' ]; /** @@ -816,6 +816,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets query * @@ -829,7 +830,7 @@ public function getQuery() /** * Sets query * - * @param string|null $query query string + * @param string|null $query Query string. * * @return self */ @@ -853,7 +854,7 @@ public function getAutomaticFacetFilters() /** * Sets automaticFacetFilters * - * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticFacetFilters names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern + * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticFacetFilters Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern. * * @return self */ @@ -877,7 +878,7 @@ public function getAutomaticOptionalFacetFilters() /** * Sets automaticOptionalFacetFilters * - * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticOptionalFacetFilters same syntax as automaticFacetFilters, but the engine treats the filters as optional + * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticOptionalFacetFilters Same syntax as automaticFacetFilters, but the engine treats the filters as optional. * * @return self */ @@ -901,7 +902,7 @@ public function getSimilarQuery() /** * Sets similarQuery * - * @param string|null $similarQuery overrides the query parameter and performs a more generic search that can be used to find \"similar\" results + * @param string|null $similarQuery Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results. * * @return self */ @@ -925,7 +926,7 @@ public function getFilters() /** * Sets filters * - * @param string|null $filters filter the query with numeric, facet and/or tag filters + * @param string|null $filters Filter the query with numeric, facet and/or tag filters. * * @return self */ @@ -949,7 +950,7 @@ public function getFacetFilters() /** * Sets facetFilters * - * @param string[]|null $facetFilters filter hits by facet value + * @param string[]|null $facetFilters Filter hits by facet value. * * @return self */ @@ -973,7 +974,7 @@ public function getOptionalFilters() /** * Sets optionalFilters * - * @param string[]|null $optionalFilters create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter + * @param string[]|null $optionalFilters Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. * * @return self */ @@ -997,7 +998,7 @@ public function getNumericFilters() /** * Sets numericFilters * - * @param string[]|null $numericFilters filter on numeric attributes + * @param string[]|null $numericFilters Filter on numeric attributes. * * @return self */ @@ -1021,7 +1022,7 @@ public function getTagFilters() /** * Sets tagFilters * - * @param string[]|null $tagFilters filter hits by tags + * @param string[]|null $tagFilters Filter hits by tags. * * @return self */ @@ -1045,7 +1046,7 @@ public function getSumOrFiltersScores() /** * Sets sumOrFiltersScores * - * @param bool|null $sumOrFiltersScores determines how to calculate the total score for filtering + * @param bool|null $sumOrFiltersScores Determines how to calculate the total score for filtering. * * @return self */ @@ -1069,7 +1070,7 @@ public function getFacets() /** * Sets facets * - * @param string[]|null $facets retrieve facets and their facet values + * @param string[]|null $facets Retrieve facets and their facet values. * * @return self */ @@ -1093,7 +1094,7 @@ public function getMaxValuesPerFacet() /** * Sets maxValuesPerFacet * - * @param int|null $maxValuesPerFacet maximum number of facet values to return for each facet during a regular search + * @param int|null $maxValuesPerFacet Maximum number of facet values to return for each facet during a regular search. * * @return self */ @@ -1117,7 +1118,7 @@ public function getFacetingAfterDistinct() /** * Sets facetingAfterDistinct * - * @param bool|null $facetingAfterDistinct force faceting to be applied after de-duplication (via the Distinct setting) + * @param bool|null $facetingAfterDistinct Force faceting to be applied after de-duplication (via the Distinct setting). * * @return self */ @@ -1141,7 +1142,7 @@ public function getSortFacetValuesBy() /** * Sets sortFacetValuesBy * - * @param string|null $sortFacetValuesBy controls how facet values are fetched + * @param string|null $sortFacetValuesBy Controls how facet values are fetched. * * @return self */ @@ -1165,7 +1166,7 @@ public function getPage() /** * Sets page * - * @param int|null $page specify the page to retrieve + * @param int|null $page Specify the page to retrieve. * * @return self */ @@ -1189,7 +1190,7 @@ public function getOffset() /** * Sets offset * - * @param int|null $offset specify the offset of the first hit to return + * @param int|null $offset Specify the offset of the first hit to return. * * @return self */ @@ -1213,7 +1214,7 @@ public function getLength() /** * Sets length * - * @param int|null $length set the number of hits to retrieve (used only with offset) + * @param int|null $length Set the number of hits to retrieve (used only with offset). * * @return self */ @@ -1245,7 +1246,7 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng search for entries around a central geolocation, enabling a geo search within a circular area + * @param string|null $aroundLatLng Search for entries around a central geolocation, enabling a geo search within a circular area. * * @return self */ @@ -1269,7 +1270,7 @@ public function getAroundLatLngViaIP() /** * Sets aroundLatLngViaIP * - * @param bool|null $aroundLatLngViaIP search for entries around a given location automatically computed from the requester's IP address + * @param bool|null $aroundLatLngViaIP Search for entries around a given location automatically computed from the requester's IP address. * * @return self */ @@ -1293,7 +1294,7 @@ public function getAroundRadius() /** * Sets aroundRadius * - * @param OneOfIntegerString|null $aroundRadius define the maximum radius for a geo search (in meters) + * @param OneOfIntegerString|null $aroundRadius Define the maximum radius for a geo search (in meters). * * @return self */ @@ -1317,7 +1318,7 @@ public function getAroundPrecision() /** * Sets aroundPrecision * - * @param int|null $aroundPrecision precision of geo search (in meters), to add grouping by geo location to the ranking formula + * @param int|null $aroundPrecision Precision of geo search (in meters), to add grouping by geo location to the ranking formula. * * @return self */ @@ -1341,7 +1342,7 @@ public function getMinimumAroundRadius() /** * Sets minimumAroundRadius * - * @param int|null $minimumAroundRadius minimum radius (in meters) used for a geo search when aroundRadius is not set + * @param int|null $minimumAroundRadius Minimum radius (in meters) used for a geo search when aroundRadius is not set. * * @return self */ @@ -1370,7 +1371,7 @@ public function getInsideBoundingBox() /** * Sets insideBoundingBox * - * @param float[]|null $insideBoundingBox search inside a rectangular area (in geo coordinates) + * @param float[]|null $insideBoundingBox Search inside a rectangular area (in geo coordinates). * * @return self */ @@ -1394,7 +1395,7 @@ public function getInsidePolygon() /** * Sets insidePolygon * - * @param float[]|null $insidePolygon search inside a polygon (in geo coordinates) + * @param float[]|null $insidePolygon Search inside a polygon (in geo coordinates). * * @return self */ @@ -1442,7 +1443,7 @@ public function getRuleContexts() /** * Sets ruleContexts * - * @param string[]|null $ruleContexts enables contextual rules + * @param string[]|null $ruleContexts Enables contextual rules. * * @return self */ @@ -1466,7 +1467,7 @@ public function getPersonalizationImpact() /** * Sets personalizationImpact * - * @param int|null $personalizationImpact define the impact of the Personalization feature + * @param int|null $personalizationImpact Define the impact of the Personalization feature. * * @return self */ @@ -1490,7 +1491,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken associates a certain user token with the current search + * @param string|null $userToken Associates a certain user token with the current search. * * @return self */ @@ -1514,7 +1515,7 @@ public function getGetRankingInfo() /** * Sets getRankingInfo * - * @param bool|null $getRankingInfo retrieve detailed ranking information + * @param bool|null $getRankingInfo Retrieve detailed ranking information. * * @return self */ @@ -1538,7 +1539,7 @@ public function getClickAnalytics() /** * Sets clickAnalytics * - * @param bool|null $clickAnalytics enable the Click Analytics feature + * @param bool|null $clickAnalytics Enable the Click Analytics feature. * * @return self */ @@ -1562,7 +1563,7 @@ public function getAnalytics() /** * Sets analytics * - * @param bool|null $analytics whether the current query will be taken into account in the Analytics + * @param bool|null $analytics Whether the current query will be taken into account in the Analytics. * * @return self */ @@ -1586,7 +1587,7 @@ public function getAnalyticsTags() /** * Sets analyticsTags * - * @param string[]|null $analyticsTags list of tags to apply to the query for analytics purposes + * @param string[]|null $analyticsTags List of tags to apply to the query for analytics purposes. * * @return self */ @@ -1610,7 +1611,7 @@ public function getPercentileComputation() /** * Sets percentileComputation * - * @param bool|null $percentileComputation whether to include or exclude a query from the processing-time percentile computation + * @param bool|null $percentileComputation Whether to include or exclude a query from the processing-time percentile computation. * * @return self */ @@ -1634,7 +1635,7 @@ public function getEnableABTest() /** * Sets enableABTest * - * @param bool|null $enableABTest whether this search should participate in running AB tests + * @param bool|null $enableABTest Whether this search should participate in running AB tests. * * @return self */ @@ -1658,7 +1659,7 @@ public function getEnableReRanking() /** * Sets enableReRanking * - * @param bool|null $enableReRanking whether this search should use AI Re-Ranking + * @param bool|null $enableReRanking Whether this search should use AI Re-Ranking. * * @return self */ @@ -1682,7 +1683,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes the complete list of attributes used for searching + * @param string[]|null $searchableAttributes The complete list of attributes used for searching. * * @return self */ @@ -1706,7 +1707,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting + * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. * * @return self */ @@ -1730,7 +1731,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time + * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. * * @return self */ @@ -1754,7 +1755,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve + * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. * * @return self */ @@ -1778,7 +1779,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes + * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. * * @return self */ @@ -1802,7 +1803,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking controls how Algolia should sort your results + * @param string[]|null $ranking Controls how Algolia should sort your results. * * @return self */ @@ -1826,7 +1827,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking specifies the custom ranking criterion + * @param string[]|null $customRanking Specifies the custom ranking criterion. * * @return self */ @@ -1850,7 +1851,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results + * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. * * @return self */ @@ -1874,7 +1875,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight list of attributes to highlight + * @param string[]|null $attributesToHighlight List of attributes to highlight. * * @return self */ @@ -1898,7 +1899,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet + * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. * * @return self */ @@ -1922,7 +1923,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results + * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. * * @return self */ @@ -1946,7 +1947,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results + * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. * * @return self */ @@ -1970,7 +1971,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated + * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. * * @return self */ @@ -1994,7 +1995,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query + * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. * * @return self */ @@ -2018,7 +2019,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage set the number of hits per page + * @param int|null $hitsPerPage Set the number of hits per page. * * @return self */ @@ -2042,7 +2043,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo + * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. * * @return self */ @@ -2066,7 +2067,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos + * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. * * @return self */ @@ -2090,7 +2091,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied + * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. * * @return self */ @@ -2124,7 +2125,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string + * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. * * @return self */ @@ -2148,7 +2149,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance + * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. * * @return self */ @@ -2172,7 +2173,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex control which separators are indexed + * @param string|null $separatorsToIndex Control which separators are indexed. * * @return self */ @@ -2196,7 +2197,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms + * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. * * @return self */ @@ -2220,7 +2221,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords removes stop (common) words from the query before executing it + * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. * * @return self */ @@ -2244,7 +2245,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize + * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. * * @return self */ @@ -2268,7 +2269,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection + * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. * * @return self */ @@ -2292,7 +2293,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query + * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. * * @return self */ @@ -2316,7 +2317,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules whether Rules should be globally enabled + * @param bool|null $enableRules Whether Rules should be globally enabled. * * @return self */ @@ -2340,7 +2341,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization enable the Personalization feature + * @param bool|null $enablePersonalization Enable the Personalization feature. * * @return self */ @@ -2364,7 +2365,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType controls if and how query words are interpreted as prefixes + * @param string|null $queryType Controls if and how query words are interpreted as prefixes. * * @return self */ @@ -2398,7 +2399,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits + * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. * * @return self */ @@ -2432,7 +2433,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax enables the advanced query syntax + * @param bool|null $advancedSyntax Enables the advanced query syntax. * * @return self */ @@ -2456,7 +2457,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query + * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. * * @return self */ @@ -2480,7 +2481,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion + * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. * * @return self */ @@ -2504,7 +2505,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word + * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. * * @return self */ @@ -2538,7 +2539,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion + * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. * * @return self */ @@ -2571,7 +2572,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled + * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. * * @return self */ @@ -2604,7 +2605,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct enables de-duplication or grouping of results + * @param int|null $distinct Enables de-duplication or grouping of results. * * @return self */ @@ -2636,7 +2637,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search + * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. * * @return self */ @@ -2660,7 +2661,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself + * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. * * @return self */ @@ -2684,7 +2685,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity precision of the proximity ranking criterion + * @param int|null $minProximity Precision of the proximity ranking criterion. * * @return self */ @@ -2769,7 +2770,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage + * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. * * @return self */ @@ -2806,9 +2807,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -2818,7 +2819,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -2847,7 +2848,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -2858,11 +2859,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -2893,3 +2893,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php b/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php index 05b718c055..0aa84a34c1 100644 --- a/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php +++ b/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * CreatedAtObject Class Doc Comment @@ -31,7 +31,7 @@ class CreatedAtObject implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'createdAt' => '\DateTime', + 'createdAt' => '\DateTime' ]; /** @@ -42,7 +42,7 @@ class CreatedAtObject implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'createdAt' => 'date-time', + 'createdAt' => 'date-time' ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'createdAt' => 'createdAt', + 'createdAt' => 'createdAt' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'createdAt' => 'setCreatedAt', + 'createdAt' => 'setCreatedAt' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'createdAt' => 'getCreatedAt', + 'createdAt' => 'getCreatedAt' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -164,7 +165,6 @@ public function listInvalidProperties() if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } - return $invalidProperties; } @@ -179,6 +179,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets createdAt * @@ -192,7 +193,7 @@ public function getCreatedAt() /** * Sets createdAt * - * @param \DateTime $createdAt date of creation (ISO-8601 format) + * @param \DateTime $createdAt Date of creation (ISO-8601 format). * * @return self */ @@ -205,9 +206,9 @@ public function setCreatedAt($createdAt) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -217,7 +218,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -246,7 +247,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -257,11 +258,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -292,3 +292,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php b/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php index 0161cef372..315a5ae358 100644 --- a/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * CreatedAtResponse Class Doc Comment * * @category Class * @description The response with a createdAt timestamp. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +32,7 @@ class CreatedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl * @var string[] */ protected static $openAPITypes = [ - 'createdAt' => '\DateTime', + 'createdAt' => '\DateTime' ]; /** @@ -44,7 +43,7 @@ class CreatedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl * @psalm-var array */ protected static $openAPIFormats = [ - 'createdAt' => 'date-time', + 'createdAt' => 'date-time' ]; /** @@ -74,7 +73,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'createdAt' => 'createdAt', + 'createdAt' => 'createdAt' ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'createdAt' => 'setCreatedAt', + 'createdAt' => 'setCreatedAt' ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'createdAt' => 'getCreatedAt', + 'createdAt' => 'getCreatedAt' ]; /** @@ -136,6 +135,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -166,7 +166,6 @@ public function listInvalidProperties() if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } - return $invalidProperties; } @@ -181,6 +180,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets createdAt * @@ -194,7 +194,7 @@ public function getCreatedAt() /** * Sets createdAt * - * @param \DateTime $createdAt date of creation (ISO-8601 format) + * @param \DateTime $createdAt Date of creation (ISO-8601 format). * * @return self */ @@ -207,9 +207,9 @@ public function setCreatedAt($createdAt) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -259,11 +259,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -294,3 +293,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php b/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php index 46eeb200e3..91a0261797 100644 --- a/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * DeleteApiKeyResponse Class Doc Comment @@ -31,7 +31,7 @@ class DeleteApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'deletedAt' => '\DateTime', + 'deletedAt' => '\DateTime' ]; /** @@ -42,7 +42,7 @@ class DeleteApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'deletedAt' => 'date-time', + 'deletedAt' => 'date-time' ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'deletedAt' => 'deletedAt', + 'deletedAt' => 'deletedAt' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'deletedAt' => 'setDeletedAt', + 'deletedAt' => 'setDeletedAt' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'deletedAt' => 'getDeletedAt', + 'deletedAt' => 'getDeletedAt' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -164,7 +165,6 @@ public function listInvalidProperties() if ($this->container['deletedAt'] === null) { $invalidProperties[] = "'deletedAt' can't be null"; } - return $invalidProperties; } @@ -179,6 +179,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets deletedAt * @@ -192,7 +193,7 @@ public function getDeletedAt() /** * Sets deletedAt * - * @param \DateTime $deletedAt date of deletion (ISO-8601 format) + * @param \DateTime $deletedAt Date of deletion (ISO-8601 format). * * @return self */ @@ -205,9 +206,9 @@ public function setDeletedAt($deletedAt) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -217,7 +218,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -246,7 +247,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -257,11 +258,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -292,3 +292,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php b/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php index 32b42cf4da..0d93123442 100644 --- a/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * DeleteSourceResponse Class Doc Comment @@ -31,7 +31,7 @@ class DeleteSourceResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'deletedAt' => '\DateTime', + 'deletedAt' => '\DateTime' ]; /** @@ -42,7 +42,7 @@ class DeleteSourceResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'deletedAt' => 'date-time', + 'deletedAt' => 'date-time' ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'deletedAt' => 'deletedAt', + 'deletedAt' => 'deletedAt' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'deletedAt' => 'setDeletedAt', + 'deletedAt' => 'setDeletedAt' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'deletedAt' => 'getDeletedAt', + 'deletedAt' => 'getDeletedAt' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -164,7 +165,6 @@ public function listInvalidProperties() if ($this->container['deletedAt'] === null) { $invalidProperties[] = "'deletedAt' can't be null"; } - return $invalidProperties; } @@ -179,6 +179,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets deletedAt * @@ -192,7 +193,7 @@ public function getDeletedAt() /** * Sets deletedAt * - * @param \DateTime $deletedAt date of deletion (ISO-8601 format) + * @param \DateTime $deletedAt Date of deletion (ISO-8601 format). * * @return self */ @@ -205,9 +206,9 @@ public function setDeletedAt($deletedAt) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -217,7 +218,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -246,7 +247,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -257,11 +258,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -292,3 +292,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php b/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php index 6890a73dec..7877e7405a 100644 --- a/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * DeletedAtResponse Class Doc Comment * * @category Class * @description The response with a taskID and a deletedAt timestamp. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +33,7 @@ class DeletedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPITypes = [ 'taskID' => 'int', - 'deletedAt' => '\DateTime', + 'deletedAt' => '\DateTime' ]; /** @@ -46,7 +45,7 @@ class DeletedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPIFormats = [ 'taskID' => null, - 'deletedAt' => 'date-time', + 'deletedAt' => 'date-time' ]; /** @@ -77,7 +76,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'taskID' => 'taskID', - 'deletedAt' => 'deletedAt', + 'deletedAt' => 'deletedAt' ]; /** @@ -87,7 +86,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'taskID' => 'setTaskID', - 'deletedAt' => 'setDeletedAt', + 'deletedAt' => 'setDeletedAt' ]; /** @@ -97,7 +96,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'taskID' => 'getTaskID', - 'deletedAt' => 'getDeletedAt', + 'deletedAt' => 'getDeletedAt' ]; /** @@ -141,6 +140,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -175,7 +175,6 @@ public function listInvalidProperties() if ($this->container['deletedAt'] === null) { $invalidProperties[] = "'deletedAt' can't be null"; } - return $invalidProperties; } @@ -190,6 +189,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets taskID * @@ -203,7 +203,7 @@ public function getTaskID() /** * Sets taskID * - * @param int $taskID taskID of the indexing task to wait for + * @param int $taskID taskID of the indexing task to wait for. * * @return self */ @@ -227,7 +227,7 @@ public function getDeletedAt() /** * Sets deletedAt * - * @param \DateTime $deletedAt date of deletion (ISO-8601 format) + * @param \DateTime $deletedAt Date of deletion (ISO-8601 format). * * @return self */ @@ -240,9 +240,9 @@ public function setDeletedAt($deletedAt) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -252,7 +252,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -281,7 +281,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -292,11 +292,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -327,3 +326,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php b/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php index f889b32a35..5f82ce427d 100644 --- a/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php +++ b/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * DictionaryEntry Class Doc Comment * * @category Class * @description A dictionary entry. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -38,7 +37,7 @@ class DictionaryEntry implements ModelInterface, ArrayAccess, \JsonSerializable 'word' => 'string', 'words' => 'string[]', 'decomposition' => 'string[]', - 'state' => 'string', + 'state' => 'string' ]; /** @@ -54,7 +53,7 @@ class DictionaryEntry implements ModelInterface, ArrayAccess, \JsonSerializable 'word' => null, 'words' => null, 'decomposition' => null, - 'state' => null, + 'state' => null ]; /** @@ -89,7 +88,7 @@ public static function openAPIFormats() 'word' => 'word', 'words' => 'words', 'decomposition' => 'decomposition', - 'state' => 'state', + 'state' => 'state' ]; /** @@ -103,7 +102,7 @@ public static function openAPIFormats() 'word' => 'setWord', 'words' => 'setWords', 'decomposition' => 'setDecomposition', - 'state' => 'setState', + 'state' => 'setState' ]; /** @@ -117,7 +116,7 @@ public static function openAPIFormats() 'word' => 'getWord', 'words' => 'getWords', 'decomposition' => 'getDecomposition', - 'state' => 'getState', + 'state' => 'getState' ]; /** @@ -238,6 +237,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets objectID * @@ -251,7 +251,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID unique identifier of the object + * @param string $objectID Unique identifier of the object. * * @return self */ @@ -299,7 +299,7 @@ public function getWord() /** * Sets word * - * @param string|null $word the word of the dictionary entry + * @param string|null $word The word of the dictionary entry. * * @return self */ @@ -323,7 +323,7 @@ public function getWords() /** * Sets words * - * @param string[]|null $words the words of the dictionary entry + * @param string[]|null $words The words of the dictionary entry. * * @return self */ @@ -347,7 +347,7 @@ public function getDecomposition() /** * Sets decomposition * - * @param string[]|null $decomposition a decomposition of the word of the dictionary entry + * @param string[]|null $decomposition A decomposition of the word of the dictionary entry. * * @return self */ @@ -371,7 +371,7 @@ public function getState() /** * Sets state * - * @param string|null $state the state of the dictionary entry + * @param string|null $state The state of the dictionary entry. * * @return self */ @@ -394,9 +394,9 @@ public function setState($state) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -406,7 +406,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -435,7 +435,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -446,11 +446,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -481,3 +480,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php b/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php index 7f857ed561..fca61ce2e7 100644 --- a/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php +++ b/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * DictionaryLanguage Class Doc Comment * * @category Class * @description Custom entries for a dictionary - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +32,7 @@ class DictionaryLanguage implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'nbCustomEntires' => 'int', + 'nbCustomEntires' => 'int' ]; /** @@ -44,7 +43,7 @@ class DictionaryLanguage implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'nbCustomEntires' => null, + 'nbCustomEntires' => null ]; /** @@ -74,7 +73,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'nbCustomEntires' => 'nbCustomEntires', + 'nbCustomEntires' => 'nbCustomEntires' ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'nbCustomEntires' => 'setNbCustomEntires', + 'nbCustomEntires' => 'setNbCustomEntires' ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'nbCustomEntires' => 'getNbCustomEntires', + 'nbCustomEntires' => 'getNbCustomEntires' ]; /** @@ -136,6 +135,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -177,6 +177,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets nbCustomEntires * @@ -203,9 +204,9 @@ public function setNbCustomEntires($nbCustomEntires) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -215,7 +216,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -244,7 +245,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -255,11 +256,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -290,3 +290,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php b/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php index 3d42992725..598f8285e6 100644 --- a/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * DictionarySettingsRequest Class Doc Comment * * @category Class * @description Disable the builtin Algolia entries for a type of dictionary per language. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +32,7 @@ class DictionarySettingsRequest implements ModelInterface, ArrayAccess, \JsonSer * @var string[] */ protected static $openAPITypes = [ - 'disableStandardEntries' => '\Algolia\AlgoliaSearch\Model\StandardEntries', + 'disableStandardEntries' => '\Algolia\AlgoliaSearch\Model\StandardEntries' ]; /** @@ -44,7 +43,7 @@ class DictionarySettingsRequest implements ModelInterface, ArrayAccess, \JsonSer * @psalm-var array */ protected static $openAPIFormats = [ - 'disableStandardEntries' => null, + 'disableStandardEntries' => null ]; /** @@ -74,7 +73,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'disableStandardEntries' => 'disableStandardEntries', + 'disableStandardEntries' => 'disableStandardEntries' ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'disableStandardEntries' => 'setDisableStandardEntries', + 'disableStandardEntries' => 'setDisableStandardEntries' ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'disableStandardEntries' => 'getDisableStandardEntries', + 'disableStandardEntries' => 'getDisableStandardEntries' ]; /** @@ -136,6 +135,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -166,7 +166,6 @@ public function listInvalidProperties() if ($this->container['disableStandardEntries'] === null) { $invalidProperties[] = "'disableStandardEntries' can't be null"; } - return $invalidProperties; } @@ -181,6 +180,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets disableStandardEntries * @@ -207,9 +207,9 @@ public function setDisableStandardEntries($disableStandardEntries) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -259,11 +259,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -294,3 +293,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/ErrorBase.php b/clients/algoliasearch-client-php/lib/Model/ErrorBase.php index 48b357631f..53696972f2 100644 --- a/clients/algoliasearch-client-php/lib/Model/ErrorBase.php +++ b/clients/algoliasearch-client-php/lib/Model/ErrorBase.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * ErrorBase Class Doc Comment * * @category Class * @description Error. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +32,7 @@ class ErrorBase implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'message' => 'string', + 'message' => 'string' ]; /** @@ -44,7 +43,7 @@ class ErrorBase implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'message' => null, + 'message' => null ]; /** @@ -74,7 +73,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'message' => 'message', + 'message' => 'message' ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'message' => 'setMessage', + 'message' => 'setMessage' ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'message' => 'getMessage', + 'message' => 'getMessage' ]; /** @@ -136,6 +135,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -177,6 +177,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets message * @@ -203,9 +204,9 @@ public function setMessage($message) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -215,7 +216,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -244,7 +245,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -255,11 +256,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -290,3 +290,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php index e76e778e39..d946c1d7b9 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * GetDictionarySettingsResponse Class Doc Comment @@ -31,7 +31,7 @@ class GetDictionarySettingsResponse implements ModelInterface, ArrayAccess, \Jso * @var string[] */ protected static $openAPITypes = [ - 'disableStandardEntries' => '\Algolia\AlgoliaSearch\Model\StandardEntries', + 'disableStandardEntries' => '\Algolia\AlgoliaSearch\Model\StandardEntries' ]; /** @@ -42,7 +42,7 @@ class GetDictionarySettingsResponse implements ModelInterface, ArrayAccess, \Jso * @psalm-var array */ protected static $openAPIFormats = [ - 'disableStandardEntries' => null, + 'disableStandardEntries' => null ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'disableStandardEntries' => 'disableStandardEntries', + 'disableStandardEntries' => 'disableStandardEntries' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'disableStandardEntries' => 'setDisableStandardEntries', + 'disableStandardEntries' => 'setDisableStandardEntries' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'disableStandardEntries' => 'getDisableStandardEntries', + 'disableStandardEntries' => 'getDisableStandardEntries' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -164,7 +165,6 @@ public function listInvalidProperties() if ($this->container['disableStandardEntries'] === null) { $invalidProperties[] = "'disableStandardEntries' can't be null"; } - return $invalidProperties; } @@ -179,6 +179,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets disableStandardEntries * @@ -205,9 +206,9 @@ public function setDisableStandardEntries($disableStandardEntries) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -217,7 +218,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -246,7 +247,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -257,11 +258,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -292,3 +292,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php index 4f45944265..c2e0033e7d 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * GetLogsResponse Class Doc Comment @@ -31,7 +31,7 @@ class GetLogsResponse implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'logs' => '\Algolia\AlgoliaSearch\Model\GetLogsResponseLogs[]', + 'logs' => '\Algolia\AlgoliaSearch\Model\GetLogsResponseLogs[]' ]; /** @@ -42,7 +42,7 @@ class GetLogsResponse implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'logs' => null, + 'logs' => null ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'logs' => 'logs', + 'logs' => 'logs' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'logs' => 'setLogs', + 'logs' => 'setLogs' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'logs' => 'getLogs', + 'logs' => 'getLogs' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -164,7 +165,6 @@ public function listInvalidProperties() if ($this->container['logs'] === null) { $invalidProperties[] = "'logs' can't be null"; } - return $invalidProperties; } @@ -179,6 +179,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets logs * @@ -205,9 +206,9 @@ public function setLogs($logs) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -217,7 +218,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -246,7 +247,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -257,11 +258,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -292,3 +292,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php index 8ae96c2c9f..a895461a73 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php +++ b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * GetLogsResponseInnerQueries Class Doc Comment @@ -33,7 +33,7 @@ class GetLogsResponseInnerQueries implements ModelInterface, ArrayAccess, \JsonS protected static $openAPITypes = [ 'indexName' => 'string', 'userToken' => 'string', - 'queryId' => 'string', + 'queryId' => 'string' ]; /** @@ -46,7 +46,7 @@ class GetLogsResponseInnerQueries implements ModelInterface, ArrayAccess, \JsonS protected static $openAPIFormats = [ 'indexName' => null, 'userToken' => null, - 'queryId' => null, + 'queryId' => null ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'indexName' => 'index_name', 'userToken' => 'user_token', - 'queryId' => 'query_id', + 'queryId' => 'query_id' ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'indexName' => 'setIndexName', 'userToken' => 'setUserToken', - 'queryId' => 'setQueryId', + 'queryId' => 'setQueryId' ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'indexName' => 'getIndexName', 'userToken' => 'getUserToken', - 'queryId' => 'getQueryId', + 'queryId' => 'getQueryId' ]; /** @@ -144,6 +144,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -187,6 +188,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets indexName * @@ -200,7 +202,7 @@ public function getIndexName() /** * Sets indexName * - * @param string|null $indexName index targeted by the query + * @param string|null $indexName Index targeted by the query. * * @return self */ @@ -224,7 +226,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken user identifier + * @param string|null $userToken User identifier. * * @return self */ @@ -248,7 +250,7 @@ public function getQueryId() /** * Sets queryId * - * @param string|null $queryId queryID for the given query + * @param string|null $queryId QueryID for the given query. * * @return self */ @@ -261,9 +263,9 @@ public function setQueryId($queryId) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -273,7 +275,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -302,7 +304,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -313,11 +315,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -348,3 +349,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php index 20a071dbf4..1c30d989b3 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php +++ b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * GetLogsResponseLogs Class Doc Comment @@ -45,7 +45,7 @@ class GetLogsResponseLogs implements ModelInterface, ArrayAccess, \JsonSerializa 'index' => 'string', 'queryParams' => 'string', 'queryNbHits' => 'string', - 'innerQueries' => '\Algolia\AlgoliaSearch\Model\GetLogsResponseInnerQueries[]', + 'innerQueries' => '\Algolia\AlgoliaSearch\Model\GetLogsResponseInnerQueries[]' ]; /** @@ -70,7 +70,7 @@ class GetLogsResponseLogs implements ModelInterface, ArrayAccess, \JsonSerializa 'index' => null, 'queryParams' => null, 'queryNbHits' => null, - 'innerQueries' => null, + 'innerQueries' => null ]; /** @@ -114,7 +114,7 @@ public static function openAPIFormats() 'index' => 'index', 'queryParams' => 'query_params', 'queryNbHits' => 'query_nb_hits', - 'innerQueries' => 'inner_queries', + 'innerQueries' => 'inner_queries' ]; /** @@ -137,7 +137,7 @@ public static function openAPIFormats() 'index' => 'setIndex', 'queryParams' => 'setQueryParams', 'queryNbHits' => 'setQueryNbHits', - 'innerQueries' => 'setInnerQueries', + 'innerQueries' => 'setInnerQueries' ]; /** @@ -160,7 +160,7 @@ public static function openAPIFormats() 'index' => 'getIndex', 'queryParams' => 'getQueryParams', 'queryNbHits' => 'getQueryNbHits', - 'innerQueries' => 'getInnerQueries', + 'innerQueries' => 'getInnerQueries' ]; /** @@ -204,6 +204,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -278,7 +279,6 @@ public function listInvalidProperties() if ($this->container['processingTimeMs'] === null) { $invalidProperties[] = "'processingTimeMs' can't be null"; } - return $invalidProperties; } @@ -293,6 +293,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets timestamp * @@ -306,7 +307,7 @@ public function getTimestamp() /** * Sets timestamp * - * @param string $timestamp timestamp in ISO-8601 format + * @param string $timestamp Timestamp in ISO-8601 format. * * @return self */ @@ -330,7 +331,7 @@ public function getMethod() /** * Sets method * - * @param string $method HTTP method of the perfomed request + * @param string $method HTTP method of the perfomed request. * * @return self */ @@ -354,7 +355,7 @@ public function getAnswerCode() /** * Sets answerCode * - * @param string $answerCode HTTP response code + * @param string $answerCode HTTP response code. * * @return self */ @@ -426,7 +427,7 @@ public function getUrl() /** * Sets url * - * @param string $url request URL + * @param string $url Request URL. * * @return self */ @@ -450,7 +451,7 @@ public function getIp() /** * Sets ip * - * @param string $ip IP of the client which perfomed the request + * @param string $ip IP of the client which perfomed the request. * * @return self */ @@ -474,7 +475,7 @@ public function getQueryHeaders() /** * Sets queryHeaders * - * @param string $queryHeaders request Headers (API Key is obfuscated) + * @param string $queryHeaders Request Headers (API Key is obfuscated). * * @return self */ @@ -498,7 +499,7 @@ public function getSha1() /** * Sets sha1 * - * @param string $sha1 SHA1 signature of the log entry + * @param string $sha1 SHA1 signature of the log entry. * * @return self */ @@ -522,7 +523,7 @@ public function getNbApiCalls() /** * Sets nbApiCalls * - * @param string $nbApiCalls number of API calls + * @param string $nbApiCalls Number of API calls. * * @return self */ @@ -570,7 +571,7 @@ public function getIndex() /** * Sets index * - * @param string|null $index index targeted by the query + * @param string|null $index Index targeted by the query. * * @return self */ @@ -594,7 +595,7 @@ public function getQueryParams() /** * Sets queryParams * - * @param string|null $queryParams query parameters sent with the request + * @param string|null $queryParams Query parameters sent with the request. * * @return self */ @@ -618,7 +619,7 @@ public function getQueryNbHits() /** * Sets queryNbHits * - * @param string|null $queryNbHits number of hits returned for the query + * @param string|null $queryNbHits Number of hits returned for the query. * * @return self */ @@ -642,7 +643,7 @@ public function getInnerQueries() /** * Sets innerQueries * - * @param \Algolia\AlgoliaSearch\Model\GetLogsResponseInnerQueries[]|null $innerQueries array of all performed queries for the given request + * @param \Algolia\AlgoliaSearch\Model\GetLogsResponseInnerQueries[]|null $innerQueries Array of all performed queries for the given request. * * @return self */ @@ -655,9 +656,9 @@ public function setInnerQueries($innerQueries) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -667,7 +668,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -696,7 +697,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -707,11 +708,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -742,3 +742,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php b/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php index 7d36088284..7e4184184d 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * GetObjectsObject Class Doc Comment * * @category Class * @description The `getObjects` requests. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +32,7 @@ class GetObjectsObject implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'requests' => '\Algolia\AlgoliaSearch\Model\MultipleGetObjectsObject[]', + 'requests' => '\Algolia\AlgoliaSearch\Model\MultipleGetObjectsObject[]' ]; /** @@ -44,7 +43,7 @@ class GetObjectsObject implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'requests' => null, + 'requests' => null ]; /** @@ -74,7 +73,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'requests' => 'requests', + 'requests' => 'requests' ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'requests' => 'setRequests', + 'requests' => 'setRequests' ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'requests' => 'getRequests', + 'requests' => 'getRequests' ]; /** @@ -136,6 +135,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -177,6 +177,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets requests * @@ -203,9 +204,9 @@ public function setRequests($requests) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -215,7 +216,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -244,7 +245,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -255,11 +256,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -290,3 +290,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php index fb8d8fcba6..3e54417691 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * GetObjectsResponse Class Doc Comment @@ -31,7 +31,7 @@ class GetObjectsResponse implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'results' => 'object[]', + 'results' => 'object[]' ]; /** @@ -42,7 +42,7 @@ class GetObjectsResponse implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'results' => null, + 'results' => null ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'results' => 'results', + 'results' => 'results' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'results' => 'setResults', + 'results' => 'setResults' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'results' => 'getResults', + 'results' => 'getResults' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -175,6 +176,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets results * @@ -188,7 +190,7 @@ public function getResults() /** * Sets results * - * @param object[]|null $results list of results fetched + * @param object[]|null $results List of results fetched. * * @return self */ @@ -201,9 +203,9 @@ public function setResults($results) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -213,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -242,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -253,11 +255,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -288,3 +289,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php b/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php index ae9e7c2f3c..5f11816c35 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * GetTaskResponse Class Doc Comment @@ -31,7 +31,7 @@ class GetTaskResponse implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'status' => 'string', + 'status' => 'string' ]; /** @@ -42,7 +42,7 @@ class GetTaskResponse implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'status' => null, + 'status' => null ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'status' => 'status', + 'status' => 'status' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'status' => 'setStatus', + 'status' => 'setStatus' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'status' => 'getStatus', + 'status' => 'getStatus' ]; /** @@ -203,6 +203,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets status * @@ -239,9 +240,9 @@ public function setStatus($status) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -251,7 +252,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -280,7 +281,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -291,11 +292,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -326,3 +326,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php index 0c381becc3..138d5abf2f 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * GetTopUserIdsResponse Class Doc Comment * * @category Class * @description Array of userIDs and clusters. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +32,7 @@ class GetTopUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSeriali * @var string[] */ protected static $openAPITypes = [ - 'topUsers' => 'array[]', + 'topUsers' => 'array[]' ]; /** @@ -44,7 +43,7 @@ class GetTopUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSeriali * @psalm-var array */ protected static $openAPIFormats = [ - 'topUsers' => null, + 'topUsers' => null ]; /** @@ -74,7 +73,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'topUsers' => 'topUsers', + 'topUsers' => 'topUsers' ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'topUsers' => 'setTopUsers', + 'topUsers' => 'setTopUsers' ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'topUsers' => 'getTopUsers', + 'topUsers' => 'getTopUsers' ]; /** @@ -136,6 +135,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -166,7 +166,6 @@ public function listInvalidProperties() if ($this->container['topUsers'] === null) { $invalidProperties[] = "'topUsers' can't be null"; } - return $invalidProperties; } @@ -181,6 +180,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets topUsers * @@ -194,7 +194,7 @@ public function getTopUsers() /** * Sets topUsers * - * @param array[] $topUsers Mapping of cluster names to top users + * @param array[] $topUsers Mapping of cluster names to top users. * * @return self */ @@ -207,9 +207,9 @@ public function setTopUsers($topUsers) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -259,11 +259,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -294,3 +293,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/HighlightResult.php b/clients/algoliasearch-client-php/lib/Model/HighlightResult.php index 5fc77c2e70..129b4740ed 100644 --- a/clients/algoliasearch-client-php/lib/Model/HighlightResult.php +++ b/clients/algoliasearch-client-php/lib/Model/HighlightResult.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * HighlightResult Class Doc Comment * * @category Class * @description Highlighted attributes. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -36,7 +35,7 @@ class HighlightResult implements ModelInterface, ArrayAccess, \JsonSerializable 'value' => 'string', 'matchLevel' => 'string', 'matchedWords' => 'string[]', - 'fullyHighlighted' => 'bool', + 'fullyHighlighted' => 'bool' ]; /** @@ -50,7 +49,7 @@ class HighlightResult implements ModelInterface, ArrayAccess, \JsonSerializable 'value' => null, 'matchLevel' => null, 'matchedWords' => null, - 'fullyHighlighted' => null, + 'fullyHighlighted' => null ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() 'value' => 'value', 'matchLevel' => 'matchLevel', 'matchedWords' => 'matchedWords', - 'fullyHighlighted' => 'fullyHighlighted', + 'fullyHighlighted' => 'fullyHighlighted' ]; /** @@ -95,7 +94,7 @@ public static function openAPIFormats() 'value' => 'setValue', 'matchLevel' => 'setMatchLevel', 'matchedWords' => 'setMatchedWords', - 'fullyHighlighted' => 'setFullyHighlighted', + 'fullyHighlighted' => 'setFullyHighlighted' ]; /** @@ -107,7 +106,7 @@ public static function openAPIFormats() 'value' => 'getValue', 'matchLevel' => 'getMatchLevel', 'matchedWords' => 'getMatchedWords', - 'fullyHighlighted' => 'getFullyHighlighted', + 'fullyHighlighted' => 'getFullyHighlighted' ]; /** @@ -222,6 +221,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets value * @@ -235,7 +235,7 @@ public function getValue() /** * Sets value * - * @param string|null $value markup text with occurrences highlighted + * @param string|null $value Markup text with occurrences highlighted. * * @return self */ @@ -259,7 +259,7 @@ public function getMatchLevel() /** * Sets matchLevel * - * @param string|null $matchLevel indicates how well the attribute matched the search query + * @param string|null $matchLevel Indicates how well the attribute matched the search query. * * @return self */ @@ -293,7 +293,7 @@ public function getMatchedWords() /** * Sets matchedWords * - * @param string[]|null $matchedWords list of words from the query that matched the object + * @param string[]|null $matchedWords List of words from the query that matched the object. * * @return self */ @@ -317,7 +317,7 @@ public function getFullyHighlighted() /** * Sets fullyHighlighted * - * @param bool|null $fullyHighlighted whether the entire attribute value is highlighted + * @param bool|null $fullyHighlighted Whether the entire attribute value is highlighted. * * @return self */ @@ -330,9 +330,9 @@ public function setFullyHighlighted($fullyHighlighted) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -342,7 +342,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -371,7 +371,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -382,11 +382,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -417,3 +416,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/Index.php b/clients/algoliasearch-client-php/lib/Model/Index.php index aa437874bf..03a2871dcd 100644 --- a/clients/algoliasearch-client-php/lib/Model/Index.php +++ b/clients/algoliasearch-client-php/lib/Model/Index.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * Index Class Doc Comment @@ -41,7 +41,7 @@ class Index implements ModelInterface, ArrayAccess, \JsonSerializable 'numberOfPendingTask' => 'int', 'pendingTask' => 'bool', 'primary' => 'string', - 'replicas' => 'string[]', + 'replicas' => 'string[]' ]; /** @@ -62,7 +62,7 @@ class Index implements ModelInterface, ArrayAccess, \JsonSerializable 'numberOfPendingTask' => null, 'pendingTask' => null, 'primary' => null, - 'replicas' => null, + 'replicas' => null ]; /** @@ -102,7 +102,7 @@ public static function openAPIFormats() 'numberOfPendingTask' => 'numberOfPendingTask', 'pendingTask' => 'pendingTask', 'primary' => 'primary', - 'replicas' => 'replicas', + 'replicas' => 'replicas' ]; /** @@ -121,7 +121,7 @@ public static function openAPIFormats() 'numberOfPendingTask' => 'setNumberOfPendingTask', 'pendingTask' => 'setPendingTask', 'primary' => 'setPrimary', - 'replicas' => 'setReplicas', + 'replicas' => 'setReplicas' ]; /** @@ -140,7 +140,7 @@ public static function openAPIFormats() 'numberOfPendingTask' => 'getNumberOfPendingTask', 'pendingTask' => 'getPendingTask', 'primary' => 'getPrimary', - 'replicas' => 'getReplicas', + 'replicas' => 'getReplicas' ]; /** @@ -184,6 +184,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -245,7 +246,6 @@ public function listInvalidProperties() if ($this->container['pendingTask'] === null) { $invalidProperties[] = "'pendingTask' can't be null"; } - return $invalidProperties; } @@ -260,6 +260,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets name * @@ -273,7 +274,7 @@ public function getName() /** * Sets name * - * @param string $name index name + * @param string $name Index name. * * @return self */ @@ -321,7 +322,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt date of last update (ISO-8601 format) + * @param \DateTime $updatedAt Date of last update (ISO-8601 format). * * @return self */ @@ -345,7 +346,7 @@ public function getEntries() /** * Sets entries * - * @param int $entries number of records contained in the index + * @param int $entries Number of records contained in the index. * * @return self */ @@ -369,7 +370,7 @@ public function getDataSize() /** * Sets dataSize * - * @param int $dataSize number of bytes of the index in minified format + * @param int $dataSize Number of bytes of the index in minified format. * * @return self */ @@ -393,7 +394,7 @@ public function getFileSize() /** * Sets fileSize * - * @param int $fileSize number of bytes of the index binary file + * @param int $fileSize Number of bytes of the index binary file. * * @return self */ @@ -526,9 +527,9 @@ public function setReplicas($replicas) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -538,7 +539,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -567,7 +568,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -578,11 +579,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -613,3 +613,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/IndexSettings.php b/clients/algoliasearch-client-php/lib/Model/IndexSettings.php index c409228d27..01ea27278c 100644 --- a/clients/algoliasearch-client-php/lib/Model/IndexSettings.php +++ b/clients/algoliasearch-client-php/lib/Model/IndexSettings.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * IndexSettings Class Doc Comment * * @category Class * @description The Algolia index settings. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -88,7 +87,7 @@ class IndexSettings implements ModelInterface, ArrayAccess, \JsonSerializable 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object', + 'renderingContent' => 'object' ]; /** @@ -154,7 +153,7 @@ class IndexSettings implements ModelInterface, ArrayAccess, \JsonSerializable 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null, + 'renderingContent' => null ]; /** @@ -239,7 +238,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent', + 'renderingContent' => 'renderingContent' ]; /** @@ -303,7 +302,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent', + 'renderingContent' => 'setRenderingContent' ]; /** @@ -367,7 +366,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent', + 'renderingContent' => 'getRenderingContent' ]; /** @@ -668,6 +667,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets replicas * @@ -681,7 +681,7 @@ public function getReplicas() /** * Sets replicas * - * @param string[]|null $replicas creates replicas, exact copies of an index + * @param string[]|null $replicas Creates replicas, exact copies of an index. * * @return self */ @@ -705,7 +705,7 @@ public function getPaginationLimitedTo() /** * Sets paginationLimitedTo * - * @param int|null $paginationLimitedTo set the maximum number of hits accessible via pagination + * @param int|null $paginationLimitedTo Set the maximum number of hits accessible via pagination. * * @return self */ @@ -729,7 +729,7 @@ public function getDisableTypoToleranceOnWords() /** * Sets disableTypoToleranceOnWords * - * @param string[]|null $disableTypoToleranceOnWords a list of words for which you want to turn off typo tolerance + * @param string[]|null $disableTypoToleranceOnWords A list of words for which you want to turn off typo tolerance. * * @return self */ @@ -753,7 +753,7 @@ public function getAttributesToTransliterate() /** * Sets attributesToTransliterate * - * @param string[]|null $attributesToTransliterate specify on which attributes to apply transliteration + * @param string[]|null $attributesToTransliterate Specify on which attributes to apply transliteration. * * @return self */ @@ -777,7 +777,7 @@ public function getCamelCaseAttributes() /** * Sets camelCaseAttributes * - * @param string[]|null $camelCaseAttributes list of attributes on which to do a decomposition of camel case words + * @param string[]|null $camelCaseAttributes List of attributes on which to do a decomposition of camel case words. * * @return self */ @@ -801,7 +801,7 @@ public function getDecompoundedAttributes() /** * Sets decompoundedAttributes * - * @param object|null $decompoundedAttributes specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding + * @param object|null $decompoundedAttributes Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding. * * @return self */ @@ -825,7 +825,7 @@ public function getIndexLanguages() /** * Sets indexLanguages * - * @param string[]|null $indexLanguages sets the languages at the index level for language-specific processing such as tokenization and normalization + * @param string[]|null $indexLanguages Sets the languages at the index level for language-specific processing such as tokenization and normalization. * * @return self */ @@ -849,7 +849,7 @@ public function getFilterPromotes() /** * Sets filterPromotes * - * @param bool|null $filterPromotes whether promoted results should match the filters of the current search, except for geographic filters + * @param bool|null $filterPromotes Whether promoted results should match the filters of the current search, except for geographic filters. * * @return self */ @@ -873,7 +873,7 @@ public function getDisablePrefixOnAttributes() /** * Sets disablePrefixOnAttributes * - * @param string[]|null $disablePrefixOnAttributes list of attributes on which you want to disable prefix matching + * @param string[]|null $disablePrefixOnAttributes List of attributes on which you want to disable prefix matching. * * @return self */ @@ -897,7 +897,7 @@ public function getAllowCompressionOfIntegerArray() /** * Sets allowCompressionOfIntegerArray * - * @param bool|null $allowCompressionOfIntegerArray enables compression of large integer arrays + * @param bool|null $allowCompressionOfIntegerArray Enables compression of large integer arrays. * * @return self */ @@ -921,7 +921,7 @@ public function getNumericAttributesForFiltering() /** * Sets numericAttributesForFiltering * - * @param string[]|null $numericAttributesForFiltering list of numeric attributes that can be used as numerical filters + * @param string[]|null $numericAttributesForFiltering List of numeric attributes that can be used as numerical filters. * * @return self */ @@ -945,7 +945,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData lets you store custom data in your indices + * @param object|null $userData Lets you store custom data in your indices. * * @return self */ @@ -969,7 +969,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes the complete list of attributes used for searching + * @param string[]|null $searchableAttributes The complete list of attributes used for searching. * * @return self */ @@ -993,7 +993,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting + * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. * * @return self */ @@ -1017,7 +1017,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time + * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. * * @return self */ @@ -1041,7 +1041,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve + * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. * * @return self */ @@ -1065,7 +1065,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes + * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. * * @return self */ @@ -1089,7 +1089,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking controls how Algolia should sort your results + * @param string[]|null $ranking Controls how Algolia should sort your results. * * @return self */ @@ -1113,7 +1113,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking specifies the custom ranking criterion + * @param string[]|null $customRanking Specifies the custom ranking criterion. * * @return self */ @@ -1137,7 +1137,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results + * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. * * @return self */ @@ -1161,7 +1161,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight list of attributes to highlight + * @param string[]|null $attributesToHighlight List of attributes to highlight. * * @return self */ @@ -1185,7 +1185,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet + * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. * * @return self */ @@ -1209,7 +1209,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results + * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. * * @return self */ @@ -1233,7 +1233,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results + * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. * * @return self */ @@ -1257,7 +1257,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated + * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. * * @return self */ @@ -1281,7 +1281,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query + * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. * * @return self */ @@ -1305,7 +1305,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage set the number of hits per page + * @param int|null $hitsPerPage Set the number of hits per page. * * @return self */ @@ -1329,7 +1329,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo + * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. * * @return self */ @@ -1353,7 +1353,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos + * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. * * @return self */ @@ -1377,7 +1377,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied + * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. * * @return self */ @@ -1411,7 +1411,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string + * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. * * @return self */ @@ -1435,7 +1435,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance + * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. * * @return self */ @@ -1459,7 +1459,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex control which separators are indexed + * @param string|null $separatorsToIndex Control which separators are indexed. * * @return self */ @@ -1483,7 +1483,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms + * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. * * @return self */ @@ -1507,7 +1507,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords removes stop (common) words from the query before executing it + * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. * * @return self */ @@ -1531,7 +1531,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize + * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. * * @return self */ @@ -1555,7 +1555,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection + * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. * * @return self */ @@ -1579,7 +1579,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query + * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. * * @return self */ @@ -1603,7 +1603,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules whether Rules should be globally enabled + * @param bool|null $enableRules Whether Rules should be globally enabled. * * @return self */ @@ -1627,7 +1627,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization enable the Personalization feature + * @param bool|null $enablePersonalization Enable the Personalization feature. * * @return self */ @@ -1651,7 +1651,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType controls if and how query words are interpreted as prefixes + * @param string|null $queryType Controls if and how query words are interpreted as prefixes. * * @return self */ @@ -1685,7 +1685,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits + * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. * * @return self */ @@ -1719,7 +1719,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax enables the advanced query syntax + * @param bool|null $advancedSyntax Enables the advanced query syntax. * * @return self */ @@ -1743,7 +1743,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query + * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. * * @return self */ @@ -1767,7 +1767,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion + * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. * * @return self */ @@ -1791,7 +1791,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word + * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. * * @return self */ @@ -1825,7 +1825,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion + * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. * * @return self */ @@ -1858,7 +1858,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled + * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. * * @return self */ @@ -1891,7 +1891,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct enables de-duplication or grouping of results + * @param int|null $distinct Enables de-duplication or grouping of results. * * @return self */ @@ -1923,7 +1923,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search + * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. * * @return self */ @@ -1947,7 +1947,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself + * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. * * @return self */ @@ -1971,7 +1971,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity precision of the proximity ranking criterion + * @param int|null $minProximity Precision of the proximity ranking criterion. * * @return self */ @@ -2056,7 +2056,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage + * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. * * @return self */ @@ -2093,9 +2093,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -2105,7 +2105,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -2134,7 +2134,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -2145,11 +2145,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -2180,3 +2179,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php b/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php index 7b3c52043e..1672b402c3 100644 --- a/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * IndexSettingsAsSearchParams Class Doc Comment @@ -74,7 +74,7 @@ class IndexSettingsAsSearchParams implements ModelInterface, ArrayAccess, \JsonS 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object', + 'renderingContent' => 'object' ]; /** @@ -128,7 +128,7 @@ class IndexSettingsAsSearchParams implements ModelInterface, ArrayAccess, \JsonS 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null, + 'renderingContent' => null ]; /** @@ -201,7 +201,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent', + 'renderingContent' => 'renderingContent' ]; /** @@ -253,7 +253,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent', + 'renderingContent' => 'setRenderingContent' ]; /** @@ -305,7 +305,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent', + 'renderingContent' => 'getRenderingContent' ]; /** @@ -594,6 +594,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets searchableAttributes * @@ -607,7 +608,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes the complete list of attributes used for searching + * @param string[]|null $searchableAttributes The complete list of attributes used for searching. * * @return self */ @@ -631,7 +632,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting + * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. * * @return self */ @@ -655,7 +656,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time + * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. * * @return self */ @@ -679,7 +680,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve + * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. * * @return self */ @@ -703,7 +704,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes + * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. * * @return self */ @@ -727,7 +728,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking controls how Algolia should sort your results + * @param string[]|null $ranking Controls how Algolia should sort your results. * * @return self */ @@ -751,7 +752,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking specifies the custom ranking criterion + * @param string[]|null $customRanking Specifies the custom ranking criterion. * * @return self */ @@ -775,7 +776,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results + * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. * * @return self */ @@ -799,7 +800,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight list of attributes to highlight + * @param string[]|null $attributesToHighlight List of attributes to highlight. * * @return self */ @@ -823,7 +824,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet + * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. * * @return self */ @@ -847,7 +848,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results + * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. * * @return self */ @@ -871,7 +872,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results + * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. * * @return self */ @@ -895,7 +896,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated + * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. * * @return self */ @@ -919,7 +920,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query + * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. * * @return self */ @@ -943,7 +944,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage set the number of hits per page + * @param int|null $hitsPerPage Set the number of hits per page. * * @return self */ @@ -967,7 +968,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo + * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. * * @return self */ @@ -991,7 +992,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos + * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. * * @return self */ @@ -1015,7 +1016,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied + * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. * * @return self */ @@ -1049,7 +1050,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string + * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. * * @return self */ @@ -1073,7 +1074,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance + * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. * * @return self */ @@ -1097,7 +1098,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex control which separators are indexed + * @param string|null $separatorsToIndex Control which separators are indexed. * * @return self */ @@ -1121,7 +1122,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms + * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. * * @return self */ @@ -1145,7 +1146,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords removes stop (common) words from the query before executing it + * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. * * @return self */ @@ -1169,7 +1170,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize + * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. * * @return self */ @@ -1193,7 +1194,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection + * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. * * @return self */ @@ -1217,7 +1218,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query + * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. * * @return self */ @@ -1241,7 +1242,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules whether Rules should be globally enabled + * @param bool|null $enableRules Whether Rules should be globally enabled. * * @return self */ @@ -1265,7 +1266,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization enable the Personalization feature + * @param bool|null $enablePersonalization Enable the Personalization feature. * * @return self */ @@ -1289,7 +1290,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType controls if and how query words are interpreted as prefixes + * @param string|null $queryType Controls if and how query words are interpreted as prefixes. * * @return self */ @@ -1323,7 +1324,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits + * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. * * @return self */ @@ -1357,7 +1358,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax enables the advanced query syntax + * @param bool|null $advancedSyntax Enables the advanced query syntax. * * @return self */ @@ -1381,7 +1382,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query + * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. * * @return self */ @@ -1405,7 +1406,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion + * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. * * @return self */ @@ -1429,7 +1430,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word + * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. * * @return self */ @@ -1463,7 +1464,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion + * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. * * @return self */ @@ -1496,7 +1497,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled + * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. * * @return self */ @@ -1529,7 +1530,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct enables de-duplication or grouping of results + * @param int|null $distinct Enables de-duplication or grouping of results. * * @return self */ @@ -1561,7 +1562,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search + * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. * * @return self */ @@ -1585,7 +1586,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself + * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. * * @return self */ @@ -1609,7 +1610,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity precision of the proximity ranking criterion + * @param int|null $minProximity Precision of the proximity ranking criterion. * * @return self */ @@ -1694,7 +1695,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage + * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. * * @return self */ @@ -1731,9 +1732,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -1743,7 +1744,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -1772,7 +1773,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -1783,11 +1784,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -1818,3 +1818,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/KeyObject.php b/clients/algoliasearch-client-php/lib/Model/KeyObject.php index 1cbaf863a3..68429a2485 100644 --- a/clients/algoliasearch-client-php/lib/Model/KeyObject.php +++ b/clients/algoliasearch-client-php/lib/Model/KeyObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * KeyObject Class Doc Comment @@ -39,7 +39,7 @@ class KeyObject implements ModelInterface, ArrayAccess, \JsonSerializable 'queryParameters' => 'string', 'referers' => 'string[]', 'validity' => 'int', - 'createdAt' => '\DateTime', + 'createdAt' => '\DateTime' ]; /** @@ -58,7 +58,7 @@ class KeyObject implements ModelInterface, ArrayAccess, \JsonSerializable 'queryParameters' => null, 'referers' => null, 'validity' => null, - 'createdAt' => 'date-time', + 'createdAt' => 'date-time' ]; /** @@ -96,7 +96,7 @@ public static function openAPIFormats() 'queryParameters' => 'queryParameters', 'referers' => 'referers', 'validity' => 'validity', - 'createdAt' => 'createdAt', + 'createdAt' => 'createdAt' ]; /** @@ -113,7 +113,7 @@ public static function openAPIFormats() 'queryParameters' => 'setQueryParameters', 'referers' => 'setReferers', 'validity' => 'setValidity', - 'createdAt' => 'setCreatedAt', + 'createdAt' => 'setCreatedAt' ]; /** @@ -130,7 +130,7 @@ public static function openAPIFormats() 'queryParameters' => 'getQueryParameters', 'referers' => 'getReferers', 'validity' => 'getValidity', - 'createdAt' => 'getCreatedAt', + 'createdAt' => 'getCreatedAt' ]; /** @@ -255,7 +255,6 @@ public function listInvalidProperties() if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } - return $invalidProperties; } @@ -270,6 +269,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets acl * @@ -283,7 +283,7 @@ public function getAcl() /** * Sets acl * - * @param string[] $acl set of permissions associated with the key + * @param string[] $acl Set of permissions associated with the key. * * @return self */ @@ -388,7 +388,7 @@ public function getMaxQueriesPerIPPerHour() /** * Sets maxQueriesPerIPPerHour * - * @param int|null $maxQueriesPerIPPerHour maximum number of API calls per hour allowed from a given IP address or a user token + * @param int|null $maxQueriesPerIPPerHour Maximum number of API calls per hour allowed from a given IP address or a user token. * * @return self */ @@ -484,7 +484,7 @@ public function getCreatedAt() /** * Sets createdAt * - * @param \DateTime $createdAt date of creation (ISO-8601 format) + * @param \DateTime $createdAt Date of creation (ISO-8601 format). * * @return self */ @@ -497,9 +497,9 @@ public function setCreatedAt($createdAt) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -509,7 +509,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -538,7 +538,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -549,11 +549,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -584,3 +583,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/Languages.php b/clients/algoliasearch-client-php/lib/Model/Languages.php index da2866454c..373bef4ce2 100644 --- a/clients/algoliasearch-client-php/lib/Model/Languages.php +++ b/clients/algoliasearch-client-php/lib/Model/Languages.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * Languages Class Doc Comment * * @category Class * @description A dictionary language. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +34,7 @@ class Languages implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'plurals' => '\Algolia\AlgoliaSearch\Model\DictionaryLanguage', 'stopwords' => '\Algolia\AlgoliaSearch\Model\DictionaryLanguage', - 'compounds' => '\Algolia\AlgoliaSearch\Model\DictionaryLanguage', + 'compounds' => '\Algolia\AlgoliaSearch\Model\DictionaryLanguage' ]; /** @@ -48,7 +47,7 @@ class Languages implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'plurals' => null, 'stopwords' => null, - 'compounds' => null, + 'compounds' => null ]; /** @@ -80,7 +79,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'plurals' => 'plurals', 'stopwords' => 'stopwords', - 'compounds' => 'compounds', + 'compounds' => 'compounds' ]; /** @@ -91,7 +90,7 @@ public static function openAPIFormats() protected static $setters = [ 'plurals' => 'setPlurals', 'stopwords' => 'setStopwords', - 'compounds' => 'setCompounds', + 'compounds' => 'setCompounds' ]; /** @@ -102,7 +101,7 @@ public static function openAPIFormats() protected static $getters = [ 'plurals' => 'getPlurals', 'stopwords' => 'getStopwords', - 'compounds' => 'getCompounds', + 'compounds' => 'getCompounds' ]; /** @@ -146,6 +145,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -184,7 +184,6 @@ public function listInvalidProperties() if ($this->container['compounds'] === null) { $invalidProperties[] = "'compounds' can't be null"; } - return $invalidProperties; } @@ -199,6 +198,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets plurals * @@ -273,9 +273,9 @@ public function setCompounds($compounds) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -285,7 +285,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -314,7 +314,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -325,11 +325,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -360,3 +359,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php b/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php index 217841d9e2..6ffa69ff60 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * ListApiKeysResponse Class Doc Comment @@ -31,7 +31,7 @@ class ListApiKeysResponse implements ModelInterface, ArrayAccess, \JsonSerializa * @var string[] */ protected static $openAPITypes = [ - 'keys' => '\Algolia\AlgoliaSearch\Model\KeyObject[]', + 'keys' => '\Algolia\AlgoliaSearch\Model\KeyObject[]' ]; /** @@ -42,7 +42,7 @@ class ListApiKeysResponse implements ModelInterface, ArrayAccess, \JsonSerializa * @psalm-var array */ protected static $openAPIFormats = [ - 'keys' => null, + 'keys' => null ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'keys' => 'keys', + 'keys' => 'keys' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'keys' => 'setKeys', + 'keys' => 'setKeys' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'keys' => 'getKeys', + 'keys' => 'getKeys' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -164,7 +165,6 @@ public function listInvalidProperties() if ($this->container['keys'] === null) { $invalidProperties[] = "'keys' can't be null"; } - return $invalidProperties; } @@ -179,6 +179,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets keys * @@ -192,7 +193,7 @@ public function getKeys() /** * Sets keys * - * @param \Algolia\AlgoliaSearch\Model\KeyObject[] $keys list of api keys + * @param \Algolia\AlgoliaSearch\Model\KeyObject[] $keys List of api keys. * * @return self */ @@ -205,9 +206,9 @@ public function setKeys($keys) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -217,7 +218,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -246,7 +247,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -257,11 +258,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -292,3 +292,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php b/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php index 32e7515265..da37124416 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * ListClustersResponse Class Doc Comment * * @category Class * @description Array of clusters. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +32,7 @@ class ListClustersResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'topUsers' => 'string[]', + 'topUsers' => 'string[]' ]; /** @@ -44,7 +43,7 @@ class ListClustersResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'topUsers' => null, + 'topUsers' => null ]; /** @@ -74,7 +73,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'topUsers' => 'topUsers', + 'topUsers' => 'topUsers' ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'topUsers' => 'setTopUsers', + 'topUsers' => 'setTopUsers' ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'topUsers' => 'getTopUsers', + 'topUsers' => 'getTopUsers' ]; /** @@ -136,6 +135,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -166,7 +166,6 @@ public function listInvalidProperties() if ($this->container['topUsers'] === null) { $invalidProperties[] = "'topUsers' can't be null"; } - return $invalidProperties; } @@ -181,6 +180,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets topUsers * @@ -194,7 +194,7 @@ public function getTopUsers() /** * Sets topUsers * - * @param string[] $topUsers mapping of cluster names to top users + * @param string[] $topUsers Mapping of cluster names to top users. * * @return self */ @@ -207,9 +207,9 @@ public function setTopUsers($topUsers) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -259,11 +259,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -294,3 +293,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php b/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php index 984b0f060d..2177f69f96 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * ListIndicesResponse Class Doc Comment @@ -32,7 +32,7 @@ class ListIndicesResponse implements ModelInterface, ArrayAccess, \JsonSerializa */ protected static $openAPITypes = [ 'items' => '\Algolia\AlgoliaSearch\Model\Index[]', - 'nbPages' => 'int', + 'nbPages' => 'int' ]; /** @@ -44,7 +44,7 @@ class ListIndicesResponse implements ModelInterface, ArrayAccess, \JsonSerializa */ protected static $openAPIFormats = [ 'items' => null, - 'nbPages' => null, + 'nbPages' => null ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'items' => 'items', - 'nbPages' => 'nbPages', + 'nbPages' => 'nbPages' ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'items' => 'setItems', - 'nbPages' => 'setNbPages', + 'nbPages' => 'setNbPages' ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'items' => 'getItems', - 'nbPages' => 'getNbPages', + 'nbPages' => 'getNbPages' ]; /** @@ -139,6 +139,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -181,6 +182,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets items * @@ -194,7 +196,7 @@ public function getItems() /** * Sets items * - * @param \Algolia\AlgoliaSearch\Model\Index[]|null $items list of the fetched indices + * @param \Algolia\AlgoliaSearch\Model\Index[]|null $items List of the fetched indices. * * @return self */ @@ -218,7 +220,7 @@ public function getNbPages() /** * Sets nbPages * - * @param int|null $nbPages number of pages + * @param int|null $nbPages Number of pages. * * @return self */ @@ -231,9 +233,9 @@ public function setNbPages($nbPages) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -243,7 +245,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -272,7 +274,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -283,11 +285,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -318,3 +319,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php index 0030ae0d27..64b26c1d72 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * ListUserIdsResponse Class Doc Comment * * @category Class * @description UserIDs data. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +32,7 @@ class ListUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSerializa * @var string[] */ protected static $openAPITypes = [ - 'userIDs' => '\Algolia\AlgoliaSearch\Model\UserId[]', + 'userIDs' => '\Algolia\AlgoliaSearch\Model\UserId[]' ]; /** @@ -44,7 +43,7 @@ class ListUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSerializa * @psalm-var array */ protected static $openAPIFormats = [ - 'userIDs' => null, + 'userIDs' => null ]; /** @@ -74,7 +73,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'userIDs' => 'userIDs', + 'userIDs' => 'userIDs' ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'userIDs' => 'setUserIDs', + 'userIDs' => 'setUserIDs' ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'userIDs' => 'getUserIDs', + 'userIDs' => 'getUserIDs' ]; /** @@ -136,6 +135,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -166,7 +166,6 @@ public function listInvalidProperties() if ($this->container['userIDs'] === null) { $invalidProperties[] = "'userIDs' can't be null"; } - return $invalidProperties; } @@ -181,6 +180,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets userIDs * @@ -194,7 +194,7 @@ public function getUserIDs() /** * Sets userIDs * - * @param \Algolia\AlgoliaSearch\Model\UserId[] $userIDs list of userIDs + * @param \Algolia\AlgoliaSearch\Model\UserId[] $userIDs List of userIDs. * * @return self */ @@ -207,9 +207,9 @@ public function setUserIDs($userIDs) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -259,11 +259,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -294,3 +293,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php b/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php index 338e9fcd9f..605c71b9d8 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * MultipleBatchResponse Class Doc Comment @@ -32,7 +32,7 @@ class MultipleBatchResponse implements ModelInterface, ArrayAccess, \JsonSeriali */ protected static $openAPITypes = [ 'taskID' => 'object', - 'objectIDs' => 'string[]', + 'objectIDs' => 'string[]' ]; /** @@ -44,7 +44,7 @@ class MultipleBatchResponse implements ModelInterface, ArrayAccess, \JsonSeriali */ protected static $openAPIFormats = [ 'taskID' => null, - 'objectIDs' => null, + 'objectIDs' => null ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'taskID' => 'taskID', - 'objectIDs' => 'objectIDs', + 'objectIDs' => 'objectIDs' ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'taskID' => 'setTaskID', - 'objectIDs' => 'setObjectIDs', + 'objectIDs' => 'setObjectIDs' ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'taskID' => 'getTaskID', - 'objectIDs' => 'getObjectIDs', + 'objectIDs' => 'getObjectIDs' ]; /** @@ -139,6 +139,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -181,6 +182,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets taskID * @@ -194,7 +196,7 @@ public function getTaskID() /** * Sets taskID * - * @param object|null $taskID list of tasksIDs per index + * @param object|null $taskID List of tasksIDs per index. * * @return self */ @@ -218,7 +220,7 @@ public function getObjectIDs() /** * Sets objectIDs * - * @param string[]|null $objectIDs list of objectID + * @param string[]|null $objectIDs List of objectID. * * @return self */ @@ -231,9 +233,9 @@ public function setObjectIDs($objectIDs) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -243,7 +245,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -272,7 +274,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -283,11 +285,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -318,3 +319,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php b/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php index d96e1b9763..ab47ce8284 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * MultipleGetObjectsObject Class Doc Comment * * @category Class * @description GetObject operation on an index. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +34,7 @@ class MultipleGetObjectsObject implements ModelInterface, ArrayAccess, \JsonSeri protected static $openAPITypes = [ 'attributesToRetrieve' => 'string[]', 'objectID' => 'string', - 'indexName' => 'string', + 'indexName' => 'string' ]; /** @@ -48,7 +47,7 @@ class MultipleGetObjectsObject implements ModelInterface, ArrayAccess, \JsonSeri protected static $openAPIFormats = [ 'attributesToRetrieve' => null, 'objectID' => null, - 'indexName' => null, + 'indexName' => null ]; /** @@ -80,7 +79,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'attributesToRetrieve' => 'attributesToRetrieve', 'objectID' => 'objectID', - 'indexName' => 'indexName', + 'indexName' => 'indexName' ]; /** @@ -91,7 +90,7 @@ public static function openAPIFormats() protected static $setters = [ 'attributesToRetrieve' => 'setAttributesToRetrieve', 'objectID' => 'setObjectID', - 'indexName' => 'setIndexName', + 'indexName' => 'setIndexName' ]; /** @@ -102,7 +101,7 @@ public static function openAPIFormats() protected static $getters = [ 'attributesToRetrieve' => 'getAttributesToRetrieve', 'objectID' => 'getObjectID', - 'indexName' => 'getIndexName', + 'indexName' => 'getIndexName' ]; /** @@ -146,6 +145,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -181,7 +181,6 @@ public function listInvalidProperties() if ($this->container['indexName'] === null) { $invalidProperties[] = "'indexName' can't be null"; } - return $invalidProperties; } @@ -196,6 +195,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets attributesToRetrieve * @@ -233,7 +233,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID ID of the object within that index + * @param string $objectID ID of the object within that index. * * @return self */ @@ -257,7 +257,7 @@ public function getIndexName() /** * Sets indexName * - * @param string $indexName name of the index containing the object + * @param string $indexName name of the index containing the object. * * @return self */ @@ -270,9 +270,9 @@ public function setIndexName($indexName) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -282,7 +282,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -311,7 +311,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -322,11 +322,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -357,3 +356,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php b/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php index 95669603ef..f29705e627 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * MultipleQueries Class Doc Comment @@ -35,7 +35,7 @@ class MultipleQueries implements ModelInterface, ArrayAccess, \JsonSerializable 'query' => 'string', 'type' => 'string', 'facet' => 'string', - 'params' => 'string', + 'params' => 'string' ]; /** @@ -50,7 +50,7 @@ class MultipleQueries implements ModelInterface, ArrayAccess, \JsonSerializable 'query' => null, 'type' => null, 'facet' => null, - 'params' => null, + 'params' => null ]; /** @@ -84,7 +84,7 @@ public static function openAPIFormats() 'query' => 'query', 'type' => 'type', 'facet' => 'facet', - 'params' => 'params', + 'params' => 'params' ]; /** @@ -97,7 +97,7 @@ public static function openAPIFormats() 'query' => 'setQuery', 'type' => 'setType', 'facet' => 'setFacet', - 'params' => 'setParams', + 'params' => 'setParams' ]; /** @@ -110,7 +110,7 @@ public static function openAPIFormats() 'query' => 'getQuery', 'type' => 'getType', 'facet' => 'getFacet', - 'params' => 'getParams', + 'params' => 'getParams' ]; /** @@ -227,6 +227,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets indexName * @@ -240,7 +241,7 @@ public function getIndexName() /** * Sets indexName * - * @param string $indexName the Algolia index name + * @param string $indexName The Algolia index name. * * @return self */ @@ -264,7 +265,7 @@ public function getQuery() /** * Sets query * - * @param string|null $query the text to search in the index + * @param string|null $query The text to search in the index. * * @return self */ @@ -288,7 +289,7 @@ public function getType() /** * Sets type * - * @param string|null $type perform a search query with `default`, will search for facet values if `facet` is given + * @param string|null $type Perform a search query with `default`, will search for facet values if `facet` is given. * * @return self */ @@ -322,7 +323,7 @@ public function getFacet() /** * Sets facet * - * @param string|null $facet the `facet` name + * @param string|null $facet The `facet` name. * * @return self */ @@ -346,7 +347,7 @@ public function getParams() /** * Sets params * - * @param string|null $params a query string of search parameters + * @param string|null $params A query string of search parameters. * * @return self */ @@ -359,9 +360,9 @@ public function setParams($params) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -371,7 +372,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -400,7 +401,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -411,11 +412,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -446,3 +446,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php index 5c1571c58f..448a05f979 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * MultipleQueriesObject Class Doc Comment @@ -32,7 +32,7 @@ class MultipleQueriesObject implements ModelInterface, ArrayAccess, \JsonSeriali */ protected static $openAPITypes = [ 'requests' => '\Algolia\AlgoliaSearch\Model\MultipleQueries[]', - 'strategy' => 'string', + 'strategy' => 'string' ]; /** @@ -44,7 +44,7 @@ class MultipleQueriesObject implements ModelInterface, ArrayAccess, \JsonSeriali */ protected static $openAPIFormats = [ 'requests' => null, - 'strategy' => null, + 'strategy' => null ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'requests' => 'requests', - 'strategy' => 'strategy', + 'strategy' => 'strategy' ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'requests' => 'setRequests', - 'strategy' => 'setStrategy', + 'strategy' => 'setStrategy' ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'requests' => 'getRequests', - 'strategy' => 'getStrategy', + 'strategy' => 'getStrategy' ]; /** @@ -209,6 +209,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets requests * @@ -269,9 +270,9 @@ public function setStrategy($strategy) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -281,7 +282,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -310,7 +311,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -321,11 +322,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -356,3 +356,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php index d441ad8268..a5109a497d 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * MultipleQueriesResponse Class Doc Comment @@ -31,7 +31,7 @@ class MultipleQueriesResponse implements ModelInterface, ArrayAccess, \JsonSeria * @var string[] */ protected static $openAPITypes = [ - 'results' => '\Algolia\AlgoliaSearch\Model\SearchResponse[]', + 'results' => '\Algolia\AlgoliaSearch\Model\SearchResponse[]' ]; /** @@ -42,7 +42,7 @@ class MultipleQueriesResponse implements ModelInterface, ArrayAccess, \JsonSeria * @psalm-var array */ protected static $openAPIFormats = [ - 'results' => null, + 'results' => null ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'results' => 'results', + 'results' => 'results' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'results' => 'setResults', + 'results' => 'setResults' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'results' => 'getResults', + 'results' => 'getResults' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -175,6 +176,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets results * @@ -201,9 +203,9 @@ public function setResults($results) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -213,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -242,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -253,11 +255,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -288,3 +289,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/Operation.php b/clients/algoliasearch-client-php/lib/Model/Operation.php index 49f65a5711..8683c73b1b 100644 --- a/clients/algoliasearch-client-php/lib/Model/Operation.php +++ b/clients/algoliasearch-client-php/lib/Model/Operation.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * Operation Class Doc Comment @@ -33,7 +33,7 @@ class Operation implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'action' => '\Algolia\AlgoliaSearch\Model\Action', 'body' => 'object', - 'indexName' => 'string', + 'indexName' => 'string' ]; /** @@ -46,7 +46,7 @@ class Operation implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'action' => null, 'body' => null, - 'indexName' => null, + 'indexName' => null ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'action' => 'action', 'body' => 'body', - 'indexName' => 'indexName', + 'indexName' => 'indexName' ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'action' => 'setAction', 'body' => 'setBody', - 'indexName' => 'setIndexName', + 'indexName' => 'setIndexName' ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'action' => 'getAction', 'body' => 'getBody', - 'indexName' => 'getIndexName', + 'indexName' => 'getIndexName' ]; /** @@ -144,6 +144,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -187,6 +188,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets action * @@ -224,7 +226,7 @@ public function getBody() /** * Sets body * - * @param object|null $body arguments to the operation (depends on the type of the operation) + * @param object|null $body arguments to the operation (depends on the type of the operation). * * @return self */ @@ -248,7 +250,7 @@ public function getIndexName() /** * Sets indexName * - * @param string|null $indexName index to target for this operation + * @param string|null $indexName Index to target for this operation. * * @return self */ @@ -261,9 +263,9 @@ public function setIndexName($indexName) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -273,7 +275,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -302,7 +304,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -313,11 +315,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -348,3 +349,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php b/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php index c6122908e0..6ce1064869 100644 --- a/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php +++ b/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * OperationIndexObject Class Doc Comment @@ -33,7 +33,7 @@ class OperationIndexObject implements ModelInterface, ArrayAccess, \JsonSerializ protected static $openAPITypes = [ 'operation' => 'string', 'destination' => 'string', - 'scope' => 'string[]', + 'scope' => 'string[]' ]; /** @@ -46,7 +46,7 @@ class OperationIndexObject implements ModelInterface, ArrayAccess, \JsonSerializ protected static $openAPIFormats = [ 'operation' => null, 'destination' => null, - 'scope' => null, + 'scope' => null ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'operation' => 'operation', 'destination' => 'destination', - 'scope' => 'scope', + 'scope' => 'scope' ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'operation' => 'setOperation', 'destination' => 'setDestination', - 'scope' => 'setScope', + 'scope' => 'setScope' ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'operation' => 'getOperation', 'destination' => 'getDestination', - 'scope' => 'getScope', + 'scope' => 'getScope' ]; /** @@ -221,7 +221,6 @@ public function listInvalidProperties() if ($this->container['destination'] === null) { $invalidProperties[] = "'destination' can't be null"; } - return $invalidProperties; } @@ -236,6 +235,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets operation * @@ -249,7 +249,7 @@ public function getOperation() /** * Sets operation * - * @param string $operation type of operation to perform (move or copy) + * @param string $operation Type of operation to perform (move or copy). * * @return self */ @@ -283,7 +283,7 @@ public function getDestination() /** * Sets destination * - * @param string $destination the Algolia index name + * @param string $destination The Algolia index name. * * @return self */ @@ -329,9 +329,9 @@ public function setScope($scope) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -341,7 +341,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -370,7 +370,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -381,11 +381,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -416,3 +415,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/Params.php b/clients/algoliasearch-client-php/lib/Model/Params.php index 7dc71a62fd..91841228dc 100644 --- a/clients/algoliasearch-client-php/lib/Model/Params.php +++ b/clients/algoliasearch-client-php/lib/Model/Params.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * Params Class Doc Comment * * @category Class * @description Additional search parameters. Any valid search parameter is allowed. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +34,7 @@ class Params implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'query' => 'string', 'automaticFacetFilters' => '\Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]', - 'automaticOptionalFacetFilters' => '\Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]', + 'automaticOptionalFacetFilters' => '\Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]' ]; /** @@ -48,7 +47,7 @@ class Params implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'query' => null, 'automaticFacetFilters' => null, - 'automaticOptionalFacetFilters' => null, + 'automaticOptionalFacetFilters' => null ]; /** @@ -80,7 +79,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'query' => 'query', 'automaticFacetFilters' => 'automaticFacetFilters', - 'automaticOptionalFacetFilters' => 'automaticOptionalFacetFilters', + 'automaticOptionalFacetFilters' => 'automaticOptionalFacetFilters' ]; /** @@ -91,7 +90,7 @@ public static function openAPIFormats() protected static $setters = [ 'query' => 'setQuery', 'automaticFacetFilters' => 'setAutomaticFacetFilters', - 'automaticOptionalFacetFilters' => 'setAutomaticOptionalFacetFilters', + 'automaticOptionalFacetFilters' => 'setAutomaticOptionalFacetFilters' ]; /** @@ -102,7 +101,7 @@ public static function openAPIFormats() protected static $getters = [ 'query' => 'getQuery', 'automaticFacetFilters' => 'getAutomaticFacetFilters', - 'automaticOptionalFacetFilters' => 'getAutomaticOptionalFacetFilters', + 'automaticOptionalFacetFilters' => 'getAutomaticOptionalFacetFilters' ]; /** @@ -146,6 +145,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -189,6 +189,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets query * @@ -202,7 +203,7 @@ public function getQuery() /** * Sets query * - * @param string|null $query query string + * @param string|null $query Query string. * * @return self */ @@ -226,7 +227,7 @@ public function getAutomaticFacetFilters() /** * Sets automaticFacetFilters * - * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticFacetFilters names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern + * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticFacetFilters Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern. * * @return self */ @@ -250,7 +251,7 @@ public function getAutomaticOptionalFacetFilters() /** * Sets automaticOptionalFacetFilters * - * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticOptionalFacetFilters same syntax as automaticFacetFilters, but the engine treats the filters as optional + * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticOptionalFacetFilters Same syntax as automaticFacetFilters, but the engine treats the filters as optional. * * @return self */ @@ -263,9 +264,9 @@ public function setAutomaticOptionalFacetFilters($automaticOptionalFacetFilters) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -275,7 +276,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -304,7 +305,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -315,11 +316,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -350,3 +350,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/Promote.php b/clients/algoliasearch-client-php/lib/Model/Promote.php index 25d29916ee..14718b1d2c 100644 --- a/clients/algoliasearch-client-php/lib/Model/Promote.php +++ b/clients/algoliasearch-client-php/lib/Model/Promote.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * Promote Class Doc Comment * * @category Class * @description Object to promote as hits. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +34,7 @@ class Promote implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'objectID' => 'string', 'objectIDs' => 'string[]', - 'position' => 'int', + 'position' => 'int' ]; /** @@ -48,7 +47,7 @@ class Promote implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'objectID' => null, 'objectIDs' => null, - 'position' => null, + 'position' => null ]; /** @@ -80,7 +79,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'objectID' => 'objectID', 'objectIDs' => 'objectIDs', - 'position' => 'position', + 'position' => 'position' ]; /** @@ -91,7 +90,7 @@ public static function openAPIFormats() protected static $setters = [ 'objectID' => 'setObjectID', 'objectIDs' => 'setObjectIDs', - 'position' => 'setPosition', + 'position' => 'setPosition' ]; /** @@ -102,7 +101,7 @@ public static function openAPIFormats() protected static $getters = [ 'objectID' => 'getObjectID', 'objectIDs' => 'getObjectIDs', - 'position' => 'getPosition', + 'position' => 'getPosition' ]; /** @@ -146,6 +145,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -178,7 +178,6 @@ public function listInvalidProperties() if ($this->container['position'] === null) { $invalidProperties[] = "'position' can't be null"; } - return $invalidProperties; } @@ -193,6 +192,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets objectID * @@ -206,7 +206,7 @@ public function getObjectID() /** * Sets objectID * - * @param string|null $objectID unique identifier of the object to promote + * @param string|null $objectID Unique identifier of the object to promote. * * @return self */ @@ -230,7 +230,7 @@ public function getObjectIDs() /** * Sets objectIDs * - * @param string[]|null $objectIDs array of unique identifiers of the objects to promote + * @param string[]|null $objectIDs Array of unique identifiers of the objects to promote. * * @return self */ @@ -267,9 +267,9 @@ public function setPosition($position) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -279,7 +279,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -308,7 +308,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -319,11 +319,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -354,3 +353,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/RankingInfo.php b/clients/algoliasearch-client-php/lib/Model/RankingInfo.php index ecdde9adf6..03196a4eb5 100644 --- a/clients/algoliasearch-client-php/lib/Model/RankingInfo.php +++ b/clients/algoliasearch-client-php/lib/Model/RankingInfo.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * RankingInfo Class Doc Comment @@ -41,7 +41,7 @@ class RankingInfo implements ModelInterface, ArrayAccess, \JsonSerializable 'promoted' => 'bool', 'proximityDistance' => 'int', 'userScore' => 'int', - 'word' => 'int', + 'word' => 'int' ]; /** @@ -62,7 +62,7 @@ class RankingInfo implements ModelInterface, ArrayAccess, \JsonSerializable 'promoted' => null, 'proximityDistance' => null, 'userScore' => null, - 'word' => null, + 'word' => null ]; /** @@ -102,7 +102,7 @@ public static function openAPIFormats() 'promoted' => 'promoted', 'proximityDistance' => 'proximityDistance', 'userScore' => 'userScore', - 'word' => 'word', + 'word' => 'word' ]; /** @@ -121,7 +121,7 @@ public static function openAPIFormats() 'promoted' => 'setPromoted', 'proximityDistance' => 'setProximityDistance', 'userScore' => 'setUserScore', - 'word' => 'setWord', + 'word' => 'setWord' ]; /** @@ -140,7 +140,7 @@ public static function openAPIFormats() 'promoted' => 'getPromoted', 'proximityDistance' => 'getProximityDistance', 'userScore' => 'getUserScore', - 'word' => 'getWord', + 'word' => 'getWord' ]; /** @@ -184,6 +184,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -235,6 +236,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets filters * @@ -248,7 +250,7 @@ public function getFilters() /** * Sets filters * - * @param int|null $filters this field is reserved for advanced usage + * @param int|null $filters This field is reserved for advanced usage. * * @return self */ @@ -272,7 +274,7 @@ public function getFirstMatchedWord() /** * Sets firstMatchedWord * - * @param int|null $firstMatchedWord position of the most important matched attribute in the attributes to index list + * @param int|null $firstMatchedWord Position of the most important matched attribute in the attributes to index list. * * @return self */ @@ -296,7 +298,7 @@ public function getGeoDistance() /** * Sets geoDistance * - * @param int|null $geoDistance distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters) + * @param int|null $geoDistance Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters). * * @return self */ @@ -320,7 +322,7 @@ public function getGeoPrecision() /** * Sets geoPrecision * - * @param int|null $geoPrecision precision used when computing the geo distance, in meters + * @param int|null $geoPrecision Precision used when computing the geo distance, in meters. * * @return self */ @@ -368,7 +370,7 @@ public function getNbExactWords() /** * Sets nbExactWords * - * @param int|null $nbExactWords number of exactly matched words + * @param int|null $nbExactWords Number of exactly matched words. * * @return self */ @@ -392,7 +394,7 @@ public function getNbTypos() /** * Sets nbTypos * - * @param int|null $nbTypos number of typos encountered when matching the record + * @param int|null $nbTypos Number of typos encountered when matching the record. * * @return self */ @@ -416,7 +418,7 @@ public function getPromoted() /** * Sets promoted * - * @param bool|null $promoted present and set to true if a Rule promoted the hit + * @param bool|null $promoted Present and set to true if a Rule promoted the hit. * * @return self */ @@ -440,7 +442,7 @@ public function getProximityDistance() /** * Sets proximityDistance * - * @param int|null $proximityDistance when the query contains more than one word, the sum of the distances between matched words (in meters) + * @param int|null $proximityDistance When the query contains more than one word, the sum of the distances between matched words (in meters). * * @return self */ @@ -464,7 +466,7 @@ public function getUserScore() /** * Sets userScore * - * @param int|null $userScore custom ranking for the object, expressed as a single integer value + * @param int|null $userScore Custom ranking for the object, expressed as a single integer value. * * @return self */ @@ -488,7 +490,7 @@ public function getWord() /** * Sets word * - * @param int|null $word number of matched words, including prefixes and typos + * @param int|null $word Number of matched words, including prefixes and typos. * * @return self */ @@ -501,9 +503,9 @@ public function setWord($word) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -513,7 +515,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -542,7 +544,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -553,11 +555,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -588,3 +589,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php b/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php index 089130d225..40e0ff224f 100644 --- a/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php +++ b/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * RankingInfoMatchedGeoLocation Class Doc Comment @@ -33,7 +33,7 @@ class RankingInfoMatchedGeoLocation implements ModelInterface, ArrayAccess, \Jso protected static $openAPITypes = [ 'lat' => 'double', 'lng' => 'double', - 'distance' => 'int', + 'distance' => 'int' ]; /** @@ -46,7 +46,7 @@ class RankingInfoMatchedGeoLocation implements ModelInterface, ArrayAccess, \Jso protected static $openAPIFormats = [ 'lat' => 'double', 'lng' => 'double', - 'distance' => null, + 'distance' => null ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'lat' => 'lat', 'lng' => 'lng', - 'distance' => 'distance', + 'distance' => 'distance' ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'lat' => 'setLat', 'lng' => 'setLng', - 'distance' => 'setDistance', + 'distance' => 'setDistance' ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'lat' => 'getLat', 'lng' => 'getLng', - 'distance' => 'getDistance', + 'distance' => 'getDistance' ]; /** @@ -144,6 +144,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -187,10 +188,11 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets lat * - * @return float|null + * @return double|null */ public function getLat() { @@ -200,7 +202,7 @@ public function getLat() /** * Sets lat * - * @param float|null $lat latitude of the matched location + * @param double|null $lat Latitude of the matched location. * * @return self */ @@ -214,7 +216,7 @@ public function setLat($lat) /** * Gets lng * - * @return float|null + * @return double|null */ public function getLng() { @@ -224,7 +226,7 @@ public function getLng() /** * Sets lng * - * @param float|null $lng longitude of the matched location + * @param double|null $lng Longitude of the matched location. * * @return self */ @@ -248,7 +250,7 @@ public function getDistance() /** * Sets distance * - * @param int|null $distance distance between the matched location and the search location (in meters) + * @param int|null $distance Distance between the matched location and the search location (in meters). * * @return self */ @@ -261,9 +263,9 @@ public function setDistance($distance) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -273,7 +275,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -302,7 +304,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -313,11 +315,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -348,3 +349,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/Record.php b/clients/algoliasearch-client-php/lib/Model/Record.php index 345113fad0..cc58da5171 100644 --- a/clients/algoliasearch-client-php/lib/Model/Record.php +++ b/clients/algoliasearch-client-php/lib/Model/Record.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * Record Class Doc Comment * * @category Class * @description A single record. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -37,7 +36,7 @@ class Record implements ModelInterface, ArrayAccess, \JsonSerializable 'highlightResult' => '\Algolia\AlgoliaSearch\Model\HighlightResult', 'snippetResult' => '\Algolia\AlgoliaSearch\Model\SnippetResult', 'rankingInfo' => '\Algolia\AlgoliaSearch\Model\RankingInfo', - 'distinctSeqID' => 'int', + 'distinctSeqID' => 'int' ]; /** @@ -52,7 +51,7 @@ class Record implements ModelInterface, ArrayAccess, \JsonSerializable 'highlightResult' => null, 'snippetResult' => null, 'rankingInfo' => null, - 'distinctSeqID' => null, + 'distinctSeqID' => null ]; /** @@ -86,7 +85,7 @@ public static function openAPIFormats() 'highlightResult' => '_highlightResult', 'snippetResult' => '_snippetResult', 'rankingInfo' => '_rankingInfo', - 'distinctSeqID' => '_distinctSeqID', + 'distinctSeqID' => '_distinctSeqID' ]; /** @@ -99,7 +98,7 @@ public static function openAPIFormats() 'highlightResult' => 'setHighlightResult', 'snippetResult' => 'setSnippetResult', 'rankingInfo' => 'setRankingInfo', - 'distinctSeqID' => 'setDistinctSeqID', + 'distinctSeqID' => 'setDistinctSeqID' ]; /** @@ -112,7 +111,7 @@ public static function openAPIFormats() 'highlightResult' => 'getHighlightResult', 'snippetResult' => 'getSnippetResult', 'rankingInfo' => 'getRankingInfo', - 'distinctSeqID' => 'getDistinctSeqID', + 'distinctSeqID' => 'getDistinctSeqID' ]; /** @@ -156,6 +155,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -190,7 +190,6 @@ public function listInvalidProperties() if ($this->container['objectID'] === null) { $invalidProperties[] = "'objectID' can't be null"; } - return $invalidProperties; } @@ -205,6 +204,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets objectID * @@ -218,7 +218,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID unique identifier of the object + * @param string $objectID Unique identifier of the object. * * @return self */ @@ -327,9 +327,9 @@ public function setDistinctSeqID($distinctSeqID) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -339,7 +339,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -368,7 +368,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -379,11 +379,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -414,3 +413,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php b/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php index 74761cee9e..0c70495abb 100644 --- a/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * RemoveUserIdResponse Class Doc Comment @@ -31,7 +31,7 @@ class RemoveUserIdResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'deletedAt' => '\DateTime', + 'deletedAt' => '\DateTime' ]; /** @@ -42,7 +42,7 @@ class RemoveUserIdResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'deletedAt' => 'date-time', + 'deletedAt' => 'date-time' ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'deletedAt' => 'deletedAt', + 'deletedAt' => 'deletedAt' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'deletedAt' => 'setDeletedAt', + 'deletedAt' => 'setDeletedAt' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'deletedAt' => 'getDeletedAt', + 'deletedAt' => 'getDeletedAt' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -164,7 +165,6 @@ public function listInvalidProperties() if ($this->container['deletedAt'] === null) { $invalidProperties[] = "'deletedAt' can't be null"; } - return $invalidProperties; } @@ -179,6 +179,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets deletedAt * @@ -192,7 +193,7 @@ public function getDeletedAt() /** * Sets deletedAt * - * @param \DateTime $deletedAt date of deletion (ISO-8601 format) + * @param \DateTime $deletedAt Date of deletion (ISO-8601 format). * * @return self */ @@ -205,9 +206,9 @@ public function setDeletedAt($deletedAt) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -217,7 +218,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -246,7 +247,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -257,11 +258,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -292,3 +292,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php b/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php index b8c981e0f0..2b7487736e 100644 --- a/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * ReplaceSourceResponse Class Doc Comment @@ -31,7 +31,7 @@ class ReplaceSourceResponse implements ModelInterface, ArrayAccess, \JsonSeriali * @var string[] */ protected static $openAPITypes = [ - 'updatedAt' => '\DateTime', + 'updatedAt' => '\DateTime' ]; /** @@ -42,7 +42,7 @@ class ReplaceSourceResponse implements ModelInterface, ArrayAccess, \JsonSeriali * @psalm-var array */ protected static $openAPIFormats = [ - 'updatedAt' => 'date-time', + 'updatedAt' => 'date-time' ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'updatedAt' => 'updatedAt', + 'updatedAt' => 'updatedAt' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'updatedAt' => 'setUpdatedAt', + 'updatedAt' => 'setUpdatedAt' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'updatedAt' => 'getUpdatedAt', + 'updatedAt' => 'getUpdatedAt' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -164,7 +165,6 @@ public function listInvalidProperties() if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } - return $invalidProperties; } @@ -179,6 +179,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets updatedAt * @@ -192,7 +193,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt date of last update (ISO-8601 format) + * @param \DateTime $updatedAt Date of last update (ISO-8601 format). * * @return self */ @@ -205,9 +206,9 @@ public function setUpdatedAt($updatedAt) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -217,7 +218,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -246,7 +247,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -257,11 +258,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -292,3 +292,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php b/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php index fea07393c7..180e14b0cd 100644 --- a/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * RequiredSearchParams Class Doc Comment @@ -31,7 +31,7 @@ class RequiredSearchParams implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'query' => 'string', + 'query' => 'string' ]; /** @@ -42,7 +42,7 @@ class RequiredSearchParams implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'query' => null, + 'query' => null ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'query' => 'query', + 'query' => 'query' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'query' => 'setQuery', + 'query' => 'setQuery' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'query' => 'getQuery', + 'query' => 'getQuery' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -164,7 +165,6 @@ public function listInvalidProperties() if ($this->container['query'] === null) { $invalidProperties[] = "'query' can't be null"; } - return $invalidProperties; } @@ -179,6 +179,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets query * @@ -192,7 +193,7 @@ public function getQuery() /** * Sets query * - * @param string $query the text to search in the index + * @param string $query The text to search in the index. * * @return self */ @@ -205,9 +206,9 @@ public function setQuery($query) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -217,7 +218,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -246,7 +247,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -257,11 +258,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -292,3 +292,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/Rule.php b/clients/algoliasearch-client-php/lib/Model/Rule.php index 646596e102..ff0c3fb926 100644 --- a/clients/algoliasearch-client-php/lib/Model/Rule.php +++ b/clients/algoliasearch-client-php/lib/Model/Rule.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * Rule Class Doc Comment * * @category Class * @description Rule object. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -38,7 +37,7 @@ class Rule implements ModelInterface, ArrayAccess, \JsonSerializable 'consequence' => '\Algolia\AlgoliaSearch\Model\Consequence', 'description' => 'string', 'enabled' => 'bool', - 'validity' => '\Algolia\AlgoliaSearch\Model\TimeRange[]', + 'validity' => '\Algolia\AlgoliaSearch\Model\TimeRange[]' ]; /** @@ -54,7 +53,7 @@ class Rule implements ModelInterface, ArrayAccess, \JsonSerializable 'consequence' => null, 'description' => null, 'enabled' => null, - 'validity' => null, + 'validity' => null ]; /** @@ -89,7 +88,7 @@ public static function openAPIFormats() 'consequence' => 'consequence', 'description' => 'description', 'enabled' => 'enabled', - 'validity' => 'validity', + 'validity' => 'validity' ]; /** @@ -103,7 +102,7 @@ public static function openAPIFormats() 'consequence' => 'setConsequence', 'description' => 'setDescription', 'enabled' => 'setEnabled', - 'validity' => 'setValidity', + 'validity' => 'setValidity' ]; /** @@ -117,7 +116,7 @@ public static function openAPIFormats() 'consequence' => 'getConsequence', 'description' => 'getDescription', 'enabled' => 'getEnabled', - 'validity' => 'getValidity', + 'validity' => 'getValidity' ]; /** @@ -161,6 +160,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -199,7 +199,6 @@ public function listInvalidProperties() if ($this->container['consequence'] === null) { $invalidProperties[] = "'consequence' can't be null"; } - return $invalidProperties; } @@ -214,6 +213,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets objectID * @@ -227,7 +227,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID unique identifier of the object + * @param string $objectID Unique identifier of the object. * * @return self */ @@ -360,9 +360,9 @@ public function setValidity($validity) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -372,7 +372,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -401,7 +401,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -412,11 +412,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -447,3 +446,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php b/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php index 1512d4260c..4b894609d1 100644 --- a/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SaveObjectResponse Class Doc Comment @@ -33,7 +33,7 @@ class SaveObjectResponse implements ModelInterface, ArrayAccess, \JsonSerializab protected static $openAPITypes = [ 'createdAt' => 'string', 'taskID' => 'int', - 'objectID' => 'string', + 'objectID' => 'string' ]; /** @@ -46,7 +46,7 @@ class SaveObjectResponse implements ModelInterface, ArrayAccess, \JsonSerializab protected static $openAPIFormats = [ 'createdAt' => null, 'taskID' => null, - 'objectID' => null, + 'objectID' => null ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'createdAt' => 'createdAt', 'taskID' => 'taskID', - 'objectID' => 'objectID', + 'objectID' => 'objectID' ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'createdAt' => 'setCreatedAt', 'taskID' => 'setTaskID', - 'objectID' => 'setObjectID', + 'objectID' => 'setObjectID' ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'createdAt' => 'getCreatedAt', 'taskID' => 'getTaskID', - 'objectID' => 'getObjectID', + 'objectID' => 'getObjectID' ]; /** @@ -144,6 +144,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -187,6 +188,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets createdAt * @@ -224,7 +226,7 @@ public function getTaskID() /** * Sets taskID * - * @param int|null $taskID taskID of the indexing task to wait for + * @param int|null $taskID taskID of the indexing task to wait for. * * @return self */ @@ -248,7 +250,7 @@ public function getObjectID() /** * Sets objectID * - * @param string|null $objectID unique identifier of the object + * @param string|null $objectID Unique identifier of the object. * * @return self */ @@ -261,9 +263,9 @@ public function setObjectID($objectID) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -273,7 +275,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -302,7 +304,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -313,11 +315,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -348,3 +349,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php b/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php index 56a5f1ab5a..5781c715c7 100644 --- a/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SaveSynonymResponse Class Doc Comment @@ -33,7 +33,7 @@ class SaveSynonymResponse implements ModelInterface, ArrayAccess, \JsonSerializa protected static $openAPITypes = [ 'taskID' => 'int', 'updatedAt' => '\DateTime', - 'id' => 'string', + 'id' => 'string' ]; /** @@ -46,7 +46,7 @@ class SaveSynonymResponse implements ModelInterface, ArrayAccess, \JsonSerializa protected static $openAPIFormats = [ 'taskID' => null, 'updatedAt' => 'date-time', - 'id' => null, + 'id' => null ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'taskID' => 'taskID', 'updatedAt' => 'updatedAt', - 'id' => 'id', + 'id' => 'id' ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'taskID' => 'setTaskID', 'updatedAt' => 'setUpdatedAt', - 'id' => 'setId', + 'id' => 'setId' ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'taskID' => 'getTaskID', 'updatedAt' => 'getUpdatedAt', - 'id' => 'getId', + 'id' => 'getId' ]; /** @@ -144,6 +144,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -182,7 +183,6 @@ public function listInvalidProperties() if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } - return $invalidProperties; } @@ -197,6 +197,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets taskID * @@ -210,7 +211,7 @@ public function getTaskID() /** * Sets taskID * - * @param int $taskID taskID of the indexing task to wait for + * @param int $taskID taskID of the indexing task to wait for. * * @return self */ @@ -234,7 +235,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt date of last update (ISO-8601 format) + * @param \DateTime $updatedAt Date of last update (ISO-8601 format). * * @return self */ @@ -258,7 +259,7 @@ public function getId() /** * Sets id * - * @param string $id objectID of the inserted object + * @param string $id objectID of the inserted object. * * @return self */ @@ -271,9 +272,9 @@ public function setId($id) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -283,7 +284,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -312,7 +313,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -323,11 +324,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -358,3 +358,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php b/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php index 9ec71bf9f3..1db78c1742 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchDictionaryEntries Class Doc Comment * * @category Class * @description The `searchDictionaryEntries` request. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -36,7 +35,7 @@ class SearchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSeria 'query' => 'string', 'page' => 'int', 'hitsPerPage' => 'int', - 'language' => 'string', + 'language' => 'string' ]; /** @@ -50,7 +49,7 @@ class SearchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSeria 'query' => null, 'page' => null, 'hitsPerPage' => null, - 'language' => null, + 'language' => null ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() 'query' => 'query', 'page' => 'page', 'hitsPerPage' => 'hitsPerPage', - 'language' => 'language', + 'language' => 'language' ]; /** @@ -95,7 +94,7 @@ public static function openAPIFormats() 'query' => 'setQuery', 'page' => 'setPage', 'hitsPerPage' => 'setHitsPerPage', - 'language' => 'setLanguage', + 'language' => 'setLanguage' ]; /** @@ -107,7 +106,7 @@ public static function openAPIFormats() 'query' => 'getQuery', 'page' => 'getPage', 'hitsPerPage' => 'getHitsPerPage', - 'language' => 'getLanguage', + 'language' => 'getLanguage' ]; /** @@ -151,6 +150,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -184,7 +184,6 @@ public function listInvalidProperties() if ($this->container['query'] === null) { $invalidProperties[] = "'query' can't be null"; } - return $invalidProperties; } @@ -199,6 +198,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets query * @@ -212,7 +212,7 @@ public function getQuery() /** * Sets query * - * @param string $query the text to search in the index + * @param string $query The text to search in the index. * * @return self */ @@ -236,7 +236,7 @@ public function getPage() /** * Sets page * - * @param int|null $page specify the page to retrieve + * @param int|null $page Specify the page to retrieve. * * @return self */ @@ -260,7 +260,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage set the number of hits per page + * @param int|null $hitsPerPage Set the number of hits per page. * * @return self */ @@ -297,9 +297,9 @@ public function setLanguage($language) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -309,7 +309,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -338,7 +338,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -349,11 +349,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -384,3 +383,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php index 29d33c4a97..9ab47c9980 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchForFacetValuesRequest Class Doc Comment @@ -33,7 +33,7 @@ class SearchForFacetValuesRequest implements ModelInterface, ArrayAccess, \JsonS protected static $openAPITypes = [ 'params' => 'string', 'facetQuery' => 'string', - 'maxFacetHits' => 'int', + 'maxFacetHits' => 'int' ]; /** @@ -46,7 +46,7 @@ class SearchForFacetValuesRequest implements ModelInterface, ArrayAccess, \JsonS protected static $openAPIFormats = [ 'params' => null, 'facetQuery' => null, - 'maxFacetHits' => null, + 'maxFacetHits' => null ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'params' => 'params', 'facetQuery' => 'facetQuery', - 'maxFacetHits' => 'maxFacetHits', + 'maxFacetHits' => 'maxFacetHits' ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'params' => 'setParams', 'facetQuery' => 'setFacetQuery', - 'maxFacetHits' => 'setMaxFacetHits', + 'maxFacetHits' => 'setMaxFacetHits' ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'params' => 'getParams', 'facetQuery' => 'getFacetQuery', - 'maxFacetHits' => 'getMaxFacetHits', + 'maxFacetHits' => 'getMaxFacetHits' ]; /** @@ -144,6 +144,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -191,6 +192,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets params * @@ -204,7 +206,7 @@ public function getParams() /** * Sets params * - * @param string|null $params search parameters as URL-encoded query string + * @param string|null $params Search parameters as URL-encoded query string. * * @return self */ @@ -228,7 +230,7 @@ public function getFacetQuery() /** * Sets facetQuery * - * @param string|null $facetQuery text to search inside the facet's values + * @param string|null $facetQuery Text to search inside the facet's values. * * @return self */ @@ -270,9 +272,9 @@ public function setMaxFacetHits($maxFacetHits) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -282,7 +284,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -311,7 +313,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -322,11 +324,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -357,3 +358,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php index 3e5bdb2eeb..7f1bfa58fa 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchForFacetValuesResponse Class Doc Comment @@ -31,7 +31,7 @@ class SearchForFacetValuesResponse implements ModelInterface, ArrayAccess, \Json * @var string[] */ protected static $openAPITypes = [ - 'facetHits' => '\Algolia\AlgoliaSearch\Model\SearchForFacetValuesResponseFacetHits[]', + 'facetHits' => '\Algolia\AlgoliaSearch\Model\SearchForFacetValuesResponseFacetHits[]' ]; /** @@ -42,7 +42,7 @@ class SearchForFacetValuesResponse implements ModelInterface, ArrayAccess, \Json * @psalm-var array */ protected static $openAPIFormats = [ - 'facetHits' => null, + 'facetHits' => null ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'facetHits' => 'facetHits', + 'facetHits' => 'facetHits' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'facetHits' => 'setFacetHits', + 'facetHits' => 'setFacetHits' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'facetHits' => 'getFacetHits', + 'facetHits' => 'getFacetHits' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -164,7 +165,6 @@ public function listInvalidProperties() if ($this->container['facetHits'] === null) { $invalidProperties[] = "'facetHits' can't be null"; } - return $invalidProperties; } @@ -179,6 +179,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets facetHits * @@ -205,9 +206,9 @@ public function setFacetHits($facetHits) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -217,7 +218,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -246,7 +247,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -257,11 +258,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -292,3 +292,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php index 071e8412fc..0b4efb1a49 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchForFacetValuesResponseFacetHits Class Doc Comment @@ -33,7 +33,7 @@ class SearchForFacetValuesResponseFacetHits implements ModelInterface, ArrayAcce protected static $openAPITypes = [ 'value' => 'string', 'highlighted' => 'string', - 'count' => 'int', + 'count' => 'int' ]; /** @@ -46,7 +46,7 @@ class SearchForFacetValuesResponseFacetHits implements ModelInterface, ArrayAcce protected static $openAPIFormats = [ 'value' => null, 'highlighted' => null, - 'count' => null, + 'count' => null ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'value' => 'value', 'highlighted' => 'highlighted', - 'count' => 'count', + 'count' => 'count' ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'value' => 'setValue', 'highlighted' => 'setHighlighted', - 'count' => 'setCount', + 'count' => 'setCount' ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'value' => 'getValue', 'highlighted' => 'getHighlighted', - 'count' => 'getCount', + 'count' => 'getCount' ]; /** @@ -144,6 +144,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -182,7 +183,6 @@ public function listInvalidProperties() if ($this->container['count'] === null) { $invalidProperties[] = "'count' can't be null"; } - return $invalidProperties; } @@ -197,6 +197,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets value * @@ -210,7 +211,7 @@ public function getValue() /** * Sets value * - * @param string $value raw value of the facet + * @param string $value Raw value of the facet. * * @return self */ @@ -234,7 +235,7 @@ public function getHighlighted() /** * Sets highlighted * - * @param string $highlighted markup text with occurrences highlighted + * @param string $highlighted Markup text with occurrences highlighted. * * @return self */ @@ -271,9 +272,9 @@ public function setCount($count) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -283,7 +284,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -312,7 +313,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -323,11 +324,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -358,3 +358,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchHits.php b/clients/algoliasearch-client-php/lib/Model/SearchHits.php index dcce6cb2d2..98d474deaf 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchHits.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchHits.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchHits Class Doc Comment @@ -31,7 +31,7 @@ class SearchHits implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]', + 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]' ]; /** @@ -42,7 +42,7 @@ class SearchHits implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'hits' => null, + 'hits' => null ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'hits' => 'hits', + 'hits' => 'hits' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'hits' => 'setHits', + 'hits' => 'setHits' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'hits' => 'getHits', + 'hits' => 'getHits' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -175,6 +176,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets hits * @@ -201,9 +203,9 @@ public function setHits($hits) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -213,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -242,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -253,11 +255,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -288,3 +289,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchParams.php b/clients/algoliasearch-client-php/lib/Model/SearchParams.php index bdde27f975..184d6356e4 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchParams Class Doc Comment @@ -108,7 +108,7 @@ class SearchParams implements ModelInterface, ArrayAccess, \JsonSerializable 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object', + 'renderingContent' => 'object' ]; /** @@ -196,7 +196,7 @@ class SearchParams implements ModelInterface, ArrayAccess, \JsonSerializable 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null, + 'renderingContent' => null ]; /** @@ -303,7 +303,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent', + 'renderingContent' => 'renderingContent' ]; /** @@ -389,7 +389,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent', + 'renderingContent' => 'setRenderingContent' ]; /** @@ -475,7 +475,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent', + 'renderingContent' => 'getRenderingContent' ]; /** @@ -813,6 +813,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets params * @@ -826,7 +827,7 @@ public function getParams() /** * Sets params * - * @param string|null $params search parameters as URL-encoded query string + * @param string|null $params Search parameters as URL-encoded query string. * * @return self */ @@ -850,7 +851,7 @@ public function getSimilarQuery() /** * Sets similarQuery * - * @param string|null $similarQuery overrides the query parameter and performs a more generic search that can be used to find \"similar\" results + * @param string|null $similarQuery Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results. * * @return self */ @@ -874,7 +875,7 @@ public function getFilters() /** * Sets filters * - * @param string|null $filters filter the query with numeric, facet and/or tag filters + * @param string|null $filters Filter the query with numeric, facet and/or tag filters. * * @return self */ @@ -898,7 +899,7 @@ public function getFacetFilters() /** * Sets facetFilters * - * @param string[]|null $facetFilters filter hits by facet value + * @param string[]|null $facetFilters Filter hits by facet value. * * @return self */ @@ -922,7 +923,7 @@ public function getOptionalFilters() /** * Sets optionalFilters * - * @param string[]|null $optionalFilters create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter + * @param string[]|null $optionalFilters Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. * * @return self */ @@ -946,7 +947,7 @@ public function getNumericFilters() /** * Sets numericFilters * - * @param string[]|null $numericFilters filter on numeric attributes + * @param string[]|null $numericFilters Filter on numeric attributes. * * @return self */ @@ -970,7 +971,7 @@ public function getTagFilters() /** * Sets tagFilters * - * @param string[]|null $tagFilters filter hits by tags + * @param string[]|null $tagFilters Filter hits by tags. * * @return self */ @@ -994,7 +995,7 @@ public function getSumOrFiltersScores() /** * Sets sumOrFiltersScores * - * @param bool|null $sumOrFiltersScores determines how to calculate the total score for filtering + * @param bool|null $sumOrFiltersScores Determines how to calculate the total score for filtering. * * @return self */ @@ -1018,7 +1019,7 @@ public function getFacets() /** * Sets facets * - * @param string[]|null $facets retrieve facets and their facet values + * @param string[]|null $facets Retrieve facets and their facet values. * * @return self */ @@ -1042,7 +1043,7 @@ public function getMaxValuesPerFacet() /** * Sets maxValuesPerFacet * - * @param int|null $maxValuesPerFacet maximum number of facet values to return for each facet during a regular search + * @param int|null $maxValuesPerFacet Maximum number of facet values to return for each facet during a regular search. * * @return self */ @@ -1066,7 +1067,7 @@ public function getFacetingAfterDistinct() /** * Sets facetingAfterDistinct * - * @param bool|null $facetingAfterDistinct force faceting to be applied after de-duplication (via the Distinct setting) + * @param bool|null $facetingAfterDistinct Force faceting to be applied after de-duplication (via the Distinct setting). * * @return self */ @@ -1090,7 +1091,7 @@ public function getSortFacetValuesBy() /** * Sets sortFacetValuesBy * - * @param string|null $sortFacetValuesBy controls how facet values are fetched + * @param string|null $sortFacetValuesBy Controls how facet values are fetched. * * @return self */ @@ -1114,7 +1115,7 @@ public function getPage() /** * Sets page * - * @param int|null $page specify the page to retrieve + * @param int|null $page Specify the page to retrieve. * * @return self */ @@ -1138,7 +1139,7 @@ public function getOffset() /** * Sets offset * - * @param int|null $offset specify the offset of the first hit to return + * @param int|null $offset Specify the offset of the first hit to return. * * @return self */ @@ -1162,7 +1163,7 @@ public function getLength() /** * Sets length * - * @param int|null $length set the number of hits to retrieve (used only with offset) + * @param int|null $length Set the number of hits to retrieve (used only with offset). * * @return self */ @@ -1194,7 +1195,7 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng search for entries around a central geolocation, enabling a geo search within a circular area + * @param string|null $aroundLatLng Search for entries around a central geolocation, enabling a geo search within a circular area. * * @return self */ @@ -1218,7 +1219,7 @@ public function getAroundLatLngViaIP() /** * Sets aroundLatLngViaIP * - * @param bool|null $aroundLatLngViaIP search for entries around a given location automatically computed from the requester's IP address + * @param bool|null $aroundLatLngViaIP Search for entries around a given location automatically computed from the requester's IP address. * * @return self */ @@ -1242,7 +1243,7 @@ public function getAroundRadius() /** * Sets aroundRadius * - * @param OneOfIntegerString|null $aroundRadius define the maximum radius for a geo search (in meters) + * @param OneOfIntegerString|null $aroundRadius Define the maximum radius for a geo search (in meters). * * @return self */ @@ -1266,7 +1267,7 @@ public function getAroundPrecision() /** * Sets aroundPrecision * - * @param int|null $aroundPrecision precision of geo search (in meters), to add grouping by geo location to the ranking formula + * @param int|null $aroundPrecision Precision of geo search (in meters), to add grouping by geo location to the ranking formula. * * @return self */ @@ -1290,7 +1291,7 @@ public function getMinimumAroundRadius() /** * Sets minimumAroundRadius * - * @param int|null $minimumAroundRadius minimum radius (in meters) used for a geo search when aroundRadius is not set + * @param int|null $minimumAroundRadius Minimum radius (in meters) used for a geo search when aroundRadius is not set. * * @return self */ @@ -1319,7 +1320,7 @@ public function getInsideBoundingBox() /** * Sets insideBoundingBox * - * @param float[]|null $insideBoundingBox search inside a rectangular area (in geo coordinates) + * @param float[]|null $insideBoundingBox Search inside a rectangular area (in geo coordinates). * * @return self */ @@ -1343,7 +1344,7 @@ public function getInsidePolygon() /** * Sets insidePolygon * - * @param float[]|null $insidePolygon search inside a polygon (in geo coordinates) + * @param float[]|null $insidePolygon Search inside a polygon (in geo coordinates). * * @return self */ @@ -1391,7 +1392,7 @@ public function getRuleContexts() /** * Sets ruleContexts * - * @param string[]|null $ruleContexts enables contextual rules + * @param string[]|null $ruleContexts Enables contextual rules. * * @return self */ @@ -1415,7 +1416,7 @@ public function getPersonalizationImpact() /** * Sets personalizationImpact * - * @param int|null $personalizationImpact define the impact of the Personalization feature + * @param int|null $personalizationImpact Define the impact of the Personalization feature. * * @return self */ @@ -1439,7 +1440,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken associates a certain user token with the current search + * @param string|null $userToken Associates a certain user token with the current search. * * @return self */ @@ -1463,7 +1464,7 @@ public function getGetRankingInfo() /** * Sets getRankingInfo * - * @param bool|null $getRankingInfo retrieve detailed ranking information + * @param bool|null $getRankingInfo Retrieve detailed ranking information. * * @return self */ @@ -1487,7 +1488,7 @@ public function getClickAnalytics() /** * Sets clickAnalytics * - * @param bool|null $clickAnalytics enable the Click Analytics feature + * @param bool|null $clickAnalytics Enable the Click Analytics feature. * * @return self */ @@ -1511,7 +1512,7 @@ public function getAnalytics() /** * Sets analytics * - * @param bool|null $analytics whether the current query will be taken into account in the Analytics + * @param bool|null $analytics Whether the current query will be taken into account in the Analytics. * * @return self */ @@ -1535,7 +1536,7 @@ public function getAnalyticsTags() /** * Sets analyticsTags * - * @param string[]|null $analyticsTags list of tags to apply to the query for analytics purposes + * @param string[]|null $analyticsTags List of tags to apply to the query for analytics purposes. * * @return self */ @@ -1559,7 +1560,7 @@ public function getPercentileComputation() /** * Sets percentileComputation * - * @param bool|null $percentileComputation whether to include or exclude a query from the processing-time percentile computation + * @param bool|null $percentileComputation Whether to include or exclude a query from the processing-time percentile computation. * * @return self */ @@ -1583,7 +1584,7 @@ public function getEnableABTest() /** * Sets enableABTest * - * @param bool|null $enableABTest whether this search should participate in running AB tests + * @param bool|null $enableABTest Whether this search should participate in running AB tests. * * @return self */ @@ -1607,7 +1608,7 @@ public function getEnableReRanking() /** * Sets enableReRanking * - * @param bool|null $enableReRanking whether this search should use AI Re-Ranking + * @param bool|null $enableReRanking Whether this search should use AI Re-Ranking. * * @return self */ @@ -1631,7 +1632,7 @@ public function getQuery() /** * Sets query * - * @param string $query the text to search in the index + * @param string $query The text to search in the index. * * @return self */ @@ -1655,7 +1656,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes the complete list of attributes used for searching + * @param string[]|null $searchableAttributes The complete list of attributes used for searching. * * @return self */ @@ -1679,7 +1680,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting + * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. * * @return self */ @@ -1703,7 +1704,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time + * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. * * @return self */ @@ -1727,7 +1728,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve + * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. * * @return self */ @@ -1751,7 +1752,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes + * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. * * @return self */ @@ -1775,7 +1776,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking controls how Algolia should sort your results + * @param string[]|null $ranking Controls how Algolia should sort your results. * * @return self */ @@ -1799,7 +1800,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking specifies the custom ranking criterion + * @param string[]|null $customRanking Specifies the custom ranking criterion. * * @return self */ @@ -1823,7 +1824,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results + * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. * * @return self */ @@ -1847,7 +1848,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight list of attributes to highlight + * @param string[]|null $attributesToHighlight List of attributes to highlight. * * @return self */ @@ -1871,7 +1872,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet + * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. * * @return self */ @@ -1895,7 +1896,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results + * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. * * @return self */ @@ -1919,7 +1920,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results + * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. * * @return self */ @@ -1943,7 +1944,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated + * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. * * @return self */ @@ -1967,7 +1968,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query + * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. * * @return self */ @@ -1991,7 +1992,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage set the number of hits per page + * @param int|null $hitsPerPage Set the number of hits per page. * * @return self */ @@ -2015,7 +2016,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo + * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. * * @return self */ @@ -2039,7 +2040,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos + * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. * * @return self */ @@ -2063,7 +2064,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied + * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. * * @return self */ @@ -2097,7 +2098,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string + * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. * * @return self */ @@ -2121,7 +2122,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance + * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. * * @return self */ @@ -2145,7 +2146,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex control which separators are indexed + * @param string|null $separatorsToIndex Control which separators are indexed. * * @return self */ @@ -2169,7 +2170,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms + * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. * * @return self */ @@ -2193,7 +2194,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords removes stop (common) words from the query before executing it + * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. * * @return self */ @@ -2217,7 +2218,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize + * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. * * @return self */ @@ -2241,7 +2242,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection + * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. * * @return self */ @@ -2265,7 +2266,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query + * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. * * @return self */ @@ -2289,7 +2290,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules whether Rules should be globally enabled + * @param bool|null $enableRules Whether Rules should be globally enabled. * * @return self */ @@ -2313,7 +2314,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization enable the Personalization feature + * @param bool|null $enablePersonalization Enable the Personalization feature. * * @return self */ @@ -2337,7 +2338,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType controls if and how query words are interpreted as prefixes + * @param string|null $queryType Controls if and how query words are interpreted as prefixes. * * @return self */ @@ -2371,7 +2372,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits + * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. * * @return self */ @@ -2405,7 +2406,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax enables the advanced query syntax + * @param bool|null $advancedSyntax Enables the advanced query syntax. * * @return self */ @@ -2429,7 +2430,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query + * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. * * @return self */ @@ -2453,7 +2454,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion + * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. * * @return self */ @@ -2477,7 +2478,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word + * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. * * @return self */ @@ -2511,7 +2512,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion + * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. * * @return self */ @@ -2544,7 +2545,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled + * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. * * @return self */ @@ -2577,7 +2578,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct enables de-duplication or grouping of results + * @param int|null $distinct Enables de-duplication or grouping of results. * * @return self */ @@ -2609,7 +2610,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search + * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. * * @return self */ @@ -2633,7 +2634,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself + * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. * * @return self */ @@ -2657,7 +2658,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity precision of the proximity ranking criterion + * @param int|null $minProximity Precision of the proximity ranking criterion. * * @return self */ @@ -2742,7 +2743,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage + * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. * * @return self */ @@ -2779,9 +2780,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -2791,7 +2792,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -2820,7 +2821,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -2831,11 +2832,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -2866,3 +2866,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php b/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php index e8ff8684b7..49956dd09f 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchParamsObject Class Doc Comment @@ -107,7 +107,7 @@ class SearchParamsObject implements ModelInterface, ArrayAccess, \JsonSerializab 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object', + 'renderingContent' => 'object' ]; /** @@ -194,7 +194,7 @@ class SearchParamsObject implements ModelInterface, ArrayAccess, \JsonSerializab 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null, + 'renderingContent' => null ]; /** @@ -300,7 +300,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent', + 'renderingContent' => 'renderingContent' ]; /** @@ -385,7 +385,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent', + 'renderingContent' => 'setRenderingContent' ]; /** @@ -470,7 +470,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent', + 'renderingContent' => 'getRenderingContent' ]; /** @@ -807,6 +807,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets similarQuery * @@ -820,7 +821,7 @@ public function getSimilarQuery() /** * Sets similarQuery * - * @param string|null $similarQuery overrides the query parameter and performs a more generic search that can be used to find \"similar\" results + * @param string|null $similarQuery Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results. * * @return self */ @@ -844,7 +845,7 @@ public function getFilters() /** * Sets filters * - * @param string|null $filters filter the query with numeric, facet and/or tag filters + * @param string|null $filters Filter the query with numeric, facet and/or tag filters. * * @return self */ @@ -868,7 +869,7 @@ public function getFacetFilters() /** * Sets facetFilters * - * @param string[]|null $facetFilters filter hits by facet value + * @param string[]|null $facetFilters Filter hits by facet value. * * @return self */ @@ -892,7 +893,7 @@ public function getOptionalFilters() /** * Sets optionalFilters * - * @param string[]|null $optionalFilters create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter + * @param string[]|null $optionalFilters Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. * * @return self */ @@ -916,7 +917,7 @@ public function getNumericFilters() /** * Sets numericFilters * - * @param string[]|null $numericFilters filter on numeric attributes + * @param string[]|null $numericFilters Filter on numeric attributes. * * @return self */ @@ -940,7 +941,7 @@ public function getTagFilters() /** * Sets tagFilters * - * @param string[]|null $tagFilters filter hits by tags + * @param string[]|null $tagFilters Filter hits by tags. * * @return self */ @@ -964,7 +965,7 @@ public function getSumOrFiltersScores() /** * Sets sumOrFiltersScores * - * @param bool|null $sumOrFiltersScores determines how to calculate the total score for filtering + * @param bool|null $sumOrFiltersScores Determines how to calculate the total score for filtering. * * @return self */ @@ -988,7 +989,7 @@ public function getFacets() /** * Sets facets * - * @param string[]|null $facets retrieve facets and their facet values + * @param string[]|null $facets Retrieve facets and their facet values. * * @return self */ @@ -1012,7 +1013,7 @@ public function getMaxValuesPerFacet() /** * Sets maxValuesPerFacet * - * @param int|null $maxValuesPerFacet maximum number of facet values to return for each facet during a regular search + * @param int|null $maxValuesPerFacet Maximum number of facet values to return for each facet during a regular search. * * @return self */ @@ -1036,7 +1037,7 @@ public function getFacetingAfterDistinct() /** * Sets facetingAfterDistinct * - * @param bool|null $facetingAfterDistinct force faceting to be applied after de-duplication (via the Distinct setting) + * @param bool|null $facetingAfterDistinct Force faceting to be applied after de-duplication (via the Distinct setting). * * @return self */ @@ -1060,7 +1061,7 @@ public function getSortFacetValuesBy() /** * Sets sortFacetValuesBy * - * @param string|null $sortFacetValuesBy controls how facet values are fetched + * @param string|null $sortFacetValuesBy Controls how facet values are fetched. * * @return self */ @@ -1084,7 +1085,7 @@ public function getPage() /** * Sets page * - * @param int|null $page specify the page to retrieve + * @param int|null $page Specify the page to retrieve. * * @return self */ @@ -1108,7 +1109,7 @@ public function getOffset() /** * Sets offset * - * @param int|null $offset specify the offset of the first hit to return + * @param int|null $offset Specify the offset of the first hit to return. * * @return self */ @@ -1132,7 +1133,7 @@ public function getLength() /** * Sets length * - * @param int|null $length set the number of hits to retrieve (used only with offset) + * @param int|null $length Set the number of hits to retrieve (used only with offset). * * @return self */ @@ -1164,7 +1165,7 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng search for entries around a central geolocation, enabling a geo search within a circular area + * @param string|null $aroundLatLng Search for entries around a central geolocation, enabling a geo search within a circular area. * * @return self */ @@ -1188,7 +1189,7 @@ public function getAroundLatLngViaIP() /** * Sets aroundLatLngViaIP * - * @param bool|null $aroundLatLngViaIP search for entries around a given location automatically computed from the requester's IP address + * @param bool|null $aroundLatLngViaIP Search for entries around a given location automatically computed from the requester's IP address. * * @return self */ @@ -1212,7 +1213,7 @@ public function getAroundRadius() /** * Sets aroundRadius * - * @param OneOfIntegerString|null $aroundRadius define the maximum radius for a geo search (in meters) + * @param OneOfIntegerString|null $aroundRadius Define the maximum radius for a geo search (in meters). * * @return self */ @@ -1236,7 +1237,7 @@ public function getAroundPrecision() /** * Sets aroundPrecision * - * @param int|null $aroundPrecision precision of geo search (in meters), to add grouping by geo location to the ranking formula + * @param int|null $aroundPrecision Precision of geo search (in meters), to add grouping by geo location to the ranking formula. * * @return self */ @@ -1260,7 +1261,7 @@ public function getMinimumAroundRadius() /** * Sets minimumAroundRadius * - * @param int|null $minimumAroundRadius minimum radius (in meters) used for a geo search when aroundRadius is not set + * @param int|null $minimumAroundRadius Minimum radius (in meters) used for a geo search when aroundRadius is not set. * * @return self */ @@ -1289,7 +1290,7 @@ public function getInsideBoundingBox() /** * Sets insideBoundingBox * - * @param float[]|null $insideBoundingBox search inside a rectangular area (in geo coordinates) + * @param float[]|null $insideBoundingBox Search inside a rectangular area (in geo coordinates). * * @return self */ @@ -1313,7 +1314,7 @@ public function getInsidePolygon() /** * Sets insidePolygon * - * @param float[]|null $insidePolygon search inside a polygon (in geo coordinates) + * @param float[]|null $insidePolygon Search inside a polygon (in geo coordinates). * * @return self */ @@ -1361,7 +1362,7 @@ public function getRuleContexts() /** * Sets ruleContexts * - * @param string[]|null $ruleContexts enables contextual rules + * @param string[]|null $ruleContexts Enables contextual rules. * * @return self */ @@ -1385,7 +1386,7 @@ public function getPersonalizationImpact() /** * Sets personalizationImpact * - * @param int|null $personalizationImpact define the impact of the Personalization feature + * @param int|null $personalizationImpact Define the impact of the Personalization feature. * * @return self */ @@ -1409,7 +1410,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken associates a certain user token with the current search + * @param string|null $userToken Associates a certain user token with the current search. * * @return self */ @@ -1433,7 +1434,7 @@ public function getGetRankingInfo() /** * Sets getRankingInfo * - * @param bool|null $getRankingInfo retrieve detailed ranking information + * @param bool|null $getRankingInfo Retrieve detailed ranking information. * * @return self */ @@ -1457,7 +1458,7 @@ public function getClickAnalytics() /** * Sets clickAnalytics * - * @param bool|null $clickAnalytics enable the Click Analytics feature + * @param bool|null $clickAnalytics Enable the Click Analytics feature. * * @return self */ @@ -1481,7 +1482,7 @@ public function getAnalytics() /** * Sets analytics * - * @param bool|null $analytics whether the current query will be taken into account in the Analytics + * @param bool|null $analytics Whether the current query will be taken into account in the Analytics. * * @return self */ @@ -1505,7 +1506,7 @@ public function getAnalyticsTags() /** * Sets analyticsTags * - * @param string[]|null $analyticsTags list of tags to apply to the query for analytics purposes + * @param string[]|null $analyticsTags List of tags to apply to the query for analytics purposes. * * @return self */ @@ -1529,7 +1530,7 @@ public function getPercentileComputation() /** * Sets percentileComputation * - * @param bool|null $percentileComputation whether to include or exclude a query from the processing-time percentile computation + * @param bool|null $percentileComputation Whether to include or exclude a query from the processing-time percentile computation. * * @return self */ @@ -1553,7 +1554,7 @@ public function getEnableABTest() /** * Sets enableABTest * - * @param bool|null $enableABTest whether this search should participate in running AB tests + * @param bool|null $enableABTest Whether this search should participate in running AB tests. * * @return self */ @@ -1577,7 +1578,7 @@ public function getEnableReRanking() /** * Sets enableReRanking * - * @param bool|null $enableReRanking whether this search should use AI Re-Ranking + * @param bool|null $enableReRanking Whether this search should use AI Re-Ranking. * * @return self */ @@ -1601,7 +1602,7 @@ public function getQuery() /** * Sets query * - * @param string $query the text to search in the index + * @param string $query The text to search in the index. * * @return self */ @@ -1625,7 +1626,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes the complete list of attributes used for searching + * @param string[]|null $searchableAttributes The complete list of attributes used for searching. * * @return self */ @@ -1649,7 +1650,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting + * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. * * @return self */ @@ -1673,7 +1674,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time + * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. * * @return self */ @@ -1697,7 +1698,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve + * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. * * @return self */ @@ -1721,7 +1722,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes + * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. * * @return self */ @@ -1745,7 +1746,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking controls how Algolia should sort your results + * @param string[]|null $ranking Controls how Algolia should sort your results. * * @return self */ @@ -1769,7 +1770,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking specifies the custom ranking criterion + * @param string[]|null $customRanking Specifies the custom ranking criterion. * * @return self */ @@ -1793,7 +1794,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results + * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. * * @return self */ @@ -1817,7 +1818,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight list of attributes to highlight + * @param string[]|null $attributesToHighlight List of attributes to highlight. * * @return self */ @@ -1841,7 +1842,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet + * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. * * @return self */ @@ -1865,7 +1866,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results + * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. * * @return self */ @@ -1889,7 +1890,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results + * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. * * @return self */ @@ -1913,7 +1914,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated + * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. * * @return self */ @@ -1937,7 +1938,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query + * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. * * @return self */ @@ -1961,7 +1962,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage set the number of hits per page + * @param int|null $hitsPerPage Set the number of hits per page. * * @return self */ @@ -1985,7 +1986,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo + * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. * * @return self */ @@ -2009,7 +2010,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos + * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. * * @return self */ @@ -2033,7 +2034,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied + * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. * * @return self */ @@ -2067,7 +2068,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string + * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. * * @return self */ @@ -2091,7 +2092,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance + * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. * * @return self */ @@ -2115,7 +2116,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex control which separators are indexed + * @param string|null $separatorsToIndex Control which separators are indexed. * * @return self */ @@ -2139,7 +2140,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms + * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. * * @return self */ @@ -2163,7 +2164,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords removes stop (common) words from the query before executing it + * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. * * @return self */ @@ -2187,7 +2188,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize + * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. * * @return self */ @@ -2211,7 +2212,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection + * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. * * @return self */ @@ -2235,7 +2236,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query + * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. * * @return self */ @@ -2259,7 +2260,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules whether Rules should be globally enabled + * @param bool|null $enableRules Whether Rules should be globally enabled. * * @return self */ @@ -2283,7 +2284,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization enable the Personalization feature + * @param bool|null $enablePersonalization Enable the Personalization feature. * * @return self */ @@ -2307,7 +2308,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType controls if and how query words are interpreted as prefixes + * @param string|null $queryType Controls if and how query words are interpreted as prefixes. * * @return self */ @@ -2341,7 +2342,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits + * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. * * @return self */ @@ -2375,7 +2376,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax enables the advanced query syntax + * @param bool|null $advancedSyntax Enables the advanced query syntax. * * @return self */ @@ -2399,7 +2400,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query + * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. * * @return self */ @@ -2423,7 +2424,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion + * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. * * @return self */ @@ -2447,7 +2448,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word + * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. * * @return self */ @@ -2481,7 +2482,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion + * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. * * @return self */ @@ -2514,7 +2515,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled + * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. * * @return self */ @@ -2547,7 +2548,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct enables de-duplication or grouping of results + * @param int|null $distinct Enables de-duplication or grouping of results. * * @return self */ @@ -2579,7 +2580,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search + * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. * * @return self */ @@ -2603,7 +2604,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself + * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. * * @return self */ @@ -2627,7 +2628,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity precision of the proximity ranking criterion + * @param int|null $minProximity Precision of the proximity ranking criterion. * * @return self */ @@ -2712,7 +2713,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage + * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. * * @return self */ @@ -2749,9 +2750,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -2761,7 +2762,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -2790,7 +2791,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -2801,11 +2802,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -2836,3 +2836,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php b/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php index c8668a3daa..ad130c49c8 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchParamsString Class Doc Comment @@ -31,7 +31,7 @@ class SearchParamsString implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'params' => 'string', + 'params' => 'string' ]; /** @@ -42,7 +42,7 @@ class SearchParamsString implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'params' => null, + 'params' => null ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'params' => 'params', + 'params' => 'params' ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'params' => 'setParams', + 'params' => 'setParams' ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'params' => 'getParams', + 'params' => 'getParams' ]; /** @@ -134,6 +134,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -175,6 +176,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets params * @@ -188,7 +190,7 @@ public function getParams() /** * Sets params * - * @param string|null $params search parameters as URL-encoded query string + * @param string|null $params Search parameters as URL-encoded query string. * * @return self */ @@ -201,9 +203,9 @@ public function setParams($params) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -213,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -242,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -253,11 +255,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -288,3 +289,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchResponse.php index e333813ee1..f5adcaad07 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchResponse Class Doc Comment @@ -55,7 +55,7 @@ class SearchResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'queryAfterRemoval' => 'string', 'serverUsed' => 'string', 'userData' => 'object', - 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]', + 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]' ]; /** @@ -90,7 +90,7 @@ class SearchResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'queryAfterRemoval' => null, 'serverUsed' => null, 'userData' => null, - 'hits' => null, + 'hits' => null ]; /** @@ -144,7 +144,7 @@ public static function openAPIFormats() 'queryAfterRemoval' => 'queryAfterRemoval', 'serverUsed' => 'serverUsed', 'userData' => 'userData', - 'hits' => 'hits', + 'hits' => 'hits' ]; /** @@ -177,7 +177,7 @@ public static function openAPIFormats() 'queryAfterRemoval' => 'setQueryAfterRemoval', 'serverUsed' => 'setServerUsed', 'userData' => 'setUserData', - 'hits' => 'setHits', + 'hits' => 'setHits' ]; /** @@ -210,7 +210,7 @@ public static function openAPIFormats() 'queryAfterRemoval' => 'getQueryAfterRemoval', 'serverUsed' => 'getServerUsed', 'userData' => 'getUserData', - 'hits' => 'getHits', + 'hits' => 'getHits' ]; /** @@ -254,6 +254,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -305,7 +306,7 @@ public function listInvalidProperties() { $invalidProperties = []; - if (!is_null($this->container['aroundLatLng']) && !preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $this->container['aroundLatLng'])) { + if (!is_null($this->container['aroundLatLng']) && !preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $this->container['aroundLatLng'])) { $invalidProperties[] = "invalid value for 'aroundLatLng', must be conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."; } @@ -339,7 +340,6 @@ public function listInvalidProperties() if ($this->container['hits'] === null) { $invalidProperties[] = "'hits' can't be null"; } - return $invalidProperties; } @@ -354,6 +354,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets abTestID * @@ -367,7 +368,7 @@ public function getAbTestID() /** * Sets abTestID * - * @param int|null $abTestID if a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID + * @param int|null $abTestID If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID. * * @return self */ @@ -391,7 +392,7 @@ public function getAbTestVariantID() /** * Sets abTestVariantID * - * @param int|null $abTestVariantID if a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used + * @param int|null $abTestVariantID If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used. * * @return self */ @@ -415,14 +416,14 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng the computed geo location + * @param string|null $aroundLatLng The computed geo location. * * @return self */ public function setAroundLatLng($aroundLatLng) { - if (!is_null($aroundLatLng) && (!preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $aroundLatLng))) { + if (!is_null($aroundLatLng) && (!preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $aroundLatLng))) { throw new \InvalidArgumentException("invalid value for $aroundLatLng when calling SearchResponse., must conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."); } @@ -468,7 +469,7 @@ public function getExhaustiveFacetsCount() /** * Sets exhaustiveFacetsCount * - * @param bool|null $exhaustiveFacetsCount whether the facet count is exhaustive or approximate + * @param bool|null $exhaustiveFacetsCount Whether the facet count is exhaustive or approximate. * * @return self */ @@ -540,7 +541,7 @@ public function getFacets() /** * Sets facets * - * @param array>|null $facets a mapping of each facet name to the corresponding facet counts + * @param array>|null $facets A mapping of each facet name to the corresponding facet counts. * * @return self */ @@ -564,7 +565,7 @@ public function getFacetsStats() /** * Sets facetsStats * - * @param array|null $facetsStats statistics for numerical facets + * @param array|null $facetsStats Statistics for numerical facets. * * @return self */ @@ -588,7 +589,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int $hitsPerPage set the number of hits per page + * @param int $hitsPerPage Set the number of hits per page. * * @return self */ @@ -612,7 +613,7 @@ public function getIndex() /** * Sets index * - * @param string|null $index index name used for the query + * @param string|null $index Index name used for the query. * * @return self */ @@ -660,7 +661,7 @@ public function getMessage() /** * Sets message * - * @param string|null $message used to return warnings about the query + * @param string|null $message Used to return warnings about the query. * * @return self */ @@ -684,7 +685,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits number of hits that the search query matched + * @param int $nbHits Number of hits that the search query matched. * * @return self */ @@ -756,7 +757,7 @@ public function getPage() /** * Sets page * - * @param int $page specify the page to retrieve + * @param int $page Specify the page to retrieve. * * @return self */ @@ -780,7 +781,7 @@ public function getParams() /** * Sets params * - * @param string $params a url-encoded string of all search parameters + * @param string $params A url-encoded string of all search parameters. * * @return self */ @@ -804,7 +805,7 @@ public function getParsedQuery() /** * Sets parsedQuery * - * @param string|null $parsedQuery the query string that will be searched, after normalization + * @param string|null $parsedQuery The query string that will be searched, after normalization. * * @return self */ @@ -828,7 +829,7 @@ public function getProcessingTimeMS() /** * Sets processingTimeMS * - * @param int $processingTimeMS time the server took to process the request, in milliseconds + * @param int $processingTimeMS Time the server took to process the request, in milliseconds. * * @return self */ @@ -852,7 +853,7 @@ public function getQuery() /** * Sets query * - * @param string $query the text to search in the index + * @param string $query The text to search in the index. * * @return self */ @@ -876,7 +877,7 @@ public function getQueryAfterRemoval() /** * Sets queryAfterRemoval * - * @param string|null $queryAfterRemoval a markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set + * @param string|null $queryAfterRemoval A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. * * @return self */ @@ -900,7 +901,7 @@ public function getServerUsed() /** * Sets serverUsed * - * @param string|null $serverUsed actual host name of the server that processed the request + * @param string|null $serverUsed Actual host name of the server that processed the request. * * @return self */ @@ -924,7 +925,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData lets you store custom data in your indices + * @param object|null $userData Lets you store custom data in your indices. * * @return self */ @@ -961,9 +962,9 @@ public function setHits($hits) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -973,7 +974,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -1002,7 +1003,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -1013,11 +1014,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -1048,3 +1048,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php b/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php index e5e167f954..604d9db2ea 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchRulesParams Class Doc Comment * * @category Class * @description Parameters for the search. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -39,7 +38,7 @@ class SearchRulesParams implements ModelInterface, ArrayAccess, \JsonSerializabl 'page' => 'int', 'hitsPerPage' => 'int', 'enabled' => 'bool', - 'requestOptions' => 'object[]', + 'requestOptions' => 'object[]' ]; /** @@ -56,7 +55,7 @@ class SearchRulesParams implements ModelInterface, ArrayAccess, \JsonSerializabl 'page' => null, 'hitsPerPage' => null, 'enabled' => null, - 'requestOptions' => null, + 'requestOptions' => null ]; /** @@ -92,7 +91,7 @@ public static function openAPIFormats() 'page' => 'page', 'hitsPerPage' => 'hitsPerPage', 'enabled' => 'enabled', - 'requestOptions' => 'requestOptions', + 'requestOptions' => 'requestOptions' ]; /** @@ -107,7 +106,7 @@ public static function openAPIFormats() 'page' => 'setPage', 'hitsPerPage' => 'setHitsPerPage', 'enabled' => 'setEnabled', - 'requestOptions' => 'setRequestOptions', + 'requestOptions' => 'setRequestOptions' ]; /** @@ -122,7 +121,7 @@ public static function openAPIFormats() 'page' => 'getPage', 'hitsPerPage' => 'getHitsPerPage', 'enabled' => 'getEnabled', - 'requestOptions' => 'getRequestOptions', + 'requestOptions' => 'getRequestOptions' ]; /** @@ -166,6 +165,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -213,6 +213,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets query * @@ -226,7 +227,7 @@ public function getQuery() /** * Sets query * - * @param string|null $query full text query + * @param string|null $query Full text query. * * @return self */ @@ -274,7 +275,7 @@ public function getContext() /** * Sets context * - * @param string|null $context restricts matches to contextual rules with a specific context (exact match) + * @param string|null $context Restricts matches to contextual rules with a specific context (exact match). * * @return self */ @@ -298,7 +299,7 @@ public function getPage() /** * Sets page * - * @param int|null $page requested page (zero-based) + * @param int|null $page Requested page (zero-based). * * @return self */ @@ -370,7 +371,7 @@ public function getRequestOptions() /** * Sets requestOptions * - * @param object[]|null $requestOptions a mapping of requestOptions to send along with the request + * @param object[]|null $requestOptions A mapping of requestOptions to send along with the request. * * @return self */ @@ -383,9 +384,9 @@ public function setRequestOptions($requestOptions) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -395,7 +396,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -424,7 +425,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -435,11 +436,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -470,3 +470,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php index a77a76adcc..2bfe6387a8 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchRulesResponse Class Doc Comment @@ -34,7 +34,7 @@ class SearchRulesResponse implements ModelInterface, ArrayAccess, \JsonSerializa 'hits' => '\Algolia\AlgoliaSearch\Model\Rule[]', 'nbHits' => 'int', 'page' => 'int', - 'nbPages' => 'int', + 'nbPages' => 'int' ]; /** @@ -48,7 +48,7 @@ class SearchRulesResponse implements ModelInterface, ArrayAccess, \JsonSerializa 'hits' => null, 'nbHits' => null, 'page' => null, - 'nbPages' => null, + 'nbPages' => null ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() 'hits' => 'hits', 'nbHits' => 'nbHits', 'page' => 'page', - 'nbPages' => 'nbPages', + 'nbPages' => 'nbPages' ]; /** @@ -93,7 +93,7 @@ public static function openAPIFormats() 'hits' => 'setHits', 'nbHits' => 'setNbHits', 'page' => 'setPage', - 'nbPages' => 'setNbPages', + 'nbPages' => 'setNbPages' ]; /** @@ -105,7 +105,7 @@ public static function openAPIFormats() 'hits' => 'getHits', 'nbHits' => 'getNbHits', 'page' => 'getPage', - 'nbPages' => 'getNbPages', + 'nbPages' => 'getNbPages' ]; /** @@ -149,6 +149,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -191,7 +192,6 @@ public function listInvalidProperties() if ($this->container['nbPages'] === null) { $invalidProperties[] = "'nbPages' can't be null"; } - return $invalidProperties; } @@ -206,6 +206,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets hits * @@ -219,7 +220,7 @@ public function getHits() /** * Sets hits * - * @param \Algolia\AlgoliaSearch\Model\Rule[] $hits fetched rules + * @param \Algolia\AlgoliaSearch\Model\Rule[] $hits Fetched rules. * * @return self */ @@ -243,7 +244,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits number of fetched rules + * @param int $nbHits Number of fetched rules. * * @return self */ @@ -267,7 +268,7 @@ public function getPage() /** * Sets page * - * @param int $page current page + * @param int $page Current page. * * @return self */ @@ -291,7 +292,7 @@ public function getNbPages() /** * Sets nbPages * - * @param int $nbPages number of pages + * @param int $nbPages Number of pages. * * @return self */ @@ -304,9 +305,9 @@ public function setNbPages($nbPages) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -316,7 +317,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -345,7 +346,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -356,11 +357,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -391,3 +391,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php index 96ecbda0cc..95e04a6329 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchSynonymsResponse Class Doc Comment @@ -32,7 +32,7 @@ class SearchSynonymsResponse implements ModelInterface, ArrayAccess, \JsonSerial */ protected static $openAPITypes = [ 'hits' => '\Algolia\AlgoliaSearch\Model\SynonymHit[]', - 'nbHits' => 'int', + 'nbHits' => 'int' ]; /** @@ -44,7 +44,7 @@ class SearchSynonymsResponse implements ModelInterface, ArrayAccess, \JsonSerial */ protected static $openAPIFormats = [ 'hits' => null, - 'nbHits' => null, + 'nbHits' => null ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'hits' => 'hits', - 'nbHits' => 'nbHits', + 'nbHits' => 'nbHits' ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'hits' => 'setHits', - 'nbHits' => 'setNbHits', + 'nbHits' => 'setNbHits' ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'hits' => 'getHits', - 'nbHits' => 'getNbHits', + 'nbHits' => 'getNbHits' ]; /** @@ -139,6 +139,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -173,7 +174,6 @@ public function listInvalidProperties() if ($this->container['nbHits'] === null) { $invalidProperties[] = "'nbHits' can't be null"; } - return $invalidProperties; } @@ -188,6 +188,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets hits * @@ -201,7 +202,7 @@ public function getHits() /** * Sets hits * - * @param \Algolia\AlgoliaSearch\Model\SynonymHit[] $hits array of synonym objects + * @param \Algolia\AlgoliaSearch\Model\SynonymHit[] $hits Array of synonym objects. * * @return self */ @@ -225,7 +226,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits number of hits that the search query matched + * @param int $nbHits Number of hits that the search query matched. * * @return self */ @@ -238,9 +239,9 @@ public function setNbHits($nbHits) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -250,7 +251,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -279,7 +280,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -290,11 +291,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -325,3 +325,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php index e0d149cc8e..2db6a4eb66 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchUserIdsObject Class Doc Comment * * @category Class * @description OK - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -36,7 +35,7 @@ class SearchUserIdsObject implements ModelInterface, ArrayAccess, \JsonSerializa 'query' => 'string', 'clusterName' => 'string', 'page' => 'int', - 'hitsPerPage' => 'int', + 'hitsPerPage' => 'int' ]; /** @@ -50,7 +49,7 @@ class SearchUserIdsObject implements ModelInterface, ArrayAccess, \JsonSerializa 'query' => null, 'clusterName' => null, 'page' => null, - 'hitsPerPage' => null, + 'hitsPerPage' => null ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() 'query' => 'query', 'clusterName' => 'clusterName', 'page' => 'page', - 'hitsPerPage' => 'hitsPerPage', + 'hitsPerPage' => 'hitsPerPage' ]; /** @@ -95,7 +94,7 @@ public static function openAPIFormats() 'query' => 'setQuery', 'clusterName' => 'setClusterName', 'page' => 'setPage', - 'hitsPerPage' => 'setHitsPerPage', + 'hitsPerPage' => 'setHitsPerPage' ]; /** @@ -107,7 +106,7 @@ public static function openAPIFormats() 'query' => 'getQuery', 'clusterName' => 'getClusterName', 'page' => 'getPage', - 'hitsPerPage' => 'getHitsPerPage', + 'hitsPerPage' => 'getHitsPerPage' ]; /** @@ -151,6 +150,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -184,7 +184,6 @@ public function listInvalidProperties() if ($this->container['query'] === null) { $invalidProperties[] = "'query' can't be null"; } - return $invalidProperties; } @@ -199,6 +198,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets query * @@ -236,7 +236,7 @@ public function getClusterName() /** * Sets clusterName * - * @param string|null $clusterName name of the cluster + * @param string|null $clusterName Name of the cluster. * * @return self */ @@ -260,7 +260,7 @@ public function getPage() /** * Sets page * - * @param int|null $page specify the page to retrieve + * @param int|null $page Specify the page to retrieve. * * @return self */ @@ -284,7 +284,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage set the number of hits per page + * @param int|null $hitsPerPage Set the number of hits per page. * * @return self */ @@ -297,9 +297,9 @@ public function setHitsPerPage($hitsPerPage) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -309,7 +309,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -338,7 +338,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -349,11 +349,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -384,3 +383,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php index f70343d00e..3c0a3ddf23 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchUserIdsResponse Class Doc Comment * * @category Class * @description userIDs data. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -37,7 +36,7 @@ class SearchUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSeriali 'nbHits' => 'int', 'page' => 'int', 'hitsPerPage' => 'int', - 'updatedAt' => '\DateTime', + 'updatedAt' => '\DateTime' ]; /** @@ -52,7 +51,7 @@ class SearchUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSeriali 'nbHits' => null, 'page' => null, 'hitsPerPage' => null, - 'updatedAt' => 'date-time', + 'updatedAt' => 'date-time' ]; /** @@ -86,7 +85,7 @@ public static function openAPIFormats() 'nbHits' => 'nbHits', 'page' => 'page', 'hitsPerPage' => 'hitsPerPage', - 'updatedAt' => 'updatedAt', + 'updatedAt' => 'updatedAt' ]; /** @@ -99,7 +98,7 @@ public static function openAPIFormats() 'nbHits' => 'setNbHits', 'page' => 'setPage', 'hitsPerPage' => 'setHitsPerPage', - 'updatedAt' => 'setUpdatedAt', + 'updatedAt' => 'setUpdatedAt' ]; /** @@ -112,7 +111,7 @@ public static function openAPIFormats() 'nbHits' => 'getNbHits', 'page' => 'getPage', 'hitsPerPage' => 'getHitsPerPage', - 'updatedAt' => 'getUpdatedAt', + 'updatedAt' => 'getUpdatedAt' ]; /** @@ -156,6 +155,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -202,7 +202,6 @@ public function listInvalidProperties() if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } - return $invalidProperties; } @@ -217,6 +216,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets hits * @@ -230,7 +230,7 @@ public function getHits() /** * Sets hits * - * @param \Algolia\AlgoliaSearch\Model\SearchUserIdsResponseHits[] $hits list of user object matching the query + * @param \Algolia\AlgoliaSearch\Model\SearchUserIdsResponseHits[] $hits List of user object matching the query. * * @return self */ @@ -254,7 +254,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits number of hits that the search query matched + * @param int $nbHits Number of hits that the search query matched. * * @return self */ @@ -278,7 +278,7 @@ public function getPage() /** * Sets page * - * @param int $page specify the page to retrieve + * @param int $page Specify the page to retrieve. * * @return self */ @@ -326,7 +326,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt date of last update (ISO-8601 format) + * @param \DateTime $updatedAt Date of last update (ISO-8601 format). * * @return self */ @@ -339,9 +339,9 @@ public function setUpdatedAt($updatedAt) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -351,7 +351,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -380,7 +380,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -391,11 +391,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -426,3 +425,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php index 60367a5e5e..c51f5eb88d 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchUserIdsResponseHighlightResult Class Doc Comment @@ -32,7 +32,7 @@ class SearchUserIdsResponseHighlightResult implements ModelInterface, ArrayAcces */ protected static $openAPITypes = [ 'userID' => '\Algolia\AlgoliaSearch\Model\HighlightResult', - 'clusterName' => '\Algolia\AlgoliaSearch\Model\HighlightResult', + 'clusterName' => '\Algolia\AlgoliaSearch\Model\HighlightResult' ]; /** @@ -44,7 +44,7 @@ class SearchUserIdsResponseHighlightResult implements ModelInterface, ArrayAcces */ protected static $openAPIFormats = [ 'userID' => null, - 'clusterName' => null, + 'clusterName' => null ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'userID' => 'userID', - 'clusterName' => 'clusterName', + 'clusterName' => 'clusterName' ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'userID' => 'setUserID', - 'clusterName' => 'setClusterName', + 'clusterName' => 'setClusterName' ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'userID' => 'getUserID', - 'clusterName' => 'getClusterName', + 'clusterName' => 'getClusterName' ]; /** @@ -139,6 +139,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -173,7 +174,6 @@ public function listInvalidProperties() if ($this->container['clusterName'] === null) { $invalidProperties[] = "'clusterName' can't be null"; } - return $invalidProperties; } @@ -188,6 +188,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets userID * @@ -238,9 +239,9 @@ public function setClusterName($clusterName) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -250,7 +251,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -279,7 +280,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -290,11 +291,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -325,3 +325,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php index c95fc5ba92..66c19bf600 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchUserIdsResponseHits Class Doc Comment @@ -36,7 +36,7 @@ class SearchUserIdsResponseHits implements ModelInterface, ArrayAccess, \JsonSer 'nbRecords' => 'int', 'dataSize' => 'int', 'objectID' => 'string', - 'highlightResult' => '\Algolia\AlgoliaSearch\Model\SearchUserIdsResponseHighlightResult', + 'highlightResult' => '\Algolia\AlgoliaSearch\Model\SearchUserIdsResponseHighlightResult' ]; /** @@ -52,7 +52,7 @@ class SearchUserIdsResponseHits implements ModelInterface, ArrayAccess, \JsonSer 'nbRecords' => null, 'dataSize' => null, 'objectID' => null, - 'highlightResult' => null, + 'highlightResult' => null ]; /** @@ -87,7 +87,7 @@ public static function openAPIFormats() 'nbRecords' => 'nbRecords', 'dataSize' => 'dataSize', 'objectID' => 'objectID', - 'highlightResult' => '_highlightResult', + 'highlightResult' => '_highlightResult' ]; /** @@ -101,7 +101,7 @@ public static function openAPIFormats() 'nbRecords' => 'setNbRecords', 'dataSize' => 'setDataSize', 'objectID' => 'setObjectID', - 'highlightResult' => 'setHighlightResult', + 'highlightResult' => 'setHighlightResult' ]; /** @@ -115,7 +115,7 @@ public static function openAPIFormats() 'nbRecords' => 'getNbRecords', 'dataSize' => 'getDataSize', 'objectID' => 'getObjectID', - 'highlightResult' => 'getHighlightResult', + 'highlightResult' => 'getHighlightResult' ]; /** @@ -159,6 +159,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -209,7 +210,6 @@ public function listInvalidProperties() if ($this->container['highlightResult'] === null) { $invalidProperties[] = "'highlightResult' can't be null"; } - return $invalidProperties; } @@ -224,6 +224,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets userID * @@ -261,7 +262,7 @@ public function getClusterName() /** * Sets clusterName * - * @param string $clusterName name of the cluster + * @param string $clusterName Name of the cluster. * * @return self */ @@ -285,7 +286,7 @@ public function getNbRecords() /** * Sets nbRecords * - * @param int $nbRecords number of records in the cluster + * @param int $nbRecords Number of records in the cluster. * * @return self */ @@ -309,7 +310,7 @@ public function getDataSize() /** * Sets dataSize * - * @param int $dataSize data size taken by all the users assigned to the cluster + * @param int $dataSize Data size taken by all the users assigned to the cluster. * * @return self */ @@ -370,9 +371,9 @@ public function setHighlightResult($highlightResult) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -382,7 +383,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -411,7 +412,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -422,11 +423,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -457,3 +457,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SnippetResult.php b/clients/algoliasearch-client-php/lib/Model/SnippetResult.php index a53c369440..a508bd46e3 100644 --- a/clients/algoliasearch-client-php/lib/Model/SnippetResult.php +++ b/clients/algoliasearch-client-php/lib/Model/SnippetResult.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SnippetResult Class Doc Comment @@ -32,7 +32,7 @@ class SnippetResult implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'value' => 'string', - 'matchLevel' => 'string', + 'matchLevel' => 'string' ]; /** @@ -44,7 +44,7 @@ class SnippetResult implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'value' => null, - 'matchLevel' => null, + 'matchLevel' => null ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'value' => 'value', - 'matchLevel' => 'matchLevel', + 'matchLevel' => 'matchLevel' ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'value' => 'setValue', - 'matchLevel' => 'setMatchLevel', + 'matchLevel' => 'setMatchLevel' ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'value' => 'getValue', - 'matchLevel' => 'getMatchLevel', + 'matchLevel' => 'getMatchLevel' ]; /** @@ -208,6 +208,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets value * @@ -221,7 +222,7 @@ public function getValue() /** * Sets value * - * @param string|null $value markup text with occurrences highlighted + * @param string|null $value Markup text with occurrences highlighted. * * @return self */ @@ -245,7 +246,7 @@ public function getMatchLevel() /** * Sets matchLevel * - * @param string|null $matchLevel indicates how well the attribute matched the search query + * @param string|null $matchLevel Indicates how well the attribute matched the search query. * * @return self */ @@ -268,9 +269,9 @@ public function setMatchLevel($matchLevel) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -280,7 +281,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -309,7 +310,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -320,11 +321,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -355,3 +355,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/Source.php b/clients/algoliasearch-client-php/lib/Model/Source.php index a366214e5c..f78c6ba8fe 100644 --- a/clients/algoliasearch-client-php/lib/Model/Source.php +++ b/clients/algoliasearch-client-php/lib/Model/Source.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * Source Class Doc Comment * * @category Class * @description The source. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +33,7 @@ class Source implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'source' => 'string', - 'description' => 'string', + 'description' => 'string' ]; /** @@ -46,7 +45,7 @@ class Source implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'source' => null, - 'description' => null, + 'description' => null ]; /** @@ -77,7 +76,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'source' => 'source', - 'description' => 'description', + 'description' => 'description' ]; /** @@ -87,7 +86,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'source' => 'setSource', - 'description' => 'setDescription', + 'description' => 'setDescription' ]; /** @@ -97,7 +96,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'source' => 'getSource', - 'description' => 'getDescription', + 'description' => 'getDescription' ]; /** @@ -141,6 +140,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -172,7 +172,6 @@ public function listInvalidProperties() if ($this->container['source'] === null) { $invalidProperties[] = "'source' can't be null"; } - return $invalidProperties; } @@ -187,6 +186,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets source * @@ -200,7 +200,7 @@ public function getSource() /** * Sets source * - * @param string $source the IP range of the source + * @param string $source The IP range of the source. * * @return self */ @@ -224,7 +224,7 @@ public function getDescription() /** * Sets description * - * @param string|null $description the description of the source + * @param string|null $description The description of the source. * * @return self */ @@ -237,9 +237,9 @@ public function setDescription($description) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -249,7 +249,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -278,7 +278,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -289,11 +289,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -324,3 +323,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/StandardEntries.php b/clients/algoliasearch-client-php/lib/Model/StandardEntries.php index a4725918f6..88e8918f9f 100644 --- a/clients/algoliasearch-client-php/lib/Model/StandardEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/StandardEntries.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * StandardEntries Class Doc Comment * * @category Class * @description Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +34,7 @@ class StandardEntries implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'plurals' => 'array', 'stopwords' => 'array', - 'compounds' => 'array', + 'compounds' => 'array' ]; /** @@ -48,7 +47,7 @@ class StandardEntries implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'plurals' => null, 'stopwords' => null, - 'compounds' => null, + 'compounds' => null ]; /** @@ -80,7 +79,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'plurals' => 'plurals', 'stopwords' => 'stopwords', - 'compounds' => 'compounds', + 'compounds' => 'compounds' ]; /** @@ -91,7 +90,7 @@ public static function openAPIFormats() protected static $setters = [ 'plurals' => 'setPlurals', 'stopwords' => 'setStopwords', - 'compounds' => 'setCompounds', + 'compounds' => 'setCompounds' ]; /** @@ -102,7 +101,7 @@ public static function openAPIFormats() protected static $getters = [ 'plurals' => 'getPlurals', 'stopwords' => 'getStopwords', - 'compounds' => 'getCompounds', + 'compounds' => 'getCompounds' ]; /** @@ -146,6 +145,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -189,6 +189,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets plurals * @@ -202,7 +203,7 @@ public function getPlurals() /** * Sets plurals * - * @param array|null $plurals language ISO code + * @param array|null $plurals Language ISO code. * * @return self */ @@ -226,7 +227,7 @@ public function getStopwords() /** * Sets stopwords * - * @param array|null $stopwords language ISO code + * @param array|null $stopwords Language ISO code. * * @return self */ @@ -250,7 +251,7 @@ public function getCompounds() /** * Sets compounds * - * @param array|null $compounds language ISO code + * @param array|null $compounds Language ISO code. * * @return self */ @@ -263,9 +264,9 @@ public function setCompounds($compounds) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -275,7 +276,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -304,7 +305,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -315,11 +316,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -350,3 +350,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SynonymHit.php b/clients/algoliasearch-client-php/lib/Model/SynonymHit.php index dddf6bc20c..cab013367c 100644 --- a/clients/algoliasearch-client-php/lib/Model/SynonymHit.php +++ b/clients/algoliasearch-client-php/lib/Model/SynonymHit.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SynonymHit Class Doc Comment * * @category Class * @description Synonym object. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -41,7 +40,7 @@ class SynonymHit implements ModelInterface, ArrayAccess, \JsonSerializable 'corrections' => 'string[]', 'placeholder' => 'string', 'replacements' => 'string[]', - 'highlightResult' => '\Algolia\AlgoliaSearch\Model\SynonymHitHighlightResult', + 'highlightResult' => '\Algolia\AlgoliaSearch\Model\SynonymHitHighlightResult' ]; /** @@ -60,7 +59,7 @@ class SynonymHit implements ModelInterface, ArrayAccess, \JsonSerializable 'corrections' => null, 'placeholder' => null, 'replacements' => null, - 'highlightResult' => null, + 'highlightResult' => null ]; /** @@ -98,7 +97,7 @@ public static function openAPIFormats() 'corrections' => 'corrections', 'placeholder' => 'placeholder', 'replacements' => 'replacements', - 'highlightResult' => '_highlightResult', + 'highlightResult' => '_highlightResult' ]; /** @@ -115,7 +114,7 @@ public static function openAPIFormats() 'corrections' => 'setCorrections', 'placeholder' => 'setPlaceholder', 'replacements' => 'setReplacements', - 'highlightResult' => 'setHighlightResult', + 'highlightResult' => 'setHighlightResult' ]; /** @@ -132,7 +131,7 @@ public static function openAPIFormats() 'corrections' => 'getCorrections', 'placeholder' => 'getPlaceholder', 'replacements' => 'getReplacements', - 'highlightResult' => 'getHighlightResult', + 'highlightResult' => 'getHighlightResult' ]; /** @@ -262,6 +261,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets objectID * @@ -275,7 +275,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID unique identifier of the synonym object to be created or updated + * @param string $objectID Unique identifier of the synonym object to be created or updated. * * @return self */ @@ -299,7 +299,7 @@ public function getType() /** * Sets type * - * @param string $type type of the synonym object + * @param string $type Type of the synonym object. * * @return self */ @@ -333,7 +333,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param string[]|null $synonyms words or phrases to be considered equivalent + * @param string[]|null $synonyms Words or phrases to be considered equivalent. * * @return self */ @@ -357,7 +357,7 @@ public function getInput() /** * Sets input * - * @param string|null $input word or phrase to appear in query strings (for onewaysynonym) + * @param string|null $input Word or phrase to appear in query strings (for onewaysynonym). * * @return self */ @@ -381,7 +381,7 @@ public function getWord() /** * Sets word * - * @param string|null $word word or phrase to appear in query strings (for altcorrection1 and altcorrection2) + * @param string|null $word Word or phrase to appear in query strings (for altcorrection1 and altcorrection2). * * @return self */ @@ -405,7 +405,7 @@ public function getCorrections() /** * Sets corrections * - * @param string[]|null $corrections words to be matched in records + * @param string[]|null $corrections Words to be matched in records. * * @return self */ @@ -429,7 +429,7 @@ public function getPlaceholder() /** * Sets placeholder * - * @param string|null $placeholder token to be put inside records + * @param string|null $placeholder Token to be put inside records. * * @return self */ @@ -453,7 +453,7 @@ public function getReplacements() /** * Sets replacements * - * @param string[]|null $replacements list of query words that will match the token + * @param string[]|null $replacements List of query words that will match the token. * * @return self */ @@ -490,9 +490,9 @@ public function setHighlightResult($highlightResult) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -502,7 +502,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -531,7 +531,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -542,11 +542,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -577,3 +576,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php b/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php index a87187c8ed..5fc7fac8f2 100644 --- a/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php +++ b/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * SynonymHitHighlightResult Class Doc Comment * * @category Class * @description Highlighted results - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +33,7 @@ class SynonymHitHighlightResult implements ModelInterface, ArrayAccess, \JsonSer */ protected static $openAPITypes = [ 'type' => '\Algolia\AlgoliaSearch\Model\HighlightResult', - 'synonyms' => '\Algolia\AlgoliaSearch\Model\HighlightResult[]', + 'synonyms' => '\Algolia\AlgoliaSearch\Model\HighlightResult[]' ]; /** @@ -46,7 +45,7 @@ class SynonymHitHighlightResult implements ModelInterface, ArrayAccess, \JsonSer */ protected static $openAPIFormats = [ 'type' => null, - 'synonyms' => null, + 'synonyms' => null ]; /** @@ -77,7 +76,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'type' => 'type', - 'synonyms' => 'synonyms', + 'synonyms' => 'synonyms' ]; /** @@ -87,7 +86,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'type' => 'setType', - 'synonyms' => 'setSynonyms', + 'synonyms' => 'setSynonyms' ]; /** @@ -97,7 +96,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'type' => 'getType', - 'synonyms' => 'getSynonyms', + 'synonyms' => 'getSynonyms' ]; /** @@ -141,6 +140,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -183,6 +183,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets type * @@ -233,9 +234,9 @@ public function setSynonyms($synonyms) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -245,7 +246,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -274,7 +275,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -285,11 +286,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -320,3 +320,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/TimeRange.php b/clients/algoliasearch-client-php/lib/Model/TimeRange.php index ed041ae6c9..d9b5b8ff4d 100644 --- a/clients/algoliasearch-client-php/lib/Model/TimeRange.php +++ b/clients/algoliasearch-client-php/lib/Model/TimeRange.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * TimeRange Class Doc Comment @@ -32,7 +32,7 @@ class TimeRange implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'from' => 'int', - 'until' => 'int', + 'until' => 'int' ]; /** @@ -44,7 +44,7 @@ class TimeRange implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'from' => null, - 'until' => null, + 'until' => null ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'from' => 'from', - 'until' => 'until', + 'until' => 'until' ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'from' => 'setFrom', - 'until' => 'setUntil', + 'until' => 'setUntil' ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'from' => 'getFrom', - 'until' => 'getUntil', + 'until' => 'getUntil' ]; /** @@ -139,6 +139,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -173,7 +174,6 @@ public function listInvalidProperties() if ($this->container['until'] === null) { $invalidProperties[] = "'until' can't be null"; } - return $invalidProperties; } @@ -188,6 +188,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets from * @@ -201,7 +202,7 @@ public function getFrom() /** * Sets from * - * @param int $from lower bound of the time range (Unix timestamp) + * @param int $from Lower bound of the time range (Unix timestamp). * * @return self */ @@ -225,7 +226,7 @@ public function getUntil() /** * Sets until * - * @param int $until upper bound of the time range (Unix timestamp) + * @param int $until Upper bound of the time range (Unix timestamp). * * @return self */ @@ -238,9 +239,9 @@ public function setUntil($until) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -250,7 +251,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -279,7 +280,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -290,11 +291,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -325,3 +325,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php index e5cf8339e9..9030ab6488 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * UpdateApiKeyResponse Class Doc Comment @@ -32,7 +32,7 @@ class UpdateApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializ */ protected static $openAPITypes = [ 'key' => 'string', - 'updatedAt' => '\DateTime', + 'updatedAt' => '\DateTime' ]; /** @@ -44,7 +44,7 @@ class UpdateApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializ */ protected static $openAPIFormats = [ 'key' => null, - 'updatedAt' => 'date-time', + 'updatedAt' => 'date-time' ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'key' => 'key', - 'updatedAt' => 'updatedAt', + 'updatedAt' => 'updatedAt' ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'key' => 'setKey', - 'updatedAt' => 'setUpdatedAt', + 'updatedAt' => 'setUpdatedAt' ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'key' => 'getKey', - 'updatedAt' => 'getUpdatedAt', + 'updatedAt' => 'getUpdatedAt' ]; /** @@ -139,6 +139,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -173,7 +174,6 @@ public function listInvalidProperties() if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } - return $invalidProperties; } @@ -188,6 +188,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets key * @@ -201,7 +202,7 @@ public function getKey() /** * Sets key * - * @param string $key key string + * @param string $key Key string. * * @return self */ @@ -225,7 +226,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt date of last update (ISO-8601 format) + * @param \DateTime $updatedAt Date of last update (ISO-8601 format). * * @return self */ @@ -238,9 +239,9 @@ public function setUpdatedAt($updatedAt) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -250,7 +251,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -279,7 +280,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -290,11 +291,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -325,3 +325,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php index 00ac404481..cc85dcb1ac 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * UpdatedAtResponse Class Doc Comment * * @category Class * @description The response with a taskID and an updatedAt timestamp. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +33,7 @@ class UpdatedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPITypes = [ 'taskID' => 'int', - 'updatedAt' => '\DateTime', + 'updatedAt' => '\DateTime' ]; /** @@ -46,7 +45,7 @@ class UpdatedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPIFormats = [ 'taskID' => null, - 'updatedAt' => 'date-time', + 'updatedAt' => 'date-time' ]; /** @@ -77,7 +76,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'taskID' => 'taskID', - 'updatedAt' => 'updatedAt', + 'updatedAt' => 'updatedAt' ]; /** @@ -87,7 +86,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'taskID' => 'setTaskID', - 'updatedAt' => 'setUpdatedAt', + 'updatedAt' => 'setUpdatedAt' ]; /** @@ -97,7 +96,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'taskID' => 'getTaskID', - 'updatedAt' => 'getUpdatedAt', + 'updatedAt' => 'getUpdatedAt' ]; /** @@ -141,6 +140,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -175,7 +175,6 @@ public function listInvalidProperties() if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } - return $invalidProperties; } @@ -190,6 +189,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets taskID * @@ -203,7 +203,7 @@ public function getTaskID() /** * Sets taskID * - * @param int $taskID taskID of the indexing task to wait for + * @param int $taskID taskID of the indexing task to wait for. * * @return self */ @@ -227,7 +227,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt date of last update (ISO-8601 format) + * @param \DateTime $updatedAt Date of last update (ISO-8601 format). * * @return self */ @@ -240,9 +240,9 @@ public function setUpdatedAt($updatedAt) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -252,7 +252,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -281,7 +281,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -292,11 +292,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -327,3 +326,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php index c5c6a6920d..49fafad1cf 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * UpdatedAtWithObjectIdResponse Class Doc Comment * * @category Class * @description The response with a taskID, an objectID and an updatedAt timestamp. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +34,7 @@ class UpdatedAtWithObjectIdResponse implements ModelInterface, ArrayAccess, \Jso protected static $openAPITypes = [ 'taskID' => 'int', 'updatedAt' => '\DateTime', - 'objectID' => 'string', + 'objectID' => 'string' ]; /** @@ -48,7 +47,7 @@ class UpdatedAtWithObjectIdResponse implements ModelInterface, ArrayAccess, \Jso protected static $openAPIFormats = [ 'taskID' => null, 'updatedAt' => 'date-time', - 'objectID' => null, + 'objectID' => null ]; /** @@ -80,7 +79,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'taskID' => 'taskID', 'updatedAt' => 'updatedAt', - 'objectID' => 'objectID', + 'objectID' => 'objectID' ]; /** @@ -91,7 +90,7 @@ public static function openAPIFormats() protected static $setters = [ 'taskID' => 'setTaskID', 'updatedAt' => 'setUpdatedAt', - 'objectID' => 'setObjectID', + 'objectID' => 'setObjectID' ]; /** @@ -102,7 +101,7 @@ public static function openAPIFormats() protected static $getters = [ 'taskID' => 'getTaskID', 'updatedAt' => 'getUpdatedAt', - 'objectID' => 'getObjectID', + 'objectID' => 'getObjectID' ]; /** @@ -146,6 +145,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -189,6 +189,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets taskID * @@ -202,7 +203,7 @@ public function getTaskID() /** * Sets taskID * - * @param int|null $taskID taskID of the indexing task to wait for + * @param int|null $taskID taskID of the indexing task to wait for. * * @return self */ @@ -226,7 +227,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime|null $updatedAt date of last update (ISO-8601 format) + * @param \DateTime|null $updatedAt Date of last update (ISO-8601 format). * * @return self */ @@ -250,7 +251,7 @@ public function getObjectID() /** * Sets objectID * - * @param string|null $objectID unique identifier of the object + * @param string|null $objectID Unique identifier of the object. * * @return self */ @@ -263,9 +264,9 @@ public function setObjectID($objectID) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -275,7 +276,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -304,7 +305,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -315,11 +316,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -350,3 +350,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php index 176d87e459..2cc041c7a4 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * UpdatedRuleResponse Class Doc Comment @@ -33,7 +33,7 @@ class UpdatedRuleResponse implements ModelInterface, ArrayAccess, \JsonSerializa protected static $openAPITypes = [ 'objectID' => 'string', 'updatedAt' => '\DateTime', - 'taskID' => 'int', + 'taskID' => 'int' ]; /** @@ -46,7 +46,7 @@ class UpdatedRuleResponse implements ModelInterface, ArrayAccess, \JsonSerializa protected static $openAPIFormats = [ 'objectID' => null, 'updatedAt' => 'date-time', - 'taskID' => null, + 'taskID' => null ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'objectID' => 'objectID', 'updatedAt' => 'updatedAt', - 'taskID' => 'taskID', + 'taskID' => 'taskID' ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'objectID' => 'setObjectID', 'updatedAt' => 'setUpdatedAt', - 'taskID' => 'setTaskID', + 'taskID' => 'setTaskID' ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'objectID' => 'getObjectID', 'updatedAt' => 'getUpdatedAt', - 'taskID' => 'getTaskID', + 'taskID' => 'getTaskID' ]; /** @@ -144,6 +144,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -182,7 +183,6 @@ public function listInvalidProperties() if ($this->container['taskID'] === null) { $invalidProperties[] = "'taskID' can't be null"; } - return $invalidProperties; } @@ -197,6 +197,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets objectID * @@ -210,7 +211,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID unique identifier of the object + * @param string $objectID Unique identifier of the object. * * @return self */ @@ -234,7 +235,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt date of last update (ISO-8601 format) + * @param \DateTime $updatedAt Date of last update (ISO-8601 format). * * @return self */ @@ -258,7 +259,7 @@ public function getTaskID() /** * Sets taskID * - * @param int $taskID taskID of the indexing task to wait for + * @param int $taskID taskID of the indexing task to wait for. * * @return self */ @@ -271,9 +272,9 @@ public function setTaskID($taskID) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -283,7 +284,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -312,7 +313,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -323,11 +324,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -358,3 +358,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/Model/UserId.php b/clients/algoliasearch-client-php/lib/Model/UserId.php index 575f4b4548..84d828f010 100644 --- a/clients/algoliasearch-client-php/lib/Model/UserId.php +++ b/clients/algoliasearch-client-php/lib/Model/UserId.php @@ -2,15 +2,14 @@ namespace Algolia\AlgoliaSearch\Model; -use \Algolia\AlgoliaSearch\ObjectSerializer; use \ArrayAccess; +use \Algolia\AlgoliaSearch\ObjectSerializer; /** * UserId Class Doc Comment * * @category Class * @description A userID. - * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -36,7 +35,7 @@ class UserId implements ModelInterface, ArrayAccess, \JsonSerializable 'userID' => 'string', 'clusterName' => 'string', 'nbRecords' => 'int', - 'dataSize' => 'int', + 'dataSize' => 'int' ]; /** @@ -50,7 +49,7 @@ class UserId implements ModelInterface, ArrayAccess, \JsonSerializable 'userID' => null, 'clusterName' => null, 'nbRecords' => null, - 'dataSize' => null, + 'dataSize' => null ]; /** @@ -83,7 +82,7 @@ public static function openAPIFormats() 'userID' => 'userID', 'clusterName' => 'clusterName', 'nbRecords' => 'nbRecords', - 'dataSize' => 'dataSize', + 'dataSize' => 'dataSize' ]; /** @@ -95,7 +94,7 @@ public static function openAPIFormats() 'userID' => 'setUserID', 'clusterName' => 'setClusterName', 'nbRecords' => 'setNbRecords', - 'dataSize' => 'setDataSize', + 'dataSize' => 'setDataSize' ]; /** @@ -107,7 +106,7 @@ public static function openAPIFormats() 'userID' => 'getUserID', 'clusterName' => 'getClusterName', 'nbRecords' => 'getNbRecords', - 'dataSize' => 'getDataSize', + 'dataSize' => 'getDataSize' ]; /** @@ -151,6 +150,7 @@ public function getModelName() return self::$openAPIModelName; } + /** * Associative array for storing property values * @@ -193,7 +193,6 @@ public function listInvalidProperties() if ($this->container['dataSize'] === null) { $invalidProperties[] = "'dataSize' can't be null"; } - return $invalidProperties; } @@ -208,6 +207,7 @@ public function valid() return count($this->listInvalidProperties()) === 0; } + /** * Gets userID * @@ -221,7 +221,7 @@ public function getUserID() /** * Sets userID * - * @param string $userID userID of the user + * @param string $userID userID of the user. * * @return self */ @@ -245,7 +245,7 @@ public function getClusterName() /** * Sets clusterName * - * @param string $clusterName cluster on which the user is assigned + * @param string $clusterName Cluster on which the user is assigned. * * @return self */ @@ -269,7 +269,7 @@ public function getNbRecords() /** * Sets nbRecords * - * @param int $nbRecords number of records belonging to the user + * @param int $nbRecords Number of records belonging to the user. * * @return self */ @@ -293,7 +293,7 @@ public function getDataSize() /** * Sets dataSize * - * @param int $dataSize data size used by the user + * @param int $dataSize Data size used by the user. * * @return self */ @@ -306,9 +306,9 @@ public function setDataSize($dataSize) /** * Returns true if offset exists. False otherwise. * - * @param int $offset Offset + * @param integer $offset Offset * - * @return bool + * @return boolean */ public function offsetExists($offset) { @@ -318,7 +318,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return mixed|null */ @@ -347,7 +347,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param int $offset Offset + * @param integer $offset Offset * * @return void */ @@ -358,11 +358,10 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). - * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource + * @return mixed Returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource. */ public function jsonSerialize() { @@ -393,3 +392,4 @@ public function toHeaderValue() } } + diff --git a/clients/algoliasearch-client-php/lib/ObjectSerializer.php b/clients/algoliasearch-client-php/lib/ObjectSerializer.php index 485916ff41..25900ca3fa 100644 --- a/clients/algoliasearch-client-php/lib/ObjectSerializer.php +++ b/clients/algoliasearch-client-php/lib/ObjectSerializer.php @@ -48,7 +48,6 @@ public static function sanitizeForSerialization($data, $type = null, $format = n foreach ($data as $property => $value) { $data[$property] = self::sanitizeForSerialization($value); } - return $data; } @@ -66,7 +65,6 @@ public static function sanitizeForSerialization($data, $type = null, $format = n $allowedEnumTypes = $callable(); if (!in_array($value, $allowedEnumTypes, true)) { $imploded = implode("', '", $allowedEnumTypes); - throw new \InvalidArgumentException("Invalid value for enum '$openAPIType', must be one of: '$imploded'"); } } @@ -80,12 +78,10 @@ public static function sanitizeForSerialization($data, $type = null, $format = n $values[$property] = self::sanitizeForSerialization($value); } } - - return (object) $values; + return (object)$values; + } else { + return (string)$data; } - - return (string) $data; - } /** @@ -100,10 +96,9 @@ public static function sanitizeFilename($filename) { if (preg_match("/.*[\/\\\\](.*)$/", $filename, $match)) { return $match[1]; - } - + } else { return $filename; - + } } /** @@ -133,10 +128,9 @@ public static function toQueryValue($object) { if (is_array($object)) { return implode(',', $object); - } - + } else { return self::toString($object); - + } } /** @@ -171,10 +165,9 @@ public static function toFormValue($value) { if ($value instanceof \SplFileObject) { return $value->getRealPath(); - } - + } else { return self::toString($value); - + } } /** @@ -193,10 +186,9 @@ public static function toString($value) return $value->format(self::$dateTimeFormat); } elseif (is_bool($value)) { return $value ? 'true' : 'false'; - } - + } else { return $value; - + } } /** @@ -252,45 +244,41 @@ public static function deserialize($data, $class, $httpHeaders = null) return null; } - if (strcasecmp(mb_substr($class, -2), '[]') === 0) { + if (strcasecmp(substr($class, -2), '[]') === 0) { $data = is_string($data) ? json_decode($data) : $data; if (!is_array($data)) { throw new \InvalidArgumentException("Invalid array '$class'"); } - $subClass = mb_substr($class, 0, -2); + $subClass = substr($class, 0, -2); $values = []; foreach ($data as $key => $value) { $values[] = self::deserialize($value, $subClass, null); } - return $values; } if (preg_match('/^(array<|map\[)/', $class)) { // for associative array e.g. array $data = is_string($data) ? json_decode($data) : $data; settype($data, 'array'); - $inner = mb_substr($class, 4, -1); + $inner = substr($class, 4, -1); $deserialized = []; - if (mb_strrpos($inner, ',') !== false) { + if (strrpos($inner, ",") !== false) { $subClass_array = explode(',', $inner, 2); $subClass = $subClass_array[1]; foreach ($data as $key => $value) { $deserialized[$key] = self::deserialize($value, $subClass, null); } } - return $deserialized; } if ($class === 'object') { settype($data, 'array'); - return $data; - } elseif ($class === 'mixed') { + } else if ($class === 'mixed') { settype($data, gettype($data)); - return $data; } @@ -319,7 +307,6 @@ public static function deserialize($data, $class, $httpHeaders = null) /** @psalm-suppress ParadoxicalCondition */ if (in_array($class, ['\DateTime', '\SplFileObject', 'array', 'bool', 'boolean', 'byte', 'double', 'float', 'int', 'integer', 'mixed', 'number', 'object', 'string', 'void'], true)) { settype($data, $class); - return $data; } @@ -344,12 +331,10 @@ public static function deserialize($data, $class, $httpHeaders = null) } elseif (method_exists($class, 'getAllowableEnumValues')) { if (!in_array($data, $class::getAllowableEnumValues(), true)) { $imploded = implode("', '", $class::getAllowableEnumValues()); - throw new \InvalidArgumentException("Invalid value for enum '$class', must be one of: '$imploded'"); } - return $data; - } + } else { $data = is_string($data) ? json_decode($data) : $data; // If a discriminator is defined and points to a valid subclass, use it. $discriminator = $class::DISCRIMINATOR; @@ -374,8 +359,7 @@ public static function deserialize($data, $class, $httpHeaders = null) $instance->$propertySetter(self::deserialize($propertyValue, $type, null)); } } - return $instance; - + } } } diff --git a/scripts/post-gen/php.sh b/scripts/post-gen/php.sh new file mode 100755 index 0000000000..ff8091be79 --- /dev/null +++ b/scripts/post-gen/php.sh @@ -0,0 +1,17 @@ +#!/bin/bash + +export GENERATOR=$1 +export CLIENT=$(cat openapitools.json | jq -r --arg generator "$GENERATOR" '."generator-cli".generators[$generator].output' | sed 's/#{cwd}\///g') + +lint_client() { + set +e + + echo "> Linting ${GENERATOR}..." + cd $CLIENT + composer install + php vendor/bin/php-cs-fixer fix lib/ -v --using-cache=no --allow-risky=yes + + set -e +} + +lint_client From ec1e3e3b35d0ac71ea94288da56c0147b33e8ca0 Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Wed, 12 Jan 2022 17:05:21 +0100 Subject: [PATCH 03/13] chore: add php workflow --- .github/actions/cache/action.yml | 7 +++++++ .github/actions/setup/action.yml | 10 +++++++++- .github/workflows/check.yml | 30 ++++++++++++++++++++++++++++++ 3 files changed, 46 insertions(+), 1 deletion(-) diff --git a/.github/actions/cache/action.yml b/.github/actions/cache/action.yml index 1d4c85e8f7..b580a3fc80 100644 --- a/.github/actions/cache/action.yml +++ b/.github/actions/cache/action.yml @@ -60,6 +60,13 @@ runs: path: /home/runner/work/api-clients-automation/api-clients-automation/clients/algoliasearch-client-java-2/target key: ${{ runner.os }}-java-client-${{ hashFiles('clients/algoliasearch-client-java-2/**') }} + - name: Restore built PHP search client + if: ${{ inputs.job == 'cts' }} + uses: actions/cache@v2 + with: + path: /home/runner/work/api-clients-automation/api-clients-automation/clients/algoliasearch-client-php/dist + key: ${{ runner.os }}-java-client-${{ hashFiles('clients/algoliasearch-client-php/**') }} + # setup yarn - name: Get yarn cache directory path shell: bash diff --git a/.github/actions/setup/action.yml b/.github/actions/setup/action.yml index fd7dd5a0bf..a619f39ba9 100644 --- a/.github/actions/setup/action.yml +++ b/.github/actions/setup/action.yml @@ -53,6 +53,9 @@ runs: echo "::set-output name=JAVA_CLIENT_CHANGED::$(git diff --shortstat origin/${{ github.base_ref }}..HEAD -- clients/algoliasearch-client-java-2 | wc -l)" echo "::set-output name=JAVA_TEMPLATE_CHANGED::$(git diff --shortstat origin/${{ github.base_ref }}..HEAD -- templates/java | wc -l)" + echo "::set-output name=PHP_CLIENT_CHANGED::$(git diff --shortstat origin/${{ github.base_ref }}..HEAD -- clients/algoliasearch-client-php | wc -l)" + echo "::set-output name=PHP_TEMPLATE_CHANGED::$(git diff --shortstat origin/${{ github.base_ref }}..HEAD -- templates/php | wc -l)" + outputs: # specs variables RUN_SPECS_SEARCH: @@ -102,7 +105,12 @@ outputs: description: Determine if the `client_java_*` job should run value: ${{ github.ref == 'refs/heads/main' || steps.diff.outputs.GITHUB_ACTIONS_CHANGED > 0 || steps.diff.outputs.COMMON_SPECS_CHANGED > 0 || steps.diff.outputs.SEARCH_SPECS_CHANGED > 0 || steps.diff.outputs.SCRIPTS_CHANGED > 0 || steps.diff.outputs.JAVA_CLIENT_CHANGED > 0 || steps.diff.outputs.JAVA_TEMPLATE_CHANGED > 0 }} + # php client variables + RUN_PHP_CLIENT_SEARCH: + description: Determine if the `client_php_*` job should run + value: ${{ github.ref == 'refs/heads/main' || steps.diff.outputs.GITHUB_ACTIONS_CHANGED > 0 || steps.diff.outputs.COMMON_SPECS_CHANGED > 0 || steps.diff.outputs.SEARCH_SPECS_CHANGED > 0 || steps.diff.outputs.SCRIPTS_CHANGED > 0 || steps.diff.outputs.PHP_CLIENT_CHANGED > 0 || steps.diff.outputs.PHP_TEMPLATE_CHANGED > 0 }} + # cts variables RUN_CTS: description: Determine if the `cts` job should run - value: ${{ github.ref_name == 'main' || steps.diff.outputs.GITHUB_ACTIONS_CHANGED > 0 || steps.diff.outputs.SPECS_CHANGED > 0 || steps.diff.outputs.TESTS_CHANGED > 0 || steps.diff.outputs.JS_CLIENT_CHANGED > 0 || steps.diff.outputs.JS_TEMPLATE_CHANGED > 0 || steps.diff.outputs.JAVA_CLIENT_CHANGED > 0 || steps.diff.outputs.JAVA_TEMPLATE_CHANGED > 0 }} + value: ${{ github.ref_name == 'main' || steps.diff.outputs.GITHUB_ACTIONS_CHANGED > 0 || steps.diff.outputs.SPECS_CHANGED > 0 || steps.diff.outputs.TESTS_CHANGED > 0 || steps.diff.outputs.JS_CLIENT_CHANGED > 0 || steps.diff.outputs.JS_TEMPLATE_CHANGED > 0 || steps.diff.outputs.JAVA_CLIENT_CHANGED > 0 || steps.diff.outputs.JAVA_TEMPLATE_CHANGED > 0 || steps.diff.outputs.PHP_CLIENT_CHANGED > 0 || steps.diff.outputs.PHP_TEMPLATE_CHANGED > 0 }} diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 2765c4543b..deb491caa8 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -43,6 +43,8 @@ jobs: RUN_JAVA_CLIENT: ${{ steps.setup.outputs.RUN_JAVA_CLIENT }} + RUN_PHP_CLIENT: ${{ steps.setup.outputs.RUN_PHP_CLIENT }} + RUN_CTS: ${{ steps.setup.outputs.RUN_CTS }} specs_search: @@ -318,6 +320,33 @@ jobs: if: steps.cache.outputs.cache-hit != 'true' run: yarn build:clients java search + client_php_search: + runs-on: ubuntu-20.04 + needs: [specs_search] + if: ${{ always() && needs.setup.outputs.RUN_PHP_CLIENT == 'true' }} + steps: + - uses: actions/checkout@v2 + + - name: Restore cache + uses: ./.github/actions/cache + with: + job: php + + - name: Cache built clients + id: cache + uses: actions/cache@v2 + with: + path: /home/runner/work/api-clients-automation/api-clients-automation/clients/algoliasearch-client-php/dist + key: ${{ runner.os }}-php-client-${{ hashFiles('clients/algoliasearch-client-php/**') }} + + - name: Generate search client + if: steps.cache.outputs.cache-hit != 'true' + run: yarn generate php search + + - name: Build search client + if: steps.cache.outputs.cache-hit != 'true' + run: yarn build:clients php search + cts: runs-on: ubuntu-20.04 needs: @@ -328,6 +357,7 @@ jobs: - client_javascript_analytics - client_javascript_insights - client_java_search + - client_php_search if: ${{ always() && needs.setup.outputs.RUN_CTS == 'true' }} steps: From 36d4b5739198529edfc88ac53ab6772e14f42c3a Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Wed, 12 Jan 2022 17:16:04 +0100 Subject: [PATCH 04/13] fix: add packageName to the config --- openapitools.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openapitools.json b/openapitools.json index 80f4e539c0..11778ea3c7 100644 --- a/openapitools.json +++ b/openapitools.json @@ -163,7 +163,8 @@ "gitRepoId": "algoliasearch-client-php", "invokerPackage": "Algolia\\AlgoliaSearch", "additionalProperties": { - "variableNamingConvention": "camelCase" + "variableNamingConvention": "camelCase", + "packageName": "algoliasearch-client-php" } } } From 51d0860760a49e406dc357569496f52750cce6af Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Wed, 12 Jan 2022 17:19:42 +0100 Subject: [PATCH 05/13] feat: add linted files --- .../lib/Api/SearchApi.php | 222 +++++++++++------- .../lib/ApiException.php | 3 +- .../lib/Configuration.php | 28 ++- .../lib/HeaderSelector.php | 17 +- .../lib/Model/Action.php | 6 +- .../lib/Model/AddApiKeyResponse.php | 33 ++- .../lib/Model/Anchoring.php | 6 +- .../lib/Model/ApiKey.php | 33 +-- .../lib/Model/AssignUserIdObject.php | 32 +-- .../lib/Model/AutomaticFacetFilter.php | 32 +-- .../lib/Model/BaseBrowseResponse.php | 29 ++- .../lib/Model/BaseIndexSettings.php | 52 ++-- .../lib/Model/BaseSearchParams.php | 90 ++++--- .../lib/Model/BaseSearchResponse.php | 69 +++--- .../Model/BaseSearchResponseFacetsStats.php | 36 ++- .../lib/Model/BatchAssignUserIdsObject.php | 32 +-- .../lib/Model/BatchDictionaryEntries.php | 32 +-- .../Model/BatchDictionaryEntriesRequest.php | 30 +-- .../lib/Model/BatchObject.php | 29 ++- .../lib/Model/BatchResponse.php | 32 ++- .../lib/Model/BatchWriteObject.php | 29 ++- .../lib/Model/BrowseRequest.php | 30 ++- .../lib/Model/BrowseResponse.php | 69 +++--- .../lib/Model/BuildInOperation.php | 33 +-- .../lib/Model/Condition.php | 32 ++- .../lib/Model/Consequence.php | 31 ++- .../lib/Model/ConsequenceHide.php | 32 +-- .../lib/Model/ConsequenceParams.php | 177 +++++++------- .../lib/Model/CreatedAtObject.php | 31 ++- .../lib/Model/CreatedAtResponse.php | 32 +-- .../lib/Model/DeleteApiKeyResponse.php | 31 ++- .../lib/Model/DeleteSourceResponse.php | 31 ++- .../lib/Model/DeletedAtResponse.php | 34 +-- .../lib/Model/DictionaryEntry.php | 38 +-- .../lib/Model/DictionaryLanguage.php | 29 ++- .../lib/Model/DictionarySettingsRequest.php | 30 +-- .../lib/Model/ErrorBase.php | 29 ++- .../Model/GetDictionarySettingsResponse.php | 29 ++- .../lib/Model/GetLogsResponse.php | 29 ++- .../lib/Model/GetLogsResponseInnerQueries.php | 34 ++- .../lib/Model/GetLogsResponseLogs.php | 53 ++--- .../lib/Model/GetObjectsObject.php | 29 ++- .../lib/Model/GetObjectsResponse.php | 30 ++- .../lib/Model/GetTaskResponse.php | 27 +-- .../lib/Model/GetTopUserIdsResponse.php | 32 +-- .../lib/Model/HighlightResult.php | 36 +-- .../lib/Model/Index.php | 39 ++- .../lib/Model/IndexSettings.php | 134 +++++------ .../lib/Model/IndexSettingsAsSearchParams.php | 109 +++++---- .../lib/Model/KeyObject.php | 34 +-- .../lib/Model/Languages.php | 30 +-- .../lib/Model/ListApiKeysResponse.php | 31 ++- .../lib/Model/ListClustersResponse.php | 32 +-- .../lib/Model/ListIndicesResponse.php | 32 ++- .../lib/Model/ListUserIdsResponse.php | 32 +-- .../lib/Model/MultipleBatchResponse.php | 32 ++- .../lib/Model/MultipleGetObjectsObject.php | 34 +-- .../lib/Model/MultipleQueries.php | 37 ++- .../lib/Model/MultipleQueriesObject.php | 27 +-- .../lib/Model/MultipleQueriesResponse.php | 28 +-- .../lib/Model/Operation.php | 32 ++- .../lib/Model/OperationIndexObject.php | 32 +-- .../lib/Model/Params.php | 35 ++- .../lib/Model/Promote.php | 34 +-- .../lib/Model/RankingInfo.php | 48 ++-- .../Model/RankingInfoMatchedGeoLocation.php | 38 ++- .../lib/Model/Record.php | 32 +-- .../lib/Model/RemoveUserIdResponse.php | 31 ++- .../lib/Model/ReplaceSourceResponse.php | 31 ++- .../lib/Model/RequiredSearchParams.php | 31 ++- .../lib/Model/Rule.php | 32 +-- .../lib/Model/SaveObjectResponse.php | 32 ++- .../lib/Model/SaveSynonymResponse.php | 35 ++- .../lib/Model/SearchDictionaryEntries.php | 36 +-- .../lib/Model/SearchForFacetValuesRequest.php | 32 ++- .../Model/SearchForFacetValuesResponse.php | 29 ++- .../SearchForFacetValuesResponseFacetHits.php | 33 ++- .../lib/Model/SearchHits.php | 28 +-- .../lib/Model/SearchParams.php | 175 +++++++------- .../lib/Model/SearchParamsObject.php | 173 +++++++------- .../lib/Model/SearchParamsString.php | 30 ++- .../lib/Model/SearchResponse.php | 69 +++--- .../lib/Model/SearchRulesParams.php | 37 ++- .../lib/Model/SearchRulesResponse.php | 37 ++- .../lib/Model/SearchSynonymsResponse.php | 33 ++- .../lib/Model/SearchUserIdsObject.php | 36 +-- .../lib/Model/SearchUserIdsResponse.php | 38 +-- .../SearchUserIdsResponseHighlightResult.php | 29 ++- .../lib/Model/SearchUserIdsResponseHits.php | 35 ++- .../lib/Model/SnippetResult.php | 31 ++- .../lib/Model/Source.php | 34 +-- .../lib/Model/StandardEntries.php | 35 ++- .../lib/Model/SynonymHit.php | 44 ++-- .../lib/Model/SynonymHitHighlightResult.php | 29 ++- .../lib/Model/TimeRange.php | 33 ++- .../lib/Model/UpdateApiKeyResponse.php | 33 ++- .../lib/Model/UpdatedAtResponse.php | 34 +-- .../Model/UpdatedAtWithObjectIdResponse.php | 35 ++- .../lib/Model/UpdatedRuleResponse.php | 35 ++- .../lib/Model/UserId.php | 38 +-- .../lib/ObjectSerializer.php | 50 ++-- 101 files changed, 2113 insertions(+), 2102 deletions(-) diff --git a/clients/algoliasearch-client-php/lib/Api/SearchApi.php b/clients/algoliasearch-client-php/lib/Api/SearchApi.php index 9491959484..0af73c90fc 100644 --- a/clients/algoliasearch-client-php/lib/Api/SearchApi.php +++ b/clients/algoliasearch-client-php/lib/Api/SearchApi.php @@ -2,17 +2,16 @@ namespace Algolia\AlgoliaSearch\Api; +use Algolia\AlgoliaSearch\ApiException; +use Algolia\AlgoliaSearch\Configuration; +use Algolia\AlgoliaSearch\HeaderSelector; +use Algolia\AlgoliaSearch\ObjectSerializer; use GuzzleHttp\Client; use GuzzleHttp\ClientInterface; -use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Exception\ConnectException; -use GuzzleHttp\Psr7\MultipartStream; +use GuzzleHttp\Exception\RequestException; use GuzzleHttp\Psr7\Request; use GuzzleHttp\RequestOptions; -use Algolia\AlgoliaSearch\ApiException; -use Algolia\AlgoliaSearch\Configuration; -use Algolia\AlgoliaSearch\HeaderSelector; -use Algolia\AlgoliaSearch\ObjectSerializer; /** * SearchApi Class Doc Comment @@ -91,6 +90,7 @@ public function getConfig() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\AddApiKeyResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function addApiKey($apiKey) @@ -142,7 +142,7 @@ public function addApiKey($apiKey) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\AddApiKeyResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -160,6 +160,7 @@ public function addApiKey($apiKey) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtWithObjectIdResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function addOrUpdateObject($indexName, $objectID, $body) @@ -239,7 +240,7 @@ public function addOrUpdateObject($indexName, $objectID, $body) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtWithObjectIdResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -253,6 +254,7 @@ public function addOrUpdateObject($indexName, $objectID, $body) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\CreatedAtResponse */ public function appendSource($source) @@ -304,7 +306,7 @@ public function appendSource($source) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\CreatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -321,6 +323,7 @@ public function appendSource($source) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\CreatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) @@ -331,8 +334,8 @@ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) 'Missing the required parameter $xAlgoliaUserID when calling assignUserId' ); } - if (!preg_match("/^[a-zA-Z0-9 \\-*.]+$/", $xAlgoliaUserID)) { - throw new \InvalidArgumentException("invalid value for \"xAlgoliaUserID\" when calling SearchApi.assignUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/."); + if (!preg_match('/^[a-zA-Z0-9 \\-*.]+$/', $xAlgoliaUserID)) { + throw new \InvalidArgumentException('invalid value for "xAlgoliaUserID" when calling SearchApi.assignUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/.'); } // verify the required parameter 'assignUserIdObject' is set @@ -389,7 +392,7 @@ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\CreatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -404,6 +407,7 @@ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\BatchResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function batch($indexName, $batchWriteObject) @@ -469,7 +473,7 @@ public function batch($indexName, $batchWriteObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\BatchResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -486,6 +490,7 @@ public function batch($indexName, $batchWriteObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\CreatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) @@ -496,8 +501,8 @@ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) 'Missing the required parameter $xAlgoliaUserID when calling batchAssignUserIds' ); } - if (!preg_match("/^[a-zA-Z0-9 \\-*.]+$/", $xAlgoliaUserID)) { - throw new \InvalidArgumentException("invalid value for \"xAlgoliaUserID\" when calling SearchApi.batchAssignUserIds, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/."); + if (!preg_match('/^[a-zA-Z0-9 \\-*.]+$/', $xAlgoliaUserID)) { + throw new \InvalidArgumentException('invalid value for "xAlgoliaUserID" when calling SearchApi.batchAssignUserIds, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/.'); } // verify the required parameter 'batchAssignUserIdsObject' is set @@ -554,7 +559,7 @@ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\CreatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -571,6 +576,7 @@ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) @@ -636,7 +642,7 @@ public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -655,6 +661,7 @@ public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function batchRules($indexName, $rule, $forwardToReplicas = null, $clearExistingRules = null) @@ -734,7 +741,7 @@ public function batchRules($indexName, $rule, $forwardToReplicas = null, $clearE $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -751,6 +758,7 @@ public function batchRules($indexName, $rule, $forwardToReplicas = null, $clearE * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\BrowseResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function browse($indexName, $browseRequest = null) @@ -810,7 +818,7 @@ public function browse($indexName, $browseRequest = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\BrowseResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -827,6 +835,7 @@ public function browse($indexName, $browseRequest = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function clearAllSynonyms($indexName, $forwardToReplicas = null) @@ -890,7 +899,7 @@ public function clearAllSynonyms($indexName, $forwardToReplicas = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -906,6 +915,7 @@ public function clearAllSynonyms($indexName, $forwardToReplicas = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function clearObjects($indexName) @@ -962,7 +972,7 @@ public function clearObjects($indexName) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -979,6 +989,7 @@ public function clearObjects($indexName) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function clearRules($indexName, $forwardToReplicas = null) @@ -1042,7 +1053,7 @@ public function clearRules($indexName, $forwardToReplicas = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1058,6 +1069,7 @@ public function clearRules($indexName, $forwardToReplicas = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\DeleteApiKeyResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteApiKey($key) @@ -1114,7 +1126,7 @@ public function deleteApiKey($key) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeleteApiKeyResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1131,6 +1143,7 @@ public function deleteApiKey($key) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\DeletedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteBy($indexName, $searchParams) @@ -1196,7 +1209,7 @@ public function deleteBy($indexName, $searchParams) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeletedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1212,6 +1225,7 @@ public function deleteBy($indexName, $searchParams) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\DeletedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteIndex($indexName) @@ -1268,7 +1282,7 @@ public function deleteIndex($indexName) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeletedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1285,6 +1299,7 @@ public function deleteIndex($indexName) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\DeletedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteObject($indexName, $objectID) @@ -1355,7 +1370,7 @@ public function deleteObject($indexName, $objectID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeletedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1373,6 +1388,7 @@ public function deleteObject($indexName, $objectID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteRule($indexName, $objectID, $forwardToReplicas = null) @@ -1450,7 +1466,7 @@ public function deleteRule($indexName, $objectID, $forwardToReplicas = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1464,6 +1480,7 @@ public function deleteRule($indexName, $objectID, $forwardToReplicas = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\DeleteSourceResponse */ public function deleteSource($source) @@ -1520,7 +1537,7 @@ public function deleteSource($source) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeleteSourceResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1538,6 +1555,7 @@ public function deleteSource($source) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\DeletedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function deleteSynonym($indexName, $objectID, $forwardToReplicas = null) @@ -1615,7 +1633,7 @@ public function deleteSynonym($indexName, $objectID, $forwardToReplicas = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\DeletedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1631,6 +1649,7 @@ public function deleteSynonym($indexName, $objectID, $forwardToReplicas = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\KeyObject|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getApiKey($key) @@ -1687,7 +1706,7 @@ public function getApiKey($key) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\KeyObject'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1702,6 +1721,7 @@ public function getApiKey($key) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return array|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getDictionaryLanguages() @@ -1744,7 +1764,7 @@ public function getDictionaryLanguages() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = 'array<string,\Algolia\AlgoliaSearch\Model\Languages>'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1759,6 +1779,7 @@ public function getDictionaryLanguages() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\GetDictionarySettingsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getDictionarySettings() @@ -1801,7 +1822,7 @@ public function getDictionarySettings() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetDictionarySettingsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1818,6 +1839,7 @@ public function getDictionarySettings() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\GetLogsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getLogs($offset = 0, $length = 10, $indexName = null, $type = 'all') @@ -1826,7 +1848,6 @@ public function getLogs($offset = 0, $length = 10, $indexName = null, $type = 'a throw new \InvalidArgumentException('invalid value for "$length" when calling SearchApi.getLogs, must be smaller than or equal to 1000.'); } - $resourcePath = '/1/logs'; $queryParams = []; $headerParams = []; @@ -1892,7 +1913,7 @@ public function getLogs($offset = 0, $length = 10, $indexName = null, $type = 'a $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetLogsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -1910,6 +1931,7 @@ public function getLogs($offset = 0, $length = 10, $indexName = null, $type = 'a * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return array|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getObject($indexName, $objectID, $attributesToRetrieve = null) @@ -1987,7 +2009,7 @@ public function getObject($indexName, $objectID, $attributesToRetrieve = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = 'array<string,string>'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2003,6 +2025,7 @@ public function getObject($indexName, $objectID, $attributesToRetrieve = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\GetObjectsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getObjects($getObjectsObject) @@ -2054,7 +2077,7 @@ public function getObjects($getObjectsObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetObjectsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2071,6 +2094,7 @@ public function getObjects($getObjectsObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\Rule|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getRule($indexName, $objectID) @@ -2141,7 +2165,7 @@ public function getRule($indexName, $objectID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\Rule'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2155,6 +2179,7 @@ public function getRule($indexName, $objectID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\IndexSettings|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getSettings($indexName) @@ -2211,7 +2236,7 @@ public function getSettings($indexName) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\IndexSettings'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2224,6 +2249,7 @@ public function getSettings($indexName) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\Source[] */ public function getSources() @@ -2266,7 +2292,7 @@ public function getSources() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\Source[]'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2283,6 +2309,7 @@ public function getSources() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SynonymHit|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getSynonym($indexName, $objectID) @@ -2353,7 +2380,7 @@ public function getSynonym($indexName, $objectID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SynonymHit'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2368,6 +2395,7 @@ public function getSynonym($indexName, $objectID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\GetTaskResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getTask($indexName, $taskID) @@ -2438,7 +2466,7 @@ public function getTask($indexName, $taskID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetTaskResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2453,6 +2481,7 @@ public function getTask($indexName, $taskID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\GetTopUserIdsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getTopUserIds() @@ -2495,7 +2524,7 @@ public function getTopUserIds() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\GetTopUserIdsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2511,6 +2540,7 @@ public function getTopUserIds() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UserId|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function getUserId($userID) @@ -2521,11 +2551,10 @@ public function getUserId($userID) 'Missing the required parameter $userID when calling getUserId' ); } - if (!preg_match("/^[a-zA-Z0-9 \\-*.]+$/", $userID)) { - throw new \InvalidArgumentException("invalid value for \"userID\" when calling SearchApi.getUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/."); + if (!preg_match('/^[a-zA-Z0-9 \\-*.]+$/', $userID)) { + throw new \InvalidArgumentException('invalid value for "userID" when calling SearchApi.getUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/.'); } - $resourcePath = '/1/clusters/mapping/{userID}'; $queryParams = []; $headerParams = []; @@ -2571,7 +2600,7 @@ public function getUserId($userID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UserId'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2587,6 +2616,7 @@ public function getUserId($userID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\CreatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function hasPendingMappings($getClusters = null) @@ -2636,7 +2666,7 @@ public function hasPendingMappings($getClusters = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\CreatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2651,6 +2681,7 @@ public function hasPendingMappings($getClusters = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\ListApiKeysResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function listApiKeys() @@ -2693,7 +2724,7 @@ public function listApiKeys() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ListApiKeysResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2708,6 +2739,7 @@ public function listApiKeys() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\ListClustersResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function listClusters() @@ -2750,7 +2782,7 @@ public function listClusters() $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ListClustersResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2766,6 +2798,7 @@ public function listClusters() * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\ListIndicesResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function listIndices($page = null) @@ -2815,7 +2848,7 @@ public function listIndices($page = null) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ListIndicesResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2832,6 +2865,7 @@ public function listIndices($page = null) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\ListUserIdsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function listUserIds($page = null, $hitsPerPage = 100) @@ -2888,7 +2922,7 @@ public function listUserIds($page = null, $hitsPerPage = 100) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ListUserIdsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2902,6 +2936,7 @@ public function listUserIds($page = null, $hitsPerPage = 100) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\MultipleBatchResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function multipleBatch($batchObject) @@ -2953,7 +2988,7 @@ public function multipleBatch($batchObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\MultipleBatchResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -2967,6 +3002,7 @@ public function multipleBatch($batchObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\MultipleQueriesResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function multipleQueries($multipleQueriesObject) @@ -3018,7 +3054,7 @@ public function multipleQueries($multipleQueriesObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\MultipleQueriesResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3035,6 +3071,7 @@ public function multipleQueries($multipleQueriesObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function operationIndex($indexName, $operationIndexObject) @@ -3100,7 +3137,7 @@ public function operationIndex($indexName, $operationIndexObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3119,6 +3156,7 @@ public function operationIndex($indexName, $operationIndexObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtWithObjectIdResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function partialUpdateObject($indexName, $objectID, $oneOfStringBuildInOperation, $createIfNotExists = true) @@ -3205,7 +3243,7 @@ public function partialUpdateObject($indexName, $objectID, $oneOfStringBuildInOp $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtWithObjectIdResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3221,6 +3259,7 @@ public function partialUpdateObject($indexName, $objectID, $oneOfStringBuildInOp * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\RemoveUserIdResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function removeUserId($userID) @@ -3231,11 +3270,10 @@ public function removeUserId($userID) 'Missing the required parameter $userID when calling removeUserId' ); } - if (!preg_match("/^[a-zA-Z0-9 \\-*.]+$/", $userID)) { - throw new \InvalidArgumentException("invalid value for \"userID\" when calling SearchApi.removeUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/."); + if (!preg_match('/^[a-zA-Z0-9 \\-*.]+$/', $userID)) { + throw new \InvalidArgumentException('invalid value for "userID" when calling SearchApi.removeUserId, must conform to the pattern /^[a-zA-Z0-9 \\-*.]+$/.'); } - $resourcePath = '/1/clusters/mapping/{userID}'; $queryParams = []; $headerParams = []; @@ -3281,7 +3319,7 @@ public function removeUserId($userID) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\RemoveUserIdResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3295,6 +3333,7 @@ public function removeUserId($userID) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\ReplaceSourceResponse */ public function replaceSources($source) @@ -3346,7 +3385,7 @@ public function replaceSources($source) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\ReplaceSourceResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3362,6 +3401,7 @@ public function replaceSources($source) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\AddApiKeyResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function restoreApiKey($key) @@ -3418,7 +3458,7 @@ public function restoreApiKey($key) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\AddApiKeyResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3433,6 +3473,7 @@ public function restoreApiKey($key) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SaveObjectResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function saveObject($indexName, $body) @@ -3498,7 +3539,7 @@ public function saveObject($indexName, $body) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SaveObjectResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3517,6 +3558,7 @@ public function saveObject($indexName, $body) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedRuleResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function saveRule($indexName, $objectID, $rule, $forwardToReplicas = null) @@ -3603,7 +3645,7 @@ public function saveRule($indexName, $objectID, $rule, $forwardToReplicas = null $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedRuleResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3622,6 +3664,7 @@ public function saveRule($indexName, $objectID, $rule, $forwardToReplicas = null * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SaveSynonymResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function saveSynonym($indexName, $objectID, $synonymHit, $forwardToReplicas = null) @@ -3708,7 +3751,7 @@ public function saveSynonym($indexName, $objectID, $synonymHit, $forwardToReplic $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SaveSynonymResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3727,6 +3770,7 @@ public function saveSynonym($indexName, $objectID, $synonymHit, $forwardToReplic * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function saveSynonyms($indexName, $synonymHit, $forwardToReplicas = null, $replaceExistingSynonyms = null) @@ -3806,7 +3850,7 @@ public function saveSynonyms($indexName, $synonymHit, $forwardToReplicas = null, $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3821,6 +3865,7 @@ public function saveSynonyms($indexName, $synonymHit, $forwardToReplicas = null, * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SearchResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function search($indexName, $searchParams) @@ -3886,7 +3931,7 @@ public function search($indexName, $searchParams) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3903,6 +3948,7 @@ public function search($indexName, $searchParams) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntries) @@ -3968,7 +4014,7 @@ public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntrie $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -3986,6 +4032,7 @@ public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntrie * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SearchForFacetValuesResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchForFacetValues($indexName, $facetName, $searchForFacetValuesRequest = null) @@ -4059,7 +4106,7 @@ public function searchForFacetValues($indexName, $facetName, $searchForFacetValu $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchForFacetValuesResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4076,6 +4123,7 @@ public function searchForFacetValues($indexName, $facetName, $searchForFacetValu * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SearchRulesResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchRules($indexName, $searchRulesParams) @@ -4141,7 +4189,7 @@ public function searchRules($indexName, $searchRulesParams) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchRulesResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4161,6 +4209,7 @@ public function searchRules($indexName, $searchRulesParams) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SearchSynonymsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchSynonyms($indexName, $query = '', $type = null, $page = 0, $hitsPerPage = 100) @@ -4245,7 +4294,7 @@ public function searchSynonyms($indexName, $query = '', $type = null, $page = 0, $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchSynonymsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4261,6 +4310,7 @@ public function searchSynonyms($indexName, $query = '', $type = null, $page = 0, * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\SearchUserIdsResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function searchUserIds($searchUserIdsObject) @@ -4312,7 +4362,7 @@ public function searchUserIds($searchUserIdsObject) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\SearchUserIdsResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4328,6 +4378,7 @@ public function searchUserIds($searchUserIdsObject) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function setDictionarySettings($dictionarySettingsRequest) @@ -4379,7 +4430,7 @@ public function setDictionarySettings($dictionarySettingsRequest) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4395,6 +4446,7 @@ public function setDictionarySettings($dictionarySettingsRequest) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function setSettings($indexName, $indexSettings, $forwardToReplicas = null) @@ -4467,7 +4519,7 @@ public function setSettings($indexName, $indexSettings, $forwardToReplicas = nul $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdatedAtResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4484,6 +4536,7 @@ public function setSettings($indexName, $indexSettings, $forwardToReplicas = nul * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException + * * @return \Algolia\AlgoliaSearch\Model\UpdateApiKeyResponse|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase|\Algolia\AlgoliaSearch\Model\ErrorBase */ public function updateApiKey($key, $apiKey) @@ -4549,7 +4602,7 @@ public function updateApiKey($key, $apiKey) $headers, $httpBody ); - + $expectedResponse = null; $expectedResponse = '\Algolia\AlgoliaSearch\Model\UpdateApiKeyResponse'; list($response) = $this->sendRequest($request, $expectedResponse); @@ -4560,6 +4613,7 @@ public function updateApiKey($key, $apiKey) * Create http client option * * @throws \RuntimeException on file opening failure + * * @return array of http client options */ protected function createHttpClientOption() @@ -4579,12 +4633,14 @@ protected function createHttpClientOption() * Send the request and handle the response * * @throws \RuntimeException on file opening failure + * * @return array */ protected function sendRequest($request, $expectedResponse) { try { $options = $this->createHttpClientOption(); + try { $response = $this->client->send($request, $options); } catch (RequestException $e) { @@ -4629,7 +4685,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, $expectedResponse, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; case 400: if ('\Algolia\AlgoliaSearch\Model\ErrorBase' === '\SplFileObject') { @@ -4641,7 +4697,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, '\Algolia\AlgoliaSearch\Model\ErrorBase', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; case 402: if ('\Algolia\AlgoliaSearch\Model\ErrorBase' === '\SplFileObject') { @@ -4653,7 +4709,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, '\Algolia\AlgoliaSearch\Model\ErrorBase', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; case 403: if ('\Algolia\AlgoliaSearch\Model\ErrorBase' === '\SplFileObject') { @@ -4665,7 +4721,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, '\Algolia\AlgoliaSearch\Model\ErrorBase', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; case 404: if ('\Algolia\AlgoliaSearch\Model\ErrorBase' === '\SplFileObject') { @@ -4677,7 +4733,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, '\Algolia\AlgoliaSearch\Model\ErrorBase', []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; } @@ -4692,7 +4748,7 @@ protected function sendRequest($request, $expectedResponse) return [ ObjectSerializer::deserialize($content, $returnType, []), $response->getStatusCode(), - $response->getHeaders() + $response->getHeaders(), ]; } catch (ApiException $e) { @@ -4704,6 +4760,7 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); + break; case 400: $data = ObjectSerializer::deserialize( @@ -4712,6 +4769,7 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); + break; case 402: $data = ObjectSerializer::deserialize( @@ -4720,6 +4778,7 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); + break; case 403: $data = ObjectSerializer::deserialize( @@ -4728,6 +4787,7 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); + break; case 404: $data = ObjectSerializer::deserialize( @@ -4736,8 +4796,10 @@ protected function sendRequest($request, $expectedResponse) $e->getResponseHeaders() ); $e->setResponseObject($data); + break; } + throw $e; } } diff --git a/clients/algoliasearch-client-php/lib/ApiException.php b/clients/algoliasearch-client-php/lib/ApiException.php index 0f80549494..d484a88eb5 100644 --- a/clients/algoliasearch-client-php/lib/ApiException.php +++ b/clients/algoliasearch-client-php/lib/ApiException.php @@ -12,7 +12,6 @@ */ class ApiException extends Exception { - /** * The HTTP body of the server response either as Json or string. * @@ -42,7 +41,7 @@ class ApiException extends Exception * @param string[]|null $responseHeaders HTTP response header * @param \stdClass|string|null $responseBody HTTP decoded body of the server response either as \stdClass or string */ - public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null) + public function __construct($message = '', $code = 0, $responseHeaders = [], $responseBody = null) { parent::__construct($message, $code); $this->responseHeaders = $responseHeaders; diff --git a/clients/algoliasearch-client-php/lib/Configuration.php b/clients/algoliasearch-client-php/lib/Configuration.php index 30f2a5e7aa..b7d8ebacb9 100644 --- a/clients/algoliasearch-client-php/lib/Configuration.php +++ b/clients/algoliasearch-client-php/lib/Configuration.php @@ -113,6 +113,7 @@ public function __construct(string $appId, string $algoliaApiKey = null) public function setApiKey($apiKeyIdentifier, $key) { $this->apiKeys[$apiKeyIdentifier] = $key; + return $this; } @@ -139,6 +140,7 @@ public function getApiKey($apiKeyIdentifier) public function setApiKeyPrefix($apiKeyIdentifier, $prefix) { $this->apiKeyPrefixes[$apiKeyIdentifier] = $prefix; + return $this; } @@ -164,6 +166,7 @@ public function getApiKeyPrefix($apiKeyIdentifier) public function setAccessToken($accessToken) { $this->accessToken = $accessToken; + return $this; } @@ -231,6 +234,7 @@ public function getAlgoliaApiKey() public function setHost($host) { $this->host = $host; + return $this; } @@ -250,6 +254,7 @@ public function getHost() * @param string $userAgent the user agent of the api client * * @throws \InvalidArgumentException + * * @return $this */ public function setUserAgent($userAgent) @@ -259,6 +264,7 @@ public function setUserAgent($userAgent) } $this->userAgent = $userAgent; + return $this; } @@ -282,6 +288,7 @@ public function getUserAgent() public function setDebug($debug) { $this->debug = $debug; + return $this; } @@ -305,6 +312,7 @@ public function getDebug() public function setDebugFile($debugFile) { $this->debugFile = $debugFile; + return $this; } @@ -328,6 +336,7 @@ public function getDebugFile() public function setTempFolderPath($tempFolderPath) { $this->tempFolderPath = $tempFolderPath; + return $this; } @@ -417,9 +426,9 @@ public function getHostSettings() { return [ [ - "url" => "", - "description" => "No description provided", - ] + 'url' => '', + 'description' => 'No description provided', + ], ]; } @@ -428,6 +437,7 @@ public function getHostSettings() * * @param int $index index of the host settings * @param array|null $variables hash of variable and the corresponding value (optional) + * * @return string URL based on host settings */ public function getHostFromSettings($index, $variables = null) @@ -444,19 +454,19 @@ public function getHostFromSettings($index, $variables = null) } $host = $hosts[$index]; - $url = $host["url"]; + $url = $host['url']; // go through variable and assign a value - foreach ($host["variables"] ?? [] as $name => $variable) { + foreach ($host['variables'] ?? [] as $name => $variable) { if (array_key_exists($name, $variables)) { // check to see if it's in the variables provided by the user - if (in_array($variables[$name], $variable["enum_values"], true)) { // check to see if the value is in the enum - $url = str_replace("{".$name."}", $variables[$name], $url); + if (in_array($variables[$name], $variable['enum_values'], true)) { // check to see if the value is in the enum + $url = str_replace('{'.$name.'}', $variables[$name], $url); } else { - throw new \InvalidArgumentException("The variable `$name` in the host URL has invalid value ".$variables[$name].". Must be ".join(',', $variable["enum_values"])."."); + throw new \InvalidArgumentException("The variable `$name` in the host URL has invalid value ".$variables[$name].'. Must be '.join(',', $variable['enum_values']).'.'); } } else { // use default value - $url = str_replace("{".$name."}", $variable["default_value"], $url); + $url = str_replace('{'.$name.'}', $variable['default_value'], $url); } } diff --git a/clients/algoliasearch-client-php/lib/HeaderSelector.php b/clients/algoliasearch-client-php/lib/HeaderSelector.php index 7d68b37a53..cdf8042d96 100644 --- a/clients/algoliasearch-client-php/lib/HeaderSelector.php +++ b/clients/algoliasearch-client-php/lib/HeaderSelector.php @@ -2,8 +2,6 @@ namespace Algolia\AlgoliaSearch; -use \Exception; - /** * ApiException Class Doc Comment * @@ -12,10 +10,10 @@ */ class HeaderSelector { - /** * @param string[] $accept * @param string[] $contentTypes + * * @return array */ public function selectHeaders($accept, $contentTypes) @@ -28,11 +26,13 @@ public function selectHeaders($accept, $contentTypes) } $headers['Content-Type'] = $this->selectContentTypeHeader($contentTypes); + return $headers; } /** * @param string[] $accept + * * @return array */ public function selectHeadersForMultipart($accept) @@ -40,6 +40,7 @@ public function selectHeadersForMultipart($accept) $headers = $this->selectHeaders($accept, []); unset($headers['Content-Type']); + return $headers; } @@ -56,9 +57,10 @@ private function selectAcceptHeader($accept) return null; } elseif ($jsonAccept = preg_grep('~(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$~', $accept)) { return implode(',', $jsonAccept); - } else { - return implode(',', $accept); } + + return implode(',', $accept); + } /** @@ -74,8 +76,9 @@ private function selectContentTypeHeader($contentType) return 'application/json'; } elseif (preg_grep("/application\/json/i", $contentType)) { return 'application/json'; - } else { - return implode(',', $contentType); } + + return implode(',', $contentType); + } } diff --git a/clients/algoliasearch-client-php/lib/Model/Action.php b/clients/algoliasearch-client-php/lib/Model/Action.php index 8781092a8c..0296001727 100644 --- a/clients/algoliasearch-client-php/lib/Model/Action.php +++ b/clients/algoliasearch-client-php/lib/Model/Action.php @@ -1,13 +1,13 @@ 'string', - 'createdAt' => '\DateTime' + 'createdAt' => '\DateTime', ]; /** @@ -44,7 +44,7 @@ class AddApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPIFormats = [ 'key' => null, - 'createdAt' => 'date-time' + 'createdAt' => 'date-time', ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'key' => 'key', - 'createdAt' => 'createdAt' + 'createdAt' => 'createdAt', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'key' => 'setKey', - 'createdAt' => 'setCreatedAt' + 'createdAt' => 'setCreatedAt', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'key' => 'getKey', - 'createdAt' => 'getCreatedAt' + 'createdAt' => 'getCreatedAt', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -174,6 +173,7 @@ public function listInvalidProperties() if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } + return $invalidProperties; } @@ -188,7 +188,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets key * @@ -202,7 +201,7 @@ public function getKey() /** * Sets key * - * @param string $key Key string. + * @param string $key key string * * @return self */ @@ -226,7 +225,7 @@ public function getCreatedAt() /** * Sets createdAt * - * @param \DateTime $createdAt Date of creation (ISO-8601 format). + * @param \DateTime $createdAt date of creation (ISO-8601 format) * * @return self */ @@ -239,9 +238,9 @@ public function setCreatedAt($createdAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -251,7 +250,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -280,7 +279,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -291,10 +290,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -325,4 +325,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Anchoring.php b/clients/algoliasearch-client-php/lib/Model/Anchoring.php index 7760ddb377..031df08b5e 100644 --- a/clients/algoliasearch-client-php/lib/Model/Anchoring.php +++ b/clients/algoliasearch-client-php/lib/Model/Anchoring.php @@ -1,13 +1,13 @@ * @template TKey int|null @@ -39,7 +40,7 @@ class ApiKey implements ModelInterface, ArrayAccess, \JsonSerializable 'maxQueriesPerIPPerHour' => 'int', 'queryParameters' => 'string', 'referers' => 'string[]', - 'validity' => 'int' + 'validity' => 'int', ]; /** @@ -57,7 +58,7 @@ class ApiKey implements ModelInterface, ArrayAccess, \JsonSerializable 'maxQueriesPerIPPerHour' => null, 'queryParameters' => null, 'referers' => null, - 'validity' => null + 'validity' => null, ]; /** @@ -94,7 +95,7 @@ public static function openAPIFormats() 'maxQueriesPerIPPerHour' => 'maxQueriesPerIPPerHour', 'queryParameters' => 'queryParameters', 'referers' => 'referers', - 'validity' => 'validity' + 'validity' => 'validity', ]; /** @@ -110,7 +111,7 @@ public static function openAPIFormats() 'maxQueriesPerIPPerHour' => 'setMaxQueriesPerIPPerHour', 'queryParameters' => 'setQueryParameters', 'referers' => 'setReferers', - 'validity' => 'setValidity' + 'validity' => 'setValidity', ]; /** @@ -126,7 +127,7 @@ public static function openAPIFormats() 'maxQueriesPerIPPerHour' => 'getMaxQueriesPerIPPerHour', 'queryParameters' => 'getQueryParameters', 'referers' => 'getReferers', - 'validity' => 'getValidity' + 'validity' => 'getValidity', ]; /** @@ -247,6 +248,7 @@ public function listInvalidProperties() if ($this->container['acl'] === null) { $invalidProperties[] = "'acl' can't be null"; } + return $invalidProperties; } @@ -261,7 +263,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets acl * @@ -275,7 +276,7 @@ public function getAcl() /** * Sets acl * - * @param string[] $acl Set of permissions associated with the key. + * @param string[] $acl set of permissions associated with the key * * @return self */ @@ -380,7 +381,7 @@ public function getMaxQueriesPerIPPerHour() /** * Sets maxQueriesPerIPPerHour * - * @param int|null $maxQueriesPerIPPerHour Maximum number of API calls per hour allowed from a given IP address or a user token. + * @param int|null $maxQueriesPerIPPerHour maximum number of API calls per hour allowed from a given IP address or a user token * * @return self */ @@ -465,9 +466,9 @@ public function setValidity($validity) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -477,7 +478,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -506,7 +507,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -517,10 +518,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -551,4 +553,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php b/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php index d46ef38fc3..913125bbde 100644 --- a/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php +++ b/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * AssignUserIdObject Class Doc Comment * * @category Class * @description Assign userID object. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class AssignUserIdObject implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'cluster' => 'string' + 'cluster' => 'string', ]; /** @@ -43,7 +44,7 @@ class AssignUserIdObject implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'cluster' => null + 'cluster' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'cluster' => 'cluster' + 'cluster' => 'cluster', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'cluster' => 'setCluster' + 'cluster' => 'setCluster', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'cluster' => 'getCluster' + 'cluster' => 'getCluster', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['cluster'] === null) { $invalidProperties[] = "'cluster' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets cluster * @@ -194,7 +194,7 @@ public function getCluster() /** * Sets cluster * - * @param string $cluster Name of the cluster. + * @param string $cluster name of the cluster * * @return self */ @@ -207,9 +207,9 @@ public function setCluster($cluster) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php b/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php index 9f4acf5062..0a63d8cdab 100644 --- a/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php +++ b/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * AutomaticFacetFilter Class Doc Comment * * @category Class * @description Automatic facet Filter. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class AutomaticFacetFilter implements ModelInterface, ArrayAccess, \JsonSerializ protected static $openAPITypes = [ 'facet' => 'string', 'score' => 'int', - 'disjunctive' => 'bool' + 'disjunctive' => 'bool', ]; /** @@ -47,7 +48,7 @@ class AutomaticFacetFilter implements ModelInterface, ArrayAccess, \JsonSerializ protected static $openAPIFormats = [ 'facet' => null, 'score' => null, - 'disjunctive' => null + 'disjunctive' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'facet' => 'facet', 'score' => 'score', - 'disjunctive' => 'disjunctive' + 'disjunctive' => 'disjunctive', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'facet' => 'setFacet', 'score' => 'setScore', - 'disjunctive' => 'setDisjunctive' + 'disjunctive' => 'setDisjunctive', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'facet' => 'getFacet', 'score' => 'getScore', - 'disjunctive' => 'getDisjunctive' + 'disjunctive' => 'getDisjunctive', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -178,6 +178,7 @@ public function listInvalidProperties() if ($this->container['facet'] === null) { $invalidProperties[] = "'facet' can't be null"; } + return $invalidProperties; } @@ -192,7 +193,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets facet * @@ -254,7 +254,7 @@ public function getDisjunctive() /** * Sets disjunctive * - * @param bool|null $disjunctive Whether the filter is disjunctive (true) or conjunctive (false). + * @param bool|null $disjunctive whether the filter is disjunctive (true) or conjunctive (false) * * @return self */ @@ -267,9 +267,9 @@ public function setDisjunctive($disjunctive) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -279,7 +279,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -308,7 +308,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -319,10 +319,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -353,4 +354,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php b/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php index fead53a789..e9f60b9c9a 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BaseBrowseResponse Class Doc Comment @@ -31,7 +31,7 @@ class BaseBrowseResponse implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'cursor' => 'string' + 'cursor' => 'string', ]; /** @@ -42,7 +42,7 @@ class BaseBrowseResponse implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'cursor' => null + 'cursor' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'cursor' => 'cursor' + 'cursor' => 'cursor', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'cursor' => 'setCursor' + 'cursor' => 'setCursor', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'cursor' => 'getCursor' + 'cursor' => 'getCursor', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['cursor'] === null) { $invalidProperties[] = "'cursor' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets cursor * @@ -206,9 +205,9 @@ public function setCursor($cursor) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php b/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php index 80195a5625..dbbc448b75 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BaseIndexSettings Class Doc Comment @@ -42,7 +42,7 @@ class BaseIndexSettings implements ModelInterface, ArrayAccess, \JsonSerializabl 'disablePrefixOnAttributes' => 'string[]', 'allowCompressionOfIntegerArray' => 'bool', 'numericAttributesForFiltering' => 'string[]', - 'userData' => 'object' + 'userData' => 'object', ]; /** @@ -64,7 +64,7 @@ class BaseIndexSettings implements ModelInterface, ArrayAccess, \JsonSerializabl 'disablePrefixOnAttributes' => null, 'allowCompressionOfIntegerArray' => null, 'numericAttributesForFiltering' => null, - 'userData' => null + 'userData' => null, ]; /** @@ -105,7 +105,7 @@ public static function openAPIFormats() 'disablePrefixOnAttributes' => 'disablePrefixOnAttributes', 'allowCompressionOfIntegerArray' => 'allowCompressionOfIntegerArray', 'numericAttributesForFiltering' => 'numericAttributesForFiltering', - 'userData' => 'userData' + 'userData' => 'userData', ]; /** @@ -125,7 +125,7 @@ public static function openAPIFormats() 'disablePrefixOnAttributes' => 'setDisablePrefixOnAttributes', 'allowCompressionOfIntegerArray' => 'setAllowCompressionOfIntegerArray', 'numericAttributesForFiltering' => 'setNumericAttributesForFiltering', - 'userData' => 'setUserData' + 'userData' => 'setUserData', ]; /** @@ -145,7 +145,7 @@ public static function openAPIFormats() 'disablePrefixOnAttributes' => 'getDisablePrefixOnAttributes', 'allowCompressionOfIntegerArray' => 'getAllowCompressionOfIntegerArray', 'numericAttributesForFiltering' => 'getNumericAttributesForFiltering', - 'userData' => 'getUserData' + 'userData' => 'getUserData', ]; /** @@ -189,7 +189,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -242,7 +241,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets replicas * @@ -256,7 +254,7 @@ public function getReplicas() /** * Sets replicas * - * @param string[]|null $replicas Creates replicas, exact copies of an index. + * @param string[]|null $replicas creates replicas, exact copies of an index * * @return self */ @@ -280,7 +278,7 @@ public function getPaginationLimitedTo() /** * Sets paginationLimitedTo * - * @param int|null $paginationLimitedTo Set the maximum number of hits accessible via pagination. + * @param int|null $paginationLimitedTo set the maximum number of hits accessible via pagination * * @return self */ @@ -304,7 +302,7 @@ public function getDisableTypoToleranceOnWords() /** * Sets disableTypoToleranceOnWords * - * @param string[]|null $disableTypoToleranceOnWords A list of words for which you want to turn off typo tolerance. + * @param string[]|null $disableTypoToleranceOnWords a list of words for which you want to turn off typo tolerance * * @return self */ @@ -328,7 +326,7 @@ public function getAttributesToTransliterate() /** * Sets attributesToTransliterate * - * @param string[]|null $attributesToTransliterate Specify on which attributes to apply transliteration. + * @param string[]|null $attributesToTransliterate specify on which attributes to apply transliteration * * @return self */ @@ -352,7 +350,7 @@ public function getCamelCaseAttributes() /** * Sets camelCaseAttributes * - * @param string[]|null $camelCaseAttributes List of attributes on which to do a decomposition of camel case words. + * @param string[]|null $camelCaseAttributes list of attributes on which to do a decomposition of camel case words * * @return self */ @@ -376,7 +374,7 @@ public function getDecompoundedAttributes() /** * Sets decompoundedAttributes * - * @param object|null $decompoundedAttributes Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding. + * @param object|null $decompoundedAttributes specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding * * @return self */ @@ -400,7 +398,7 @@ public function getIndexLanguages() /** * Sets indexLanguages * - * @param string[]|null $indexLanguages Sets the languages at the index level for language-specific processing such as tokenization and normalization. + * @param string[]|null $indexLanguages sets the languages at the index level for language-specific processing such as tokenization and normalization * * @return self */ @@ -424,7 +422,7 @@ public function getFilterPromotes() /** * Sets filterPromotes * - * @param bool|null $filterPromotes Whether promoted results should match the filters of the current search, except for geographic filters. + * @param bool|null $filterPromotes whether promoted results should match the filters of the current search, except for geographic filters * * @return self */ @@ -448,7 +446,7 @@ public function getDisablePrefixOnAttributes() /** * Sets disablePrefixOnAttributes * - * @param string[]|null $disablePrefixOnAttributes List of attributes on which you want to disable prefix matching. + * @param string[]|null $disablePrefixOnAttributes list of attributes on which you want to disable prefix matching * * @return self */ @@ -472,7 +470,7 @@ public function getAllowCompressionOfIntegerArray() /** * Sets allowCompressionOfIntegerArray * - * @param bool|null $allowCompressionOfIntegerArray Enables compression of large integer arrays. + * @param bool|null $allowCompressionOfIntegerArray enables compression of large integer arrays * * @return self */ @@ -496,7 +494,7 @@ public function getNumericAttributesForFiltering() /** * Sets numericAttributesForFiltering * - * @param string[]|null $numericAttributesForFiltering List of numeric attributes that can be used as numerical filters. + * @param string[]|null $numericAttributesForFiltering list of numeric attributes that can be used as numerical filters * * @return self */ @@ -520,7 +518,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData Lets you store custom data in your indices. + * @param object|null $userData lets you store custom data in your indices * * @return self */ @@ -533,9 +531,9 @@ public function setUserData($userData) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -545,7 +543,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -574,7 +572,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -585,10 +583,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -619,4 +618,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php b/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php index bf573dc75a..6aafbea93e 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BaseSearchParams Class Doc Comment @@ -62,7 +62,7 @@ class BaseSearchParams implements ModelInterface, ArrayAccess, \JsonSerializable 'analyticsTags' => 'string[]', 'percentileComputation' => 'bool', 'enableABTest' => 'bool', - 'enableReRanking' => 'bool' + 'enableReRanking' => 'bool', ]; /** @@ -104,7 +104,7 @@ class BaseSearchParams implements ModelInterface, ArrayAccess, \JsonSerializable 'analyticsTags' => null, 'percentileComputation' => null, 'enableABTest' => null, - 'enableReRanking' => null + 'enableReRanking' => null, ]; /** @@ -165,7 +165,7 @@ public static function openAPIFormats() 'analyticsTags' => 'analyticsTags', 'percentileComputation' => 'percentileComputation', 'enableABTest' => 'enableABTest', - 'enableReRanking' => 'enableReRanking' + 'enableReRanking' => 'enableReRanking', ]; /** @@ -205,7 +205,7 @@ public static function openAPIFormats() 'analyticsTags' => 'setAnalyticsTags', 'percentileComputation' => 'setPercentileComputation', 'enableABTest' => 'setEnableABTest', - 'enableReRanking' => 'setEnableReRanking' + 'enableReRanking' => 'setEnableReRanking', ]; /** @@ -245,7 +245,7 @@ public static function openAPIFormats() 'analyticsTags' => 'getAnalyticsTags', 'percentileComputation' => 'getPercentileComputation', 'enableABTest' => 'getEnableABTest', - 'enableReRanking' => 'getEnableReRanking' + 'enableReRanking' => 'getEnableReRanking', ]; /** @@ -289,7 +289,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -374,7 +373,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets similarQuery * @@ -388,7 +386,7 @@ public function getSimilarQuery() /** * Sets similarQuery * - * @param string|null $similarQuery Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results. + * @param string|null $similarQuery overrides the query parameter and performs a more generic search that can be used to find \"similar\" results * * @return self */ @@ -412,7 +410,7 @@ public function getFilters() /** * Sets filters * - * @param string|null $filters Filter the query with numeric, facet and/or tag filters. + * @param string|null $filters filter the query with numeric, facet and/or tag filters * * @return self */ @@ -436,7 +434,7 @@ public function getFacetFilters() /** * Sets facetFilters * - * @param string[]|null $facetFilters Filter hits by facet value. + * @param string[]|null $facetFilters filter hits by facet value * * @return self */ @@ -460,7 +458,7 @@ public function getOptionalFilters() /** * Sets optionalFilters * - * @param string[]|null $optionalFilters Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. + * @param string[]|null $optionalFilters create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter * * @return self */ @@ -484,7 +482,7 @@ public function getNumericFilters() /** * Sets numericFilters * - * @param string[]|null $numericFilters Filter on numeric attributes. + * @param string[]|null $numericFilters filter on numeric attributes * * @return self */ @@ -508,7 +506,7 @@ public function getTagFilters() /** * Sets tagFilters * - * @param string[]|null $tagFilters Filter hits by tags. + * @param string[]|null $tagFilters filter hits by tags * * @return self */ @@ -532,7 +530,7 @@ public function getSumOrFiltersScores() /** * Sets sumOrFiltersScores * - * @param bool|null $sumOrFiltersScores Determines how to calculate the total score for filtering. + * @param bool|null $sumOrFiltersScores determines how to calculate the total score for filtering * * @return self */ @@ -556,7 +554,7 @@ public function getFacets() /** * Sets facets * - * @param string[]|null $facets Retrieve facets and their facet values. + * @param string[]|null $facets retrieve facets and their facet values * * @return self */ @@ -580,7 +578,7 @@ public function getMaxValuesPerFacet() /** * Sets maxValuesPerFacet * - * @param int|null $maxValuesPerFacet Maximum number of facet values to return for each facet during a regular search. + * @param int|null $maxValuesPerFacet maximum number of facet values to return for each facet during a regular search * * @return self */ @@ -604,7 +602,7 @@ public function getFacetingAfterDistinct() /** * Sets facetingAfterDistinct * - * @param bool|null $facetingAfterDistinct Force faceting to be applied after de-duplication (via the Distinct setting). + * @param bool|null $facetingAfterDistinct force faceting to be applied after de-duplication (via the Distinct setting) * * @return self */ @@ -628,7 +626,7 @@ public function getSortFacetValuesBy() /** * Sets sortFacetValuesBy * - * @param string|null $sortFacetValuesBy Controls how facet values are fetched. + * @param string|null $sortFacetValuesBy controls how facet values are fetched * * @return self */ @@ -652,7 +650,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Specify the page to retrieve. + * @param int|null $page specify the page to retrieve * * @return self */ @@ -676,7 +674,7 @@ public function getOffset() /** * Sets offset * - * @param int|null $offset Specify the offset of the first hit to return. + * @param int|null $offset specify the offset of the first hit to return * * @return self */ @@ -700,7 +698,7 @@ public function getLength() /** * Sets length * - * @param int|null $length Set the number of hits to retrieve (used only with offset). + * @param int|null $length set the number of hits to retrieve (used only with offset) * * @return self */ @@ -732,7 +730,7 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng Search for entries around a central geolocation, enabling a geo search within a circular area. + * @param string|null $aroundLatLng search for entries around a central geolocation, enabling a geo search within a circular area * * @return self */ @@ -756,7 +754,7 @@ public function getAroundLatLngViaIP() /** * Sets aroundLatLngViaIP * - * @param bool|null $aroundLatLngViaIP Search for entries around a given location automatically computed from the requester's IP address. + * @param bool|null $aroundLatLngViaIP search for entries around a given location automatically computed from the requester's IP address * * @return self */ @@ -780,7 +778,7 @@ public function getAroundRadius() /** * Sets aroundRadius * - * @param OneOfIntegerString|null $aroundRadius Define the maximum radius for a geo search (in meters). + * @param OneOfIntegerString|null $aroundRadius define the maximum radius for a geo search (in meters) * * @return self */ @@ -804,7 +802,7 @@ public function getAroundPrecision() /** * Sets aroundPrecision * - * @param int|null $aroundPrecision Precision of geo search (in meters), to add grouping by geo location to the ranking formula. + * @param int|null $aroundPrecision precision of geo search (in meters), to add grouping by geo location to the ranking formula * * @return self */ @@ -828,7 +826,7 @@ public function getMinimumAroundRadius() /** * Sets minimumAroundRadius * - * @param int|null $minimumAroundRadius Minimum radius (in meters) used for a geo search when aroundRadius is not set. + * @param int|null $minimumAroundRadius minimum radius (in meters) used for a geo search when aroundRadius is not set * * @return self */ @@ -857,7 +855,7 @@ public function getInsideBoundingBox() /** * Sets insideBoundingBox * - * @param float[]|null $insideBoundingBox Search inside a rectangular area (in geo coordinates). + * @param float[]|null $insideBoundingBox search inside a rectangular area (in geo coordinates) * * @return self */ @@ -881,7 +879,7 @@ public function getInsidePolygon() /** * Sets insidePolygon * - * @param float[]|null $insidePolygon Search inside a polygon (in geo coordinates). + * @param float[]|null $insidePolygon search inside a polygon (in geo coordinates) * * @return self */ @@ -929,7 +927,7 @@ public function getRuleContexts() /** * Sets ruleContexts * - * @param string[]|null $ruleContexts Enables contextual rules. + * @param string[]|null $ruleContexts enables contextual rules * * @return self */ @@ -953,7 +951,7 @@ public function getPersonalizationImpact() /** * Sets personalizationImpact * - * @param int|null $personalizationImpact Define the impact of the Personalization feature. + * @param int|null $personalizationImpact define the impact of the Personalization feature * * @return self */ @@ -977,7 +975,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken Associates a certain user token with the current search. + * @param string|null $userToken associates a certain user token with the current search * * @return self */ @@ -1001,7 +999,7 @@ public function getGetRankingInfo() /** * Sets getRankingInfo * - * @param bool|null $getRankingInfo Retrieve detailed ranking information. + * @param bool|null $getRankingInfo retrieve detailed ranking information * * @return self */ @@ -1025,7 +1023,7 @@ public function getClickAnalytics() /** * Sets clickAnalytics * - * @param bool|null $clickAnalytics Enable the Click Analytics feature. + * @param bool|null $clickAnalytics enable the Click Analytics feature * * @return self */ @@ -1049,7 +1047,7 @@ public function getAnalytics() /** * Sets analytics * - * @param bool|null $analytics Whether the current query will be taken into account in the Analytics. + * @param bool|null $analytics whether the current query will be taken into account in the Analytics * * @return self */ @@ -1073,7 +1071,7 @@ public function getAnalyticsTags() /** * Sets analyticsTags * - * @param string[]|null $analyticsTags List of tags to apply to the query for analytics purposes. + * @param string[]|null $analyticsTags list of tags to apply to the query for analytics purposes * * @return self */ @@ -1097,7 +1095,7 @@ public function getPercentileComputation() /** * Sets percentileComputation * - * @param bool|null $percentileComputation Whether to include or exclude a query from the processing-time percentile computation. + * @param bool|null $percentileComputation whether to include or exclude a query from the processing-time percentile computation * * @return self */ @@ -1121,7 +1119,7 @@ public function getEnableABTest() /** * Sets enableABTest * - * @param bool|null $enableABTest Whether this search should participate in running AB tests. + * @param bool|null $enableABTest whether this search should participate in running AB tests * * @return self */ @@ -1145,7 +1143,7 @@ public function getEnableReRanking() /** * Sets enableReRanking * - * @param bool|null $enableReRanking Whether this search should use AI Re-Ranking. + * @param bool|null $enableReRanking whether this search should use AI Re-Ranking * * @return self */ @@ -1158,9 +1156,9 @@ public function setEnableReRanking($enableReRanking) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -1170,7 +1168,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -1199,7 +1197,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -1210,10 +1208,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -1244,4 +1243,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php index 37b4705831..5d758f3f99 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BaseSearchResponse Class Doc Comment @@ -54,7 +54,7 @@ class BaseSearchResponse implements ModelInterface, ArrayAccess, \JsonSerializab 'query' => 'string', 'queryAfterRemoval' => 'string', 'serverUsed' => 'string', - 'userData' => 'object' + 'userData' => 'object', ]; /** @@ -88,7 +88,7 @@ class BaseSearchResponse implements ModelInterface, ArrayAccess, \JsonSerializab 'query' => null, 'queryAfterRemoval' => null, 'serverUsed' => null, - 'userData' => null + 'userData' => null, ]; /** @@ -141,7 +141,7 @@ public static function openAPIFormats() 'query' => 'query', 'queryAfterRemoval' => 'queryAfterRemoval', 'serverUsed' => 'serverUsed', - 'userData' => 'userData' + 'userData' => 'userData', ]; /** @@ -173,7 +173,7 @@ public static function openAPIFormats() 'query' => 'setQuery', 'queryAfterRemoval' => 'setQueryAfterRemoval', 'serverUsed' => 'setServerUsed', - 'userData' => 'setUserData' + 'userData' => 'setUserData', ]; /** @@ -205,7 +205,7 @@ public static function openAPIFormats() 'query' => 'getQuery', 'queryAfterRemoval' => 'getQueryAfterRemoval', 'serverUsed' => 'getServerUsed', - 'userData' => 'getUserData' + 'userData' => 'getUserData', ]; /** @@ -249,7 +249,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -300,7 +299,7 @@ public function listInvalidProperties() { $invalidProperties = []; - if (!is_null($this->container['aroundLatLng']) && !preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $this->container['aroundLatLng'])) { + if (!is_null($this->container['aroundLatLng']) && !preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $this->container['aroundLatLng'])) { $invalidProperties[] = "invalid value for 'aroundLatLng', must be conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."; } @@ -331,6 +330,7 @@ public function listInvalidProperties() if ($this->container['query'] === null) { $invalidProperties[] = "'query' can't be null"; } + return $invalidProperties; } @@ -345,7 +345,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets abTestID * @@ -359,7 +358,7 @@ public function getAbTestID() /** * Sets abTestID * - * @param int|null $abTestID If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID. + * @param int|null $abTestID if a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID * * @return self */ @@ -383,7 +382,7 @@ public function getAbTestVariantID() /** * Sets abTestVariantID * - * @param int|null $abTestVariantID If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used. + * @param int|null $abTestVariantID if a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used * * @return self */ @@ -407,14 +406,14 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng The computed geo location. + * @param string|null $aroundLatLng the computed geo location * * @return self */ public function setAroundLatLng($aroundLatLng) { - if (!is_null($aroundLatLng) && (!preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $aroundLatLng))) { + if (!is_null($aroundLatLng) && (!preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $aroundLatLng))) { throw new \InvalidArgumentException("invalid value for $aroundLatLng when calling BaseSearchResponse., must conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."); } @@ -460,7 +459,7 @@ public function getExhaustiveFacetsCount() /** * Sets exhaustiveFacetsCount * - * @param bool|null $exhaustiveFacetsCount Whether the facet count is exhaustive or approximate. + * @param bool|null $exhaustiveFacetsCount whether the facet count is exhaustive or approximate * * @return self */ @@ -532,7 +531,7 @@ public function getFacets() /** * Sets facets * - * @param array>|null $facets A mapping of each facet name to the corresponding facet counts. + * @param array>|null $facets a mapping of each facet name to the corresponding facet counts * * @return self */ @@ -556,7 +555,7 @@ public function getFacetsStats() /** * Sets facetsStats * - * @param array|null $facetsStats Statistics for numerical facets. + * @param array|null $facetsStats statistics for numerical facets * * @return self */ @@ -580,7 +579,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int $hitsPerPage Set the number of hits per page. + * @param int $hitsPerPage set the number of hits per page * * @return self */ @@ -604,7 +603,7 @@ public function getIndex() /** * Sets index * - * @param string|null $index Index name used for the query. + * @param string|null $index index name used for the query * * @return self */ @@ -652,7 +651,7 @@ public function getMessage() /** * Sets message * - * @param string|null $message Used to return warnings about the query. + * @param string|null $message used to return warnings about the query * * @return self */ @@ -676,7 +675,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits Number of hits that the search query matched. + * @param int $nbHits number of hits that the search query matched * * @return self */ @@ -748,7 +747,7 @@ public function getPage() /** * Sets page * - * @param int $page Specify the page to retrieve. + * @param int $page specify the page to retrieve * * @return self */ @@ -772,7 +771,7 @@ public function getParams() /** * Sets params * - * @param string $params A url-encoded string of all search parameters. + * @param string $params a url-encoded string of all search parameters * * @return self */ @@ -796,7 +795,7 @@ public function getParsedQuery() /** * Sets parsedQuery * - * @param string|null $parsedQuery The query string that will be searched, after normalization. + * @param string|null $parsedQuery the query string that will be searched, after normalization * * @return self */ @@ -820,7 +819,7 @@ public function getProcessingTimeMS() /** * Sets processingTimeMS * - * @param int $processingTimeMS Time the server took to process the request, in milliseconds. + * @param int $processingTimeMS time the server took to process the request, in milliseconds * * @return self */ @@ -844,7 +843,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -868,7 +867,7 @@ public function getQueryAfterRemoval() /** * Sets queryAfterRemoval * - * @param string|null $queryAfterRemoval A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. + * @param string|null $queryAfterRemoval a markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set * * @return self */ @@ -892,7 +891,7 @@ public function getServerUsed() /** * Sets serverUsed * - * @param string|null $serverUsed Actual host name of the server that processed the request. + * @param string|null $serverUsed actual host name of the server that processed the request * * @return self */ @@ -916,7 +915,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData Lets you store custom data in your indices. + * @param object|null $userData lets you store custom data in your indices * * @return self */ @@ -929,9 +928,9 @@ public function setUserData($userData) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -941,7 +940,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -970,7 +969,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -981,10 +980,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -1015,4 +1015,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php index 2d97e8e94b..f260c78f71 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BaseSearchResponseFacetsStats Class Doc Comment @@ -34,7 +34,7 @@ class BaseSearchResponseFacetsStats implements ModelInterface, ArrayAccess, \Jso 'min' => 'int', 'max' => 'int', 'avg' => 'int', - 'sum' => 'int' + 'sum' => 'int', ]; /** @@ -48,7 +48,7 @@ class BaseSearchResponseFacetsStats implements ModelInterface, ArrayAccess, \Jso 'min' => null, 'max' => null, 'avg' => null, - 'sum' => null + 'sum' => null, ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() 'min' => 'min', 'max' => 'max', 'avg' => 'avg', - 'sum' => 'sum' + 'sum' => 'sum', ]; /** @@ -93,7 +93,7 @@ public static function openAPIFormats() 'min' => 'setMin', 'max' => 'setMax', 'avg' => 'setAvg', - 'sum' => 'setSum' + 'sum' => 'setSum', ]; /** @@ -105,7 +105,7 @@ public static function openAPIFormats() 'min' => 'getMin', 'max' => 'getMax', 'avg' => 'getAvg', - 'sum' => 'getSum' + 'sum' => 'getSum', ]; /** @@ -149,7 +149,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -194,7 +193,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets min * @@ -208,7 +206,7 @@ public function getMin() /** * Sets min * - * @param int|null $min The minimum value in the result set. + * @param int|null $min the minimum value in the result set * * @return self */ @@ -232,7 +230,7 @@ public function getMax() /** * Sets max * - * @param int|null $max The maximum value in the result set. + * @param int|null $max the maximum value in the result set * * @return self */ @@ -256,7 +254,7 @@ public function getAvg() /** * Sets avg * - * @param int|null $avg The average facet value in the result set. + * @param int|null $avg the average facet value in the result set * * @return self */ @@ -280,7 +278,7 @@ public function getSum() /** * Sets sum * - * @param int|null $sum The sum of all values in the result set. + * @param int|null $sum the sum of all values in the result set * * @return self */ @@ -293,9 +291,9 @@ public function setSum($sum) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -305,7 +303,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -334,7 +332,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -345,10 +343,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -379,4 +378,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php b/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php index 43c76dd3dd..60ad6bd7ef 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BatchAssignUserIdsObject Class Doc Comment * * @category Class * @description Assign userID object. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class BatchAssignUserIdsObject implements ModelInterface, ArrayAccess, \JsonSeri */ protected static $openAPITypes = [ 'cluster' => 'string', - 'users' => 'string[]' + 'users' => 'string[]', ]; /** @@ -45,7 +46,7 @@ class BatchAssignUserIdsObject implements ModelInterface, ArrayAccess, \JsonSeri */ protected static $openAPIFormats = [ 'cluster' => null, - 'users' => null + 'users' => null, ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'cluster' => 'cluster', - 'users' => 'users' + 'users' => 'users', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'cluster' => 'setCluster', - 'users' => 'setUsers' + 'users' => 'setUsers', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'cluster' => 'getCluster', - 'users' => 'getUsers' + 'users' => 'getUsers', ]; /** @@ -140,7 +141,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -175,6 +175,7 @@ public function listInvalidProperties() if ($this->container['users'] === null) { $invalidProperties[] = "'users' can't be null"; } + return $invalidProperties; } @@ -189,7 +190,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets cluster * @@ -203,7 +203,7 @@ public function getCluster() /** * Sets cluster * - * @param string $cluster Name of the cluster. + * @param string $cluster name of the cluster * * @return self */ @@ -240,9 +240,9 @@ public function setUsers($users) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -252,7 +252,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -281,7 +281,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -292,10 +292,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -326,4 +327,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php index 8c5a853c0e..d0ba7be83a 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BatchDictionaryEntries Class Doc Comment * * @category Class * @description The `batchDictionaryEntries` requests. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class BatchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSerial */ protected static $openAPITypes = [ 'clearExistingDictionaryEntries' => 'bool', - 'requests' => '\Algolia\AlgoliaSearch\Model\BatchDictionaryEntriesRequest[]' + 'requests' => '\Algolia\AlgoliaSearch\Model\BatchDictionaryEntriesRequest[]', ]; /** @@ -45,7 +46,7 @@ class BatchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSerial */ protected static $openAPIFormats = [ 'clearExistingDictionaryEntries' => null, - 'requests' => null + 'requests' => null, ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'clearExistingDictionaryEntries' => 'clearExistingDictionaryEntries', - 'requests' => 'requests' + 'requests' => 'requests', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'clearExistingDictionaryEntries' => 'setClearExistingDictionaryEntries', - 'requests' => 'setRequests' + 'requests' => 'setRequests', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'clearExistingDictionaryEntries' => 'getClearExistingDictionaryEntries', - 'requests' => 'getRequests' + 'requests' => 'getRequests', ]; /** @@ -140,7 +141,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -172,6 +172,7 @@ public function listInvalidProperties() if ($this->container['requests'] === null) { $invalidProperties[] = "'requests' can't be null"; } + return $invalidProperties; } @@ -186,7 +187,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets clearExistingDictionaryEntries * @@ -200,7 +200,7 @@ public function getClearExistingDictionaryEntries() /** * Sets clearExistingDictionaryEntries * - * @param bool|null $clearExistingDictionaryEntries When `true`, start the batch by removing all the custom entries from the dictionary. + * @param bool|null $clearExistingDictionaryEntries when `true`, start the batch by removing all the custom entries from the dictionary * * @return self */ @@ -237,9 +237,9 @@ public function setRequests($requests) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -249,7 +249,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -278,7 +278,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -289,10 +289,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -323,4 +324,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php index 073e38595f..e74c45c010 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BatchDictionaryEntriesRequest Class Doc Comment @@ -32,7 +32,7 @@ class BatchDictionaryEntriesRequest implements ModelInterface, ArrayAccess, \Jso */ protected static $openAPITypes = [ 'action' => 'string', - 'body' => '\Algolia\AlgoliaSearch\Model\DictionaryEntry' + 'body' => '\Algolia\AlgoliaSearch\Model\DictionaryEntry', ]; /** @@ -44,7 +44,7 @@ class BatchDictionaryEntriesRequest implements ModelInterface, ArrayAccess, \Jso */ protected static $openAPIFormats = [ 'action' => null, - 'body' => null + 'body' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'action' => 'action', - 'body' => 'body' + 'body' => 'body', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'action' => 'setAction', - 'body' => 'setBody' + 'body' => 'setBody', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'action' => 'getAction', - 'body' => 'getBody' + 'body' => 'getBody', ]; /** @@ -198,6 +198,7 @@ public function listInvalidProperties() if ($this->container['body'] === null) { $invalidProperties[] = "'body' can't be null"; } + return $invalidProperties; } @@ -212,7 +213,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets action * @@ -226,7 +226,7 @@ public function getAction() /** * Sets action * - * @param string $action Actions to perform. + * @param string $action actions to perform * * @return self */ @@ -273,9 +273,9 @@ public function setBody($body) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -285,7 +285,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -314,7 +314,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -325,10 +325,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -359,4 +360,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BatchObject.php b/clients/algoliasearch-client-php/lib/Model/BatchObject.php index 815e85b5cb..11b433c681 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchObject.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BatchObject Class Doc Comment * * @category Class * @description The `batch` requests. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class BatchObject implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'requests' => '\Algolia\AlgoliaSearch\Model\Operation[]' + 'requests' => '\Algolia\AlgoliaSearch\Model\Operation[]', ]; /** @@ -43,7 +44,7 @@ class BatchObject implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'requests' => null + 'requests' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'requests' => 'requests' + 'requests' => 'requests', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'requests' => 'setRequests' + 'requests' => 'setRequests', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'requests' => 'getRequests' + 'requests' => 'getRequests', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -177,7 +177,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets requests * @@ -204,9 +203,9 @@ public function setRequests($requests) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -216,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -245,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -256,10 +255,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -290,4 +290,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BatchResponse.php b/clients/algoliasearch-client-php/lib/Model/BatchResponse.php index ad20982c93..149eae702c 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BatchResponse Class Doc Comment @@ -32,7 +32,7 @@ class BatchResponse implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'taskID' => 'int', - 'objectIDs' => 'string[]' + 'objectIDs' => 'string[]', ]; /** @@ -44,7 +44,7 @@ class BatchResponse implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'taskID' => null, - 'objectIDs' => null + 'objectIDs' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'taskID' => 'taskID', - 'objectIDs' => 'objectIDs' + 'objectIDs' => 'objectIDs', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'taskID' => 'setTaskID', - 'objectIDs' => 'setObjectIDs' + 'objectIDs' => 'setObjectIDs', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'taskID' => 'getTaskID', - 'objectIDs' => 'getObjectIDs' + 'objectIDs' => 'getObjectIDs', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -182,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets taskID * @@ -196,7 +194,7 @@ public function getTaskID() /** * Sets taskID * - * @param int|null $taskID taskID of the indexing task to wait for. + * @param int|null $taskID taskID of the indexing task to wait for * * @return self */ @@ -220,7 +218,7 @@ public function getObjectIDs() /** * Sets objectIDs * - * @param string[]|null $objectIDs List of objectID. + * @param string[]|null $objectIDs list of objectID * * @return self */ @@ -233,9 +231,9 @@ public function setObjectIDs($objectIDs) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -245,7 +243,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -274,7 +272,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -285,10 +283,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -319,4 +318,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php b/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php index 896d0c3b8f..9b61babd79 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BatchWriteObject Class Doc Comment * * @category Class * @description The `batch` requests. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class BatchWriteObject implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'requests' => '\Algolia\AlgoliaSearch\Model\Operation[]' + 'requests' => '\Algolia\AlgoliaSearch\Model\Operation[]', ]; /** @@ -43,7 +44,7 @@ class BatchWriteObject implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'requests' => null + 'requests' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'requests' => 'requests' + 'requests' => 'requests', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'requests' => 'setRequests' + 'requests' => 'setRequests', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'requests' => 'getRequests' + 'requests' => 'getRequests', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -177,7 +177,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets requests * @@ -204,9 +203,9 @@ public function setRequests($requests) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -216,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -245,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -256,10 +255,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -290,4 +290,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php b/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php index 8c2728944a..1f2fe9ca43 100644 --- a/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BrowseRequest Class Doc Comment @@ -32,7 +32,7 @@ class BrowseRequest implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'params' => 'string', - 'cursor' => 'string' + 'cursor' => 'string', ]; /** @@ -44,7 +44,7 @@ class BrowseRequest implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'params' => null, - 'cursor' => null + 'cursor' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'params' => 'params', - 'cursor' => 'cursor' + 'cursor' => 'cursor', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'params' => 'setParams', - 'cursor' => 'setCursor' + 'cursor' => 'setCursor', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'params' => 'getParams', - 'cursor' => 'getCursor' + 'cursor' => 'getCursor', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -182,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets params * @@ -196,7 +194,7 @@ public function getParams() /** * Sets params * - * @param string|null $params Search parameters as URL-encoded query string. + * @param string|null $params search parameters as URL-encoded query string * * @return self */ @@ -233,9 +231,9 @@ public function setCursor($cursor) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -245,7 +243,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -274,7 +272,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -285,10 +283,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -319,4 +318,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php b/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php index 389fa30b65..a42ad93b22 100644 --- a/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BrowseResponse Class Doc Comment @@ -56,7 +56,7 @@ class BrowseResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'serverUsed' => 'string', 'userData' => 'object', 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]', - 'cursor' => 'string' + 'cursor' => 'string', ]; /** @@ -92,7 +92,7 @@ class BrowseResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'serverUsed' => null, 'userData' => null, 'hits' => null, - 'cursor' => null + 'cursor' => null, ]; /** @@ -147,7 +147,7 @@ public static function openAPIFormats() 'serverUsed' => 'serverUsed', 'userData' => 'userData', 'hits' => 'hits', - 'cursor' => 'cursor' + 'cursor' => 'cursor', ]; /** @@ -181,7 +181,7 @@ public static function openAPIFormats() 'serverUsed' => 'setServerUsed', 'userData' => 'setUserData', 'hits' => 'setHits', - 'cursor' => 'setCursor' + 'cursor' => 'setCursor', ]; /** @@ -215,7 +215,7 @@ public static function openAPIFormats() 'serverUsed' => 'getServerUsed', 'userData' => 'getUserData', 'hits' => 'getHits', - 'cursor' => 'getCursor' + 'cursor' => 'getCursor', ]; /** @@ -259,7 +259,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -312,7 +311,7 @@ public function listInvalidProperties() { $invalidProperties = []; - if (!is_null($this->container['aroundLatLng']) && !preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $this->container['aroundLatLng'])) { + if (!is_null($this->container['aroundLatLng']) && !preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $this->container['aroundLatLng'])) { $invalidProperties[] = "invalid value for 'aroundLatLng', must be conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."; } @@ -349,6 +348,7 @@ public function listInvalidProperties() if ($this->container['cursor'] === null) { $invalidProperties[] = "'cursor' can't be null"; } + return $invalidProperties; } @@ -363,7 +363,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets abTestID * @@ -377,7 +376,7 @@ public function getAbTestID() /** * Sets abTestID * - * @param int|null $abTestID If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID. + * @param int|null $abTestID if a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID * * @return self */ @@ -401,7 +400,7 @@ public function getAbTestVariantID() /** * Sets abTestVariantID * - * @param int|null $abTestVariantID If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used. + * @param int|null $abTestVariantID if a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used * * @return self */ @@ -425,14 +424,14 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng The computed geo location. + * @param string|null $aroundLatLng the computed geo location * * @return self */ public function setAroundLatLng($aroundLatLng) { - if (!is_null($aroundLatLng) && (!preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $aroundLatLng))) { + if (!is_null($aroundLatLng) && (!preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $aroundLatLng))) { throw new \InvalidArgumentException("invalid value for $aroundLatLng when calling BrowseResponse., must conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."); } @@ -478,7 +477,7 @@ public function getExhaustiveFacetsCount() /** * Sets exhaustiveFacetsCount * - * @param bool|null $exhaustiveFacetsCount Whether the facet count is exhaustive or approximate. + * @param bool|null $exhaustiveFacetsCount whether the facet count is exhaustive or approximate * * @return self */ @@ -550,7 +549,7 @@ public function getFacets() /** * Sets facets * - * @param array>|null $facets A mapping of each facet name to the corresponding facet counts. + * @param array>|null $facets a mapping of each facet name to the corresponding facet counts * * @return self */ @@ -574,7 +573,7 @@ public function getFacetsStats() /** * Sets facetsStats * - * @param array|null $facetsStats Statistics for numerical facets. + * @param array|null $facetsStats statistics for numerical facets * * @return self */ @@ -598,7 +597,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int $hitsPerPage Set the number of hits per page. + * @param int $hitsPerPage set the number of hits per page * * @return self */ @@ -622,7 +621,7 @@ public function getIndex() /** * Sets index * - * @param string|null $index Index name used for the query. + * @param string|null $index index name used for the query * * @return self */ @@ -670,7 +669,7 @@ public function getMessage() /** * Sets message * - * @param string|null $message Used to return warnings about the query. + * @param string|null $message used to return warnings about the query * * @return self */ @@ -694,7 +693,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits Number of hits that the search query matched. + * @param int $nbHits number of hits that the search query matched * * @return self */ @@ -766,7 +765,7 @@ public function getPage() /** * Sets page * - * @param int $page Specify the page to retrieve. + * @param int $page specify the page to retrieve * * @return self */ @@ -790,7 +789,7 @@ public function getParams() /** * Sets params * - * @param string $params A url-encoded string of all search parameters. + * @param string $params a url-encoded string of all search parameters * * @return self */ @@ -814,7 +813,7 @@ public function getParsedQuery() /** * Sets parsedQuery * - * @param string|null $parsedQuery The query string that will be searched, after normalization. + * @param string|null $parsedQuery the query string that will be searched, after normalization * * @return self */ @@ -838,7 +837,7 @@ public function getProcessingTimeMS() /** * Sets processingTimeMS * - * @param int $processingTimeMS Time the server took to process the request, in milliseconds. + * @param int $processingTimeMS time the server took to process the request, in milliseconds * * @return self */ @@ -862,7 +861,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -886,7 +885,7 @@ public function getQueryAfterRemoval() /** * Sets queryAfterRemoval * - * @param string|null $queryAfterRemoval A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. + * @param string|null $queryAfterRemoval a markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set * * @return self */ @@ -910,7 +909,7 @@ public function getServerUsed() /** * Sets serverUsed * - * @param string|null $serverUsed Actual host name of the server that processed the request. + * @param string|null $serverUsed actual host name of the server that processed the request * * @return self */ @@ -934,7 +933,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData Lets you store custom data in your indices. + * @param object|null $userData lets you store custom data in your indices * * @return self */ @@ -995,9 +994,9 @@ public function setCursor($cursor) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -1007,7 +1006,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -1036,7 +1035,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -1047,10 +1046,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -1081,4 +1081,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php b/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php index 3812d64acb..0b47b91e5e 100644 --- a/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php +++ b/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * BuildInOperation Class Doc Comment * * @category Class * @description To update an attribute without pushing the entire record, you can use these built-in operations. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class BuildInOperation implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'operation' => 'string', - 'value' => 'string' + 'value' => 'string', ]; /** @@ -45,7 +46,7 @@ class BuildInOperation implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'operation' => null, - 'value' => null + 'value' => null, ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'operation' => '_operation', - 'value' => 'value' + 'value' => 'value', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'operation' => 'setOperation', - 'value' => 'setValue' + 'value' => 'setValue', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'operation' => 'getOperation', - 'value' => 'getValue' + 'value' => 'getValue', ]; /** @@ -209,6 +210,7 @@ public function listInvalidProperties() if ($this->container['value'] === null) { $invalidProperties[] = "'value' can't be null"; } + return $invalidProperties; } @@ -223,7 +225,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets operation * @@ -237,7 +238,7 @@ public function getOperation() /** * Sets operation * - * @param string $operation The operation to apply on the attribute. + * @param string $operation the operation to apply on the attribute * * @return self */ @@ -271,7 +272,7 @@ public function getValue() /** * Sets value * - * @param string $value the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove. + * @param string $value the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove * * @return self */ @@ -284,9 +285,9 @@ public function setValue($value) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -296,7 +297,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -325,7 +326,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -336,10 +337,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -370,4 +372,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Condition.php b/clients/algoliasearch-client-php/lib/Model/Condition.php index 56abe62cb6..df2723672e 100644 --- a/clients/algoliasearch-client-php/lib/Model/Condition.php +++ b/clients/algoliasearch-client-php/lib/Model/Condition.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Condition Class Doc Comment @@ -34,7 +34,7 @@ class Condition implements ModelInterface, ArrayAccess, \JsonSerializable 'pattern' => 'string', 'anchoring' => '\Algolia\AlgoliaSearch\Model\Anchoring', 'alternatives' => 'bool', - 'context' => 'string' + 'context' => 'string', ]; /** @@ -48,7 +48,7 @@ class Condition implements ModelInterface, ArrayAccess, \JsonSerializable 'pattern' => null, 'anchoring' => null, 'alternatives' => null, - 'context' => null + 'context' => null, ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() 'pattern' => 'pattern', 'anchoring' => 'anchoring', 'alternatives' => 'alternatives', - 'context' => 'context' + 'context' => 'context', ]; /** @@ -93,7 +93,7 @@ public static function openAPIFormats() 'pattern' => 'setPattern', 'anchoring' => 'setAnchoring', 'alternatives' => 'setAlternatives', - 'context' => 'setContext' + 'context' => 'setContext', ]; /** @@ -105,7 +105,7 @@ public static function openAPIFormats() 'pattern' => 'getPattern', 'anchoring' => 'getAnchoring', 'alternatives' => 'getAlternatives', - 'context' => 'getContext' + 'context' => 'getContext', ]; /** @@ -149,7 +149,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -194,7 +193,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets pattern * @@ -256,7 +254,7 @@ public function getAlternatives() /** * Sets alternatives * - * @param bool|null $alternatives Whether the pattern matches on plurals, synonyms, and typos. + * @param bool|null $alternatives whether the pattern matches on plurals, synonyms, and typos * * @return self */ @@ -280,7 +278,7 @@ public function getContext() /** * Sets context * - * @param string|null $context Rule context format: [A-Za-z0-9_-]+). + * @param string|null $context rule context format: [A-Za-z0-9_-]+) * * @return self */ @@ -293,9 +291,9 @@ public function setContext($context) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -305,7 +303,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -334,7 +332,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -345,10 +343,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -379,4 +378,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Consequence.php b/clients/algoliasearch-client-php/lib/Model/Consequence.php index 5399db7de5..d3d51ae219 100644 --- a/clients/algoliasearch-client-php/lib/Model/Consequence.php +++ b/clients/algoliasearch-client-php/lib/Model/Consequence.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Consequence Class Doc Comment * * @category Class * @description Consequence of the Rule. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -36,7 +37,7 @@ class Consequence implements ModelInterface, ArrayAccess, \JsonSerializable 'promote' => '\Algolia\AlgoliaSearch\Model\Promote[]', 'filterPromotes' => 'bool', 'hide' => '\Algolia\AlgoliaSearch\Model\ConsequenceHide[]', - 'userData' => 'object' + 'userData' => 'object', ]; /** @@ -51,7 +52,7 @@ class Consequence implements ModelInterface, ArrayAccess, \JsonSerializable 'promote' => null, 'filterPromotes' => null, 'hide' => null, - 'userData' => null + 'userData' => null, ]; /** @@ -85,7 +86,7 @@ public static function openAPIFormats() 'promote' => 'promote', 'filterPromotes' => 'filterPromotes', 'hide' => 'hide', - 'userData' => 'userData' + 'userData' => 'userData', ]; /** @@ -98,7 +99,7 @@ public static function openAPIFormats() 'promote' => 'setPromote', 'filterPromotes' => 'setFilterPromotes', 'hide' => 'setHide', - 'userData' => 'setUserData' + 'userData' => 'setUserData', ]; /** @@ -111,7 +112,7 @@ public static function openAPIFormats() 'promote' => 'getPromote', 'filterPromotes' => 'getFilterPromotes', 'hide' => 'getHide', - 'userData' => 'getUserData' + 'userData' => 'getUserData', ]; /** @@ -155,7 +156,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -201,7 +201,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets params * @@ -239,7 +238,7 @@ public function getPromote() /** * Sets promote * - * @param \Algolia\AlgoliaSearch\Model\Promote[]|null $promote Objects to promote as hits. + * @param \Algolia\AlgoliaSearch\Model\Promote[]|null $promote objects to promote as hits * * @return self */ @@ -324,9 +323,9 @@ public function setUserData($userData) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -336,7 +335,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -365,7 +364,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -376,10 +375,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -410,4 +410,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php b/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php index 35fcc49b7b..8a5716ca77 100644 --- a/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php +++ b/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ConsequenceHide Class Doc Comment * * @category Class * @description Unique identifier of the object to hide. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class ConsequenceHide implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'objectID' => 'string' + 'objectID' => 'string', ]; /** @@ -43,7 +44,7 @@ class ConsequenceHide implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'objectID' => null + 'objectID' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'objectID' => 'objectID' + 'objectID' => 'objectID', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'objectID' => 'setObjectID' + 'objectID' => 'setObjectID', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'objectID' => 'getObjectID' + 'objectID' => 'getObjectID', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['objectID'] === null) { $invalidProperties[] = "'objectID' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -194,7 +194,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID Unique identifier of the object. + * @param string $objectID unique identifier of the object * * @return self */ @@ -207,9 +207,9 @@ public function setObjectID($objectID) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php b/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php index 1d45a92a8a..2851a1ea17 100644 --- a/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php +++ b/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ConsequenceParams Class Doc Comment @@ -109,7 +109,7 @@ class ConsequenceParams implements ModelInterface, ArrayAccess, \JsonSerializabl 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object' + 'renderingContent' => 'object', ]; /** @@ -198,7 +198,7 @@ class ConsequenceParams implements ModelInterface, ArrayAccess, \JsonSerializabl 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null + 'renderingContent' => null, ]; /** @@ -306,7 +306,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent' + 'renderingContent' => 'renderingContent', ]; /** @@ -393,7 +393,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent' + 'renderingContent' => 'setRenderingContent', ]; /** @@ -480,7 +480,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent' + 'renderingContent' => 'getRenderingContent', ]; /** @@ -816,7 +816,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets query * @@ -830,7 +829,7 @@ public function getQuery() /** * Sets query * - * @param string|null $query Query string. + * @param string|null $query query string * * @return self */ @@ -854,7 +853,7 @@ public function getAutomaticFacetFilters() /** * Sets automaticFacetFilters * - * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticFacetFilters Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern. + * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticFacetFilters names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern * * @return self */ @@ -878,7 +877,7 @@ public function getAutomaticOptionalFacetFilters() /** * Sets automaticOptionalFacetFilters * - * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticOptionalFacetFilters Same syntax as automaticFacetFilters, but the engine treats the filters as optional. + * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticOptionalFacetFilters same syntax as automaticFacetFilters, but the engine treats the filters as optional * * @return self */ @@ -902,7 +901,7 @@ public function getSimilarQuery() /** * Sets similarQuery * - * @param string|null $similarQuery Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results. + * @param string|null $similarQuery overrides the query parameter and performs a more generic search that can be used to find \"similar\" results * * @return self */ @@ -926,7 +925,7 @@ public function getFilters() /** * Sets filters * - * @param string|null $filters Filter the query with numeric, facet and/or tag filters. + * @param string|null $filters filter the query with numeric, facet and/or tag filters * * @return self */ @@ -950,7 +949,7 @@ public function getFacetFilters() /** * Sets facetFilters * - * @param string[]|null $facetFilters Filter hits by facet value. + * @param string[]|null $facetFilters filter hits by facet value * * @return self */ @@ -974,7 +973,7 @@ public function getOptionalFilters() /** * Sets optionalFilters * - * @param string[]|null $optionalFilters Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. + * @param string[]|null $optionalFilters create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter * * @return self */ @@ -998,7 +997,7 @@ public function getNumericFilters() /** * Sets numericFilters * - * @param string[]|null $numericFilters Filter on numeric attributes. + * @param string[]|null $numericFilters filter on numeric attributes * * @return self */ @@ -1022,7 +1021,7 @@ public function getTagFilters() /** * Sets tagFilters * - * @param string[]|null $tagFilters Filter hits by tags. + * @param string[]|null $tagFilters filter hits by tags * * @return self */ @@ -1046,7 +1045,7 @@ public function getSumOrFiltersScores() /** * Sets sumOrFiltersScores * - * @param bool|null $sumOrFiltersScores Determines how to calculate the total score for filtering. + * @param bool|null $sumOrFiltersScores determines how to calculate the total score for filtering * * @return self */ @@ -1070,7 +1069,7 @@ public function getFacets() /** * Sets facets * - * @param string[]|null $facets Retrieve facets and their facet values. + * @param string[]|null $facets retrieve facets and their facet values * * @return self */ @@ -1094,7 +1093,7 @@ public function getMaxValuesPerFacet() /** * Sets maxValuesPerFacet * - * @param int|null $maxValuesPerFacet Maximum number of facet values to return for each facet during a regular search. + * @param int|null $maxValuesPerFacet maximum number of facet values to return for each facet during a regular search * * @return self */ @@ -1118,7 +1117,7 @@ public function getFacetingAfterDistinct() /** * Sets facetingAfterDistinct * - * @param bool|null $facetingAfterDistinct Force faceting to be applied after de-duplication (via the Distinct setting). + * @param bool|null $facetingAfterDistinct force faceting to be applied after de-duplication (via the Distinct setting) * * @return self */ @@ -1142,7 +1141,7 @@ public function getSortFacetValuesBy() /** * Sets sortFacetValuesBy * - * @param string|null $sortFacetValuesBy Controls how facet values are fetched. + * @param string|null $sortFacetValuesBy controls how facet values are fetched * * @return self */ @@ -1166,7 +1165,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Specify the page to retrieve. + * @param int|null $page specify the page to retrieve * * @return self */ @@ -1190,7 +1189,7 @@ public function getOffset() /** * Sets offset * - * @param int|null $offset Specify the offset of the first hit to return. + * @param int|null $offset specify the offset of the first hit to return * * @return self */ @@ -1214,7 +1213,7 @@ public function getLength() /** * Sets length * - * @param int|null $length Set the number of hits to retrieve (used only with offset). + * @param int|null $length set the number of hits to retrieve (used only with offset) * * @return self */ @@ -1246,7 +1245,7 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng Search for entries around a central geolocation, enabling a geo search within a circular area. + * @param string|null $aroundLatLng search for entries around a central geolocation, enabling a geo search within a circular area * * @return self */ @@ -1270,7 +1269,7 @@ public function getAroundLatLngViaIP() /** * Sets aroundLatLngViaIP * - * @param bool|null $aroundLatLngViaIP Search for entries around a given location automatically computed from the requester's IP address. + * @param bool|null $aroundLatLngViaIP search for entries around a given location automatically computed from the requester's IP address * * @return self */ @@ -1294,7 +1293,7 @@ public function getAroundRadius() /** * Sets aroundRadius * - * @param OneOfIntegerString|null $aroundRadius Define the maximum radius for a geo search (in meters). + * @param OneOfIntegerString|null $aroundRadius define the maximum radius for a geo search (in meters) * * @return self */ @@ -1318,7 +1317,7 @@ public function getAroundPrecision() /** * Sets aroundPrecision * - * @param int|null $aroundPrecision Precision of geo search (in meters), to add grouping by geo location to the ranking formula. + * @param int|null $aroundPrecision precision of geo search (in meters), to add grouping by geo location to the ranking formula * * @return self */ @@ -1342,7 +1341,7 @@ public function getMinimumAroundRadius() /** * Sets minimumAroundRadius * - * @param int|null $minimumAroundRadius Minimum radius (in meters) used for a geo search when aroundRadius is not set. + * @param int|null $minimumAroundRadius minimum radius (in meters) used for a geo search when aroundRadius is not set * * @return self */ @@ -1371,7 +1370,7 @@ public function getInsideBoundingBox() /** * Sets insideBoundingBox * - * @param float[]|null $insideBoundingBox Search inside a rectangular area (in geo coordinates). + * @param float[]|null $insideBoundingBox search inside a rectangular area (in geo coordinates) * * @return self */ @@ -1395,7 +1394,7 @@ public function getInsidePolygon() /** * Sets insidePolygon * - * @param float[]|null $insidePolygon Search inside a polygon (in geo coordinates). + * @param float[]|null $insidePolygon search inside a polygon (in geo coordinates) * * @return self */ @@ -1443,7 +1442,7 @@ public function getRuleContexts() /** * Sets ruleContexts * - * @param string[]|null $ruleContexts Enables contextual rules. + * @param string[]|null $ruleContexts enables contextual rules * * @return self */ @@ -1467,7 +1466,7 @@ public function getPersonalizationImpact() /** * Sets personalizationImpact * - * @param int|null $personalizationImpact Define the impact of the Personalization feature. + * @param int|null $personalizationImpact define the impact of the Personalization feature * * @return self */ @@ -1491,7 +1490,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken Associates a certain user token with the current search. + * @param string|null $userToken associates a certain user token with the current search * * @return self */ @@ -1515,7 +1514,7 @@ public function getGetRankingInfo() /** * Sets getRankingInfo * - * @param bool|null $getRankingInfo Retrieve detailed ranking information. + * @param bool|null $getRankingInfo retrieve detailed ranking information * * @return self */ @@ -1539,7 +1538,7 @@ public function getClickAnalytics() /** * Sets clickAnalytics * - * @param bool|null $clickAnalytics Enable the Click Analytics feature. + * @param bool|null $clickAnalytics enable the Click Analytics feature * * @return self */ @@ -1563,7 +1562,7 @@ public function getAnalytics() /** * Sets analytics * - * @param bool|null $analytics Whether the current query will be taken into account in the Analytics. + * @param bool|null $analytics whether the current query will be taken into account in the Analytics * * @return self */ @@ -1587,7 +1586,7 @@ public function getAnalyticsTags() /** * Sets analyticsTags * - * @param string[]|null $analyticsTags List of tags to apply to the query for analytics purposes. + * @param string[]|null $analyticsTags list of tags to apply to the query for analytics purposes * * @return self */ @@ -1611,7 +1610,7 @@ public function getPercentileComputation() /** * Sets percentileComputation * - * @param bool|null $percentileComputation Whether to include or exclude a query from the processing-time percentile computation. + * @param bool|null $percentileComputation whether to include or exclude a query from the processing-time percentile computation * * @return self */ @@ -1635,7 +1634,7 @@ public function getEnableABTest() /** * Sets enableABTest * - * @param bool|null $enableABTest Whether this search should participate in running AB tests. + * @param bool|null $enableABTest whether this search should participate in running AB tests * * @return self */ @@ -1659,7 +1658,7 @@ public function getEnableReRanking() /** * Sets enableReRanking * - * @param bool|null $enableReRanking Whether this search should use AI Re-Ranking. + * @param bool|null $enableReRanking whether this search should use AI Re-Ranking * * @return self */ @@ -1683,7 +1682,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes The complete list of attributes used for searching. + * @param string[]|null $searchableAttributes the complete list of attributes used for searching * * @return self */ @@ -1707,7 +1706,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. + * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting * * @return self */ @@ -1731,7 +1730,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. + * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time * * @return self */ @@ -1755,7 +1754,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. + * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve * * @return self */ @@ -1779,7 +1778,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. + * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes * * @return self */ @@ -1803,7 +1802,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking Controls how Algolia should sort your results. + * @param string[]|null $ranking controls how Algolia should sort your results * * @return self */ @@ -1827,7 +1826,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking Specifies the custom ranking criterion. + * @param string[]|null $customRanking specifies the custom ranking criterion * * @return self */ @@ -1851,7 +1850,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. + * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results * * @return self */ @@ -1875,7 +1874,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight List of attributes to highlight. + * @param string[]|null $attributesToHighlight list of attributes to highlight * * @return self */ @@ -1899,7 +1898,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. + * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet * * @return self */ @@ -1923,7 +1922,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results * * @return self */ @@ -1947,7 +1946,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results * * @return self */ @@ -1971,7 +1970,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. + * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated * * @return self */ @@ -1995,7 +1994,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. + * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query * * @return self */ @@ -2019,7 +2018,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -2043,7 +2042,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. + * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo * * @return self */ @@ -2067,7 +2066,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. + * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos * * @return self */ @@ -2091,7 +2090,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. + * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied * * @return self */ @@ -2125,7 +2124,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. + * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string * * @return self */ @@ -2149,7 +2148,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. + * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance * * @return self */ @@ -2173,7 +2172,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex Control which separators are indexed. + * @param string|null $separatorsToIndex control which separators are indexed * * @return self */ @@ -2197,7 +2196,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. + * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms * * @return self */ @@ -2221,7 +2220,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. + * @param string|null $removeStopWords removes stop (common) words from the query before executing it * * @return self */ @@ -2245,7 +2244,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. + * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize * * @return self */ @@ -2269,7 +2268,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. + * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection * * @return self */ @@ -2293,7 +2292,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. + * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query * * @return self */ @@ -2317,7 +2316,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules Whether Rules should be globally enabled. + * @param bool|null $enableRules whether Rules should be globally enabled * * @return self */ @@ -2341,7 +2340,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization Enable the Personalization feature. + * @param bool|null $enablePersonalization enable the Personalization feature * * @return self */ @@ -2365,7 +2364,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType Controls if and how query words are interpreted as prefixes. + * @param string|null $queryType controls if and how query words are interpreted as prefixes * * @return self */ @@ -2399,7 +2398,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. + * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits * * @return self */ @@ -2433,7 +2432,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax Enables the advanced query syntax. + * @param bool|null $advancedSyntax enables the advanced query syntax * * @return self */ @@ -2457,7 +2456,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. + * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query * * @return self */ @@ -2481,7 +2480,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. + * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion * * @return self */ @@ -2505,7 +2504,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. + * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word * * @return self */ @@ -2539,7 +2538,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. + * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion * * @return self */ @@ -2572,7 +2571,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. + * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled * * @return self */ @@ -2605,7 +2604,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct Enables de-duplication or grouping of results. + * @param int|null $distinct enables de-duplication or grouping of results * * @return self */ @@ -2637,7 +2636,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. + * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search * * @return self */ @@ -2661,7 +2660,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. + * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself * * @return self */ @@ -2685,7 +2684,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity Precision of the proximity ranking criterion. + * @param int|null $minProximity precision of the proximity ranking criterion * * @return self */ @@ -2770,7 +2769,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. + * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage * * @return self */ @@ -2807,9 +2806,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -2819,7 +2818,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -2848,7 +2847,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -2859,10 +2858,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -2893,4 +2893,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php b/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php index 0aa84a34c1..05b718c055 100644 --- a/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php +++ b/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * CreatedAtObject Class Doc Comment @@ -31,7 +31,7 @@ class CreatedAtObject implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'createdAt' => '\DateTime' + 'createdAt' => '\DateTime', ]; /** @@ -42,7 +42,7 @@ class CreatedAtObject implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'createdAt' => 'date-time' + 'createdAt' => 'date-time', ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'createdAt' => 'createdAt' + 'createdAt' => 'createdAt', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'createdAt' => 'setCreatedAt' + 'createdAt' => 'setCreatedAt', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'createdAt' => 'getCreatedAt' + 'createdAt' => 'getCreatedAt', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets createdAt * @@ -193,7 +192,7 @@ public function getCreatedAt() /** * Sets createdAt * - * @param \DateTime $createdAt Date of creation (ISO-8601 format). + * @param \DateTime $createdAt date of creation (ISO-8601 format) * * @return self */ @@ -206,9 +205,9 @@ public function setCreatedAt($createdAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php b/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php index 315a5ae358..0161cef372 100644 --- a/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * CreatedAtResponse Class Doc Comment * * @category Class * @description The response with a createdAt timestamp. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class CreatedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl * @var string[] */ protected static $openAPITypes = [ - 'createdAt' => '\DateTime' + 'createdAt' => '\DateTime', ]; /** @@ -43,7 +44,7 @@ class CreatedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl * @psalm-var array */ protected static $openAPIFormats = [ - 'createdAt' => 'date-time' + 'createdAt' => 'date-time', ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'createdAt' => 'createdAt' + 'createdAt' => 'createdAt', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'createdAt' => 'setCreatedAt' + 'createdAt' => 'setCreatedAt', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'createdAt' => 'getCreatedAt' + 'createdAt' => 'getCreatedAt', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets createdAt * @@ -194,7 +194,7 @@ public function getCreatedAt() /** * Sets createdAt * - * @param \DateTime $createdAt Date of creation (ISO-8601 format). + * @param \DateTime $createdAt date of creation (ISO-8601 format) * * @return self */ @@ -207,9 +207,9 @@ public function setCreatedAt($createdAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php b/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php index 91a0261797..46eeb200e3 100644 --- a/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * DeleteApiKeyResponse Class Doc Comment @@ -31,7 +31,7 @@ class DeleteApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'deletedAt' => '\DateTime' + 'deletedAt' => '\DateTime', ]; /** @@ -42,7 +42,7 @@ class DeleteApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'deletedAt' => 'date-time' + 'deletedAt' => 'date-time', ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'deletedAt' => 'deletedAt' + 'deletedAt' => 'deletedAt', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'deletedAt' => 'setDeletedAt' + 'deletedAt' => 'setDeletedAt', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'deletedAt' => 'getDeletedAt' + 'deletedAt' => 'getDeletedAt', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['deletedAt'] === null) { $invalidProperties[] = "'deletedAt' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets deletedAt * @@ -193,7 +192,7 @@ public function getDeletedAt() /** * Sets deletedAt * - * @param \DateTime $deletedAt Date of deletion (ISO-8601 format). + * @param \DateTime $deletedAt date of deletion (ISO-8601 format) * * @return self */ @@ -206,9 +205,9 @@ public function setDeletedAt($deletedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php b/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php index 0d93123442..32b42cf4da 100644 --- a/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * DeleteSourceResponse Class Doc Comment @@ -31,7 +31,7 @@ class DeleteSourceResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'deletedAt' => '\DateTime' + 'deletedAt' => '\DateTime', ]; /** @@ -42,7 +42,7 @@ class DeleteSourceResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'deletedAt' => 'date-time' + 'deletedAt' => 'date-time', ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'deletedAt' => 'deletedAt' + 'deletedAt' => 'deletedAt', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'deletedAt' => 'setDeletedAt' + 'deletedAt' => 'setDeletedAt', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'deletedAt' => 'getDeletedAt' + 'deletedAt' => 'getDeletedAt', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['deletedAt'] === null) { $invalidProperties[] = "'deletedAt' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets deletedAt * @@ -193,7 +192,7 @@ public function getDeletedAt() /** * Sets deletedAt * - * @param \DateTime $deletedAt Date of deletion (ISO-8601 format). + * @param \DateTime $deletedAt date of deletion (ISO-8601 format) * * @return self */ @@ -206,9 +205,9 @@ public function setDeletedAt($deletedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php b/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php index 7877e7405a..6890a73dec 100644 --- a/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * DeletedAtResponse Class Doc Comment * * @category Class * @description The response with a taskID and a deletedAt timestamp. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class DeletedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPITypes = [ 'taskID' => 'int', - 'deletedAt' => '\DateTime' + 'deletedAt' => '\DateTime', ]; /** @@ -45,7 +46,7 @@ class DeletedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPIFormats = [ 'taskID' => null, - 'deletedAt' => 'date-time' + 'deletedAt' => 'date-time', ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'taskID' => 'taskID', - 'deletedAt' => 'deletedAt' + 'deletedAt' => 'deletedAt', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'taskID' => 'setTaskID', - 'deletedAt' => 'setDeletedAt' + 'deletedAt' => 'setDeletedAt', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'taskID' => 'getTaskID', - 'deletedAt' => 'getDeletedAt' + 'deletedAt' => 'getDeletedAt', ]; /** @@ -140,7 +141,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -175,6 +175,7 @@ public function listInvalidProperties() if ($this->container['deletedAt'] === null) { $invalidProperties[] = "'deletedAt' can't be null"; } + return $invalidProperties; } @@ -189,7 +190,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets taskID * @@ -203,7 +203,7 @@ public function getTaskID() /** * Sets taskID * - * @param int $taskID taskID of the indexing task to wait for. + * @param int $taskID taskID of the indexing task to wait for * * @return self */ @@ -227,7 +227,7 @@ public function getDeletedAt() /** * Sets deletedAt * - * @param \DateTime $deletedAt Date of deletion (ISO-8601 format). + * @param \DateTime $deletedAt date of deletion (ISO-8601 format) * * @return self */ @@ -240,9 +240,9 @@ public function setDeletedAt($deletedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -252,7 +252,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -281,7 +281,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -292,10 +292,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -326,4 +327,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php b/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php index 5f82ce427d..f889b32a35 100644 --- a/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php +++ b/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * DictionaryEntry Class Doc Comment * * @category Class * @description A dictionary entry. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -37,7 +38,7 @@ class DictionaryEntry implements ModelInterface, ArrayAccess, \JsonSerializable 'word' => 'string', 'words' => 'string[]', 'decomposition' => 'string[]', - 'state' => 'string' + 'state' => 'string', ]; /** @@ -53,7 +54,7 @@ class DictionaryEntry implements ModelInterface, ArrayAccess, \JsonSerializable 'word' => null, 'words' => null, 'decomposition' => null, - 'state' => null + 'state' => null, ]; /** @@ -88,7 +89,7 @@ public static function openAPIFormats() 'word' => 'word', 'words' => 'words', 'decomposition' => 'decomposition', - 'state' => 'state' + 'state' => 'state', ]; /** @@ -102,7 +103,7 @@ public static function openAPIFormats() 'word' => 'setWord', 'words' => 'setWords', 'decomposition' => 'setDecomposition', - 'state' => 'setState' + 'state' => 'setState', ]; /** @@ -116,7 +117,7 @@ public static function openAPIFormats() 'word' => 'getWord', 'words' => 'getWords', 'decomposition' => 'getDecomposition', - 'state' => 'getState' + 'state' => 'getState', ]; /** @@ -237,7 +238,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -251,7 +251,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID Unique identifier of the object. + * @param string $objectID unique identifier of the object * * @return self */ @@ -299,7 +299,7 @@ public function getWord() /** * Sets word * - * @param string|null $word The word of the dictionary entry. + * @param string|null $word the word of the dictionary entry * * @return self */ @@ -323,7 +323,7 @@ public function getWords() /** * Sets words * - * @param string[]|null $words The words of the dictionary entry. + * @param string[]|null $words the words of the dictionary entry * * @return self */ @@ -347,7 +347,7 @@ public function getDecomposition() /** * Sets decomposition * - * @param string[]|null $decomposition A decomposition of the word of the dictionary entry. + * @param string[]|null $decomposition a decomposition of the word of the dictionary entry * * @return self */ @@ -371,7 +371,7 @@ public function getState() /** * Sets state * - * @param string|null $state The state of the dictionary entry. + * @param string|null $state the state of the dictionary entry * * @return self */ @@ -394,9 +394,9 @@ public function setState($state) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -406,7 +406,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -435,7 +435,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -446,10 +446,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -480,4 +481,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php b/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php index fca61ce2e7..7f857ed561 100644 --- a/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php +++ b/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * DictionaryLanguage Class Doc Comment * * @category Class * @description Custom entries for a dictionary + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class DictionaryLanguage implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'nbCustomEntires' => 'int' + 'nbCustomEntires' => 'int', ]; /** @@ -43,7 +44,7 @@ class DictionaryLanguage implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'nbCustomEntires' => null + 'nbCustomEntires' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'nbCustomEntires' => 'nbCustomEntires' + 'nbCustomEntires' => 'nbCustomEntires', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'nbCustomEntires' => 'setNbCustomEntires' + 'nbCustomEntires' => 'setNbCustomEntires', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'nbCustomEntires' => 'getNbCustomEntires' + 'nbCustomEntires' => 'getNbCustomEntires', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -177,7 +177,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets nbCustomEntires * @@ -204,9 +203,9 @@ public function setNbCustomEntires($nbCustomEntires) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -216,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -245,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -256,10 +255,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -290,4 +290,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php b/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php index 598f8285e6..3d42992725 100644 --- a/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * DictionarySettingsRequest Class Doc Comment * * @category Class * @description Disable the builtin Algolia entries for a type of dictionary per language. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class DictionarySettingsRequest implements ModelInterface, ArrayAccess, \JsonSer * @var string[] */ protected static $openAPITypes = [ - 'disableStandardEntries' => '\Algolia\AlgoliaSearch\Model\StandardEntries' + 'disableStandardEntries' => '\Algolia\AlgoliaSearch\Model\StandardEntries', ]; /** @@ -43,7 +44,7 @@ class DictionarySettingsRequest implements ModelInterface, ArrayAccess, \JsonSer * @psalm-var array */ protected static $openAPIFormats = [ - 'disableStandardEntries' => null + 'disableStandardEntries' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'disableStandardEntries' => 'disableStandardEntries' + 'disableStandardEntries' => 'disableStandardEntries', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'disableStandardEntries' => 'setDisableStandardEntries' + 'disableStandardEntries' => 'setDisableStandardEntries', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'disableStandardEntries' => 'getDisableStandardEntries' + 'disableStandardEntries' => 'getDisableStandardEntries', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['disableStandardEntries'] === null) { $invalidProperties[] = "'disableStandardEntries' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets disableStandardEntries * @@ -207,9 +207,9 @@ public function setDisableStandardEntries($disableStandardEntries) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ErrorBase.php b/clients/algoliasearch-client-php/lib/Model/ErrorBase.php index 53696972f2..48b357631f 100644 --- a/clients/algoliasearch-client-php/lib/Model/ErrorBase.php +++ b/clients/algoliasearch-client-php/lib/Model/ErrorBase.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ErrorBase Class Doc Comment * * @category Class * @description Error. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class ErrorBase implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'message' => 'string' + 'message' => 'string', ]; /** @@ -43,7 +44,7 @@ class ErrorBase implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'message' => null + 'message' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'message' => 'message' + 'message' => 'message', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'message' => 'setMessage' + 'message' => 'setMessage', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'message' => 'getMessage' + 'message' => 'getMessage', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -177,7 +177,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets message * @@ -204,9 +203,9 @@ public function setMessage($message) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -216,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -245,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -256,10 +255,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -290,4 +290,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php index d946c1d7b9..e76e778e39 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetDictionarySettingsResponse Class Doc Comment @@ -31,7 +31,7 @@ class GetDictionarySettingsResponse implements ModelInterface, ArrayAccess, \Jso * @var string[] */ protected static $openAPITypes = [ - 'disableStandardEntries' => '\Algolia\AlgoliaSearch\Model\StandardEntries' + 'disableStandardEntries' => '\Algolia\AlgoliaSearch\Model\StandardEntries', ]; /** @@ -42,7 +42,7 @@ class GetDictionarySettingsResponse implements ModelInterface, ArrayAccess, \Jso * @psalm-var array */ protected static $openAPIFormats = [ - 'disableStandardEntries' => null + 'disableStandardEntries' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'disableStandardEntries' => 'disableStandardEntries' + 'disableStandardEntries' => 'disableStandardEntries', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'disableStandardEntries' => 'setDisableStandardEntries' + 'disableStandardEntries' => 'setDisableStandardEntries', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'disableStandardEntries' => 'getDisableStandardEntries' + 'disableStandardEntries' => 'getDisableStandardEntries', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['disableStandardEntries'] === null) { $invalidProperties[] = "'disableStandardEntries' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets disableStandardEntries * @@ -206,9 +205,9 @@ public function setDisableStandardEntries($disableStandardEntries) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php index c2e0033e7d..4f45944265 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetLogsResponse Class Doc Comment @@ -31,7 +31,7 @@ class GetLogsResponse implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'logs' => '\Algolia\AlgoliaSearch\Model\GetLogsResponseLogs[]' + 'logs' => '\Algolia\AlgoliaSearch\Model\GetLogsResponseLogs[]', ]; /** @@ -42,7 +42,7 @@ class GetLogsResponse implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'logs' => null + 'logs' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'logs' => 'logs' + 'logs' => 'logs', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'logs' => 'setLogs' + 'logs' => 'setLogs', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'logs' => 'getLogs' + 'logs' => 'getLogs', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['logs'] === null) { $invalidProperties[] = "'logs' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets logs * @@ -206,9 +205,9 @@ public function setLogs($logs) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php index a895461a73..8ae96c2c9f 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php +++ b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetLogsResponseInnerQueries Class Doc Comment @@ -33,7 +33,7 @@ class GetLogsResponseInnerQueries implements ModelInterface, ArrayAccess, \JsonS protected static $openAPITypes = [ 'indexName' => 'string', 'userToken' => 'string', - 'queryId' => 'string' + 'queryId' => 'string', ]; /** @@ -46,7 +46,7 @@ class GetLogsResponseInnerQueries implements ModelInterface, ArrayAccess, \JsonS protected static $openAPIFormats = [ 'indexName' => null, 'userToken' => null, - 'queryId' => null + 'queryId' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'indexName' => 'index_name', 'userToken' => 'user_token', - 'queryId' => 'query_id' + 'queryId' => 'query_id', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'indexName' => 'setIndexName', 'userToken' => 'setUserToken', - 'queryId' => 'setQueryId' + 'queryId' => 'setQueryId', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'indexName' => 'getIndexName', 'userToken' => 'getUserToken', - 'queryId' => 'getQueryId' + 'queryId' => 'getQueryId', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -188,7 +187,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets indexName * @@ -202,7 +200,7 @@ public function getIndexName() /** * Sets indexName * - * @param string|null $indexName Index targeted by the query. + * @param string|null $indexName index targeted by the query * * @return self */ @@ -226,7 +224,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken User identifier. + * @param string|null $userToken user identifier * * @return self */ @@ -250,7 +248,7 @@ public function getQueryId() /** * Sets queryId * - * @param string|null $queryId QueryID for the given query. + * @param string|null $queryId queryID for the given query * * @return self */ @@ -263,9 +261,9 @@ public function setQueryId($queryId) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -275,7 +273,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -304,7 +302,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -315,10 +313,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -349,4 +348,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php index 1c30d989b3..20a071dbf4 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php +++ b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetLogsResponseLogs Class Doc Comment @@ -45,7 +45,7 @@ class GetLogsResponseLogs implements ModelInterface, ArrayAccess, \JsonSerializa 'index' => 'string', 'queryParams' => 'string', 'queryNbHits' => 'string', - 'innerQueries' => '\Algolia\AlgoliaSearch\Model\GetLogsResponseInnerQueries[]' + 'innerQueries' => '\Algolia\AlgoliaSearch\Model\GetLogsResponseInnerQueries[]', ]; /** @@ -70,7 +70,7 @@ class GetLogsResponseLogs implements ModelInterface, ArrayAccess, \JsonSerializa 'index' => null, 'queryParams' => null, 'queryNbHits' => null, - 'innerQueries' => null + 'innerQueries' => null, ]; /** @@ -114,7 +114,7 @@ public static function openAPIFormats() 'index' => 'index', 'queryParams' => 'query_params', 'queryNbHits' => 'query_nb_hits', - 'innerQueries' => 'inner_queries' + 'innerQueries' => 'inner_queries', ]; /** @@ -137,7 +137,7 @@ public static function openAPIFormats() 'index' => 'setIndex', 'queryParams' => 'setQueryParams', 'queryNbHits' => 'setQueryNbHits', - 'innerQueries' => 'setInnerQueries' + 'innerQueries' => 'setInnerQueries', ]; /** @@ -160,7 +160,7 @@ public static function openAPIFormats() 'index' => 'getIndex', 'queryParams' => 'getQueryParams', 'queryNbHits' => 'getQueryNbHits', - 'innerQueries' => 'getInnerQueries' + 'innerQueries' => 'getInnerQueries', ]; /** @@ -204,7 +204,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -279,6 +278,7 @@ public function listInvalidProperties() if ($this->container['processingTimeMs'] === null) { $invalidProperties[] = "'processingTimeMs' can't be null"; } + return $invalidProperties; } @@ -293,7 +293,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets timestamp * @@ -307,7 +306,7 @@ public function getTimestamp() /** * Sets timestamp * - * @param string $timestamp Timestamp in ISO-8601 format. + * @param string $timestamp timestamp in ISO-8601 format * * @return self */ @@ -331,7 +330,7 @@ public function getMethod() /** * Sets method * - * @param string $method HTTP method of the perfomed request. + * @param string $method HTTP method of the perfomed request * * @return self */ @@ -355,7 +354,7 @@ public function getAnswerCode() /** * Sets answerCode * - * @param string $answerCode HTTP response code. + * @param string $answerCode HTTP response code * * @return self */ @@ -427,7 +426,7 @@ public function getUrl() /** * Sets url * - * @param string $url Request URL. + * @param string $url request URL * * @return self */ @@ -451,7 +450,7 @@ public function getIp() /** * Sets ip * - * @param string $ip IP of the client which perfomed the request. + * @param string $ip IP of the client which perfomed the request * * @return self */ @@ -475,7 +474,7 @@ public function getQueryHeaders() /** * Sets queryHeaders * - * @param string $queryHeaders Request Headers (API Key is obfuscated). + * @param string $queryHeaders request Headers (API Key is obfuscated) * * @return self */ @@ -499,7 +498,7 @@ public function getSha1() /** * Sets sha1 * - * @param string $sha1 SHA1 signature of the log entry. + * @param string $sha1 SHA1 signature of the log entry * * @return self */ @@ -523,7 +522,7 @@ public function getNbApiCalls() /** * Sets nbApiCalls * - * @param string $nbApiCalls Number of API calls. + * @param string $nbApiCalls number of API calls * * @return self */ @@ -571,7 +570,7 @@ public function getIndex() /** * Sets index * - * @param string|null $index Index targeted by the query. + * @param string|null $index index targeted by the query * * @return self */ @@ -595,7 +594,7 @@ public function getQueryParams() /** * Sets queryParams * - * @param string|null $queryParams Query parameters sent with the request. + * @param string|null $queryParams query parameters sent with the request * * @return self */ @@ -619,7 +618,7 @@ public function getQueryNbHits() /** * Sets queryNbHits * - * @param string|null $queryNbHits Number of hits returned for the query. + * @param string|null $queryNbHits number of hits returned for the query * * @return self */ @@ -643,7 +642,7 @@ public function getInnerQueries() /** * Sets innerQueries * - * @param \Algolia\AlgoliaSearch\Model\GetLogsResponseInnerQueries[]|null $innerQueries Array of all performed queries for the given request. + * @param \Algolia\AlgoliaSearch\Model\GetLogsResponseInnerQueries[]|null $innerQueries array of all performed queries for the given request * * @return self */ @@ -656,9 +655,9 @@ public function setInnerQueries($innerQueries) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -668,7 +667,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -697,7 +696,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -708,10 +707,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -742,4 +742,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php b/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php index 7e4184184d..7d36088284 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetObjectsObject Class Doc Comment * * @category Class * @description The `getObjects` requests. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class GetObjectsObject implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'requests' => '\Algolia\AlgoliaSearch\Model\MultipleGetObjectsObject[]' + 'requests' => '\Algolia\AlgoliaSearch\Model\MultipleGetObjectsObject[]', ]; /** @@ -43,7 +44,7 @@ class GetObjectsObject implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'requests' => null + 'requests' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'requests' => 'requests' + 'requests' => 'requests', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'requests' => 'setRequests' + 'requests' => 'setRequests', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'requests' => 'getRequests' + 'requests' => 'getRequests', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -177,7 +177,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets requests * @@ -204,9 +203,9 @@ public function setRequests($requests) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -216,7 +215,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -245,7 +244,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -256,10 +255,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -290,4 +290,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php index 3e54417691..fb8d8fcba6 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetObjectsResponse Class Doc Comment @@ -31,7 +31,7 @@ class GetObjectsResponse implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'results' => 'object[]' + 'results' => 'object[]', ]; /** @@ -42,7 +42,7 @@ class GetObjectsResponse implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'results' => null + 'results' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'results' => 'results' + 'results' => 'results', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'results' => 'setResults' + 'results' => 'setResults', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'results' => 'getResults' + 'results' => 'getResults', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -176,7 +175,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets results * @@ -190,7 +188,7 @@ public function getResults() /** * Sets results * - * @param object[]|null $results List of results fetched. + * @param object[]|null $results list of results fetched * * @return self */ @@ -203,9 +201,9 @@ public function setResults($results) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -215,7 +213,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -244,7 +242,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -255,10 +253,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -289,4 +288,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php b/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php index 5f11816c35..ae9e7c2f3c 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetTaskResponse Class Doc Comment @@ -31,7 +31,7 @@ class GetTaskResponse implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'status' => 'string' + 'status' => 'string', ]; /** @@ -42,7 +42,7 @@ class GetTaskResponse implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'status' => null + 'status' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'status' => 'status' + 'status' => 'status', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'status' => 'setStatus' + 'status' => 'setStatus', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'status' => 'getStatus' + 'status' => 'getStatus', ]; /** @@ -203,7 +203,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets status * @@ -240,9 +239,9 @@ public function setStatus($status) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -252,7 +251,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -281,7 +280,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -292,10 +291,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -326,4 +326,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php index 138d5abf2f..0c381becc3 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * GetTopUserIdsResponse Class Doc Comment * * @category Class * @description Array of userIDs and clusters. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class GetTopUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSeriali * @var string[] */ protected static $openAPITypes = [ - 'topUsers' => 'array[]' + 'topUsers' => 'array[]', ]; /** @@ -43,7 +44,7 @@ class GetTopUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSeriali * @psalm-var array */ protected static $openAPIFormats = [ - 'topUsers' => null + 'topUsers' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'topUsers' => 'topUsers' + 'topUsers' => 'topUsers', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'topUsers' => 'setTopUsers' + 'topUsers' => 'setTopUsers', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'topUsers' => 'getTopUsers' + 'topUsers' => 'getTopUsers', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['topUsers'] === null) { $invalidProperties[] = "'topUsers' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets topUsers * @@ -194,7 +194,7 @@ public function getTopUsers() /** * Sets topUsers * - * @param array[] $topUsers Mapping of cluster names to top users. + * @param array[] $topUsers Mapping of cluster names to top users * * @return self */ @@ -207,9 +207,9 @@ public function setTopUsers($topUsers) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/HighlightResult.php b/clients/algoliasearch-client-php/lib/Model/HighlightResult.php index 129b4740ed..5fc77c2e70 100644 --- a/clients/algoliasearch-client-php/lib/Model/HighlightResult.php +++ b/clients/algoliasearch-client-php/lib/Model/HighlightResult.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * HighlightResult Class Doc Comment * * @category Class * @description Highlighted attributes. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +36,7 @@ class HighlightResult implements ModelInterface, ArrayAccess, \JsonSerializable 'value' => 'string', 'matchLevel' => 'string', 'matchedWords' => 'string[]', - 'fullyHighlighted' => 'bool' + 'fullyHighlighted' => 'bool', ]; /** @@ -49,7 +50,7 @@ class HighlightResult implements ModelInterface, ArrayAccess, \JsonSerializable 'value' => null, 'matchLevel' => null, 'matchedWords' => null, - 'fullyHighlighted' => null + 'fullyHighlighted' => null, ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() 'value' => 'value', 'matchLevel' => 'matchLevel', 'matchedWords' => 'matchedWords', - 'fullyHighlighted' => 'fullyHighlighted' + 'fullyHighlighted' => 'fullyHighlighted', ]; /** @@ -94,7 +95,7 @@ public static function openAPIFormats() 'value' => 'setValue', 'matchLevel' => 'setMatchLevel', 'matchedWords' => 'setMatchedWords', - 'fullyHighlighted' => 'setFullyHighlighted' + 'fullyHighlighted' => 'setFullyHighlighted', ]; /** @@ -106,7 +107,7 @@ public static function openAPIFormats() 'value' => 'getValue', 'matchLevel' => 'getMatchLevel', 'matchedWords' => 'getMatchedWords', - 'fullyHighlighted' => 'getFullyHighlighted' + 'fullyHighlighted' => 'getFullyHighlighted', ]; /** @@ -221,7 +222,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets value * @@ -235,7 +235,7 @@ public function getValue() /** * Sets value * - * @param string|null $value Markup text with occurrences highlighted. + * @param string|null $value markup text with occurrences highlighted * * @return self */ @@ -259,7 +259,7 @@ public function getMatchLevel() /** * Sets matchLevel * - * @param string|null $matchLevel Indicates how well the attribute matched the search query. + * @param string|null $matchLevel indicates how well the attribute matched the search query * * @return self */ @@ -293,7 +293,7 @@ public function getMatchedWords() /** * Sets matchedWords * - * @param string[]|null $matchedWords List of words from the query that matched the object. + * @param string[]|null $matchedWords list of words from the query that matched the object * * @return self */ @@ -317,7 +317,7 @@ public function getFullyHighlighted() /** * Sets fullyHighlighted * - * @param bool|null $fullyHighlighted Whether the entire attribute value is highlighted. + * @param bool|null $fullyHighlighted whether the entire attribute value is highlighted * * @return self */ @@ -330,9 +330,9 @@ public function setFullyHighlighted($fullyHighlighted) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -342,7 +342,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -371,7 +371,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -382,10 +382,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -416,4 +417,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Index.php b/clients/algoliasearch-client-php/lib/Model/Index.php index 03a2871dcd..aa437874bf 100644 --- a/clients/algoliasearch-client-php/lib/Model/Index.php +++ b/clients/algoliasearch-client-php/lib/Model/Index.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Index Class Doc Comment @@ -41,7 +41,7 @@ class Index implements ModelInterface, ArrayAccess, \JsonSerializable 'numberOfPendingTask' => 'int', 'pendingTask' => 'bool', 'primary' => 'string', - 'replicas' => 'string[]' + 'replicas' => 'string[]', ]; /** @@ -62,7 +62,7 @@ class Index implements ModelInterface, ArrayAccess, \JsonSerializable 'numberOfPendingTask' => null, 'pendingTask' => null, 'primary' => null, - 'replicas' => null + 'replicas' => null, ]; /** @@ -102,7 +102,7 @@ public static function openAPIFormats() 'numberOfPendingTask' => 'numberOfPendingTask', 'pendingTask' => 'pendingTask', 'primary' => 'primary', - 'replicas' => 'replicas' + 'replicas' => 'replicas', ]; /** @@ -121,7 +121,7 @@ public static function openAPIFormats() 'numberOfPendingTask' => 'setNumberOfPendingTask', 'pendingTask' => 'setPendingTask', 'primary' => 'setPrimary', - 'replicas' => 'setReplicas' + 'replicas' => 'setReplicas', ]; /** @@ -140,7 +140,7 @@ public static function openAPIFormats() 'numberOfPendingTask' => 'getNumberOfPendingTask', 'pendingTask' => 'getPendingTask', 'primary' => 'getPrimary', - 'replicas' => 'getReplicas' + 'replicas' => 'getReplicas', ]; /** @@ -184,7 +184,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -246,6 +245,7 @@ public function listInvalidProperties() if ($this->container['pendingTask'] === null) { $invalidProperties[] = "'pendingTask' can't be null"; } + return $invalidProperties; } @@ -260,7 +260,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets name * @@ -274,7 +273,7 @@ public function getName() /** * Sets name * - * @param string $name Index name. + * @param string $name index name * * @return self */ @@ -322,7 +321,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -346,7 +345,7 @@ public function getEntries() /** * Sets entries * - * @param int $entries Number of records contained in the index. + * @param int $entries number of records contained in the index * * @return self */ @@ -370,7 +369,7 @@ public function getDataSize() /** * Sets dataSize * - * @param int $dataSize Number of bytes of the index in minified format. + * @param int $dataSize number of bytes of the index in minified format * * @return self */ @@ -394,7 +393,7 @@ public function getFileSize() /** * Sets fileSize * - * @param int $fileSize Number of bytes of the index binary file. + * @param int $fileSize number of bytes of the index binary file * * @return self */ @@ -527,9 +526,9 @@ public function setReplicas($replicas) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -539,7 +538,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -568,7 +567,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -579,10 +578,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -613,4 +613,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/IndexSettings.php b/clients/algoliasearch-client-php/lib/Model/IndexSettings.php index 01ea27278c..c409228d27 100644 --- a/clients/algoliasearch-client-php/lib/Model/IndexSettings.php +++ b/clients/algoliasearch-client-php/lib/Model/IndexSettings.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * IndexSettings Class Doc Comment * * @category Class * @description The Algolia index settings. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -87,7 +88,7 @@ class IndexSettings implements ModelInterface, ArrayAccess, \JsonSerializable 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object' + 'renderingContent' => 'object', ]; /** @@ -153,7 +154,7 @@ class IndexSettings implements ModelInterface, ArrayAccess, \JsonSerializable 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null + 'renderingContent' => null, ]; /** @@ -238,7 +239,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent' + 'renderingContent' => 'renderingContent', ]; /** @@ -302,7 +303,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent' + 'renderingContent' => 'setRenderingContent', ]; /** @@ -366,7 +367,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent' + 'renderingContent' => 'getRenderingContent', ]; /** @@ -667,7 +668,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets replicas * @@ -681,7 +681,7 @@ public function getReplicas() /** * Sets replicas * - * @param string[]|null $replicas Creates replicas, exact copies of an index. + * @param string[]|null $replicas creates replicas, exact copies of an index * * @return self */ @@ -705,7 +705,7 @@ public function getPaginationLimitedTo() /** * Sets paginationLimitedTo * - * @param int|null $paginationLimitedTo Set the maximum number of hits accessible via pagination. + * @param int|null $paginationLimitedTo set the maximum number of hits accessible via pagination * * @return self */ @@ -729,7 +729,7 @@ public function getDisableTypoToleranceOnWords() /** * Sets disableTypoToleranceOnWords * - * @param string[]|null $disableTypoToleranceOnWords A list of words for which you want to turn off typo tolerance. + * @param string[]|null $disableTypoToleranceOnWords a list of words for which you want to turn off typo tolerance * * @return self */ @@ -753,7 +753,7 @@ public function getAttributesToTransliterate() /** * Sets attributesToTransliterate * - * @param string[]|null $attributesToTransliterate Specify on which attributes to apply transliteration. + * @param string[]|null $attributesToTransliterate specify on which attributes to apply transliteration * * @return self */ @@ -777,7 +777,7 @@ public function getCamelCaseAttributes() /** * Sets camelCaseAttributes * - * @param string[]|null $camelCaseAttributes List of attributes on which to do a decomposition of camel case words. + * @param string[]|null $camelCaseAttributes list of attributes on which to do a decomposition of camel case words * * @return self */ @@ -801,7 +801,7 @@ public function getDecompoundedAttributes() /** * Sets decompoundedAttributes * - * @param object|null $decompoundedAttributes Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding. + * @param object|null $decompoundedAttributes specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding * * @return self */ @@ -825,7 +825,7 @@ public function getIndexLanguages() /** * Sets indexLanguages * - * @param string[]|null $indexLanguages Sets the languages at the index level for language-specific processing such as tokenization and normalization. + * @param string[]|null $indexLanguages sets the languages at the index level for language-specific processing such as tokenization and normalization * * @return self */ @@ -849,7 +849,7 @@ public function getFilterPromotes() /** * Sets filterPromotes * - * @param bool|null $filterPromotes Whether promoted results should match the filters of the current search, except for geographic filters. + * @param bool|null $filterPromotes whether promoted results should match the filters of the current search, except for geographic filters * * @return self */ @@ -873,7 +873,7 @@ public function getDisablePrefixOnAttributes() /** * Sets disablePrefixOnAttributes * - * @param string[]|null $disablePrefixOnAttributes List of attributes on which you want to disable prefix matching. + * @param string[]|null $disablePrefixOnAttributes list of attributes on which you want to disable prefix matching * * @return self */ @@ -897,7 +897,7 @@ public function getAllowCompressionOfIntegerArray() /** * Sets allowCompressionOfIntegerArray * - * @param bool|null $allowCompressionOfIntegerArray Enables compression of large integer arrays. + * @param bool|null $allowCompressionOfIntegerArray enables compression of large integer arrays * * @return self */ @@ -921,7 +921,7 @@ public function getNumericAttributesForFiltering() /** * Sets numericAttributesForFiltering * - * @param string[]|null $numericAttributesForFiltering List of numeric attributes that can be used as numerical filters. + * @param string[]|null $numericAttributesForFiltering list of numeric attributes that can be used as numerical filters * * @return self */ @@ -945,7 +945,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData Lets you store custom data in your indices. + * @param object|null $userData lets you store custom data in your indices * * @return self */ @@ -969,7 +969,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes The complete list of attributes used for searching. + * @param string[]|null $searchableAttributes the complete list of attributes used for searching * * @return self */ @@ -993,7 +993,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. + * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting * * @return self */ @@ -1017,7 +1017,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. + * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time * * @return self */ @@ -1041,7 +1041,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. + * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve * * @return self */ @@ -1065,7 +1065,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. + * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes * * @return self */ @@ -1089,7 +1089,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking Controls how Algolia should sort your results. + * @param string[]|null $ranking controls how Algolia should sort your results * * @return self */ @@ -1113,7 +1113,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking Specifies the custom ranking criterion. + * @param string[]|null $customRanking specifies the custom ranking criterion * * @return self */ @@ -1137,7 +1137,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. + * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results * * @return self */ @@ -1161,7 +1161,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight List of attributes to highlight. + * @param string[]|null $attributesToHighlight list of attributes to highlight * * @return self */ @@ -1185,7 +1185,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. + * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet * * @return self */ @@ -1209,7 +1209,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results * * @return self */ @@ -1233,7 +1233,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results * * @return self */ @@ -1257,7 +1257,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. + * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated * * @return self */ @@ -1281,7 +1281,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. + * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query * * @return self */ @@ -1305,7 +1305,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -1329,7 +1329,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. + * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo * * @return self */ @@ -1353,7 +1353,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. + * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos * * @return self */ @@ -1377,7 +1377,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. + * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied * * @return self */ @@ -1411,7 +1411,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. + * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string * * @return self */ @@ -1435,7 +1435,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. + * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance * * @return self */ @@ -1459,7 +1459,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex Control which separators are indexed. + * @param string|null $separatorsToIndex control which separators are indexed * * @return self */ @@ -1483,7 +1483,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. + * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms * * @return self */ @@ -1507,7 +1507,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. + * @param string|null $removeStopWords removes stop (common) words from the query before executing it * * @return self */ @@ -1531,7 +1531,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. + * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize * * @return self */ @@ -1555,7 +1555,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. + * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection * * @return self */ @@ -1579,7 +1579,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. + * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query * * @return self */ @@ -1603,7 +1603,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules Whether Rules should be globally enabled. + * @param bool|null $enableRules whether Rules should be globally enabled * * @return self */ @@ -1627,7 +1627,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization Enable the Personalization feature. + * @param bool|null $enablePersonalization enable the Personalization feature * * @return self */ @@ -1651,7 +1651,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType Controls if and how query words are interpreted as prefixes. + * @param string|null $queryType controls if and how query words are interpreted as prefixes * * @return self */ @@ -1685,7 +1685,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. + * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits * * @return self */ @@ -1719,7 +1719,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax Enables the advanced query syntax. + * @param bool|null $advancedSyntax enables the advanced query syntax * * @return self */ @@ -1743,7 +1743,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. + * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query * * @return self */ @@ -1767,7 +1767,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. + * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion * * @return self */ @@ -1791,7 +1791,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. + * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word * * @return self */ @@ -1825,7 +1825,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. + * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion * * @return self */ @@ -1858,7 +1858,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. + * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled * * @return self */ @@ -1891,7 +1891,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct Enables de-duplication or grouping of results. + * @param int|null $distinct enables de-duplication or grouping of results * * @return self */ @@ -1923,7 +1923,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. + * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search * * @return self */ @@ -1947,7 +1947,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. + * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself * * @return self */ @@ -1971,7 +1971,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity Precision of the proximity ranking criterion. + * @param int|null $minProximity precision of the proximity ranking criterion * * @return self */ @@ -2056,7 +2056,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. + * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage * * @return self */ @@ -2093,9 +2093,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -2105,7 +2105,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -2134,7 +2134,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -2145,10 +2145,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -2179,4 +2180,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php b/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php index 1672b402c3..7b3c52043e 100644 --- a/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * IndexSettingsAsSearchParams Class Doc Comment @@ -74,7 +74,7 @@ class IndexSettingsAsSearchParams implements ModelInterface, ArrayAccess, \JsonS 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object' + 'renderingContent' => 'object', ]; /** @@ -128,7 +128,7 @@ class IndexSettingsAsSearchParams implements ModelInterface, ArrayAccess, \JsonS 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null + 'renderingContent' => null, ]; /** @@ -201,7 +201,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent' + 'renderingContent' => 'renderingContent', ]; /** @@ -253,7 +253,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent' + 'renderingContent' => 'setRenderingContent', ]; /** @@ -305,7 +305,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent' + 'renderingContent' => 'getRenderingContent', ]; /** @@ -594,7 +594,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets searchableAttributes * @@ -608,7 +607,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes The complete list of attributes used for searching. + * @param string[]|null $searchableAttributes the complete list of attributes used for searching * * @return self */ @@ -632,7 +631,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. + * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting * * @return self */ @@ -656,7 +655,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. + * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time * * @return self */ @@ -680,7 +679,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. + * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve * * @return self */ @@ -704,7 +703,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. + * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes * * @return self */ @@ -728,7 +727,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking Controls how Algolia should sort your results. + * @param string[]|null $ranking controls how Algolia should sort your results * * @return self */ @@ -752,7 +751,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking Specifies the custom ranking criterion. + * @param string[]|null $customRanking specifies the custom ranking criterion * * @return self */ @@ -776,7 +775,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. + * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results * * @return self */ @@ -800,7 +799,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight List of attributes to highlight. + * @param string[]|null $attributesToHighlight list of attributes to highlight * * @return self */ @@ -824,7 +823,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. + * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet * * @return self */ @@ -848,7 +847,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results * * @return self */ @@ -872,7 +871,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results * * @return self */ @@ -896,7 +895,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. + * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated * * @return self */ @@ -920,7 +919,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. + * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query * * @return self */ @@ -944,7 +943,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -968,7 +967,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. + * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo * * @return self */ @@ -992,7 +991,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. + * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos * * @return self */ @@ -1016,7 +1015,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. + * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied * * @return self */ @@ -1050,7 +1049,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. + * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string * * @return self */ @@ -1074,7 +1073,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. + * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance * * @return self */ @@ -1098,7 +1097,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex Control which separators are indexed. + * @param string|null $separatorsToIndex control which separators are indexed * * @return self */ @@ -1122,7 +1121,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. + * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms * * @return self */ @@ -1146,7 +1145,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. + * @param string|null $removeStopWords removes stop (common) words from the query before executing it * * @return self */ @@ -1170,7 +1169,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. + * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize * * @return self */ @@ -1194,7 +1193,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. + * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection * * @return self */ @@ -1218,7 +1217,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. + * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query * * @return self */ @@ -1242,7 +1241,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules Whether Rules should be globally enabled. + * @param bool|null $enableRules whether Rules should be globally enabled * * @return self */ @@ -1266,7 +1265,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization Enable the Personalization feature. + * @param bool|null $enablePersonalization enable the Personalization feature * * @return self */ @@ -1290,7 +1289,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType Controls if and how query words are interpreted as prefixes. + * @param string|null $queryType controls if and how query words are interpreted as prefixes * * @return self */ @@ -1324,7 +1323,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. + * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits * * @return self */ @@ -1358,7 +1357,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax Enables the advanced query syntax. + * @param bool|null $advancedSyntax enables the advanced query syntax * * @return self */ @@ -1382,7 +1381,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. + * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query * * @return self */ @@ -1406,7 +1405,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. + * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion * * @return self */ @@ -1430,7 +1429,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. + * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word * * @return self */ @@ -1464,7 +1463,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. + * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion * * @return self */ @@ -1497,7 +1496,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. + * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled * * @return self */ @@ -1530,7 +1529,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct Enables de-duplication or grouping of results. + * @param int|null $distinct enables de-duplication or grouping of results * * @return self */ @@ -1562,7 +1561,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. + * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search * * @return self */ @@ -1586,7 +1585,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. + * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself * * @return self */ @@ -1610,7 +1609,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity Precision of the proximity ranking criterion. + * @param int|null $minProximity precision of the proximity ranking criterion * * @return self */ @@ -1695,7 +1694,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. + * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage * * @return self */ @@ -1732,9 +1731,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -1744,7 +1743,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -1773,7 +1772,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -1784,10 +1783,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -1818,4 +1818,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/KeyObject.php b/clients/algoliasearch-client-php/lib/Model/KeyObject.php index 68429a2485..1cbaf863a3 100644 --- a/clients/algoliasearch-client-php/lib/Model/KeyObject.php +++ b/clients/algoliasearch-client-php/lib/Model/KeyObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * KeyObject Class Doc Comment @@ -39,7 +39,7 @@ class KeyObject implements ModelInterface, ArrayAccess, \JsonSerializable 'queryParameters' => 'string', 'referers' => 'string[]', 'validity' => 'int', - 'createdAt' => '\DateTime' + 'createdAt' => '\DateTime', ]; /** @@ -58,7 +58,7 @@ class KeyObject implements ModelInterface, ArrayAccess, \JsonSerializable 'queryParameters' => null, 'referers' => null, 'validity' => null, - 'createdAt' => 'date-time' + 'createdAt' => 'date-time', ]; /** @@ -96,7 +96,7 @@ public static function openAPIFormats() 'queryParameters' => 'queryParameters', 'referers' => 'referers', 'validity' => 'validity', - 'createdAt' => 'createdAt' + 'createdAt' => 'createdAt', ]; /** @@ -113,7 +113,7 @@ public static function openAPIFormats() 'queryParameters' => 'setQueryParameters', 'referers' => 'setReferers', 'validity' => 'setValidity', - 'createdAt' => 'setCreatedAt' + 'createdAt' => 'setCreatedAt', ]; /** @@ -130,7 +130,7 @@ public static function openAPIFormats() 'queryParameters' => 'getQueryParameters', 'referers' => 'getReferers', 'validity' => 'getValidity', - 'createdAt' => 'getCreatedAt' + 'createdAt' => 'getCreatedAt', ]; /** @@ -255,6 +255,7 @@ public function listInvalidProperties() if ($this->container['createdAt'] === null) { $invalidProperties[] = "'createdAt' can't be null"; } + return $invalidProperties; } @@ -269,7 +270,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets acl * @@ -283,7 +283,7 @@ public function getAcl() /** * Sets acl * - * @param string[] $acl Set of permissions associated with the key. + * @param string[] $acl set of permissions associated with the key * * @return self */ @@ -388,7 +388,7 @@ public function getMaxQueriesPerIPPerHour() /** * Sets maxQueriesPerIPPerHour * - * @param int|null $maxQueriesPerIPPerHour Maximum number of API calls per hour allowed from a given IP address or a user token. + * @param int|null $maxQueriesPerIPPerHour maximum number of API calls per hour allowed from a given IP address or a user token * * @return self */ @@ -484,7 +484,7 @@ public function getCreatedAt() /** * Sets createdAt * - * @param \DateTime $createdAt Date of creation (ISO-8601 format). + * @param \DateTime $createdAt date of creation (ISO-8601 format) * * @return self */ @@ -497,9 +497,9 @@ public function setCreatedAt($createdAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -509,7 +509,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -538,7 +538,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -549,10 +549,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -583,4 +584,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Languages.php b/clients/algoliasearch-client-php/lib/Model/Languages.php index 373bef4ce2..da2866454c 100644 --- a/clients/algoliasearch-client-php/lib/Model/Languages.php +++ b/clients/algoliasearch-client-php/lib/Model/Languages.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Languages Class Doc Comment * * @category Class * @description A dictionary language. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class Languages implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'plurals' => '\Algolia\AlgoliaSearch\Model\DictionaryLanguage', 'stopwords' => '\Algolia\AlgoliaSearch\Model\DictionaryLanguage', - 'compounds' => '\Algolia\AlgoliaSearch\Model\DictionaryLanguage' + 'compounds' => '\Algolia\AlgoliaSearch\Model\DictionaryLanguage', ]; /** @@ -47,7 +48,7 @@ class Languages implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'plurals' => null, 'stopwords' => null, - 'compounds' => null + 'compounds' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'plurals' => 'plurals', 'stopwords' => 'stopwords', - 'compounds' => 'compounds' + 'compounds' => 'compounds', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'plurals' => 'setPlurals', 'stopwords' => 'setStopwords', - 'compounds' => 'setCompounds' + 'compounds' => 'setCompounds', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'plurals' => 'getPlurals', 'stopwords' => 'getStopwords', - 'compounds' => 'getCompounds' + 'compounds' => 'getCompounds', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -184,6 +184,7 @@ public function listInvalidProperties() if ($this->container['compounds'] === null) { $invalidProperties[] = "'compounds' can't be null"; } + return $invalidProperties; } @@ -198,7 +199,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets plurals * @@ -273,9 +273,9 @@ public function setCompounds($compounds) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -285,7 +285,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -314,7 +314,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -325,10 +325,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -359,4 +360,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php b/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php index 6ffa69ff60..217841d9e2 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ListApiKeysResponse Class Doc Comment @@ -31,7 +31,7 @@ class ListApiKeysResponse implements ModelInterface, ArrayAccess, \JsonSerializa * @var string[] */ protected static $openAPITypes = [ - 'keys' => '\Algolia\AlgoliaSearch\Model\KeyObject[]' + 'keys' => '\Algolia\AlgoliaSearch\Model\KeyObject[]', ]; /** @@ -42,7 +42,7 @@ class ListApiKeysResponse implements ModelInterface, ArrayAccess, \JsonSerializa * @psalm-var array */ protected static $openAPIFormats = [ - 'keys' => null + 'keys' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'keys' => 'keys' + 'keys' => 'keys', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'keys' => 'setKeys' + 'keys' => 'setKeys', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'keys' => 'getKeys' + 'keys' => 'getKeys', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['keys'] === null) { $invalidProperties[] = "'keys' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets keys * @@ -193,7 +192,7 @@ public function getKeys() /** * Sets keys * - * @param \Algolia\AlgoliaSearch\Model\KeyObject[] $keys List of api keys. + * @param \Algolia\AlgoliaSearch\Model\KeyObject[] $keys list of api keys * * @return self */ @@ -206,9 +205,9 @@ public function setKeys($keys) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php b/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php index da37124416..32e7515265 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ListClustersResponse Class Doc Comment * * @category Class * @description Array of clusters. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class ListClustersResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'topUsers' => 'string[]' + 'topUsers' => 'string[]', ]; /** @@ -43,7 +44,7 @@ class ListClustersResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'topUsers' => null + 'topUsers' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'topUsers' => 'topUsers' + 'topUsers' => 'topUsers', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'topUsers' => 'setTopUsers' + 'topUsers' => 'setTopUsers', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'topUsers' => 'getTopUsers' + 'topUsers' => 'getTopUsers', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['topUsers'] === null) { $invalidProperties[] = "'topUsers' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets topUsers * @@ -194,7 +194,7 @@ public function getTopUsers() /** * Sets topUsers * - * @param string[] $topUsers Mapping of cluster names to top users. + * @param string[] $topUsers mapping of cluster names to top users * * @return self */ @@ -207,9 +207,9 @@ public function setTopUsers($topUsers) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php b/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php index 2177f69f96..984b0f060d 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ListIndicesResponse Class Doc Comment @@ -32,7 +32,7 @@ class ListIndicesResponse implements ModelInterface, ArrayAccess, \JsonSerializa */ protected static $openAPITypes = [ 'items' => '\Algolia\AlgoliaSearch\Model\Index[]', - 'nbPages' => 'int' + 'nbPages' => 'int', ]; /** @@ -44,7 +44,7 @@ class ListIndicesResponse implements ModelInterface, ArrayAccess, \JsonSerializa */ protected static $openAPIFormats = [ 'items' => null, - 'nbPages' => null + 'nbPages' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'items' => 'items', - 'nbPages' => 'nbPages' + 'nbPages' => 'nbPages', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'items' => 'setItems', - 'nbPages' => 'setNbPages' + 'nbPages' => 'setNbPages', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'items' => 'getItems', - 'nbPages' => 'getNbPages' + 'nbPages' => 'getNbPages', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -182,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets items * @@ -196,7 +194,7 @@ public function getItems() /** * Sets items * - * @param \Algolia\AlgoliaSearch\Model\Index[]|null $items List of the fetched indices. + * @param \Algolia\AlgoliaSearch\Model\Index[]|null $items list of the fetched indices * * @return self */ @@ -220,7 +218,7 @@ public function getNbPages() /** * Sets nbPages * - * @param int|null $nbPages Number of pages. + * @param int|null $nbPages number of pages * * @return self */ @@ -233,9 +231,9 @@ public function setNbPages($nbPages) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -245,7 +243,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -274,7 +272,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -285,10 +283,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -319,4 +318,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php index 64b26c1d72..0030ae0d27 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ListUserIdsResponse Class Doc Comment * * @category Class * @description UserIDs data. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -32,7 +33,7 @@ class ListUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSerializa * @var string[] */ protected static $openAPITypes = [ - 'userIDs' => '\Algolia\AlgoliaSearch\Model\UserId[]' + 'userIDs' => '\Algolia\AlgoliaSearch\Model\UserId[]', ]; /** @@ -43,7 +44,7 @@ class ListUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSerializa * @psalm-var array */ protected static $openAPIFormats = [ - 'userIDs' => null + 'userIDs' => null, ]; /** @@ -73,7 +74,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'userIDs' => 'userIDs' + 'userIDs' => 'userIDs', ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'userIDs' => 'setUserIDs' + 'userIDs' => 'setUserIDs', ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'userIDs' => 'getUserIDs' + 'userIDs' => 'getUserIDs', ]; /** @@ -135,7 +136,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -166,6 +166,7 @@ public function listInvalidProperties() if ($this->container['userIDs'] === null) { $invalidProperties[] = "'userIDs' can't be null"; } + return $invalidProperties; } @@ -180,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets userIDs * @@ -194,7 +194,7 @@ public function getUserIDs() /** * Sets userIDs * - * @param \Algolia\AlgoliaSearch\Model\UserId[] $userIDs List of userIDs. + * @param \Algolia\AlgoliaSearch\Model\UserId[] $userIDs list of userIDs * * @return self */ @@ -207,9 +207,9 @@ public function setUserIDs($userIDs) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -219,7 +219,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -248,7 +248,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -259,10 +259,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -293,4 +294,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php b/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php index 605c71b9d8..338e9fcd9f 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * MultipleBatchResponse Class Doc Comment @@ -32,7 +32,7 @@ class MultipleBatchResponse implements ModelInterface, ArrayAccess, \JsonSeriali */ protected static $openAPITypes = [ 'taskID' => 'object', - 'objectIDs' => 'string[]' + 'objectIDs' => 'string[]', ]; /** @@ -44,7 +44,7 @@ class MultipleBatchResponse implements ModelInterface, ArrayAccess, \JsonSeriali */ protected static $openAPIFormats = [ 'taskID' => null, - 'objectIDs' => null + 'objectIDs' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'taskID' => 'taskID', - 'objectIDs' => 'objectIDs' + 'objectIDs' => 'objectIDs', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'taskID' => 'setTaskID', - 'objectIDs' => 'setObjectIDs' + 'objectIDs' => 'setObjectIDs', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'taskID' => 'getTaskID', - 'objectIDs' => 'getObjectIDs' + 'objectIDs' => 'getObjectIDs', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -182,7 +181,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets taskID * @@ -196,7 +194,7 @@ public function getTaskID() /** * Sets taskID * - * @param object|null $taskID List of tasksIDs per index. + * @param object|null $taskID list of tasksIDs per index * * @return self */ @@ -220,7 +218,7 @@ public function getObjectIDs() /** * Sets objectIDs * - * @param string[]|null $objectIDs List of objectID. + * @param string[]|null $objectIDs list of objectID * * @return self */ @@ -233,9 +231,9 @@ public function setObjectIDs($objectIDs) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -245,7 +243,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -274,7 +272,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -285,10 +283,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -319,4 +318,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php b/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php index ab47ce8284..d96e1b9763 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * MultipleGetObjectsObject Class Doc Comment * * @category Class * @description GetObject operation on an index. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class MultipleGetObjectsObject implements ModelInterface, ArrayAccess, \JsonSeri protected static $openAPITypes = [ 'attributesToRetrieve' => 'string[]', 'objectID' => 'string', - 'indexName' => 'string' + 'indexName' => 'string', ]; /** @@ -47,7 +48,7 @@ class MultipleGetObjectsObject implements ModelInterface, ArrayAccess, \JsonSeri protected static $openAPIFormats = [ 'attributesToRetrieve' => null, 'objectID' => null, - 'indexName' => null + 'indexName' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'attributesToRetrieve' => 'attributesToRetrieve', 'objectID' => 'objectID', - 'indexName' => 'indexName' + 'indexName' => 'indexName', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'attributesToRetrieve' => 'setAttributesToRetrieve', 'objectID' => 'setObjectID', - 'indexName' => 'setIndexName' + 'indexName' => 'setIndexName', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'attributesToRetrieve' => 'getAttributesToRetrieve', 'objectID' => 'getObjectID', - 'indexName' => 'getIndexName' + 'indexName' => 'getIndexName', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -181,6 +181,7 @@ public function listInvalidProperties() if ($this->container['indexName'] === null) { $invalidProperties[] = "'indexName' can't be null"; } + return $invalidProperties; } @@ -195,7 +196,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets attributesToRetrieve * @@ -233,7 +233,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID ID of the object within that index. + * @param string $objectID ID of the object within that index * * @return self */ @@ -257,7 +257,7 @@ public function getIndexName() /** * Sets indexName * - * @param string $indexName name of the index containing the object. + * @param string $indexName name of the index containing the object * * @return self */ @@ -270,9 +270,9 @@ public function setIndexName($indexName) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -282,7 +282,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -311,7 +311,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -322,10 +322,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -356,4 +357,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php b/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php index f29705e627..95669603ef 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * MultipleQueries Class Doc Comment @@ -35,7 +35,7 @@ class MultipleQueries implements ModelInterface, ArrayAccess, \JsonSerializable 'query' => 'string', 'type' => 'string', 'facet' => 'string', - 'params' => 'string' + 'params' => 'string', ]; /** @@ -50,7 +50,7 @@ class MultipleQueries implements ModelInterface, ArrayAccess, \JsonSerializable 'query' => null, 'type' => null, 'facet' => null, - 'params' => null + 'params' => null, ]; /** @@ -84,7 +84,7 @@ public static function openAPIFormats() 'query' => 'query', 'type' => 'type', 'facet' => 'facet', - 'params' => 'params' + 'params' => 'params', ]; /** @@ -97,7 +97,7 @@ public static function openAPIFormats() 'query' => 'setQuery', 'type' => 'setType', 'facet' => 'setFacet', - 'params' => 'setParams' + 'params' => 'setParams', ]; /** @@ -110,7 +110,7 @@ public static function openAPIFormats() 'query' => 'getQuery', 'type' => 'getType', 'facet' => 'getFacet', - 'params' => 'getParams' + 'params' => 'getParams', ]; /** @@ -227,7 +227,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets indexName * @@ -241,7 +240,7 @@ public function getIndexName() /** * Sets indexName * - * @param string $indexName The Algolia index name. + * @param string $indexName the Algolia index name * * @return self */ @@ -265,7 +264,7 @@ public function getQuery() /** * Sets query * - * @param string|null $query The text to search in the index. + * @param string|null $query the text to search in the index * * @return self */ @@ -289,7 +288,7 @@ public function getType() /** * Sets type * - * @param string|null $type Perform a search query with `default`, will search for facet values if `facet` is given. + * @param string|null $type perform a search query with `default`, will search for facet values if `facet` is given * * @return self */ @@ -323,7 +322,7 @@ public function getFacet() /** * Sets facet * - * @param string|null $facet The `facet` name. + * @param string|null $facet the `facet` name * * @return self */ @@ -347,7 +346,7 @@ public function getParams() /** * Sets params * - * @param string|null $params A query string of search parameters. + * @param string|null $params a query string of search parameters * * @return self */ @@ -360,9 +359,9 @@ public function setParams($params) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -372,7 +371,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -401,7 +400,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -412,10 +411,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -446,4 +446,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php index 448a05f979..5c1571c58f 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * MultipleQueriesObject Class Doc Comment @@ -32,7 +32,7 @@ class MultipleQueriesObject implements ModelInterface, ArrayAccess, \JsonSeriali */ protected static $openAPITypes = [ 'requests' => '\Algolia\AlgoliaSearch\Model\MultipleQueries[]', - 'strategy' => 'string' + 'strategy' => 'string', ]; /** @@ -44,7 +44,7 @@ class MultipleQueriesObject implements ModelInterface, ArrayAccess, \JsonSeriali */ protected static $openAPIFormats = [ 'requests' => null, - 'strategy' => null + 'strategy' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'requests' => 'requests', - 'strategy' => 'strategy' + 'strategy' => 'strategy', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'requests' => 'setRequests', - 'strategy' => 'setStrategy' + 'strategy' => 'setStrategy', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'requests' => 'getRequests', - 'strategy' => 'getStrategy' + 'strategy' => 'getStrategy', ]; /** @@ -209,7 +209,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets requests * @@ -270,9 +269,9 @@ public function setStrategy($strategy) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -282,7 +281,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -311,7 +310,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -322,10 +321,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -356,4 +356,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php index a5109a497d..d441ad8268 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * MultipleQueriesResponse Class Doc Comment @@ -31,7 +31,7 @@ class MultipleQueriesResponse implements ModelInterface, ArrayAccess, \JsonSeria * @var string[] */ protected static $openAPITypes = [ - 'results' => '\Algolia\AlgoliaSearch\Model\SearchResponse[]' + 'results' => '\Algolia\AlgoliaSearch\Model\SearchResponse[]', ]; /** @@ -42,7 +42,7 @@ class MultipleQueriesResponse implements ModelInterface, ArrayAccess, \JsonSeria * @psalm-var array */ protected static $openAPIFormats = [ - 'results' => null + 'results' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'results' => 'results' + 'results' => 'results', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'results' => 'setResults' + 'results' => 'setResults', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'results' => 'getResults' + 'results' => 'getResults', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -176,7 +175,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets results * @@ -203,9 +201,9 @@ public function setResults($results) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -215,7 +213,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -244,7 +242,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -255,10 +253,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -289,4 +288,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Operation.php b/clients/algoliasearch-client-php/lib/Model/Operation.php index 8683c73b1b..49f65a5711 100644 --- a/clients/algoliasearch-client-php/lib/Model/Operation.php +++ b/clients/algoliasearch-client-php/lib/Model/Operation.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Operation Class Doc Comment @@ -33,7 +33,7 @@ class Operation implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'action' => '\Algolia\AlgoliaSearch\Model\Action', 'body' => 'object', - 'indexName' => 'string' + 'indexName' => 'string', ]; /** @@ -46,7 +46,7 @@ class Operation implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'action' => null, 'body' => null, - 'indexName' => null + 'indexName' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'action' => 'action', 'body' => 'body', - 'indexName' => 'indexName' + 'indexName' => 'indexName', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'action' => 'setAction', 'body' => 'setBody', - 'indexName' => 'setIndexName' + 'indexName' => 'setIndexName', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'action' => 'getAction', 'body' => 'getBody', - 'indexName' => 'getIndexName' + 'indexName' => 'getIndexName', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -188,7 +187,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets action * @@ -226,7 +224,7 @@ public function getBody() /** * Sets body * - * @param object|null $body arguments to the operation (depends on the type of the operation). + * @param object|null $body arguments to the operation (depends on the type of the operation) * * @return self */ @@ -250,7 +248,7 @@ public function getIndexName() /** * Sets indexName * - * @param string|null $indexName Index to target for this operation. + * @param string|null $indexName index to target for this operation * * @return self */ @@ -263,9 +261,9 @@ public function setIndexName($indexName) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -275,7 +273,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -304,7 +302,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -315,10 +313,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -349,4 +348,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php b/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php index 6ce1064869..c6122908e0 100644 --- a/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php +++ b/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * OperationIndexObject Class Doc Comment @@ -33,7 +33,7 @@ class OperationIndexObject implements ModelInterface, ArrayAccess, \JsonSerializ protected static $openAPITypes = [ 'operation' => 'string', 'destination' => 'string', - 'scope' => 'string[]' + 'scope' => 'string[]', ]; /** @@ -46,7 +46,7 @@ class OperationIndexObject implements ModelInterface, ArrayAccess, \JsonSerializ protected static $openAPIFormats = [ 'operation' => null, 'destination' => null, - 'scope' => null + 'scope' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'operation' => 'operation', 'destination' => 'destination', - 'scope' => 'scope' + 'scope' => 'scope', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'operation' => 'setOperation', 'destination' => 'setDestination', - 'scope' => 'setScope' + 'scope' => 'setScope', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'operation' => 'getOperation', 'destination' => 'getDestination', - 'scope' => 'getScope' + 'scope' => 'getScope', ]; /** @@ -221,6 +221,7 @@ public function listInvalidProperties() if ($this->container['destination'] === null) { $invalidProperties[] = "'destination' can't be null"; } + return $invalidProperties; } @@ -235,7 +236,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets operation * @@ -249,7 +249,7 @@ public function getOperation() /** * Sets operation * - * @param string $operation Type of operation to perform (move or copy). + * @param string $operation type of operation to perform (move or copy) * * @return self */ @@ -283,7 +283,7 @@ public function getDestination() /** * Sets destination * - * @param string $destination The Algolia index name. + * @param string $destination the Algolia index name * * @return self */ @@ -329,9 +329,9 @@ public function setScope($scope) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -341,7 +341,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -370,7 +370,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -381,10 +381,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -415,4 +416,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Params.php b/clients/algoliasearch-client-php/lib/Model/Params.php index 91841228dc..7dc71a62fd 100644 --- a/clients/algoliasearch-client-php/lib/Model/Params.php +++ b/clients/algoliasearch-client-php/lib/Model/Params.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Params Class Doc Comment * * @category Class * @description Additional search parameters. Any valid search parameter is allowed. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class Params implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'query' => 'string', 'automaticFacetFilters' => '\Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]', - 'automaticOptionalFacetFilters' => '\Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]' + 'automaticOptionalFacetFilters' => '\Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]', ]; /** @@ -47,7 +48,7 @@ class Params implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'query' => null, 'automaticFacetFilters' => null, - 'automaticOptionalFacetFilters' => null + 'automaticOptionalFacetFilters' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'query' => 'query', 'automaticFacetFilters' => 'automaticFacetFilters', - 'automaticOptionalFacetFilters' => 'automaticOptionalFacetFilters' + 'automaticOptionalFacetFilters' => 'automaticOptionalFacetFilters', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'query' => 'setQuery', 'automaticFacetFilters' => 'setAutomaticFacetFilters', - 'automaticOptionalFacetFilters' => 'setAutomaticOptionalFacetFilters' + 'automaticOptionalFacetFilters' => 'setAutomaticOptionalFacetFilters', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'query' => 'getQuery', 'automaticFacetFilters' => 'getAutomaticFacetFilters', - 'automaticOptionalFacetFilters' => 'getAutomaticOptionalFacetFilters' + 'automaticOptionalFacetFilters' => 'getAutomaticOptionalFacetFilters', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -189,7 +189,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets query * @@ -203,7 +202,7 @@ public function getQuery() /** * Sets query * - * @param string|null $query Query string. + * @param string|null $query query string * * @return self */ @@ -227,7 +226,7 @@ public function getAutomaticFacetFilters() /** * Sets automaticFacetFilters * - * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticFacetFilters Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern. + * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticFacetFilters names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern * * @return self */ @@ -251,7 +250,7 @@ public function getAutomaticOptionalFacetFilters() /** * Sets automaticOptionalFacetFilters * - * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticOptionalFacetFilters Same syntax as automaticFacetFilters, but the engine treats the filters as optional. + * @param \Algolia\AlgoliaSearch\Model\AutomaticFacetFilter[]|null $automaticOptionalFacetFilters same syntax as automaticFacetFilters, but the engine treats the filters as optional * * @return self */ @@ -264,9 +263,9 @@ public function setAutomaticOptionalFacetFilters($automaticOptionalFacetFilters) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -276,7 +275,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -305,7 +304,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -316,10 +315,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -350,4 +350,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Promote.php b/clients/algoliasearch-client-php/lib/Model/Promote.php index 14718b1d2c..25d29916ee 100644 --- a/clients/algoliasearch-client-php/lib/Model/Promote.php +++ b/clients/algoliasearch-client-php/lib/Model/Promote.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Promote Class Doc Comment * * @category Class * @description Object to promote as hits. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class Promote implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'objectID' => 'string', 'objectIDs' => 'string[]', - 'position' => 'int' + 'position' => 'int', ]; /** @@ -47,7 +48,7 @@ class Promote implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'objectID' => null, 'objectIDs' => null, - 'position' => null + 'position' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'objectID' => 'objectID', 'objectIDs' => 'objectIDs', - 'position' => 'position' + 'position' => 'position', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'objectID' => 'setObjectID', 'objectIDs' => 'setObjectIDs', - 'position' => 'setPosition' + 'position' => 'setPosition', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'objectID' => 'getObjectID', 'objectIDs' => 'getObjectIDs', - 'position' => 'getPosition' + 'position' => 'getPosition', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -178,6 +178,7 @@ public function listInvalidProperties() if ($this->container['position'] === null) { $invalidProperties[] = "'position' can't be null"; } + return $invalidProperties; } @@ -192,7 +193,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -206,7 +206,7 @@ public function getObjectID() /** * Sets objectID * - * @param string|null $objectID Unique identifier of the object to promote. + * @param string|null $objectID unique identifier of the object to promote * * @return self */ @@ -230,7 +230,7 @@ public function getObjectIDs() /** * Sets objectIDs * - * @param string[]|null $objectIDs Array of unique identifiers of the objects to promote. + * @param string[]|null $objectIDs array of unique identifiers of the objects to promote * * @return self */ @@ -267,9 +267,9 @@ public function setPosition($position) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -279,7 +279,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -308,7 +308,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -319,10 +319,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -353,4 +354,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/RankingInfo.php b/clients/algoliasearch-client-php/lib/Model/RankingInfo.php index 03196a4eb5..ecdde9adf6 100644 --- a/clients/algoliasearch-client-php/lib/Model/RankingInfo.php +++ b/clients/algoliasearch-client-php/lib/Model/RankingInfo.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * RankingInfo Class Doc Comment @@ -41,7 +41,7 @@ class RankingInfo implements ModelInterface, ArrayAccess, \JsonSerializable 'promoted' => 'bool', 'proximityDistance' => 'int', 'userScore' => 'int', - 'word' => 'int' + 'word' => 'int', ]; /** @@ -62,7 +62,7 @@ class RankingInfo implements ModelInterface, ArrayAccess, \JsonSerializable 'promoted' => null, 'proximityDistance' => null, 'userScore' => null, - 'word' => null + 'word' => null, ]; /** @@ -102,7 +102,7 @@ public static function openAPIFormats() 'promoted' => 'promoted', 'proximityDistance' => 'proximityDistance', 'userScore' => 'userScore', - 'word' => 'word' + 'word' => 'word', ]; /** @@ -121,7 +121,7 @@ public static function openAPIFormats() 'promoted' => 'setPromoted', 'proximityDistance' => 'setProximityDistance', 'userScore' => 'setUserScore', - 'word' => 'setWord' + 'word' => 'setWord', ]; /** @@ -140,7 +140,7 @@ public static function openAPIFormats() 'promoted' => 'getPromoted', 'proximityDistance' => 'getProximityDistance', 'userScore' => 'getUserScore', - 'word' => 'getWord' + 'word' => 'getWord', ]; /** @@ -184,7 +184,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -236,7 +235,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets filters * @@ -250,7 +248,7 @@ public function getFilters() /** * Sets filters * - * @param int|null $filters This field is reserved for advanced usage. + * @param int|null $filters this field is reserved for advanced usage * * @return self */ @@ -274,7 +272,7 @@ public function getFirstMatchedWord() /** * Sets firstMatchedWord * - * @param int|null $firstMatchedWord Position of the most important matched attribute in the attributes to index list. + * @param int|null $firstMatchedWord position of the most important matched attribute in the attributes to index list * * @return self */ @@ -298,7 +296,7 @@ public function getGeoDistance() /** * Sets geoDistance * - * @param int|null $geoDistance Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters). + * @param int|null $geoDistance distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters) * * @return self */ @@ -322,7 +320,7 @@ public function getGeoPrecision() /** * Sets geoPrecision * - * @param int|null $geoPrecision Precision used when computing the geo distance, in meters. + * @param int|null $geoPrecision precision used when computing the geo distance, in meters * * @return self */ @@ -370,7 +368,7 @@ public function getNbExactWords() /** * Sets nbExactWords * - * @param int|null $nbExactWords Number of exactly matched words. + * @param int|null $nbExactWords number of exactly matched words * * @return self */ @@ -394,7 +392,7 @@ public function getNbTypos() /** * Sets nbTypos * - * @param int|null $nbTypos Number of typos encountered when matching the record. + * @param int|null $nbTypos number of typos encountered when matching the record * * @return self */ @@ -418,7 +416,7 @@ public function getPromoted() /** * Sets promoted * - * @param bool|null $promoted Present and set to true if a Rule promoted the hit. + * @param bool|null $promoted present and set to true if a Rule promoted the hit * * @return self */ @@ -442,7 +440,7 @@ public function getProximityDistance() /** * Sets proximityDistance * - * @param int|null $proximityDistance When the query contains more than one word, the sum of the distances between matched words (in meters). + * @param int|null $proximityDistance when the query contains more than one word, the sum of the distances between matched words (in meters) * * @return self */ @@ -466,7 +464,7 @@ public function getUserScore() /** * Sets userScore * - * @param int|null $userScore Custom ranking for the object, expressed as a single integer value. + * @param int|null $userScore custom ranking for the object, expressed as a single integer value * * @return self */ @@ -490,7 +488,7 @@ public function getWord() /** * Sets word * - * @param int|null $word Number of matched words, including prefixes and typos. + * @param int|null $word number of matched words, including prefixes and typos * * @return self */ @@ -503,9 +501,9 @@ public function setWord($word) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -515,7 +513,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -544,7 +542,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -555,10 +553,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -589,4 +588,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php b/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php index 40e0ff224f..089130d225 100644 --- a/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php +++ b/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * RankingInfoMatchedGeoLocation Class Doc Comment @@ -33,7 +33,7 @@ class RankingInfoMatchedGeoLocation implements ModelInterface, ArrayAccess, \Jso protected static $openAPITypes = [ 'lat' => 'double', 'lng' => 'double', - 'distance' => 'int' + 'distance' => 'int', ]; /** @@ -46,7 +46,7 @@ class RankingInfoMatchedGeoLocation implements ModelInterface, ArrayAccess, \Jso protected static $openAPIFormats = [ 'lat' => 'double', 'lng' => 'double', - 'distance' => null + 'distance' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'lat' => 'lat', 'lng' => 'lng', - 'distance' => 'distance' + 'distance' => 'distance', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'lat' => 'setLat', 'lng' => 'setLng', - 'distance' => 'setDistance' + 'distance' => 'setDistance', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'lat' => 'getLat', 'lng' => 'getLng', - 'distance' => 'getDistance' + 'distance' => 'getDistance', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -188,11 +187,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets lat * - * @return double|null + * @return float|null */ public function getLat() { @@ -202,7 +200,7 @@ public function getLat() /** * Sets lat * - * @param double|null $lat Latitude of the matched location. + * @param float|null $lat latitude of the matched location * * @return self */ @@ -216,7 +214,7 @@ public function setLat($lat) /** * Gets lng * - * @return double|null + * @return float|null */ public function getLng() { @@ -226,7 +224,7 @@ public function getLng() /** * Sets lng * - * @param double|null $lng Longitude of the matched location. + * @param float|null $lng longitude of the matched location * * @return self */ @@ -250,7 +248,7 @@ public function getDistance() /** * Sets distance * - * @param int|null $distance Distance between the matched location and the search location (in meters). + * @param int|null $distance distance between the matched location and the search location (in meters) * * @return self */ @@ -263,9 +261,9 @@ public function setDistance($distance) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -275,7 +273,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -304,7 +302,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -315,10 +313,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -349,4 +348,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Record.php b/clients/algoliasearch-client-php/lib/Model/Record.php index cc58da5171..345113fad0 100644 --- a/clients/algoliasearch-client-php/lib/Model/Record.php +++ b/clients/algoliasearch-client-php/lib/Model/Record.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Record Class Doc Comment * * @category Class * @description A single record. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -36,7 +37,7 @@ class Record implements ModelInterface, ArrayAccess, \JsonSerializable 'highlightResult' => '\Algolia\AlgoliaSearch\Model\HighlightResult', 'snippetResult' => '\Algolia\AlgoliaSearch\Model\SnippetResult', 'rankingInfo' => '\Algolia\AlgoliaSearch\Model\RankingInfo', - 'distinctSeqID' => 'int' + 'distinctSeqID' => 'int', ]; /** @@ -51,7 +52,7 @@ class Record implements ModelInterface, ArrayAccess, \JsonSerializable 'highlightResult' => null, 'snippetResult' => null, 'rankingInfo' => null, - 'distinctSeqID' => null + 'distinctSeqID' => null, ]; /** @@ -85,7 +86,7 @@ public static function openAPIFormats() 'highlightResult' => '_highlightResult', 'snippetResult' => '_snippetResult', 'rankingInfo' => '_rankingInfo', - 'distinctSeqID' => '_distinctSeqID' + 'distinctSeqID' => '_distinctSeqID', ]; /** @@ -98,7 +99,7 @@ public static function openAPIFormats() 'highlightResult' => 'setHighlightResult', 'snippetResult' => 'setSnippetResult', 'rankingInfo' => 'setRankingInfo', - 'distinctSeqID' => 'setDistinctSeqID' + 'distinctSeqID' => 'setDistinctSeqID', ]; /** @@ -111,7 +112,7 @@ public static function openAPIFormats() 'highlightResult' => 'getHighlightResult', 'snippetResult' => 'getSnippetResult', 'rankingInfo' => 'getRankingInfo', - 'distinctSeqID' => 'getDistinctSeqID' + 'distinctSeqID' => 'getDistinctSeqID', ]; /** @@ -155,7 +156,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -190,6 +190,7 @@ public function listInvalidProperties() if ($this->container['objectID'] === null) { $invalidProperties[] = "'objectID' can't be null"; } + return $invalidProperties; } @@ -204,7 +205,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -218,7 +218,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID Unique identifier of the object. + * @param string $objectID unique identifier of the object * * @return self */ @@ -327,9 +327,9 @@ public function setDistinctSeqID($distinctSeqID) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -339,7 +339,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -368,7 +368,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -379,10 +379,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -413,4 +414,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php b/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php index 0c70495abb..74761cee9e 100644 --- a/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * RemoveUserIdResponse Class Doc Comment @@ -31,7 +31,7 @@ class RemoveUserIdResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'deletedAt' => '\DateTime' + 'deletedAt' => '\DateTime', ]; /** @@ -42,7 +42,7 @@ class RemoveUserIdResponse implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'deletedAt' => 'date-time' + 'deletedAt' => 'date-time', ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'deletedAt' => 'deletedAt' + 'deletedAt' => 'deletedAt', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'deletedAt' => 'setDeletedAt' + 'deletedAt' => 'setDeletedAt', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'deletedAt' => 'getDeletedAt' + 'deletedAt' => 'getDeletedAt', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['deletedAt'] === null) { $invalidProperties[] = "'deletedAt' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets deletedAt * @@ -193,7 +192,7 @@ public function getDeletedAt() /** * Sets deletedAt * - * @param \DateTime $deletedAt Date of deletion (ISO-8601 format). + * @param \DateTime $deletedAt date of deletion (ISO-8601 format) * * @return self */ @@ -206,9 +205,9 @@ public function setDeletedAt($deletedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php b/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php index 2b7487736e..b8c981e0f0 100644 --- a/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * ReplaceSourceResponse Class Doc Comment @@ -31,7 +31,7 @@ class ReplaceSourceResponse implements ModelInterface, ArrayAccess, \JsonSeriali * @var string[] */ protected static $openAPITypes = [ - 'updatedAt' => '\DateTime' + 'updatedAt' => '\DateTime', ]; /** @@ -42,7 +42,7 @@ class ReplaceSourceResponse implements ModelInterface, ArrayAccess, \JsonSeriali * @psalm-var array */ protected static $openAPIFormats = [ - 'updatedAt' => 'date-time' + 'updatedAt' => 'date-time', ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'updatedAt' => 'updatedAt' + 'updatedAt' => 'updatedAt', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'updatedAt' => 'setUpdatedAt' + 'updatedAt' => 'setUpdatedAt', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'updatedAt' => 'getUpdatedAt' + 'updatedAt' => 'getUpdatedAt', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets updatedAt * @@ -193,7 +192,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -206,9 +205,9 @@ public function setUpdatedAt($updatedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php b/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php index 180e14b0cd..fea07393c7 100644 --- a/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * RequiredSearchParams Class Doc Comment @@ -31,7 +31,7 @@ class RequiredSearchParams implements ModelInterface, ArrayAccess, \JsonSerializ * @var string[] */ protected static $openAPITypes = [ - 'query' => 'string' + 'query' => 'string', ]; /** @@ -42,7 +42,7 @@ class RequiredSearchParams implements ModelInterface, ArrayAccess, \JsonSerializ * @psalm-var array */ protected static $openAPIFormats = [ - 'query' => null + 'query' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'query' => 'query' + 'query' => 'query', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'query' => 'setQuery' + 'query' => 'setQuery', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'query' => 'getQuery' + 'query' => 'getQuery', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['query'] === null) { $invalidProperties[] = "'query' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets query * @@ -193,7 +192,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -206,9 +205,9 @@ public function setQuery($query) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Rule.php b/clients/algoliasearch-client-php/lib/Model/Rule.php index ff0c3fb926..646596e102 100644 --- a/clients/algoliasearch-client-php/lib/Model/Rule.php +++ b/clients/algoliasearch-client-php/lib/Model/Rule.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Rule Class Doc Comment * * @category Class * @description Rule object. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -37,7 +38,7 @@ class Rule implements ModelInterface, ArrayAccess, \JsonSerializable 'consequence' => '\Algolia\AlgoliaSearch\Model\Consequence', 'description' => 'string', 'enabled' => 'bool', - 'validity' => '\Algolia\AlgoliaSearch\Model\TimeRange[]' + 'validity' => '\Algolia\AlgoliaSearch\Model\TimeRange[]', ]; /** @@ -53,7 +54,7 @@ class Rule implements ModelInterface, ArrayAccess, \JsonSerializable 'consequence' => null, 'description' => null, 'enabled' => null, - 'validity' => null + 'validity' => null, ]; /** @@ -88,7 +89,7 @@ public static function openAPIFormats() 'consequence' => 'consequence', 'description' => 'description', 'enabled' => 'enabled', - 'validity' => 'validity' + 'validity' => 'validity', ]; /** @@ -102,7 +103,7 @@ public static function openAPIFormats() 'consequence' => 'setConsequence', 'description' => 'setDescription', 'enabled' => 'setEnabled', - 'validity' => 'setValidity' + 'validity' => 'setValidity', ]; /** @@ -116,7 +117,7 @@ public static function openAPIFormats() 'consequence' => 'getConsequence', 'description' => 'getDescription', 'enabled' => 'getEnabled', - 'validity' => 'getValidity' + 'validity' => 'getValidity', ]; /** @@ -160,7 +161,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -199,6 +199,7 @@ public function listInvalidProperties() if ($this->container['consequence'] === null) { $invalidProperties[] = "'consequence' can't be null"; } + return $invalidProperties; } @@ -213,7 +214,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -227,7 +227,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID Unique identifier of the object. + * @param string $objectID unique identifier of the object * * @return self */ @@ -360,9 +360,9 @@ public function setValidity($validity) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -372,7 +372,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -401,7 +401,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -412,10 +412,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -446,4 +447,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php b/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php index 4b894609d1..1512d4260c 100644 --- a/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SaveObjectResponse Class Doc Comment @@ -33,7 +33,7 @@ class SaveObjectResponse implements ModelInterface, ArrayAccess, \JsonSerializab protected static $openAPITypes = [ 'createdAt' => 'string', 'taskID' => 'int', - 'objectID' => 'string' + 'objectID' => 'string', ]; /** @@ -46,7 +46,7 @@ class SaveObjectResponse implements ModelInterface, ArrayAccess, \JsonSerializab protected static $openAPIFormats = [ 'createdAt' => null, 'taskID' => null, - 'objectID' => null + 'objectID' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'createdAt' => 'createdAt', 'taskID' => 'taskID', - 'objectID' => 'objectID' + 'objectID' => 'objectID', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'createdAt' => 'setCreatedAt', 'taskID' => 'setTaskID', - 'objectID' => 'setObjectID' + 'objectID' => 'setObjectID', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'createdAt' => 'getCreatedAt', 'taskID' => 'getTaskID', - 'objectID' => 'getObjectID' + 'objectID' => 'getObjectID', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -188,7 +187,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets createdAt * @@ -226,7 +224,7 @@ public function getTaskID() /** * Sets taskID * - * @param int|null $taskID taskID of the indexing task to wait for. + * @param int|null $taskID taskID of the indexing task to wait for * * @return self */ @@ -250,7 +248,7 @@ public function getObjectID() /** * Sets objectID * - * @param string|null $objectID Unique identifier of the object. + * @param string|null $objectID unique identifier of the object * * @return self */ @@ -263,9 +261,9 @@ public function setObjectID($objectID) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -275,7 +273,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -304,7 +302,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -315,10 +313,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -349,4 +348,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php b/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php index 5781c715c7..56a5f1ab5a 100644 --- a/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SaveSynonymResponse Class Doc Comment @@ -33,7 +33,7 @@ class SaveSynonymResponse implements ModelInterface, ArrayAccess, \JsonSerializa protected static $openAPITypes = [ 'taskID' => 'int', 'updatedAt' => '\DateTime', - 'id' => 'string' + 'id' => 'string', ]; /** @@ -46,7 +46,7 @@ class SaveSynonymResponse implements ModelInterface, ArrayAccess, \JsonSerializa protected static $openAPIFormats = [ 'taskID' => null, 'updatedAt' => 'date-time', - 'id' => null + 'id' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'taskID' => 'taskID', 'updatedAt' => 'updatedAt', - 'id' => 'id' + 'id' => 'id', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'taskID' => 'setTaskID', 'updatedAt' => 'setUpdatedAt', - 'id' => 'setId' + 'id' => 'setId', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'taskID' => 'getTaskID', 'updatedAt' => 'getUpdatedAt', - 'id' => 'getId' + 'id' => 'getId', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -183,6 +182,7 @@ public function listInvalidProperties() if ($this->container['id'] === null) { $invalidProperties[] = "'id' can't be null"; } + return $invalidProperties; } @@ -197,7 +197,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets taskID * @@ -211,7 +210,7 @@ public function getTaskID() /** * Sets taskID * - * @param int $taskID taskID of the indexing task to wait for. + * @param int $taskID taskID of the indexing task to wait for * * @return self */ @@ -235,7 +234,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -259,7 +258,7 @@ public function getId() /** * Sets id * - * @param string $id objectID of the inserted object. + * @param string $id objectID of the inserted object * * @return self */ @@ -272,9 +271,9 @@ public function setId($id) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -284,7 +283,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -313,7 +312,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -324,10 +323,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -358,4 +358,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php b/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php index 1db78c1742..9ec71bf9f3 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchDictionaryEntries Class Doc Comment * * @category Class * @description The `searchDictionaryEntries` request. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +36,7 @@ class SearchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSeria 'query' => 'string', 'page' => 'int', 'hitsPerPage' => 'int', - 'language' => 'string' + 'language' => 'string', ]; /** @@ -49,7 +50,7 @@ class SearchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSeria 'query' => null, 'page' => null, 'hitsPerPage' => null, - 'language' => null + 'language' => null, ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() 'query' => 'query', 'page' => 'page', 'hitsPerPage' => 'hitsPerPage', - 'language' => 'language' + 'language' => 'language', ]; /** @@ -94,7 +95,7 @@ public static function openAPIFormats() 'query' => 'setQuery', 'page' => 'setPage', 'hitsPerPage' => 'setHitsPerPage', - 'language' => 'setLanguage' + 'language' => 'setLanguage', ]; /** @@ -106,7 +107,7 @@ public static function openAPIFormats() 'query' => 'getQuery', 'page' => 'getPage', 'hitsPerPage' => 'getHitsPerPage', - 'language' => 'getLanguage' + 'language' => 'getLanguage', ]; /** @@ -150,7 +151,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -184,6 +184,7 @@ public function listInvalidProperties() if ($this->container['query'] === null) { $invalidProperties[] = "'query' can't be null"; } + return $invalidProperties; } @@ -198,7 +199,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets query * @@ -212,7 +212,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -236,7 +236,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Specify the page to retrieve. + * @param int|null $page specify the page to retrieve * * @return self */ @@ -260,7 +260,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -297,9 +297,9 @@ public function setLanguage($language) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -309,7 +309,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -338,7 +338,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -349,10 +349,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -383,4 +384,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php index 9ab47c9980..29d33c4a97 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchForFacetValuesRequest Class Doc Comment @@ -33,7 +33,7 @@ class SearchForFacetValuesRequest implements ModelInterface, ArrayAccess, \JsonS protected static $openAPITypes = [ 'params' => 'string', 'facetQuery' => 'string', - 'maxFacetHits' => 'int' + 'maxFacetHits' => 'int', ]; /** @@ -46,7 +46,7 @@ class SearchForFacetValuesRequest implements ModelInterface, ArrayAccess, \JsonS protected static $openAPIFormats = [ 'params' => null, 'facetQuery' => null, - 'maxFacetHits' => null + 'maxFacetHits' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'params' => 'params', 'facetQuery' => 'facetQuery', - 'maxFacetHits' => 'maxFacetHits' + 'maxFacetHits' => 'maxFacetHits', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'params' => 'setParams', 'facetQuery' => 'setFacetQuery', - 'maxFacetHits' => 'setMaxFacetHits' + 'maxFacetHits' => 'setMaxFacetHits', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'params' => 'getParams', 'facetQuery' => 'getFacetQuery', - 'maxFacetHits' => 'getMaxFacetHits' + 'maxFacetHits' => 'getMaxFacetHits', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -192,7 +191,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets params * @@ -206,7 +204,7 @@ public function getParams() /** * Sets params * - * @param string|null $params Search parameters as URL-encoded query string. + * @param string|null $params search parameters as URL-encoded query string * * @return self */ @@ -230,7 +228,7 @@ public function getFacetQuery() /** * Sets facetQuery * - * @param string|null $facetQuery Text to search inside the facet's values. + * @param string|null $facetQuery text to search inside the facet's values * * @return self */ @@ -272,9 +270,9 @@ public function setMaxFacetHits($maxFacetHits) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -284,7 +282,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -313,7 +311,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -324,10 +322,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -358,4 +357,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php index 7f1bfa58fa..3e5bdb2eeb 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchForFacetValuesResponse Class Doc Comment @@ -31,7 +31,7 @@ class SearchForFacetValuesResponse implements ModelInterface, ArrayAccess, \Json * @var string[] */ protected static $openAPITypes = [ - 'facetHits' => '\Algolia\AlgoliaSearch\Model\SearchForFacetValuesResponseFacetHits[]' + 'facetHits' => '\Algolia\AlgoliaSearch\Model\SearchForFacetValuesResponseFacetHits[]', ]; /** @@ -42,7 +42,7 @@ class SearchForFacetValuesResponse implements ModelInterface, ArrayAccess, \Json * @psalm-var array */ protected static $openAPIFormats = [ - 'facetHits' => null + 'facetHits' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'facetHits' => 'facetHits' + 'facetHits' => 'facetHits', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'facetHits' => 'setFacetHits' + 'facetHits' => 'setFacetHits', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'facetHits' => 'getFacetHits' + 'facetHits' => 'getFacetHits', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -165,6 +164,7 @@ public function listInvalidProperties() if ($this->container['facetHits'] === null) { $invalidProperties[] = "'facetHits' can't be null"; } + return $invalidProperties; } @@ -179,7 +179,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets facetHits * @@ -206,9 +205,9 @@ public function setFacetHits($facetHits) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -218,7 +217,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -247,7 +246,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -258,10 +257,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -292,4 +292,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php index 0b4efb1a49..071e8412fc 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchForFacetValuesResponseFacetHits Class Doc Comment @@ -33,7 +33,7 @@ class SearchForFacetValuesResponseFacetHits implements ModelInterface, ArrayAcce protected static $openAPITypes = [ 'value' => 'string', 'highlighted' => 'string', - 'count' => 'int' + 'count' => 'int', ]; /** @@ -46,7 +46,7 @@ class SearchForFacetValuesResponseFacetHits implements ModelInterface, ArrayAcce protected static $openAPIFormats = [ 'value' => null, 'highlighted' => null, - 'count' => null + 'count' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'value' => 'value', 'highlighted' => 'highlighted', - 'count' => 'count' + 'count' => 'count', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'value' => 'setValue', 'highlighted' => 'setHighlighted', - 'count' => 'setCount' + 'count' => 'setCount', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'value' => 'getValue', 'highlighted' => 'getHighlighted', - 'count' => 'getCount' + 'count' => 'getCount', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -183,6 +182,7 @@ public function listInvalidProperties() if ($this->container['count'] === null) { $invalidProperties[] = "'count' can't be null"; } + return $invalidProperties; } @@ -197,7 +197,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets value * @@ -211,7 +210,7 @@ public function getValue() /** * Sets value * - * @param string $value Raw value of the facet. + * @param string $value raw value of the facet * * @return self */ @@ -235,7 +234,7 @@ public function getHighlighted() /** * Sets highlighted * - * @param string $highlighted Markup text with occurrences highlighted. + * @param string $highlighted markup text with occurrences highlighted * * @return self */ @@ -272,9 +271,9 @@ public function setCount($count) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -284,7 +283,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -313,7 +312,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -324,10 +323,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -358,4 +358,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchHits.php b/clients/algoliasearch-client-php/lib/Model/SearchHits.php index 98d474deaf..dcce6cb2d2 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchHits.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchHits.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchHits Class Doc Comment @@ -31,7 +31,7 @@ class SearchHits implements ModelInterface, ArrayAccess, \JsonSerializable * @var string[] */ protected static $openAPITypes = [ - 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]' + 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]', ]; /** @@ -42,7 +42,7 @@ class SearchHits implements ModelInterface, ArrayAccess, \JsonSerializable * @psalm-var array */ protected static $openAPIFormats = [ - 'hits' => null + 'hits' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'hits' => 'hits' + 'hits' => 'hits', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'hits' => 'setHits' + 'hits' => 'setHits', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'hits' => 'getHits' + 'hits' => 'getHits', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -176,7 +175,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets hits * @@ -203,9 +201,9 @@ public function setHits($hits) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -215,7 +213,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -244,7 +242,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -255,10 +253,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -289,4 +288,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchParams.php b/clients/algoliasearch-client-php/lib/Model/SearchParams.php index 184d6356e4..bdde27f975 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchParams.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchParams Class Doc Comment @@ -108,7 +108,7 @@ class SearchParams implements ModelInterface, ArrayAccess, \JsonSerializable 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object' + 'renderingContent' => 'object', ]; /** @@ -196,7 +196,7 @@ class SearchParams implements ModelInterface, ArrayAccess, \JsonSerializable 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null + 'renderingContent' => null, ]; /** @@ -303,7 +303,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent' + 'renderingContent' => 'renderingContent', ]; /** @@ -389,7 +389,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent' + 'renderingContent' => 'setRenderingContent', ]; /** @@ -475,7 +475,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent' + 'renderingContent' => 'getRenderingContent', ]; /** @@ -813,7 +813,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets params * @@ -827,7 +826,7 @@ public function getParams() /** * Sets params * - * @param string|null $params Search parameters as URL-encoded query string. + * @param string|null $params search parameters as URL-encoded query string * * @return self */ @@ -851,7 +850,7 @@ public function getSimilarQuery() /** * Sets similarQuery * - * @param string|null $similarQuery Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results. + * @param string|null $similarQuery overrides the query parameter and performs a more generic search that can be used to find \"similar\" results * * @return self */ @@ -875,7 +874,7 @@ public function getFilters() /** * Sets filters * - * @param string|null $filters Filter the query with numeric, facet and/or tag filters. + * @param string|null $filters filter the query with numeric, facet and/or tag filters * * @return self */ @@ -899,7 +898,7 @@ public function getFacetFilters() /** * Sets facetFilters * - * @param string[]|null $facetFilters Filter hits by facet value. + * @param string[]|null $facetFilters filter hits by facet value * * @return self */ @@ -923,7 +922,7 @@ public function getOptionalFilters() /** * Sets optionalFilters * - * @param string[]|null $optionalFilters Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. + * @param string[]|null $optionalFilters create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter * * @return self */ @@ -947,7 +946,7 @@ public function getNumericFilters() /** * Sets numericFilters * - * @param string[]|null $numericFilters Filter on numeric attributes. + * @param string[]|null $numericFilters filter on numeric attributes * * @return self */ @@ -971,7 +970,7 @@ public function getTagFilters() /** * Sets tagFilters * - * @param string[]|null $tagFilters Filter hits by tags. + * @param string[]|null $tagFilters filter hits by tags * * @return self */ @@ -995,7 +994,7 @@ public function getSumOrFiltersScores() /** * Sets sumOrFiltersScores * - * @param bool|null $sumOrFiltersScores Determines how to calculate the total score for filtering. + * @param bool|null $sumOrFiltersScores determines how to calculate the total score for filtering * * @return self */ @@ -1019,7 +1018,7 @@ public function getFacets() /** * Sets facets * - * @param string[]|null $facets Retrieve facets and their facet values. + * @param string[]|null $facets retrieve facets and their facet values * * @return self */ @@ -1043,7 +1042,7 @@ public function getMaxValuesPerFacet() /** * Sets maxValuesPerFacet * - * @param int|null $maxValuesPerFacet Maximum number of facet values to return for each facet during a regular search. + * @param int|null $maxValuesPerFacet maximum number of facet values to return for each facet during a regular search * * @return self */ @@ -1067,7 +1066,7 @@ public function getFacetingAfterDistinct() /** * Sets facetingAfterDistinct * - * @param bool|null $facetingAfterDistinct Force faceting to be applied after de-duplication (via the Distinct setting). + * @param bool|null $facetingAfterDistinct force faceting to be applied after de-duplication (via the Distinct setting) * * @return self */ @@ -1091,7 +1090,7 @@ public function getSortFacetValuesBy() /** * Sets sortFacetValuesBy * - * @param string|null $sortFacetValuesBy Controls how facet values are fetched. + * @param string|null $sortFacetValuesBy controls how facet values are fetched * * @return self */ @@ -1115,7 +1114,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Specify the page to retrieve. + * @param int|null $page specify the page to retrieve * * @return self */ @@ -1139,7 +1138,7 @@ public function getOffset() /** * Sets offset * - * @param int|null $offset Specify the offset of the first hit to return. + * @param int|null $offset specify the offset of the first hit to return * * @return self */ @@ -1163,7 +1162,7 @@ public function getLength() /** * Sets length * - * @param int|null $length Set the number of hits to retrieve (used only with offset). + * @param int|null $length set the number of hits to retrieve (used only with offset) * * @return self */ @@ -1195,7 +1194,7 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng Search for entries around a central geolocation, enabling a geo search within a circular area. + * @param string|null $aroundLatLng search for entries around a central geolocation, enabling a geo search within a circular area * * @return self */ @@ -1219,7 +1218,7 @@ public function getAroundLatLngViaIP() /** * Sets aroundLatLngViaIP * - * @param bool|null $aroundLatLngViaIP Search for entries around a given location automatically computed from the requester's IP address. + * @param bool|null $aroundLatLngViaIP search for entries around a given location automatically computed from the requester's IP address * * @return self */ @@ -1243,7 +1242,7 @@ public function getAroundRadius() /** * Sets aroundRadius * - * @param OneOfIntegerString|null $aroundRadius Define the maximum radius for a geo search (in meters). + * @param OneOfIntegerString|null $aroundRadius define the maximum radius for a geo search (in meters) * * @return self */ @@ -1267,7 +1266,7 @@ public function getAroundPrecision() /** * Sets aroundPrecision * - * @param int|null $aroundPrecision Precision of geo search (in meters), to add grouping by geo location to the ranking formula. + * @param int|null $aroundPrecision precision of geo search (in meters), to add grouping by geo location to the ranking formula * * @return self */ @@ -1291,7 +1290,7 @@ public function getMinimumAroundRadius() /** * Sets minimumAroundRadius * - * @param int|null $minimumAroundRadius Minimum radius (in meters) used for a geo search when aroundRadius is not set. + * @param int|null $minimumAroundRadius minimum radius (in meters) used for a geo search when aroundRadius is not set * * @return self */ @@ -1320,7 +1319,7 @@ public function getInsideBoundingBox() /** * Sets insideBoundingBox * - * @param float[]|null $insideBoundingBox Search inside a rectangular area (in geo coordinates). + * @param float[]|null $insideBoundingBox search inside a rectangular area (in geo coordinates) * * @return self */ @@ -1344,7 +1343,7 @@ public function getInsidePolygon() /** * Sets insidePolygon * - * @param float[]|null $insidePolygon Search inside a polygon (in geo coordinates). + * @param float[]|null $insidePolygon search inside a polygon (in geo coordinates) * * @return self */ @@ -1392,7 +1391,7 @@ public function getRuleContexts() /** * Sets ruleContexts * - * @param string[]|null $ruleContexts Enables contextual rules. + * @param string[]|null $ruleContexts enables contextual rules * * @return self */ @@ -1416,7 +1415,7 @@ public function getPersonalizationImpact() /** * Sets personalizationImpact * - * @param int|null $personalizationImpact Define the impact of the Personalization feature. + * @param int|null $personalizationImpact define the impact of the Personalization feature * * @return self */ @@ -1440,7 +1439,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken Associates a certain user token with the current search. + * @param string|null $userToken associates a certain user token with the current search * * @return self */ @@ -1464,7 +1463,7 @@ public function getGetRankingInfo() /** * Sets getRankingInfo * - * @param bool|null $getRankingInfo Retrieve detailed ranking information. + * @param bool|null $getRankingInfo retrieve detailed ranking information * * @return self */ @@ -1488,7 +1487,7 @@ public function getClickAnalytics() /** * Sets clickAnalytics * - * @param bool|null $clickAnalytics Enable the Click Analytics feature. + * @param bool|null $clickAnalytics enable the Click Analytics feature * * @return self */ @@ -1512,7 +1511,7 @@ public function getAnalytics() /** * Sets analytics * - * @param bool|null $analytics Whether the current query will be taken into account in the Analytics. + * @param bool|null $analytics whether the current query will be taken into account in the Analytics * * @return self */ @@ -1536,7 +1535,7 @@ public function getAnalyticsTags() /** * Sets analyticsTags * - * @param string[]|null $analyticsTags List of tags to apply to the query for analytics purposes. + * @param string[]|null $analyticsTags list of tags to apply to the query for analytics purposes * * @return self */ @@ -1560,7 +1559,7 @@ public function getPercentileComputation() /** * Sets percentileComputation * - * @param bool|null $percentileComputation Whether to include or exclude a query from the processing-time percentile computation. + * @param bool|null $percentileComputation whether to include or exclude a query from the processing-time percentile computation * * @return self */ @@ -1584,7 +1583,7 @@ public function getEnableABTest() /** * Sets enableABTest * - * @param bool|null $enableABTest Whether this search should participate in running AB tests. + * @param bool|null $enableABTest whether this search should participate in running AB tests * * @return self */ @@ -1608,7 +1607,7 @@ public function getEnableReRanking() /** * Sets enableReRanking * - * @param bool|null $enableReRanking Whether this search should use AI Re-Ranking. + * @param bool|null $enableReRanking whether this search should use AI Re-Ranking * * @return self */ @@ -1632,7 +1631,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -1656,7 +1655,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes The complete list of attributes used for searching. + * @param string[]|null $searchableAttributes the complete list of attributes used for searching * * @return self */ @@ -1680,7 +1679,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. + * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting * * @return self */ @@ -1704,7 +1703,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. + * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time * * @return self */ @@ -1728,7 +1727,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. + * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve * * @return self */ @@ -1752,7 +1751,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. + * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes * * @return self */ @@ -1776,7 +1775,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking Controls how Algolia should sort your results. + * @param string[]|null $ranking controls how Algolia should sort your results * * @return self */ @@ -1800,7 +1799,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking Specifies the custom ranking criterion. + * @param string[]|null $customRanking specifies the custom ranking criterion * * @return self */ @@ -1824,7 +1823,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. + * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results * * @return self */ @@ -1848,7 +1847,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight List of attributes to highlight. + * @param string[]|null $attributesToHighlight list of attributes to highlight * * @return self */ @@ -1872,7 +1871,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. + * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet * * @return self */ @@ -1896,7 +1895,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results * * @return self */ @@ -1920,7 +1919,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results * * @return self */ @@ -1944,7 +1943,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. + * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated * * @return self */ @@ -1968,7 +1967,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. + * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query * * @return self */ @@ -1992,7 +1991,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -2016,7 +2015,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. + * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo * * @return self */ @@ -2040,7 +2039,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. + * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos * * @return self */ @@ -2064,7 +2063,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. + * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied * * @return self */ @@ -2098,7 +2097,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. + * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string * * @return self */ @@ -2122,7 +2121,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. + * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance * * @return self */ @@ -2146,7 +2145,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex Control which separators are indexed. + * @param string|null $separatorsToIndex control which separators are indexed * * @return self */ @@ -2170,7 +2169,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. + * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms * * @return self */ @@ -2194,7 +2193,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. + * @param string|null $removeStopWords removes stop (common) words from the query before executing it * * @return self */ @@ -2218,7 +2217,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. + * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize * * @return self */ @@ -2242,7 +2241,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. + * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection * * @return self */ @@ -2266,7 +2265,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. + * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query * * @return self */ @@ -2290,7 +2289,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules Whether Rules should be globally enabled. + * @param bool|null $enableRules whether Rules should be globally enabled * * @return self */ @@ -2314,7 +2313,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization Enable the Personalization feature. + * @param bool|null $enablePersonalization enable the Personalization feature * * @return self */ @@ -2338,7 +2337,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType Controls if and how query words are interpreted as prefixes. + * @param string|null $queryType controls if and how query words are interpreted as prefixes * * @return self */ @@ -2372,7 +2371,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. + * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits * * @return self */ @@ -2406,7 +2405,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax Enables the advanced query syntax. + * @param bool|null $advancedSyntax enables the advanced query syntax * * @return self */ @@ -2430,7 +2429,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. + * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query * * @return self */ @@ -2454,7 +2453,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. + * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion * * @return self */ @@ -2478,7 +2477,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. + * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word * * @return self */ @@ -2512,7 +2511,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. + * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion * * @return self */ @@ -2545,7 +2544,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. + * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled * * @return self */ @@ -2578,7 +2577,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct Enables de-duplication or grouping of results. + * @param int|null $distinct enables de-duplication or grouping of results * * @return self */ @@ -2610,7 +2609,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. + * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search * * @return self */ @@ -2634,7 +2633,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. + * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself * * @return self */ @@ -2658,7 +2657,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity Precision of the proximity ranking criterion. + * @param int|null $minProximity precision of the proximity ranking criterion * * @return self */ @@ -2743,7 +2742,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. + * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage * * @return self */ @@ -2780,9 +2779,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -2792,7 +2791,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -2821,7 +2820,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -2832,10 +2831,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -2866,4 +2866,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php b/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php index 49956dd09f..e8ff8684b7 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchParamsObject Class Doc Comment @@ -107,7 +107,7 @@ class SearchParamsObject implements ModelInterface, ArrayAccess, \JsonSerializab 'responseFields' => 'string[]', 'maxFacetHits' => 'int', 'attributeCriteriaComputedByMinProximity' => 'bool', - 'renderingContent' => 'object' + 'renderingContent' => 'object', ]; /** @@ -194,7 +194,7 @@ class SearchParamsObject implements ModelInterface, ArrayAccess, \JsonSerializab 'responseFields' => null, 'maxFacetHits' => null, 'attributeCriteriaComputedByMinProximity' => null, - 'renderingContent' => null + 'renderingContent' => null, ]; /** @@ -300,7 +300,7 @@ public static function openAPIFormats() 'responseFields' => 'responseFields', 'maxFacetHits' => 'maxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'attributeCriteriaComputedByMinProximity', - 'renderingContent' => 'renderingContent' + 'renderingContent' => 'renderingContent', ]; /** @@ -385,7 +385,7 @@ public static function openAPIFormats() 'responseFields' => 'setResponseFields', 'maxFacetHits' => 'setMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'setAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'setRenderingContent' + 'renderingContent' => 'setRenderingContent', ]; /** @@ -470,7 +470,7 @@ public static function openAPIFormats() 'responseFields' => 'getResponseFields', 'maxFacetHits' => 'getMaxFacetHits', 'attributeCriteriaComputedByMinProximity' => 'getAttributeCriteriaComputedByMinProximity', - 'renderingContent' => 'getRenderingContent' + 'renderingContent' => 'getRenderingContent', ]; /** @@ -807,7 +807,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets similarQuery * @@ -821,7 +820,7 @@ public function getSimilarQuery() /** * Sets similarQuery * - * @param string|null $similarQuery Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results. + * @param string|null $similarQuery overrides the query parameter and performs a more generic search that can be used to find \"similar\" results * * @return self */ @@ -845,7 +844,7 @@ public function getFilters() /** * Sets filters * - * @param string|null $filters Filter the query with numeric, facet and/or tag filters. + * @param string|null $filters filter the query with numeric, facet and/or tag filters * * @return self */ @@ -869,7 +868,7 @@ public function getFacetFilters() /** * Sets facetFilters * - * @param string[]|null $facetFilters Filter hits by facet value. + * @param string[]|null $facetFilters filter hits by facet value * * @return self */ @@ -893,7 +892,7 @@ public function getOptionalFilters() /** * Sets optionalFilters * - * @param string[]|null $optionalFilters Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter. + * @param string[]|null $optionalFilters create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter * * @return self */ @@ -917,7 +916,7 @@ public function getNumericFilters() /** * Sets numericFilters * - * @param string[]|null $numericFilters Filter on numeric attributes. + * @param string[]|null $numericFilters filter on numeric attributes * * @return self */ @@ -941,7 +940,7 @@ public function getTagFilters() /** * Sets tagFilters * - * @param string[]|null $tagFilters Filter hits by tags. + * @param string[]|null $tagFilters filter hits by tags * * @return self */ @@ -965,7 +964,7 @@ public function getSumOrFiltersScores() /** * Sets sumOrFiltersScores * - * @param bool|null $sumOrFiltersScores Determines how to calculate the total score for filtering. + * @param bool|null $sumOrFiltersScores determines how to calculate the total score for filtering * * @return self */ @@ -989,7 +988,7 @@ public function getFacets() /** * Sets facets * - * @param string[]|null $facets Retrieve facets and their facet values. + * @param string[]|null $facets retrieve facets and their facet values * * @return self */ @@ -1013,7 +1012,7 @@ public function getMaxValuesPerFacet() /** * Sets maxValuesPerFacet * - * @param int|null $maxValuesPerFacet Maximum number of facet values to return for each facet during a regular search. + * @param int|null $maxValuesPerFacet maximum number of facet values to return for each facet during a regular search * * @return self */ @@ -1037,7 +1036,7 @@ public function getFacetingAfterDistinct() /** * Sets facetingAfterDistinct * - * @param bool|null $facetingAfterDistinct Force faceting to be applied after de-duplication (via the Distinct setting). + * @param bool|null $facetingAfterDistinct force faceting to be applied after de-duplication (via the Distinct setting) * * @return self */ @@ -1061,7 +1060,7 @@ public function getSortFacetValuesBy() /** * Sets sortFacetValuesBy * - * @param string|null $sortFacetValuesBy Controls how facet values are fetched. + * @param string|null $sortFacetValuesBy controls how facet values are fetched * * @return self */ @@ -1085,7 +1084,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Specify the page to retrieve. + * @param int|null $page specify the page to retrieve * * @return self */ @@ -1109,7 +1108,7 @@ public function getOffset() /** * Sets offset * - * @param int|null $offset Specify the offset of the first hit to return. + * @param int|null $offset specify the offset of the first hit to return * * @return self */ @@ -1133,7 +1132,7 @@ public function getLength() /** * Sets length * - * @param int|null $length Set the number of hits to retrieve (used only with offset). + * @param int|null $length set the number of hits to retrieve (used only with offset) * * @return self */ @@ -1165,7 +1164,7 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng Search for entries around a central geolocation, enabling a geo search within a circular area. + * @param string|null $aroundLatLng search for entries around a central geolocation, enabling a geo search within a circular area * * @return self */ @@ -1189,7 +1188,7 @@ public function getAroundLatLngViaIP() /** * Sets aroundLatLngViaIP * - * @param bool|null $aroundLatLngViaIP Search for entries around a given location automatically computed from the requester's IP address. + * @param bool|null $aroundLatLngViaIP search for entries around a given location automatically computed from the requester's IP address * * @return self */ @@ -1213,7 +1212,7 @@ public function getAroundRadius() /** * Sets aroundRadius * - * @param OneOfIntegerString|null $aroundRadius Define the maximum radius for a geo search (in meters). + * @param OneOfIntegerString|null $aroundRadius define the maximum radius for a geo search (in meters) * * @return self */ @@ -1237,7 +1236,7 @@ public function getAroundPrecision() /** * Sets aroundPrecision * - * @param int|null $aroundPrecision Precision of geo search (in meters), to add grouping by geo location to the ranking formula. + * @param int|null $aroundPrecision precision of geo search (in meters), to add grouping by geo location to the ranking formula * * @return self */ @@ -1261,7 +1260,7 @@ public function getMinimumAroundRadius() /** * Sets minimumAroundRadius * - * @param int|null $minimumAroundRadius Minimum radius (in meters) used for a geo search when aroundRadius is not set. + * @param int|null $minimumAroundRadius minimum radius (in meters) used for a geo search when aroundRadius is not set * * @return self */ @@ -1290,7 +1289,7 @@ public function getInsideBoundingBox() /** * Sets insideBoundingBox * - * @param float[]|null $insideBoundingBox Search inside a rectangular area (in geo coordinates). + * @param float[]|null $insideBoundingBox search inside a rectangular area (in geo coordinates) * * @return self */ @@ -1314,7 +1313,7 @@ public function getInsidePolygon() /** * Sets insidePolygon * - * @param float[]|null $insidePolygon Search inside a polygon (in geo coordinates). + * @param float[]|null $insidePolygon search inside a polygon (in geo coordinates) * * @return self */ @@ -1362,7 +1361,7 @@ public function getRuleContexts() /** * Sets ruleContexts * - * @param string[]|null $ruleContexts Enables contextual rules. + * @param string[]|null $ruleContexts enables contextual rules * * @return self */ @@ -1386,7 +1385,7 @@ public function getPersonalizationImpact() /** * Sets personalizationImpact * - * @param int|null $personalizationImpact Define the impact of the Personalization feature. + * @param int|null $personalizationImpact define the impact of the Personalization feature * * @return self */ @@ -1410,7 +1409,7 @@ public function getUserToken() /** * Sets userToken * - * @param string|null $userToken Associates a certain user token with the current search. + * @param string|null $userToken associates a certain user token with the current search * * @return self */ @@ -1434,7 +1433,7 @@ public function getGetRankingInfo() /** * Sets getRankingInfo * - * @param bool|null $getRankingInfo Retrieve detailed ranking information. + * @param bool|null $getRankingInfo retrieve detailed ranking information * * @return self */ @@ -1458,7 +1457,7 @@ public function getClickAnalytics() /** * Sets clickAnalytics * - * @param bool|null $clickAnalytics Enable the Click Analytics feature. + * @param bool|null $clickAnalytics enable the Click Analytics feature * * @return self */ @@ -1482,7 +1481,7 @@ public function getAnalytics() /** * Sets analytics * - * @param bool|null $analytics Whether the current query will be taken into account in the Analytics. + * @param bool|null $analytics whether the current query will be taken into account in the Analytics * * @return self */ @@ -1506,7 +1505,7 @@ public function getAnalyticsTags() /** * Sets analyticsTags * - * @param string[]|null $analyticsTags List of tags to apply to the query for analytics purposes. + * @param string[]|null $analyticsTags list of tags to apply to the query for analytics purposes * * @return self */ @@ -1530,7 +1529,7 @@ public function getPercentileComputation() /** * Sets percentileComputation * - * @param bool|null $percentileComputation Whether to include or exclude a query from the processing-time percentile computation. + * @param bool|null $percentileComputation whether to include or exclude a query from the processing-time percentile computation * * @return self */ @@ -1554,7 +1553,7 @@ public function getEnableABTest() /** * Sets enableABTest * - * @param bool|null $enableABTest Whether this search should participate in running AB tests. + * @param bool|null $enableABTest whether this search should participate in running AB tests * * @return self */ @@ -1578,7 +1577,7 @@ public function getEnableReRanking() /** * Sets enableReRanking * - * @param bool|null $enableReRanking Whether this search should use AI Re-Ranking. + * @param bool|null $enableReRanking whether this search should use AI Re-Ranking * * @return self */ @@ -1602,7 +1601,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -1626,7 +1625,7 @@ public function getSearchableAttributes() /** * Sets searchableAttributes * - * @param string[]|null $searchableAttributes The complete list of attributes used for searching. + * @param string[]|null $searchableAttributes the complete list of attributes used for searching * * @return self */ @@ -1650,7 +1649,7 @@ public function getAttributesForFaceting() /** * Sets attributesForFaceting * - * @param string[]|null $attributesForFaceting The complete list of attributes that will be used for faceting. + * @param string[]|null $attributesForFaceting the complete list of attributes that will be used for faceting * * @return self */ @@ -1674,7 +1673,7 @@ public function getUnretrievableAttributes() /** * Sets unretrievableAttributes * - * @param string[]|null $unretrievableAttributes List of attributes that can't be retrieved at query time. + * @param string[]|null $unretrievableAttributes list of attributes that can't be retrieved at query time * * @return self */ @@ -1698,7 +1697,7 @@ public function getAttributesToRetrieve() /** * Sets attributesToRetrieve * - * @param string[]|null $attributesToRetrieve This parameter controls which attributes to retrieve and which not to retrieve. + * @param string[]|null $attributesToRetrieve this parameter controls which attributes to retrieve and which not to retrieve * * @return self */ @@ -1722,7 +1721,7 @@ public function getRestrictSearchableAttributes() /** * Sets restrictSearchableAttributes * - * @param string[]|null $restrictSearchableAttributes Restricts a given query to look in only a subset of your searchable attributes. + * @param string[]|null $restrictSearchableAttributes restricts a given query to look in only a subset of your searchable attributes * * @return self */ @@ -1746,7 +1745,7 @@ public function getRanking() /** * Sets ranking * - * @param string[]|null $ranking Controls how Algolia should sort your results. + * @param string[]|null $ranking controls how Algolia should sort your results * * @return self */ @@ -1770,7 +1769,7 @@ public function getCustomRanking() /** * Sets customRanking * - * @param string[]|null $customRanking Specifies the custom ranking criterion. + * @param string[]|null $customRanking specifies the custom ranking criterion * * @return self */ @@ -1794,7 +1793,7 @@ public function getRelevancyStrictness() /** * Sets relevancyStrictness * - * @param int|null $relevancyStrictness Controls the relevancy threshold below which less relevant results aren't included in the results. + * @param int|null $relevancyStrictness controls the relevancy threshold below which less relevant results aren't included in the results * * @return self */ @@ -1818,7 +1817,7 @@ public function getAttributesToHighlight() /** * Sets attributesToHighlight * - * @param string[]|null $attributesToHighlight List of attributes to highlight. + * @param string[]|null $attributesToHighlight list of attributes to highlight * * @return self */ @@ -1842,7 +1841,7 @@ public function getAttributesToSnippet() /** * Sets attributesToSnippet * - * @param string[]|null $attributesToSnippet List of attributes to snippet, with an optional maximum number of words to snippet. + * @param string[]|null $attributesToSnippet list of attributes to snippet, with an optional maximum number of words to snippet * * @return self */ @@ -1866,7 +1865,7 @@ public function getHighlightPreTag() /** * Sets highlightPreTag * - * @param string|null $highlightPreTag The HTML string to insert before the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPreTag the HTML string to insert before the highlighted parts in all highlight and snippet results * * @return self */ @@ -1890,7 +1889,7 @@ public function getHighlightPostTag() /** * Sets highlightPostTag * - * @param string|null $highlightPostTag The HTML string to insert after the highlighted parts in all highlight and snippet results. + * @param string|null $highlightPostTag the HTML string to insert after the highlighted parts in all highlight and snippet results * * @return self */ @@ -1914,7 +1913,7 @@ public function getSnippetEllipsisText() /** * Sets snippetEllipsisText * - * @param string|null $snippetEllipsisText String used as an ellipsis indicator when a snippet is truncated. + * @param string|null $snippetEllipsisText string used as an ellipsis indicator when a snippet is truncated * * @return self */ @@ -1938,7 +1937,7 @@ public function getRestrictHighlightAndSnippetArrays() /** * Sets restrictHighlightAndSnippetArrays * - * @param bool|null $restrictHighlightAndSnippetArrays Restrict highlighting and snippeting to items that matched the query. + * @param bool|null $restrictHighlightAndSnippetArrays restrict highlighting and snippeting to items that matched the query * * @return self */ @@ -1962,7 +1961,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -1986,7 +1985,7 @@ public function getMinWordSizefor1Typo() /** * Sets minWordSizefor1Typo * - * @param int|null $minWordSizefor1Typo Minimum number of characters a word in the query string must contain to accept matches with 1 typo. + * @param int|null $minWordSizefor1Typo minimum number of characters a word in the query string must contain to accept matches with 1 typo * * @return self */ @@ -2010,7 +2009,7 @@ public function getMinWordSizefor2Typos() /** * Sets minWordSizefor2Typos * - * @param int|null $minWordSizefor2Typos Minimum number of characters a word in the query string must contain to accept matches with 2 typos. + * @param int|null $minWordSizefor2Typos minimum number of characters a word in the query string must contain to accept matches with 2 typos * * @return self */ @@ -2034,7 +2033,7 @@ public function getTypoTolerance() /** * Sets typoTolerance * - * @param string|null $typoTolerance Controls whether typo tolerance is enabled and how it is applied. + * @param string|null $typoTolerance controls whether typo tolerance is enabled and how it is applied * * @return self */ @@ -2068,7 +2067,7 @@ public function getAllowTyposOnNumericTokens() /** * Sets allowTyposOnNumericTokens * - * @param bool|null $allowTyposOnNumericTokens Whether to allow typos on numbers (\"numeric tokens\") in the query string. + * @param bool|null $allowTyposOnNumericTokens whether to allow typos on numbers (\"numeric tokens\") in the query string * * @return self */ @@ -2092,7 +2091,7 @@ public function getDisableTypoToleranceOnAttributes() /** * Sets disableTypoToleranceOnAttributes * - * @param string[]|null $disableTypoToleranceOnAttributes List of attributes on which you want to disable typo tolerance. + * @param string[]|null $disableTypoToleranceOnAttributes list of attributes on which you want to disable typo tolerance * * @return self */ @@ -2116,7 +2115,7 @@ public function getSeparatorsToIndex() /** * Sets separatorsToIndex * - * @param string|null $separatorsToIndex Control which separators are indexed. + * @param string|null $separatorsToIndex control which separators are indexed * * @return self */ @@ -2140,7 +2139,7 @@ public function getIgnorePlurals() /** * Sets ignorePlurals * - * @param string|null $ignorePlurals Treats singular, plurals, and other forms of declensions as matching terms. + * @param string|null $ignorePlurals treats singular, plurals, and other forms of declensions as matching terms * * @return self */ @@ -2164,7 +2163,7 @@ public function getRemoveStopWords() /** * Sets removeStopWords * - * @param string|null $removeStopWords Removes stop (common) words from the query before executing it. + * @param string|null $removeStopWords removes stop (common) words from the query before executing it * * @return self */ @@ -2188,7 +2187,7 @@ public function getKeepDiacriticsOnCharacters() /** * Sets keepDiacriticsOnCharacters * - * @param string|null $keepDiacriticsOnCharacters List of characters that the engine shouldn't automatically normalize. + * @param string|null $keepDiacriticsOnCharacters list of characters that the engine shouldn't automatically normalize * * @return self */ @@ -2212,7 +2211,7 @@ public function getQueryLanguages() /** * Sets queryLanguages * - * @param string[]|null $queryLanguages Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. + * @param string[]|null $queryLanguages sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection * * @return self */ @@ -2236,7 +2235,7 @@ public function getDecompoundQuery() /** * Sets decompoundQuery * - * @param bool|null $decompoundQuery Splits compound words into their composing atoms in the query. + * @param bool|null $decompoundQuery splits compound words into their composing atoms in the query * * @return self */ @@ -2260,7 +2259,7 @@ public function getEnableRules() /** * Sets enableRules * - * @param bool|null $enableRules Whether Rules should be globally enabled. + * @param bool|null $enableRules whether Rules should be globally enabled * * @return self */ @@ -2284,7 +2283,7 @@ public function getEnablePersonalization() /** * Sets enablePersonalization * - * @param bool|null $enablePersonalization Enable the Personalization feature. + * @param bool|null $enablePersonalization enable the Personalization feature * * @return self */ @@ -2308,7 +2307,7 @@ public function getQueryType() /** * Sets queryType * - * @param string|null $queryType Controls if and how query words are interpreted as prefixes. + * @param string|null $queryType controls if and how query words are interpreted as prefixes * * @return self */ @@ -2342,7 +2341,7 @@ public function getRemoveWordsIfNoResults() /** * Sets removeWordsIfNoResults * - * @param string|null $removeWordsIfNoResults Selects a strategy to remove words from the query when it doesn't match any hits. + * @param string|null $removeWordsIfNoResults selects a strategy to remove words from the query when it doesn't match any hits * * @return self */ @@ -2376,7 +2375,7 @@ public function getAdvancedSyntax() /** * Sets advancedSyntax * - * @param bool|null $advancedSyntax Enables the advanced query syntax. + * @param bool|null $advancedSyntax enables the advanced query syntax * * @return self */ @@ -2400,7 +2399,7 @@ public function getOptionalWords() /** * Sets optionalWords * - * @param string[]|null $optionalWords A list of words that should be considered as optional when found in the query. + * @param string[]|null $optionalWords a list of words that should be considered as optional when found in the query * * @return self */ @@ -2424,7 +2423,7 @@ public function getDisableExactOnAttributes() /** * Sets disableExactOnAttributes * - * @param string[]|null $disableExactOnAttributes List of attributes on which you want to disable the exact ranking criterion. + * @param string[]|null $disableExactOnAttributes list of attributes on which you want to disable the exact ranking criterion * * @return self */ @@ -2448,7 +2447,7 @@ public function getExactOnSingleWordQuery() /** * Sets exactOnSingleWordQuery * - * @param string|null $exactOnSingleWordQuery Controls how the exact ranking criterion is computed when the query contains only one word. + * @param string|null $exactOnSingleWordQuery controls how the exact ranking criterion is computed when the query contains only one word * * @return self */ @@ -2482,7 +2481,7 @@ public function getAlternativesAsExact() /** * Sets alternativesAsExact * - * @param string[]|null $alternativesAsExact List of alternatives that should be considered an exact match by the exact ranking criterion. + * @param string[]|null $alternativesAsExact list of alternatives that should be considered an exact match by the exact ranking criterion * * @return self */ @@ -2515,7 +2514,7 @@ public function getAdvancedSyntaxFeatures() /** * Sets advancedSyntaxFeatures * - * @param string[]|null $advancedSyntaxFeatures Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. + * @param string[]|null $advancedSyntaxFeatures allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled * * @return self */ @@ -2548,7 +2547,7 @@ public function getDistinct() /** * Sets distinct * - * @param int|null $distinct Enables de-duplication or grouping of results. + * @param int|null $distinct enables de-duplication or grouping of results * * @return self */ @@ -2580,7 +2579,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param bool|null $synonyms Whether to take into account an index's synonyms for a particular search. + * @param bool|null $synonyms whether to take into account an index's synonyms for a particular search * * @return self */ @@ -2604,7 +2603,7 @@ public function getReplaceSynonymsInHighlight() /** * Sets replaceSynonymsInHighlight * - * @param bool|null $replaceSynonymsInHighlight Whether to highlight and snippet the original word that matches the synonym or the synonym itself. + * @param bool|null $replaceSynonymsInHighlight whether to highlight and snippet the original word that matches the synonym or the synonym itself * * @return self */ @@ -2628,7 +2627,7 @@ public function getMinProximity() /** * Sets minProximity * - * @param int|null $minProximity Precision of the proximity ranking criterion. + * @param int|null $minProximity precision of the proximity ranking criterion * * @return self */ @@ -2713,7 +2712,7 @@ public function getAttributeCriteriaComputedByMinProximity() /** * Sets attributeCriteriaComputedByMinProximity * - * @param bool|null $attributeCriteriaComputedByMinProximity When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage. + * @param bool|null $attributeCriteriaComputedByMinProximity when attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage * * @return self */ @@ -2750,9 +2749,9 @@ public function setRenderingContent($renderingContent) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -2762,7 +2761,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -2791,7 +2790,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -2802,10 +2801,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -2836,4 +2836,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php b/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php index ad130c49c8..c8668a3daa 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchParamsString Class Doc Comment @@ -31,7 +31,7 @@ class SearchParamsString implements ModelInterface, ArrayAccess, \JsonSerializab * @var string[] */ protected static $openAPITypes = [ - 'params' => 'string' + 'params' => 'string', ]; /** @@ -42,7 +42,7 @@ class SearchParamsString implements ModelInterface, ArrayAccess, \JsonSerializab * @psalm-var array */ protected static $openAPIFormats = [ - 'params' => null + 'params' => null, ]; /** @@ -72,7 +72,7 @@ public static function openAPIFormats() * @var string[] */ protected static $attributeMap = [ - 'params' => 'params' + 'params' => 'params', ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() * @var string[] */ protected static $setters = [ - 'params' => 'setParams' + 'params' => 'setParams', ]; /** @@ -90,7 +90,7 @@ public static function openAPIFormats() * @var string[] */ protected static $getters = [ - 'params' => 'getParams' + 'params' => 'getParams', ]; /** @@ -134,7 +134,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -176,7 +175,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets params * @@ -190,7 +188,7 @@ public function getParams() /** * Sets params * - * @param string|null $params Search parameters as URL-encoded query string. + * @param string|null $params search parameters as URL-encoded query string * * @return self */ @@ -203,9 +201,9 @@ public function setParams($params) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -215,7 +213,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -244,7 +242,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -255,10 +253,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -289,4 +288,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchResponse.php index f5adcaad07..e333813ee1 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchResponse Class Doc Comment @@ -55,7 +55,7 @@ class SearchResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'queryAfterRemoval' => 'string', 'serverUsed' => 'string', 'userData' => 'object', - 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]' + 'hits' => '\Algolia\AlgoliaSearch\Model\Record[]', ]; /** @@ -90,7 +90,7 @@ class SearchResponse implements ModelInterface, ArrayAccess, \JsonSerializable 'queryAfterRemoval' => null, 'serverUsed' => null, 'userData' => null, - 'hits' => null + 'hits' => null, ]; /** @@ -144,7 +144,7 @@ public static function openAPIFormats() 'queryAfterRemoval' => 'queryAfterRemoval', 'serverUsed' => 'serverUsed', 'userData' => 'userData', - 'hits' => 'hits' + 'hits' => 'hits', ]; /** @@ -177,7 +177,7 @@ public static function openAPIFormats() 'queryAfterRemoval' => 'setQueryAfterRemoval', 'serverUsed' => 'setServerUsed', 'userData' => 'setUserData', - 'hits' => 'setHits' + 'hits' => 'setHits', ]; /** @@ -210,7 +210,7 @@ public static function openAPIFormats() 'queryAfterRemoval' => 'getQueryAfterRemoval', 'serverUsed' => 'getServerUsed', 'userData' => 'getUserData', - 'hits' => 'getHits' + 'hits' => 'getHits', ]; /** @@ -254,7 +254,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -306,7 +305,7 @@ public function listInvalidProperties() { $invalidProperties = []; - if (!is_null($this->container['aroundLatLng']) && !preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $this->container['aroundLatLng'])) { + if (!is_null($this->container['aroundLatLng']) && !preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $this->container['aroundLatLng'])) { $invalidProperties[] = "invalid value for 'aroundLatLng', must be conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."; } @@ -340,6 +339,7 @@ public function listInvalidProperties() if ($this->container['hits'] === null) { $invalidProperties[] = "'hits' can't be null"; } + return $invalidProperties; } @@ -354,7 +354,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets abTestID * @@ -368,7 +367,7 @@ public function getAbTestID() /** * Sets abTestID * - * @param int|null $abTestID If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID. + * @param int|null $abTestID if a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID * * @return self */ @@ -392,7 +391,7 @@ public function getAbTestVariantID() /** * Sets abTestVariantID * - * @param int|null $abTestVariantID If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used. + * @param int|null $abTestVariantID if a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used * * @return self */ @@ -416,14 +415,14 @@ public function getAroundLatLng() /** * Sets aroundLatLng * - * @param string|null $aroundLatLng The computed geo location. + * @param string|null $aroundLatLng the computed geo location * * @return self */ public function setAroundLatLng($aroundLatLng) { - if (!is_null($aroundLatLng) && (!preg_match("/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/", $aroundLatLng))) { + if (!is_null($aroundLatLng) && (!preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $aroundLatLng))) { throw new \InvalidArgumentException("invalid value for $aroundLatLng when calling SearchResponse., must conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."); } @@ -469,7 +468,7 @@ public function getExhaustiveFacetsCount() /** * Sets exhaustiveFacetsCount * - * @param bool|null $exhaustiveFacetsCount Whether the facet count is exhaustive or approximate. + * @param bool|null $exhaustiveFacetsCount whether the facet count is exhaustive or approximate * * @return self */ @@ -541,7 +540,7 @@ public function getFacets() /** * Sets facets * - * @param array>|null $facets A mapping of each facet name to the corresponding facet counts. + * @param array>|null $facets a mapping of each facet name to the corresponding facet counts * * @return self */ @@ -565,7 +564,7 @@ public function getFacetsStats() /** * Sets facetsStats * - * @param array|null $facetsStats Statistics for numerical facets. + * @param array|null $facetsStats statistics for numerical facets * * @return self */ @@ -589,7 +588,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int $hitsPerPage Set the number of hits per page. + * @param int $hitsPerPage set the number of hits per page * * @return self */ @@ -613,7 +612,7 @@ public function getIndex() /** * Sets index * - * @param string|null $index Index name used for the query. + * @param string|null $index index name used for the query * * @return self */ @@ -661,7 +660,7 @@ public function getMessage() /** * Sets message * - * @param string|null $message Used to return warnings about the query. + * @param string|null $message used to return warnings about the query * * @return self */ @@ -685,7 +684,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits Number of hits that the search query matched. + * @param int $nbHits number of hits that the search query matched * * @return self */ @@ -757,7 +756,7 @@ public function getPage() /** * Sets page * - * @param int $page Specify the page to retrieve. + * @param int $page specify the page to retrieve * * @return self */ @@ -781,7 +780,7 @@ public function getParams() /** * Sets params * - * @param string $params A url-encoded string of all search parameters. + * @param string $params a url-encoded string of all search parameters * * @return self */ @@ -805,7 +804,7 @@ public function getParsedQuery() /** * Sets parsedQuery * - * @param string|null $parsedQuery The query string that will be searched, after normalization. + * @param string|null $parsedQuery the query string that will be searched, after normalization * * @return self */ @@ -829,7 +828,7 @@ public function getProcessingTimeMS() /** * Sets processingTimeMS * - * @param int $processingTimeMS Time the server took to process the request, in milliseconds. + * @param int $processingTimeMS time the server took to process the request, in milliseconds * * @return self */ @@ -853,7 +852,7 @@ public function getQuery() /** * Sets query * - * @param string $query The text to search in the index. + * @param string $query the text to search in the index * * @return self */ @@ -877,7 +876,7 @@ public function getQueryAfterRemoval() /** * Sets queryAfterRemoval * - * @param string|null $queryAfterRemoval A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set. + * @param string|null $queryAfterRemoval a markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set * * @return self */ @@ -901,7 +900,7 @@ public function getServerUsed() /** * Sets serverUsed * - * @param string|null $serverUsed Actual host name of the server that processed the request. + * @param string|null $serverUsed actual host name of the server that processed the request * * @return self */ @@ -925,7 +924,7 @@ public function getUserData() /** * Sets userData * - * @param object|null $userData Lets you store custom data in your indices. + * @param object|null $userData lets you store custom data in your indices * * @return self */ @@ -962,9 +961,9 @@ public function setHits($hits) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -974,7 +973,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -1003,7 +1002,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -1014,10 +1013,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -1048,4 +1048,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php b/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php index 604d9db2ea..e5e167f954 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchRulesParams Class Doc Comment * * @category Class * @description Parameters for the search. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -38,7 +39,7 @@ class SearchRulesParams implements ModelInterface, ArrayAccess, \JsonSerializabl 'page' => 'int', 'hitsPerPage' => 'int', 'enabled' => 'bool', - 'requestOptions' => 'object[]' + 'requestOptions' => 'object[]', ]; /** @@ -55,7 +56,7 @@ class SearchRulesParams implements ModelInterface, ArrayAccess, \JsonSerializabl 'page' => null, 'hitsPerPage' => null, 'enabled' => null, - 'requestOptions' => null + 'requestOptions' => null, ]; /** @@ -91,7 +92,7 @@ public static function openAPIFormats() 'page' => 'page', 'hitsPerPage' => 'hitsPerPage', 'enabled' => 'enabled', - 'requestOptions' => 'requestOptions' + 'requestOptions' => 'requestOptions', ]; /** @@ -106,7 +107,7 @@ public static function openAPIFormats() 'page' => 'setPage', 'hitsPerPage' => 'setHitsPerPage', 'enabled' => 'setEnabled', - 'requestOptions' => 'setRequestOptions' + 'requestOptions' => 'setRequestOptions', ]; /** @@ -121,7 +122,7 @@ public static function openAPIFormats() 'page' => 'getPage', 'hitsPerPage' => 'getHitsPerPage', 'enabled' => 'getEnabled', - 'requestOptions' => 'getRequestOptions' + 'requestOptions' => 'getRequestOptions', ]; /** @@ -165,7 +166,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -213,7 +213,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets query * @@ -227,7 +226,7 @@ public function getQuery() /** * Sets query * - * @param string|null $query Full text query. + * @param string|null $query full text query * * @return self */ @@ -275,7 +274,7 @@ public function getContext() /** * Sets context * - * @param string|null $context Restricts matches to contextual rules with a specific context (exact match). + * @param string|null $context restricts matches to contextual rules with a specific context (exact match) * * @return self */ @@ -299,7 +298,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Requested page (zero-based). + * @param int|null $page requested page (zero-based) * * @return self */ @@ -371,7 +370,7 @@ public function getRequestOptions() /** * Sets requestOptions * - * @param object[]|null $requestOptions A mapping of requestOptions to send along with the request. + * @param object[]|null $requestOptions a mapping of requestOptions to send along with the request * * @return self */ @@ -384,9 +383,9 @@ public function setRequestOptions($requestOptions) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -396,7 +395,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -425,7 +424,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -436,10 +435,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -470,4 +470,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php index 2bfe6387a8..a77a76adcc 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchRulesResponse Class Doc Comment @@ -34,7 +34,7 @@ class SearchRulesResponse implements ModelInterface, ArrayAccess, \JsonSerializa 'hits' => '\Algolia\AlgoliaSearch\Model\Rule[]', 'nbHits' => 'int', 'page' => 'int', - 'nbPages' => 'int' + 'nbPages' => 'int', ]; /** @@ -48,7 +48,7 @@ class SearchRulesResponse implements ModelInterface, ArrayAccess, \JsonSerializa 'hits' => null, 'nbHits' => null, 'page' => null, - 'nbPages' => null + 'nbPages' => null, ]; /** @@ -81,7 +81,7 @@ public static function openAPIFormats() 'hits' => 'hits', 'nbHits' => 'nbHits', 'page' => 'page', - 'nbPages' => 'nbPages' + 'nbPages' => 'nbPages', ]; /** @@ -93,7 +93,7 @@ public static function openAPIFormats() 'hits' => 'setHits', 'nbHits' => 'setNbHits', 'page' => 'setPage', - 'nbPages' => 'setNbPages' + 'nbPages' => 'setNbPages', ]; /** @@ -105,7 +105,7 @@ public static function openAPIFormats() 'hits' => 'getHits', 'nbHits' => 'getNbHits', 'page' => 'getPage', - 'nbPages' => 'getNbPages' + 'nbPages' => 'getNbPages', ]; /** @@ -149,7 +149,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -192,6 +191,7 @@ public function listInvalidProperties() if ($this->container['nbPages'] === null) { $invalidProperties[] = "'nbPages' can't be null"; } + return $invalidProperties; } @@ -206,7 +206,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets hits * @@ -220,7 +219,7 @@ public function getHits() /** * Sets hits * - * @param \Algolia\AlgoliaSearch\Model\Rule[] $hits Fetched rules. + * @param \Algolia\AlgoliaSearch\Model\Rule[] $hits fetched rules * * @return self */ @@ -244,7 +243,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits Number of fetched rules. + * @param int $nbHits number of fetched rules * * @return self */ @@ -268,7 +267,7 @@ public function getPage() /** * Sets page * - * @param int $page Current page. + * @param int $page current page * * @return self */ @@ -292,7 +291,7 @@ public function getNbPages() /** * Sets nbPages * - * @param int $nbPages Number of pages. + * @param int $nbPages number of pages * * @return self */ @@ -305,9 +304,9 @@ public function setNbPages($nbPages) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -317,7 +316,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -346,7 +345,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -357,10 +356,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -391,4 +391,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php index 95e04a6329..96ecbda0cc 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchSynonymsResponse Class Doc Comment @@ -32,7 +32,7 @@ class SearchSynonymsResponse implements ModelInterface, ArrayAccess, \JsonSerial */ protected static $openAPITypes = [ 'hits' => '\Algolia\AlgoliaSearch\Model\SynonymHit[]', - 'nbHits' => 'int' + 'nbHits' => 'int', ]; /** @@ -44,7 +44,7 @@ class SearchSynonymsResponse implements ModelInterface, ArrayAccess, \JsonSerial */ protected static $openAPIFormats = [ 'hits' => null, - 'nbHits' => null + 'nbHits' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'hits' => 'hits', - 'nbHits' => 'nbHits' + 'nbHits' => 'nbHits', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'hits' => 'setHits', - 'nbHits' => 'setNbHits' + 'nbHits' => 'setNbHits', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'hits' => 'getHits', - 'nbHits' => 'getNbHits' + 'nbHits' => 'getNbHits', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -174,6 +173,7 @@ public function listInvalidProperties() if ($this->container['nbHits'] === null) { $invalidProperties[] = "'nbHits' can't be null"; } + return $invalidProperties; } @@ -188,7 +188,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets hits * @@ -202,7 +201,7 @@ public function getHits() /** * Sets hits * - * @param \Algolia\AlgoliaSearch\Model\SynonymHit[] $hits Array of synonym objects. + * @param \Algolia\AlgoliaSearch\Model\SynonymHit[] $hits array of synonym objects * * @return self */ @@ -226,7 +225,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits Number of hits that the search query matched. + * @param int $nbHits number of hits that the search query matched * * @return self */ @@ -239,9 +238,9 @@ public function setNbHits($nbHits) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -251,7 +250,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -280,7 +279,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -291,10 +290,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -325,4 +325,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php index 2db6a4eb66..e0d149cc8e 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchUserIdsObject Class Doc Comment * * @category Class * @description OK + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +36,7 @@ class SearchUserIdsObject implements ModelInterface, ArrayAccess, \JsonSerializa 'query' => 'string', 'clusterName' => 'string', 'page' => 'int', - 'hitsPerPage' => 'int' + 'hitsPerPage' => 'int', ]; /** @@ -49,7 +50,7 @@ class SearchUserIdsObject implements ModelInterface, ArrayAccess, \JsonSerializa 'query' => null, 'clusterName' => null, 'page' => null, - 'hitsPerPage' => null + 'hitsPerPage' => null, ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() 'query' => 'query', 'clusterName' => 'clusterName', 'page' => 'page', - 'hitsPerPage' => 'hitsPerPage' + 'hitsPerPage' => 'hitsPerPage', ]; /** @@ -94,7 +95,7 @@ public static function openAPIFormats() 'query' => 'setQuery', 'clusterName' => 'setClusterName', 'page' => 'setPage', - 'hitsPerPage' => 'setHitsPerPage' + 'hitsPerPage' => 'setHitsPerPage', ]; /** @@ -106,7 +107,7 @@ public static function openAPIFormats() 'query' => 'getQuery', 'clusterName' => 'getClusterName', 'page' => 'getPage', - 'hitsPerPage' => 'getHitsPerPage' + 'hitsPerPage' => 'getHitsPerPage', ]; /** @@ -150,7 +151,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -184,6 +184,7 @@ public function listInvalidProperties() if ($this->container['query'] === null) { $invalidProperties[] = "'query' can't be null"; } + return $invalidProperties; } @@ -198,7 +199,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets query * @@ -236,7 +236,7 @@ public function getClusterName() /** * Sets clusterName * - * @param string|null $clusterName Name of the cluster. + * @param string|null $clusterName name of the cluster * * @return self */ @@ -260,7 +260,7 @@ public function getPage() /** * Sets page * - * @param int|null $page Specify the page to retrieve. + * @param int|null $page specify the page to retrieve * * @return self */ @@ -284,7 +284,7 @@ public function getHitsPerPage() /** * Sets hitsPerPage * - * @param int|null $hitsPerPage Set the number of hits per page. + * @param int|null $hitsPerPage set the number of hits per page * * @return self */ @@ -297,9 +297,9 @@ public function setHitsPerPage($hitsPerPage) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -309,7 +309,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -338,7 +338,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -349,10 +349,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -383,4 +384,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php index 3c0a3ddf23..f70343d00e 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchUserIdsResponse Class Doc Comment * * @category Class * @description userIDs data. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -36,7 +37,7 @@ class SearchUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSeriali 'nbHits' => 'int', 'page' => 'int', 'hitsPerPage' => 'int', - 'updatedAt' => '\DateTime' + 'updatedAt' => '\DateTime', ]; /** @@ -51,7 +52,7 @@ class SearchUserIdsResponse implements ModelInterface, ArrayAccess, \JsonSeriali 'nbHits' => null, 'page' => null, 'hitsPerPage' => null, - 'updatedAt' => 'date-time' + 'updatedAt' => 'date-time', ]; /** @@ -85,7 +86,7 @@ public static function openAPIFormats() 'nbHits' => 'nbHits', 'page' => 'page', 'hitsPerPage' => 'hitsPerPage', - 'updatedAt' => 'updatedAt' + 'updatedAt' => 'updatedAt', ]; /** @@ -98,7 +99,7 @@ public static function openAPIFormats() 'nbHits' => 'setNbHits', 'page' => 'setPage', 'hitsPerPage' => 'setHitsPerPage', - 'updatedAt' => 'setUpdatedAt' + 'updatedAt' => 'setUpdatedAt', ]; /** @@ -111,7 +112,7 @@ public static function openAPIFormats() 'nbHits' => 'getNbHits', 'page' => 'getPage', 'hitsPerPage' => 'getHitsPerPage', - 'updatedAt' => 'getUpdatedAt' + 'updatedAt' => 'getUpdatedAt', ]; /** @@ -155,7 +156,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -202,6 +202,7 @@ public function listInvalidProperties() if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } + return $invalidProperties; } @@ -216,7 +217,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets hits * @@ -230,7 +230,7 @@ public function getHits() /** * Sets hits * - * @param \Algolia\AlgoliaSearch\Model\SearchUserIdsResponseHits[] $hits List of user object matching the query. + * @param \Algolia\AlgoliaSearch\Model\SearchUserIdsResponseHits[] $hits list of user object matching the query * * @return self */ @@ -254,7 +254,7 @@ public function getNbHits() /** * Sets nbHits * - * @param int $nbHits Number of hits that the search query matched. + * @param int $nbHits number of hits that the search query matched * * @return self */ @@ -278,7 +278,7 @@ public function getPage() /** * Sets page * - * @param int $page Specify the page to retrieve. + * @param int $page specify the page to retrieve * * @return self */ @@ -326,7 +326,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -339,9 +339,9 @@ public function setUpdatedAt($updatedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -351,7 +351,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -380,7 +380,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -391,10 +391,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -425,4 +426,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php index c51f5eb88d..60367a5e5e 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchUserIdsResponseHighlightResult Class Doc Comment @@ -32,7 +32,7 @@ class SearchUserIdsResponseHighlightResult implements ModelInterface, ArrayAcces */ protected static $openAPITypes = [ 'userID' => '\Algolia\AlgoliaSearch\Model\HighlightResult', - 'clusterName' => '\Algolia\AlgoliaSearch\Model\HighlightResult' + 'clusterName' => '\Algolia\AlgoliaSearch\Model\HighlightResult', ]; /** @@ -44,7 +44,7 @@ class SearchUserIdsResponseHighlightResult implements ModelInterface, ArrayAcces */ protected static $openAPIFormats = [ 'userID' => null, - 'clusterName' => null + 'clusterName' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'userID' => 'userID', - 'clusterName' => 'clusterName' + 'clusterName' => 'clusterName', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'userID' => 'setUserID', - 'clusterName' => 'setClusterName' + 'clusterName' => 'setClusterName', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'userID' => 'getUserID', - 'clusterName' => 'getClusterName' + 'clusterName' => 'getClusterName', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -174,6 +173,7 @@ public function listInvalidProperties() if ($this->container['clusterName'] === null) { $invalidProperties[] = "'clusterName' can't be null"; } + return $invalidProperties; } @@ -188,7 +188,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets userID * @@ -239,9 +238,9 @@ public function setClusterName($clusterName) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -251,7 +250,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -280,7 +279,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -291,10 +290,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -325,4 +325,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php index 66c19bf600..c95fc5ba92 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SearchUserIdsResponseHits Class Doc Comment @@ -36,7 +36,7 @@ class SearchUserIdsResponseHits implements ModelInterface, ArrayAccess, \JsonSer 'nbRecords' => 'int', 'dataSize' => 'int', 'objectID' => 'string', - 'highlightResult' => '\Algolia\AlgoliaSearch\Model\SearchUserIdsResponseHighlightResult' + 'highlightResult' => '\Algolia\AlgoliaSearch\Model\SearchUserIdsResponseHighlightResult', ]; /** @@ -52,7 +52,7 @@ class SearchUserIdsResponseHits implements ModelInterface, ArrayAccess, \JsonSer 'nbRecords' => null, 'dataSize' => null, 'objectID' => null, - 'highlightResult' => null + 'highlightResult' => null, ]; /** @@ -87,7 +87,7 @@ public static function openAPIFormats() 'nbRecords' => 'nbRecords', 'dataSize' => 'dataSize', 'objectID' => 'objectID', - 'highlightResult' => '_highlightResult' + 'highlightResult' => '_highlightResult', ]; /** @@ -101,7 +101,7 @@ public static function openAPIFormats() 'nbRecords' => 'setNbRecords', 'dataSize' => 'setDataSize', 'objectID' => 'setObjectID', - 'highlightResult' => 'setHighlightResult' + 'highlightResult' => 'setHighlightResult', ]; /** @@ -115,7 +115,7 @@ public static function openAPIFormats() 'nbRecords' => 'getNbRecords', 'dataSize' => 'getDataSize', 'objectID' => 'getObjectID', - 'highlightResult' => 'getHighlightResult' + 'highlightResult' => 'getHighlightResult', ]; /** @@ -159,7 +159,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -210,6 +209,7 @@ public function listInvalidProperties() if ($this->container['highlightResult'] === null) { $invalidProperties[] = "'highlightResult' can't be null"; } + return $invalidProperties; } @@ -224,7 +224,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets userID * @@ -262,7 +261,7 @@ public function getClusterName() /** * Sets clusterName * - * @param string $clusterName Name of the cluster. + * @param string $clusterName name of the cluster * * @return self */ @@ -286,7 +285,7 @@ public function getNbRecords() /** * Sets nbRecords * - * @param int $nbRecords Number of records in the cluster. + * @param int $nbRecords number of records in the cluster * * @return self */ @@ -310,7 +309,7 @@ public function getDataSize() /** * Sets dataSize * - * @param int $dataSize Data size taken by all the users assigned to the cluster. + * @param int $dataSize data size taken by all the users assigned to the cluster * * @return self */ @@ -371,9 +370,9 @@ public function setHighlightResult($highlightResult) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -383,7 +382,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -412,7 +411,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -423,10 +422,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -457,4 +457,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SnippetResult.php b/clients/algoliasearch-client-php/lib/Model/SnippetResult.php index a508bd46e3..a53c369440 100644 --- a/clients/algoliasearch-client-php/lib/Model/SnippetResult.php +++ b/clients/algoliasearch-client-php/lib/Model/SnippetResult.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SnippetResult Class Doc Comment @@ -32,7 +32,7 @@ class SnippetResult implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'value' => 'string', - 'matchLevel' => 'string' + 'matchLevel' => 'string', ]; /** @@ -44,7 +44,7 @@ class SnippetResult implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'value' => null, - 'matchLevel' => null + 'matchLevel' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'value' => 'value', - 'matchLevel' => 'matchLevel' + 'matchLevel' => 'matchLevel', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'value' => 'setValue', - 'matchLevel' => 'setMatchLevel' + 'matchLevel' => 'setMatchLevel', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'value' => 'getValue', - 'matchLevel' => 'getMatchLevel' + 'matchLevel' => 'getMatchLevel', ]; /** @@ -208,7 +208,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets value * @@ -222,7 +221,7 @@ public function getValue() /** * Sets value * - * @param string|null $value Markup text with occurrences highlighted. + * @param string|null $value markup text with occurrences highlighted * * @return self */ @@ -246,7 +245,7 @@ public function getMatchLevel() /** * Sets matchLevel * - * @param string|null $matchLevel Indicates how well the attribute matched the search query. + * @param string|null $matchLevel indicates how well the attribute matched the search query * * @return self */ @@ -269,9 +268,9 @@ public function setMatchLevel($matchLevel) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -281,7 +280,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -310,7 +309,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -321,10 +320,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -355,4 +355,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/Source.php b/clients/algoliasearch-client-php/lib/Model/Source.php index f78c6ba8fe..a366214e5c 100644 --- a/clients/algoliasearch-client-php/lib/Model/Source.php +++ b/clients/algoliasearch-client-php/lib/Model/Source.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * Source Class Doc Comment * * @category Class * @description The source. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class Source implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'source' => 'string', - 'description' => 'string' + 'description' => 'string', ]; /** @@ -45,7 +46,7 @@ class Source implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'source' => null, - 'description' => null + 'description' => null, ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'source' => 'source', - 'description' => 'description' + 'description' => 'description', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'source' => 'setSource', - 'description' => 'setDescription' + 'description' => 'setDescription', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'source' => 'getSource', - 'description' => 'getDescription' + 'description' => 'getDescription', ]; /** @@ -140,7 +141,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -172,6 +172,7 @@ public function listInvalidProperties() if ($this->container['source'] === null) { $invalidProperties[] = "'source' can't be null"; } + return $invalidProperties; } @@ -186,7 +187,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets source * @@ -200,7 +200,7 @@ public function getSource() /** * Sets source * - * @param string $source The IP range of the source. + * @param string $source the IP range of the source * * @return self */ @@ -224,7 +224,7 @@ public function getDescription() /** * Sets description * - * @param string|null $description The description of the source. + * @param string|null $description the description of the source * * @return self */ @@ -237,9 +237,9 @@ public function setDescription($description) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -249,7 +249,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -278,7 +278,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -289,10 +289,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -323,4 +324,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/StandardEntries.php b/clients/algoliasearch-client-php/lib/Model/StandardEntries.php index 88e8918f9f..a4725918f6 100644 --- a/clients/algoliasearch-client-php/lib/Model/StandardEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/StandardEntries.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * StandardEntries Class Doc Comment * * @category Class * @description Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class StandardEntries implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPITypes = [ 'plurals' => 'array', 'stopwords' => 'array', - 'compounds' => 'array' + 'compounds' => 'array', ]; /** @@ -47,7 +48,7 @@ class StandardEntries implements ModelInterface, ArrayAccess, \JsonSerializable protected static $openAPIFormats = [ 'plurals' => null, 'stopwords' => null, - 'compounds' => null + 'compounds' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'plurals' => 'plurals', 'stopwords' => 'stopwords', - 'compounds' => 'compounds' + 'compounds' => 'compounds', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'plurals' => 'setPlurals', 'stopwords' => 'setStopwords', - 'compounds' => 'setCompounds' + 'compounds' => 'setCompounds', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'plurals' => 'getPlurals', 'stopwords' => 'getStopwords', - 'compounds' => 'getCompounds' + 'compounds' => 'getCompounds', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -189,7 +189,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets plurals * @@ -203,7 +202,7 @@ public function getPlurals() /** * Sets plurals * - * @param array|null $plurals Language ISO code. + * @param array|null $plurals language ISO code * * @return self */ @@ -227,7 +226,7 @@ public function getStopwords() /** * Sets stopwords * - * @param array|null $stopwords Language ISO code. + * @param array|null $stopwords language ISO code * * @return self */ @@ -251,7 +250,7 @@ public function getCompounds() /** * Sets compounds * - * @param array|null $compounds Language ISO code. + * @param array|null $compounds language ISO code * * @return self */ @@ -264,9 +263,9 @@ public function setCompounds($compounds) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -276,7 +275,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -305,7 +304,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -316,10 +315,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -350,4 +350,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SynonymHit.php b/clients/algoliasearch-client-php/lib/Model/SynonymHit.php index cab013367c..dddf6bc20c 100644 --- a/clients/algoliasearch-client-php/lib/Model/SynonymHit.php +++ b/clients/algoliasearch-client-php/lib/Model/SynonymHit.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SynonymHit Class Doc Comment * * @category Class * @description Synonym object. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -40,7 +41,7 @@ class SynonymHit implements ModelInterface, ArrayAccess, \JsonSerializable 'corrections' => 'string[]', 'placeholder' => 'string', 'replacements' => 'string[]', - 'highlightResult' => '\Algolia\AlgoliaSearch\Model\SynonymHitHighlightResult' + 'highlightResult' => '\Algolia\AlgoliaSearch\Model\SynonymHitHighlightResult', ]; /** @@ -59,7 +60,7 @@ class SynonymHit implements ModelInterface, ArrayAccess, \JsonSerializable 'corrections' => null, 'placeholder' => null, 'replacements' => null, - 'highlightResult' => null + 'highlightResult' => null, ]; /** @@ -97,7 +98,7 @@ public static function openAPIFormats() 'corrections' => 'corrections', 'placeholder' => 'placeholder', 'replacements' => 'replacements', - 'highlightResult' => '_highlightResult' + 'highlightResult' => '_highlightResult', ]; /** @@ -114,7 +115,7 @@ public static function openAPIFormats() 'corrections' => 'setCorrections', 'placeholder' => 'setPlaceholder', 'replacements' => 'setReplacements', - 'highlightResult' => 'setHighlightResult' + 'highlightResult' => 'setHighlightResult', ]; /** @@ -131,7 +132,7 @@ public static function openAPIFormats() 'corrections' => 'getCorrections', 'placeholder' => 'getPlaceholder', 'replacements' => 'getReplacements', - 'highlightResult' => 'getHighlightResult' + 'highlightResult' => 'getHighlightResult', ]; /** @@ -261,7 +262,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -275,7 +275,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID Unique identifier of the synonym object to be created or updated. + * @param string $objectID unique identifier of the synonym object to be created or updated * * @return self */ @@ -299,7 +299,7 @@ public function getType() /** * Sets type * - * @param string $type Type of the synonym object. + * @param string $type type of the synonym object * * @return self */ @@ -333,7 +333,7 @@ public function getSynonyms() /** * Sets synonyms * - * @param string[]|null $synonyms Words or phrases to be considered equivalent. + * @param string[]|null $synonyms words or phrases to be considered equivalent * * @return self */ @@ -357,7 +357,7 @@ public function getInput() /** * Sets input * - * @param string|null $input Word or phrase to appear in query strings (for onewaysynonym). + * @param string|null $input word or phrase to appear in query strings (for onewaysynonym) * * @return self */ @@ -381,7 +381,7 @@ public function getWord() /** * Sets word * - * @param string|null $word Word or phrase to appear in query strings (for altcorrection1 and altcorrection2). + * @param string|null $word word or phrase to appear in query strings (for altcorrection1 and altcorrection2) * * @return self */ @@ -405,7 +405,7 @@ public function getCorrections() /** * Sets corrections * - * @param string[]|null $corrections Words to be matched in records. + * @param string[]|null $corrections words to be matched in records * * @return self */ @@ -429,7 +429,7 @@ public function getPlaceholder() /** * Sets placeholder * - * @param string|null $placeholder Token to be put inside records. + * @param string|null $placeholder token to be put inside records * * @return self */ @@ -453,7 +453,7 @@ public function getReplacements() /** * Sets replacements * - * @param string[]|null $replacements List of query words that will match the token. + * @param string[]|null $replacements list of query words that will match the token * * @return self */ @@ -490,9 +490,9 @@ public function setHighlightResult($highlightResult) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -502,7 +502,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -531,7 +531,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -542,10 +542,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -576,4 +577,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php b/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php index 5fc7fac8f2..a87187c8ed 100644 --- a/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php +++ b/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * SynonymHitHighlightResult Class Doc Comment * * @category Class * @description Highlighted results + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class SynonymHitHighlightResult implements ModelInterface, ArrayAccess, \JsonSer */ protected static $openAPITypes = [ 'type' => '\Algolia\AlgoliaSearch\Model\HighlightResult', - 'synonyms' => '\Algolia\AlgoliaSearch\Model\HighlightResult[]' + 'synonyms' => '\Algolia\AlgoliaSearch\Model\HighlightResult[]', ]; /** @@ -45,7 +46,7 @@ class SynonymHitHighlightResult implements ModelInterface, ArrayAccess, \JsonSer */ protected static $openAPIFormats = [ 'type' => null, - 'synonyms' => null + 'synonyms' => null, ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'type' => 'type', - 'synonyms' => 'synonyms' + 'synonyms' => 'synonyms', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'type' => 'setType', - 'synonyms' => 'setSynonyms' + 'synonyms' => 'setSynonyms', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'type' => 'getType', - 'synonyms' => 'getSynonyms' + 'synonyms' => 'getSynonyms', ]; /** @@ -140,7 +141,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -183,7 +183,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets type * @@ -234,9 +233,9 @@ public function setSynonyms($synonyms) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -246,7 +245,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -275,7 +274,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -286,10 +285,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -320,4 +320,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/TimeRange.php b/clients/algoliasearch-client-php/lib/Model/TimeRange.php index d9b5b8ff4d..ed041ae6c9 100644 --- a/clients/algoliasearch-client-php/lib/Model/TimeRange.php +++ b/clients/algoliasearch-client-php/lib/Model/TimeRange.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * TimeRange Class Doc Comment @@ -32,7 +32,7 @@ class TimeRange implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPITypes = [ 'from' => 'int', - 'until' => 'int' + 'until' => 'int', ]; /** @@ -44,7 +44,7 @@ class TimeRange implements ModelInterface, ArrayAccess, \JsonSerializable */ protected static $openAPIFormats = [ 'from' => null, - 'until' => null + 'until' => null, ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'from' => 'from', - 'until' => 'until' + 'until' => 'until', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'from' => 'setFrom', - 'until' => 'setUntil' + 'until' => 'setUntil', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'from' => 'getFrom', - 'until' => 'getUntil' + 'until' => 'getUntil', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -174,6 +173,7 @@ public function listInvalidProperties() if ($this->container['until'] === null) { $invalidProperties[] = "'until' can't be null"; } + return $invalidProperties; } @@ -188,7 +188,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets from * @@ -202,7 +201,7 @@ public function getFrom() /** * Sets from * - * @param int $from Lower bound of the time range (Unix timestamp). + * @param int $from lower bound of the time range (Unix timestamp) * * @return self */ @@ -226,7 +225,7 @@ public function getUntil() /** * Sets until * - * @param int $until Upper bound of the time range (Unix timestamp). + * @param int $until upper bound of the time range (Unix timestamp) * * @return self */ @@ -239,9 +238,9 @@ public function setUntil($until) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -251,7 +250,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -280,7 +279,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -291,10 +290,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -325,4 +325,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php index 9030ab6488..e5cf8339e9 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * UpdateApiKeyResponse Class Doc Comment @@ -32,7 +32,7 @@ class UpdateApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializ */ protected static $openAPITypes = [ 'key' => 'string', - 'updatedAt' => '\DateTime' + 'updatedAt' => '\DateTime', ]; /** @@ -44,7 +44,7 @@ class UpdateApiKeyResponse implements ModelInterface, ArrayAccess, \JsonSerializ */ protected static $openAPIFormats = [ 'key' => null, - 'updatedAt' => 'date-time' + 'updatedAt' => 'date-time', ]; /** @@ -75,7 +75,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'key' => 'key', - 'updatedAt' => 'updatedAt' + 'updatedAt' => 'updatedAt', ]; /** @@ -85,7 +85,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'key' => 'setKey', - 'updatedAt' => 'setUpdatedAt' + 'updatedAt' => 'setUpdatedAt', ]; /** @@ -95,7 +95,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'key' => 'getKey', - 'updatedAt' => 'getUpdatedAt' + 'updatedAt' => 'getUpdatedAt', ]; /** @@ -139,7 +139,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -174,6 +173,7 @@ public function listInvalidProperties() if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } + return $invalidProperties; } @@ -188,7 +188,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets key * @@ -202,7 +201,7 @@ public function getKey() /** * Sets key * - * @param string $key Key string. + * @param string $key key string * * @return self */ @@ -226,7 +225,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -239,9 +238,9 @@ public function setUpdatedAt($updatedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -251,7 +250,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -280,7 +279,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -291,10 +290,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -325,4 +325,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php index cc85dcb1ac..00ac404481 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * UpdatedAtResponse Class Doc Comment * * @category Class * @description The response with a taskID and an updatedAt timestamp. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -33,7 +34,7 @@ class UpdatedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPITypes = [ 'taskID' => 'int', - 'updatedAt' => '\DateTime' + 'updatedAt' => '\DateTime', ]; /** @@ -45,7 +46,7 @@ class UpdatedAtResponse implements ModelInterface, ArrayAccess, \JsonSerializabl */ protected static $openAPIFormats = [ 'taskID' => null, - 'updatedAt' => 'date-time' + 'updatedAt' => 'date-time', ]; /** @@ -76,7 +77,7 @@ public static function openAPIFormats() */ protected static $attributeMap = [ 'taskID' => 'taskID', - 'updatedAt' => 'updatedAt' + 'updatedAt' => 'updatedAt', ]; /** @@ -86,7 +87,7 @@ public static function openAPIFormats() */ protected static $setters = [ 'taskID' => 'setTaskID', - 'updatedAt' => 'setUpdatedAt' + 'updatedAt' => 'setUpdatedAt', ]; /** @@ -96,7 +97,7 @@ public static function openAPIFormats() */ protected static $getters = [ 'taskID' => 'getTaskID', - 'updatedAt' => 'getUpdatedAt' + 'updatedAt' => 'getUpdatedAt', ]; /** @@ -140,7 +141,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -175,6 +175,7 @@ public function listInvalidProperties() if ($this->container['updatedAt'] === null) { $invalidProperties[] = "'updatedAt' can't be null"; } + return $invalidProperties; } @@ -189,7 +190,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets taskID * @@ -203,7 +203,7 @@ public function getTaskID() /** * Sets taskID * - * @param int $taskID taskID of the indexing task to wait for. + * @param int $taskID taskID of the indexing task to wait for * * @return self */ @@ -227,7 +227,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -240,9 +240,9 @@ public function setUpdatedAt($updatedAt) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -252,7 +252,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -281,7 +281,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -292,10 +292,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -326,4 +327,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php index 49fafad1cf..c5c6a6920d 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * UpdatedAtWithObjectIdResponse Class Doc Comment * * @category Class * @description The response with a taskID, an objectID and an updatedAt timestamp. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -34,7 +35,7 @@ class UpdatedAtWithObjectIdResponse implements ModelInterface, ArrayAccess, \Jso protected static $openAPITypes = [ 'taskID' => 'int', 'updatedAt' => '\DateTime', - 'objectID' => 'string' + 'objectID' => 'string', ]; /** @@ -47,7 +48,7 @@ class UpdatedAtWithObjectIdResponse implements ModelInterface, ArrayAccess, \Jso protected static $openAPIFormats = [ 'taskID' => null, 'updatedAt' => 'date-time', - 'objectID' => null + 'objectID' => null, ]; /** @@ -79,7 +80,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'taskID' => 'taskID', 'updatedAt' => 'updatedAt', - 'objectID' => 'objectID' + 'objectID' => 'objectID', ]; /** @@ -90,7 +91,7 @@ public static function openAPIFormats() protected static $setters = [ 'taskID' => 'setTaskID', 'updatedAt' => 'setUpdatedAt', - 'objectID' => 'setObjectID' + 'objectID' => 'setObjectID', ]; /** @@ -101,7 +102,7 @@ public static function openAPIFormats() protected static $getters = [ 'taskID' => 'getTaskID', 'updatedAt' => 'getUpdatedAt', - 'objectID' => 'getObjectID' + 'objectID' => 'getObjectID', ]; /** @@ -145,7 +146,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -189,7 +189,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets taskID * @@ -203,7 +202,7 @@ public function getTaskID() /** * Sets taskID * - * @param int|null $taskID taskID of the indexing task to wait for. + * @param int|null $taskID taskID of the indexing task to wait for * * @return self */ @@ -227,7 +226,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime|null $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime|null $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -251,7 +250,7 @@ public function getObjectID() /** * Sets objectID * - * @param string|null $objectID Unique identifier of the object. + * @param string|null $objectID unique identifier of the object * * @return self */ @@ -264,9 +263,9 @@ public function setObjectID($objectID) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -276,7 +275,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -305,7 +304,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -316,10 +315,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -350,4 +350,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php index 2cc041c7a4..176d87e459 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php @@ -2,8 +2,8 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * UpdatedRuleResponse Class Doc Comment @@ -33,7 +33,7 @@ class UpdatedRuleResponse implements ModelInterface, ArrayAccess, \JsonSerializa protected static $openAPITypes = [ 'objectID' => 'string', 'updatedAt' => '\DateTime', - 'taskID' => 'int' + 'taskID' => 'int', ]; /** @@ -46,7 +46,7 @@ class UpdatedRuleResponse implements ModelInterface, ArrayAccess, \JsonSerializa protected static $openAPIFormats = [ 'objectID' => null, 'updatedAt' => 'date-time', - 'taskID' => null + 'taskID' => null, ]; /** @@ -78,7 +78,7 @@ public static function openAPIFormats() protected static $attributeMap = [ 'objectID' => 'objectID', 'updatedAt' => 'updatedAt', - 'taskID' => 'taskID' + 'taskID' => 'taskID', ]; /** @@ -89,7 +89,7 @@ public static function openAPIFormats() protected static $setters = [ 'objectID' => 'setObjectID', 'updatedAt' => 'setUpdatedAt', - 'taskID' => 'setTaskID' + 'taskID' => 'setTaskID', ]; /** @@ -100,7 +100,7 @@ public static function openAPIFormats() protected static $getters = [ 'objectID' => 'getObjectID', 'updatedAt' => 'getUpdatedAt', - 'taskID' => 'getTaskID' + 'taskID' => 'getTaskID', ]; /** @@ -144,7 +144,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -183,6 +182,7 @@ public function listInvalidProperties() if ($this->container['taskID'] === null) { $invalidProperties[] = "'taskID' can't be null"; } + return $invalidProperties; } @@ -197,7 +197,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets objectID * @@ -211,7 +210,7 @@ public function getObjectID() /** * Sets objectID * - * @param string $objectID Unique identifier of the object. + * @param string $objectID unique identifier of the object * * @return self */ @@ -235,7 +234,7 @@ public function getUpdatedAt() /** * Sets updatedAt * - * @param \DateTime $updatedAt Date of last update (ISO-8601 format). + * @param \DateTime $updatedAt date of last update (ISO-8601 format) * * @return self */ @@ -259,7 +258,7 @@ public function getTaskID() /** * Sets taskID * - * @param int $taskID taskID of the indexing task to wait for. + * @param int $taskID taskID of the indexing task to wait for * * @return self */ @@ -272,9 +271,9 @@ public function setTaskID($taskID) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -284,7 +283,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -313,7 +312,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -324,10 +323,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -358,4 +358,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/Model/UserId.php b/clients/algoliasearch-client-php/lib/Model/UserId.php index 84d828f010..575f4b4548 100644 --- a/clients/algoliasearch-client-php/lib/Model/UserId.php +++ b/clients/algoliasearch-client-php/lib/Model/UserId.php @@ -2,14 +2,15 @@ namespace Algolia\AlgoliaSearch\Model; -use \ArrayAccess; use \Algolia\AlgoliaSearch\ObjectSerializer; +use \ArrayAccess; /** * UserId Class Doc Comment * * @category Class * @description A userID. + * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null @@ -35,7 +36,7 @@ class UserId implements ModelInterface, ArrayAccess, \JsonSerializable 'userID' => 'string', 'clusterName' => 'string', 'nbRecords' => 'int', - 'dataSize' => 'int' + 'dataSize' => 'int', ]; /** @@ -49,7 +50,7 @@ class UserId implements ModelInterface, ArrayAccess, \JsonSerializable 'userID' => null, 'clusterName' => null, 'nbRecords' => null, - 'dataSize' => null + 'dataSize' => null, ]; /** @@ -82,7 +83,7 @@ public static function openAPIFormats() 'userID' => 'userID', 'clusterName' => 'clusterName', 'nbRecords' => 'nbRecords', - 'dataSize' => 'dataSize' + 'dataSize' => 'dataSize', ]; /** @@ -94,7 +95,7 @@ public static function openAPIFormats() 'userID' => 'setUserID', 'clusterName' => 'setClusterName', 'nbRecords' => 'setNbRecords', - 'dataSize' => 'setDataSize' + 'dataSize' => 'setDataSize', ]; /** @@ -106,7 +107,7 @@ public static function openAPIFormats() 'userID' => 'getUserID', 'clusterName' => 'getClusterName', 'nbRecords' => 'getNbRecords', - 'dataSize' => 'getDataSize' + 'dataSize' => 'getDataSize', ]; /** @@ -150,7 +151,6 @@ public function getModelName() return self::$openAPIModelName; } - /** * Associative array for storing property values * @@ -193,6 +193,7 @@ public function listInvalidProperties() if ($this->container['dataSize'] === null) { $invalidProperties[] = "'dataSize' can't be null"; } + return $invalidProperties; } @@ -207,7 +208,6 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** * Gets userID * @@ -221,7 +221,7 @@ public function getUserID() /** * Sets userID * - * @param string $userID userID of the user. + * @param string $userID userID of the user * * @return self */ @@ -245,7 +245,7 @@ public function getClusterName() /** * Sets clusterName * - * @param string $clusterName Cluster on which the user is assigned. + * @param string $clusterName cluster on which the user is assigned * * @return self */ @@ -269,7 +269,7 @@ public function getNbRecords() /** * Sets nbRecords * - * @param int $nbRecords Number of records belonging to the user. + * @param int $nbRecords number of records belonging to the user * * @return self */ @@ -293,7 +293,7 @@ public function getDataSize() /** * Sets dataSize * - * @param int $dataSize Data size used by the user. + * @param int $dataSize data size used by the user * * @return self */ @@ -306,9 +306,9 @@ public function setDataSize($dataSize) /** * Returns true if offset exists. False otherwise. * - * @param integer $offset Offset + * @param int $offset Offset * - * @return boolean + * @return bool */ public function offsetExists($offset) { @@ -318,7 +318,7 @@ public function offsetExists($offset) /** * Gets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return mixed|null */ @@ -347,7 +347,7 @@ public function offsetSet($offset, $value) /** * Unsets offset. * - * @param integer $offset Offset + * @param int $offset Offset * * @return void */ @@ -358,10 +358,11 @@ public function offsetUnset($offset) /** * Serializes the object to a value that can be serialized natively by json_encode(). + * * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php * - * @return mixed Returns data which can be serialized by json_encode(), which is a value - * of any type other than a resource. + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource */ public function jsonSerialize() { @@ -392,4 +393,3 @@ public function toHeaderValue() } } - diff --git a/clients/algoliasearch-client-php/lib/ObjectSerializer.php b/clients/algoliasearch-client-php/lib/ObjectSerializer.php index 25900ca3fa..9d7a5c6936 100644 --- a/clients/algoliasearch-client-php/lib/ObjectSerializer.php +++ b/clients/algoliasearch-client-php/lib/ObjectSerializer.php @@ -48,6 +48,7 @@ public static function sanitizeForSerialization($data, $type = null, $format = n foreach ($data as $property => $value) { $data[$property] = self::sanitizeForSerialization($value); } + return $data; } @@ -65,6 +66,7 @@ public static function sanitizeForSerialization($data, $type = null, $format = n $allowedEnumTypes = $callable(); if (!in_array($value, $allowedEnumTypes, true)) { $imploded = implode("', '", $allowedEnumTypes); + throw new \InvalidArgumentException("Invalid value for enum '$openAPIType', must be one of: '$imploded'"); } } @@ -78,10 +80,12 @@ public static function sanitizeForSerialization($data, $type = null, $format = n $values[$property] = self::sanitizeForSerialization($value); } } - return (object)$values; - } else { - return (string)$data; + + return (object) $values; } + + return (string) $data; + } /** @@ -96,9 +100,10 @@ public static function sanitizeFilename($filename) { if (preg_match("/.*[\/\\\\](.*)$/", $filename, $match)) { return $match[1]; - } else { - return $filename; } + + return $filename; + } /** @@ -128,9 +133,10 @@ public static function toQueryValue($object) { if (is_array($object)) { return implode(',', $object); - } else { - return self::toString($object); } + + return self::toString($object); + } /** @@ -165,9 +171,10 @@ public static function toFormValue($value) { if ($value instanceof \SplFileObject) { return $value->getRealPath(); - } else { - return self::toString($value); } + + return self::toString($value); + } /** @@ -186,9 +193,10 @@ public static function toString($value) return $value->format(self::$dateTimeFormat); } elseif (is_bool($value)) { return $value ? 'true' : 'false'; - } else { - return $value; } + + return $value; + } /** @@ -244,41 +252,45 @@ public static function deserialize($data, $class, $httpHeaders = null) return null; } - if (strcasecmp(substr($class, -2), '[]') === 0) { + if (strcasecmp(mb_substr($class, -2), '[]') === 0) { $data = is_string($data) ? json_decode($data) : $data; if (!is_array($data)) { throw new \InvalidArgumentException("Invalid array '$class'"); } - $subClass = substr($class, 0, -2); + $subClass = mb_substr($class, 0, -2); $values = []; foreach ($data as $key => $value) { $values[] = self::deserialize($value, $subClass, null); } + return $values; } if (preg_match('/^(array<|map\[)/', $class)) { // for associative array e.g. array $data = is_string($data) ? json_decode($data) : $data; settype($data, 'array'); - $inner = substr($class, 4, -1); + $inner = mb_substr($class, 4, -1); $deserialized = []; - if (strrpos($inner, ",") !== false) { + if (mb_strrpos($inner, ',') !== false) { $subClass_array = explode(',', $inner, 2); $subClass = $subClass_array[1]; foreach ($data as $key => $value) { $deserialized[$key] = self::deserialize($value, $subClass, null); } } + return $deserialized; } if ($class === 'object') { settype($data, 'array'); + return $data; } else if ($class === 'mixed') { settype($data, gettype($data)); + return $data; } @@ -307,6 +319,7 @@ public static function deserialize($data, $class, $httpHeaders = null) /** @psalm-suppress ParadoxicalCondition */ if (in_array($class, ['\DateTime', '\SplFileObject', 'array', 'bool', 'boolean', 'byte', 'double', 'float', 'int', 'integer', 'mixed', 'number', 'object', 'string', 'void'], true)) { settype($data, $class); + return $data; } @@ -331,10 +344,12 @@ public static function deserialize($data, $class, $httpHeaders = null) } elseif (method_exists($class, 'getAllowableEnumValues')) { if (!in_array($data, $class::getAllowableEnumValues(), true)) { $imploded = implode("', '", $class::getAllowableEnumValues()); + throw new \InvalidArgumentException("Invalid value for enum '$class', must be one of: '$imploded'"); } + return $data; - } else { + } $data = is_string($data) ? json_decode($data) : $data; // If a discriminator is defined and points to a valid subclass, use it. $discriminator = $class::DISCRIMINATOR; @@ -359,7 +374,8 @@ public static function deserialize($data, $class, $httpHeaders = null) $instance->$propertySetter(self::deserialize($propertyValue, $type, null)); } } + return $instance; - } + } } From b2d7eabed17f38d327cb3e6d4694050c50bdb9b0 Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Wed, 12 Jan 2022 17:22:05 +0100 Subject: [PATCH 06/13] fix: oopsy --- .github/actions/cache/action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/actions/cache/action.yml b/.github/actions/cache/action.yml index b580a3fc80..ea4a116171 100644 --- a/.github/actions/cache/action.yml +++ b/.github/actions/cache/action.yml @@ -65,7 +65,7 @@ runs: uses: actions/cache@v2 with: path: /home/runner/work/api-clients-automation/api-clients-automation/clients/algoliasearch-client-php/dist - key: ${{ runner.os }}-java-client-${{ hashFiles('clients/algoliasearch-client-php/**') }} + key: ${{ runner.os }}-php-client-${{ hashFiles('clients/algoliasearch-client-php/**') }} # setup yarn - name: Get yarn cache directory path From 45a043c6ba6560717c29d3abacb3806c50465768 Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Fri, 14 Jan 2022 15:17:53 +0100 Subject: [PATCH 07/13] fix: prettier --- .github/actions/setup/action.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/actions/setup/action.yml b/.github/actions/setup/action.yml index cf2795150d..1398e38277 100644 --- a/.github/actions/setup/action.yml +++ b/.github/actions/setup/action.yml @@ -93,7 +93,7 @@ runs: echo "::set-output name=MATRIX::$matrix" echo "::set-output name=RUN_CLIENT::$run" - + - name: Compute the PHP client build matrix id: php-matrix shell: bash @@ -135,7 +135,7 @@ outputs: JAVA_MATRIX: description: Generate the matrix for the Java client value: ${{ steps.java-matrix.outputs.MATRIX }} - + RUN_PHP: description: Whether to run php client or not value: ${{ steps.php-matrix.outputs.RUN_CLIENT }} From 06805b5ccdc9ed9d6fb1500b6ee978cfd04060cc Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Fri, 14 Jan 2022 15:37:18 +0100 Subject: [PATCH 08/13] fix: update linter --- .../.openapi-generator-ignore | 1 + .../.php-cs-fixer.php | 4 +- clients/algoliasearch-client-php/.php_cs | 23 ---- .../lib/Api/SearchApi.php | 128 ++++++++---------- .../lib/Configuration.php | 4 +- .../lib/HeaderSelector.php | 6 +- .../lib/Model/AddApiKeyResponse.php | 2 +- .../lib/Model/ApiKey.php | 2 +- .../lib/Model/AssignUserIdObject.php | 2 +- .../lib/Model/AutomaticFacetFilter.php | 2 +- .../lib/Model/BaseBrowseResponse.php | 2 +- .../lib/Model/BaseIndexSettings.php | 2 +- .../lib/Model/BaseSearchParams.php | 4 +- .../lib/Model/BaseSearchResponse.php | 3 +- .../Model/BaseSearchResponseFacetsStats.php | 2 +- .../lib/Model/BatchAssignUserIdsObject.php | 2 +- .../lib/Model/BatchDictionaryEntries.php | 2 +- .../Model/BatchDictionaryEntriesRequest.php | 2 +- .../lib/Model/BatchObject.php | 2 +- .../lib/Model/BatchResponse.php | 2 +- .../lib/Model/BatchWriteObject.php | 2 +- .../lib/Model/BrowseRequest.php | 2 +- .../lib/Model/BrowseResponse.php | 3 +- .../lib/Model/BuildInOperation.php | 2 +- .../lib/Model/Condition.php | 2 +- .../lib/Model/Consequence.php | 2 +- .../lib/Model/ConsequenceHide.php | 2 +- .../lib/Model/ConsequenceParams.php | 7 +- .../lib/Model/CreatedAtObject.php | 2 +- .../lib/Model/CreatedAtResponse.php | 2 +- .../lib/Model/DeleteApiKeyResponse.php | 2 +- .../lib/Model/DeleteSourceResponse.php | 2 +- .../lib/Model/DeletedAtResponse.php | 2 +- .../lib/Model/DictionaryEntry.php | 2 +- .../lib/Model/DictionaryLanguage.php | 2 +- .../lib/Model/DictionarySettingsRequest.php | 2 +- .../lib/Model/ErrorBase.php | 2 +- .../Model/GetDictionarySettingsResponse.php | 2 +- .../lib/Model/GetLogsResponse.php | 2 +- .../lib/Model/GetLogsResponseInnerQueries.php | 2 +- .../lib/Model/GetLogsResponseLogs.php | 2 +- .../lib/Model/GetObjectsObject.php | 2 +- .../lib/Model/GetObjectsResponse.php | 2 +- .../lib/Model/GetTaskResponse.php | 2 +- .../lib/Model/GetTopUserIdsResponse.php | 2 +- .../lib/Model/HighlightResult.php | 2 +- .../lib/Model/Index.php | 2 +- .../lib/Model/IndexSettings.php | 5 +- .../lib/Model/IndexSettingsAsSearchParams.php | 5 +- .../lib/Model/KeyObject.php | 2 +- .../lib/Model/Languages.php | 2 +- .../lib/Model/ListApiKeysResponse.php | 2 +- .../lib/Model/ListClustersResponse.php | 2 +- .../lib/Model/ListIndicesResponse.php | 2 +- .../lib/Model/ListUserIdsResponse.php | 2 +- .../lib/Model/MultipleBatchResponse.php | 2 +- .../lib/Model/MultipleGetObjectsObject.php | 2 +- .../lib/Model/MultipleQueries.php | 2 +- .../lib/Model/MultipleQueriesObject.php | 2 +- .../lib/Model/MultipleQueriesResponse.php | 2 +- .../lib/Model/Operation.php | 2 +- .../lib/Model/OperationIndexObject.php | 2 +- .../lib/Model/Params.php | 2 +- .../lib/Model/Promote.php | 2 +- .../lib/Model/RankingInfo.php | 2 +- .../Model/RankingInfoMatchedGeoLocation.php | 2 +- .../lib/Model/Record.php | 2 +- .../lib/Model/RemoveUserIdResponse.php | 2 +- .../lib/Model/ReplaceSourceResponse.php | 2 +- .../lib/Model/RequiredSearchParams.php | 2 +- .../lib/Model/Rule.php | 2 +- .../lib/Model/SaveObjectResponse.php | 2 +- .../lib/Model/SaveSynonymResponse.php | 2 +- .../lib/Model/SearchDictionaryEntries.php | 2 +- .../lib/Model/SearchForFacetValuesRequest.php | 3 +- .../Model/SearchForFacetValuesResponse.php | 2 +- .../SearchForFacetValuesResponseFacetHits.php | 2 +- .../lib/Model/SearchHits.php | 2 +- .../lib/Model/SearchParams.php | 7 +- .../lib/Model/SearchParamsObject.php | 7 +- .../lib/Model/SearchParamsString.php | 2 +- .../lib/Model/SearchResponse.php | 3 +- .../lib/Model/SearchRulesParams.php | 2 +- .../lib/Model/SearchRulesResponse.php | 2 +- .../lib/Model/SearchSynonymsResponse.php | 2 +- .../lib/Model/SearchUserIdsObject.php | 2 +- .../lib/Model/SearchUserIdsResponse.php | 2 +- .../SearchUserIdsResponseHighlightResult.php | 2 +- .../lib/Model/SearchUserIdsResponseHits.php | 2 +- .../lib/Model/SnippetResult.php | 2 +- .../lib/Model/Source.php | 2 +- .../lib/Model/StandardEntries.php | 2 +- .../lib/Model/SynonymHit.php | 2 +- .../lib/Model/SynonymHitHighlightResult.php | 2 +- .../lib/Model/TimeRange.php | 2 +- .../lib/Model/UpdateApiKeyResponse.php | 2 +- .../lib/Model/UpdatedAtResponse.php | 2 +- .../Model/UpdatedAtWithObjectIdResponse.php | 2 +- .../lib/Model/UpdatedRuleResponse.php | 2 +- .../lib/Model/UserId.php | 2 +- .../lib/ObjectSerializer.php | 62 ++++----- 101 files changed, 188 insertions(+), 255 deletions(-) delete mode 100644 clients/algoliasearch-client-php/.php_cs diff --git a/clients/algoliasearch-client-php/.openapi-generator-ignore b/clients/algoliasearch-client-php/.openapi-generator-ignore index d526d59ea0..e0b35c13b6 100644 --- a/clients/algoliasearch-client-php/.openapi-generator-ignore +++ b/clients/algoliasearch-client-php/.openapi-generator-ignore @@ -11,3 +11,4 @@ test/** phpunit.xml.dist README.md git_push.sh +.php_cs diff --git a/clients/algoliasearch-client-php/.php-cs-fixer.php b/clients/algoliasearch-client-php/.php-cs-fixer.php index e54be96e8c..96dde31c05 100644 --- a/clients/algoliasearch-client-php/.php-cs-fixer.php +++ b/clients/algoliasearch-client-php/.php-cs-fixer.php @@ -21,7 +21,7 @@ 'no_extra_blank_lines' => true, 'no_multiline_whitespace_around_double_arrow' => true, 'no_short_bool_cast' => true, - 'no_trailing_whitespace' => false, + 'no_trailing_whitespace' => true, 'no_trailing_whitespace_in_comment' => false, 'no_unneeded_control_parentheses' => true, 'no_unreachable_default_argument_value' => true, @@ -42,7 +42,7 @@ 'phpdoc_single_line_var_spacing' => true, 'phpdoc_tag_type' => true, 'protected_to_private' => true, - 'psr_autoloading' => true, + '@PSR2' => true, 'short_scalar_cast' => true, 'single_blank_line_at_eof' => false, 'single_blank_line_before_namespace' => true, diff --git a/clients/algoliasearch-client-php/.php_cs b/clients/algoliasearch-client-php/.php_cs deleted file mode 100644 index 4fbe53ec5f..0000000000 --- a/clients/algoliasearch-client-php/.php_cs +++ /dev/null @@ -1,23 +0,0 @@ -setUsingCache(true) - ->setRules([ - '@PSR2' => true, - 'ordered_imports' => true, - 'phpdoc_order' => true, - 'array_syntax' => [ 'syntax' => 'short' ], - 'strict_comparison' => true, - 'strict_param' => true, - 'no_trailing_whitespace' => false, - 'no_trailing_whitespace_in_comment' => false, - 'braces' => false, - 'single_blank_line_at_eof' => false, - 'blank_line_after_namespace' => false, - ]) - ->setFinder( - PhpCsFixer\Finder::create() - ->exclude('test') - ->exclude('tests') - ->in(__DIR__) - ); diff --git a/clients/algoliasearch-client-php/lib/Api/SearchApi.php b/clients/algoliasearch-client-php/lib/Api/SearchApi.php index 0af73c90fc..690b95da0a 100644 --- a/clients/algoliasearch-client-php/lib/Api/SearchApi.php +++ b/clients/algoliasearch-client-php/lib/Api/SearchApi.php @@ -44,7 +44,7 @@ class SearchApi /** * @param Configuration $config */ - public function __construct(Configuration $config = null) + public function __construct(Configuration $config = null) { $this->config = $config ?: new Configuration(); @@ -110,9 +110,9 @@ public function addApiKey($apiKey) ['application/json'], ['application/json'] ); - if (isset($apiKey)) { + if (isset($apiKey)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($apiKey)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -208,9 +208,9 @@ public function addOrUpdateObject($indexName, $objectID, $body) ['application/json'], ['application/json'] ); - if (isset($body)) { + if (isset($body)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($body)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -274,9 +274,9 @@ public function appendSource($source) ['application/json'], ['application/json'] ); - if (isset($source)) { + if (isset($source)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($source)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -360,9 +360,9 @@ public function assignUserId($xAlgoliaUserID, $assignUserIdObject) ['application/json'], ['application/json'] ); - if (isset($assignUserIdObject)) { + if (isset($assignUserIdObject)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($assignUserIdObject)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -441,9 +441,9 @@ public function batch($indexName, $batchWriteObject) ['application/json'], ['application/json'] ); - if (isset($batchWriteObject)) { + if (isset($batchWriteObject)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($batchWriteObject)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -527,9 +527,9 @@ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsObject) ['application/json'], ['application/json'] ); - if (isset($batchAssignUserIdsObject)) { + if (isset($batchAssignUserIdsObject)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($batchAssignUserIdsObject)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -610,9 +610,9 @@ public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) ['application/json'], ['application/json'] ); - if (isset($batchDictionaryEntries)) { + if (isset($batchDictionaryEntries)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($batchDictionaryEntries)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -709,9 +709,9 @@ public function batchRules($indexName, $rule, $forwardToReplicas = null, $clearE ['application/json'], ['application/json'] ); - if (isset($rule)) { + if (isset($rule)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($rule)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -786,9 +786,9 @@ public function browse($indexName, $browseRequest = null) ['application/json'], ['application/json'] ); - if (isset($browseRequest)) { + if (isset($browseRequest)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($browseRequest)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -1177,9 +1177,9 @@ public function deleteBy($indexName, $searchParams) ['application/json'], ['application/json'] ); - if (isset($searchParams)) { + if (isset($searchParams)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($searchParams)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -1726,7 +1726,6 @@ public function getApiKey($key) */ public function getDictionaryLanguages() { - $resourcePath = '/1/dictionaries/*/languages'; $queryParams = []; $headerParams = []; @@ -1784,7 +1783,6 @@ public function getDictionaryLanguages() */ public function getDictionarySettings() { - $resourcePath = '/1/dictionaries/*/settings'; $queryParams = []; $headerParams = []; @@ -2045,9 +2043,9 @@ public function getObjects($getObjectsObject) ['application/json'], ['application/json'] ); - if (isset($getObjectsObject)) { + if (isset($getObjectsObject)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($getObjectsObject)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -2254,7 +2252,6 @@ public function getSettings($indexName) */ public function getSources() { - $resourcePath = '/1/security/sources'; $queryParams = []; $headerParams = []; @@ -2486,7 +2483,6 @@ public function getTask($indexName, $taskID) */ public function getTopUserIds() { - $resourcePath = '/1/clusters/mapping/top'; $queryParams = []; $headerParams = []; @@ -2621,7 +2617,6 @@ public function getUserId($userID) */ public function hasPendingMappings($getClusters = null) { - $resourcePath = '/1/clusters/mapping/pending'; $queryParams = []; $headerParams = []; @@ -2686,7 +2681,6 @@ public function hasPendingMappings($getClusters = null) */ public function listApiKeys() { - $resourcePath = '/1/keys'; $queryParams = []; $headerParams = []; @@ -2744,7 +2738,6 @@ public function listApiKeys() */ public function listClusters() { - $resourcePath = '/1/clusters'; $queryParams = []; $headerParams = []; @@ -2803,7 +2796,6 @@ public function listClusters() */ public function listIndices($page = null) { - $resourcePath = '/1/indexes'; $queryParams = []; $headerParams = []; @@ -2870,7 +2862,6 @@ public function listIndices($page = null) */ public function listUserIds($page = null, $hitsPerPage = 100) { - $resourcePath = '/1/clusters/mapping'; $queryParams = []; $headerParams = []; @@ -2956,9 +2947,9 @@ public function multipleBatch($batchObject) ['application/json'], ['application/json'] ); - if (isset($batchObject)) { + if (isset($batchObject)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($batchObject)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -3022,9 +3013,9 @@ public function multipleQueries($multipleQueriesObject) ['application/json'], ['application/json'] ); - if (isset($multipleQueriesObject)) { + if (isset($multipleQueriesObject)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($multipleQueriesObject)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -3105,9 +3096,9 @@ public function operationIndex($indexName, $operationIndexObject) ['application/json'], ['application/json'] ); - if (isset($operationIndexObject)) { + if (isset($operationIndexObject)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($operationIndexObject)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -3211,9 +3202,9 @@ public function partialUpdateObject($indexName, $objectID, $oneOfStringBuildInOp ['application/json'], ['application/json'] ); - if (isset($oneOfStringBuildInOperation)) { + if (isset($oneOfStringBuildInOperation)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($oneOfStringBuildInOperation)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -3353,9 +3344,9 @@ public function replaceSources($source) ['application/json'], ['application/json'] ); - if (isset($source)) { + if (isset($source)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($source)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -3507,9 +3498,9 @@ public function saveObject($indexName, $body) ['application/json'], ['application/json'] ); - if (isset($body)) { + if (isset($body)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($body)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -3613,9 +3604,9 @@ public function saveRule($indexName, $objectID, $rule, $forwardToReplicas = null ['application/json'], ['application/json'] ); - if (isset($rule)) { + if (isset($rule)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($rule)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -3719,9 +3710,9 @@ public function saveSynonym($indexName, $objectID, $synonymHit, $forwardToReplic ['application/json'], ['application/json'] ); - if (isset($synonymHit)) { + if (isset($synonymHit)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($synonymHit)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -3818,9 +3809,9 @@ public function saveSynonyms($indexName, $synonymHit, $forwardToReplicas = null, ['application/json'], ['application/json'] ); - if (isset($synonymHit)) { + if (isset($synonymHit)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($synonymHit)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -3899,9 +3890,9 @@ public function search($indexName, $searchParams) ['application/json'], ['application/json'] ); - if (isset($searchParams)) { + if (isset($searchParams)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($searchParams)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -3982,9 +3973,9 @@ public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntrie ['application/json'], ['application/json'] ); - if (isset($searchDictionaryEntries)) { + if (isset($searchDictionaryEntries)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($searchDictionaryEntries)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -4074,9 +4065,9 @@ public function searchForFacetValues($indexName, $facetName, $searchForFacetValu ['application/json'], ['application/json'] ); - if (isset($searchForFacetValuesRequest)) { + if (isset($searchForFacetValuesRequest)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($searchForFacetValuesRequest)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -4157,9 +4148,9 @@ public function searchRules($indexName, $searchRulesParams) ['application/json'], ['application/json'] ); - if (isset($searchRulesParams)) { + if (isset($searchRulesParams)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($searchRulesParams)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -4330,9 +4321,9 @@ public function searchUserIds($searchUserIdsObject) ['application/json'], ['application/json'] ); - if (isset($searchUserIdsObject)) { + if (isset($searchUserIdsObject)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($searchUserIdsObject)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -4398,9 +4389,9 @@ public function setDictionarySettings($dictionarySettingsRequest) ['application/json'], ['application/json'] ); - if (isset($dictionarySettingsRequest)) { + if (isset($dictionarySettingsRequest)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($dictionarySettingsRequest)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -4487,9 +4478,9 @@ public function setSettings($indexName, $indexSettings, $forwardToReplicas = nul ['application/json'], ['application/json'] ); - if (isset($indexSettings)) { + if (isset($indexSettings)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($indexSettings)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -4570,9 +4561,9 @@ public function updateApiKey($key, $apiKey) ['application/json'], ['application/json'] ); - if (isset($apiKey)) { + if (isset($apiKey)) { $httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($apiKey)); - } + } // this endpoint requires API key authentication $apiKey = $this->config->getApiKeyWithPrefix('X-Algolia-API-Key'); if ($apiKey !== null) { @@ -4634,7 +4625,7 @@ protected function createHttpClientOption() * * @throws \RuntimeException on file opening failure * - * @return array + * @return array */ protected function sendRequest($request, $expectedResponse) { @@ -4674,7 +4665,7 @@ protected function sendRequest($request, $expectedResponse) ); } - switch($statusCode) { + switch ($statusCode) { case 200: if ($expectedResponse === '\SplFileObject') { $content = $response->getBody(); //stream goes to serializer @@ -4750,7 +4741,6 @@ protected function sendRequest($request, $expectedResponse) $response->getStatusCode(), $response->getHeaders(), ]; - } catch (ApiException $e) { switch ($e->getCode()) { case 200: diff --git a/clients/algoliasearch-client-php/lib/Configuration.php b/clients/algoliasearch-client-php/lib/Configuration.php index b7d8ebacb9..3027efaecd 100644 --- a/clients/algoliasearch-client-php/lib/Configuration.php +++ b/clients/algoliasearch-client-php/lib/Configuration.php @@ -195,7 +195,7 @@ public function setAppId($appId = '') /** * Gets the Algolia application ID * - * @return string + * @return string */ public function getAppId() { @@ -217,7 +217,7 @@ public function setAlgoliaApiKey($algoliaApiKey = '') /** * Gets the Algolia API Key * - * @return string + * @return string */ public function getAlgoliaApiKey() { diff --git a/clients/algoliasearch-client-php/lib/HeaderSelector.php b/clients/algoliasearch-client-php/lib/HeaderSelector.php index cdf8042d96..c8cdd57128 100644 --- a/clients/algoliasearch-client-php/lib/HeaderSelector.php +++ b/clients/algoliasearch-client-php/lib/HeaderSelector.php @@ -58,9 +58,8 @@ private function selectAcceptHeader($accept) } elseif ($jsonAccept = preg_grep('~(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$~', $accept)) { return implode(',', $jsonAccept); } - - return implode(',', $accept); + return implode(',', $accept); } /** @@ -77,8 +76,7 @@ private function selectContentTypeHeader($contentType) } elseif (preg_grep("/application\/json/i", $contentType)) { return 'application/json'; } - - return implode(',', $contentType); + return implode(',', $contentType); } } diff --git a/clients/algoliasearch-client-php/lib/Model/AddApiKeyResponse.php b/clients/algoliasearch-client-php/lib/Model/AddApiKeyResponse.php index 4ceb4fb731..b27451a5a0 100644 --- a/clients/algoliasearch-client-php/lib/Model/AddApiKeyResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/AddApiKeyResponse.php @@ -298,7 +298,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/ApiKey.php b/clients/algoliasearch-client-php/lib/Model/ApiKey.php index e3abb8ac3e..8f950b9393 100644 --- a/clients/algoliasearch-client-php/lib/Model/ApiKey.php +++ b/clients/algoliasearch-client-php/lib/Model/ApiKey.php @@ -526,7 +526,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php b/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php index 913125bbde..258696246c 100644 --- a/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php +++ b/clients/algoliasearch-client-php/lib/Model/AssignUserIdObject.php @@ -267,7 +267,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php b/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php index 0a63d8cdab..e95f3c1f58 100644 --- a/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php +++ b/clients/algoliasearch-client-php/lib/Model/AutomaticFacetFilter.php @@ -327,7 +327,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php b/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php index e9f60b9c9a..39283cf771 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseBrowseResponse.php @@ -265,7 +265,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php b/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php index dbbc448b75..4d67edd158 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseIndexSettings.php @@ -591,7 +591,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php b/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php index 6aafbea93e..93b1dd7be6 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseSearchParams.php @@ -704,7 +704,6 @@ public function getLength() */ public function setLength($length) { - if (!is_null($length) && ($length > 1000)) { throw new \InvalidArgumentException('invalid value for $length when calling BaseSearchParams., must be smaller than or equal to 1000.'); } @@ -832,7 +831,6 @@ public function getMinimumAroundRadius() */ public function setMinimumAroundRadius($minimumAroundRadius) { - if (!is_null($minimumAroundRadius) && ($minimumAroundRadius < 1)) { throw new \InvalidArgumentException('invalid value for $minimumAroundRadius when calling BaseSearchParams., must be bigger than or equal to 1.'); } @@ -1216,7 +1214,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php index 5d758f3f99..9c0e3eb811 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponse.php @@ -412,7 +412,6 @@ public function getAroundLatLng() */ public function setAroundLatLng($aroundLatLng) { - if (!is_null($aroundLatLng) && (!preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $aroundLatLng))) { throw new \InvalidArgumentException("invalid value for $aroundLatLng when calling BaseSearchResponse., must conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."); } @@ -988,7 +987,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php index f260c78f71..5af39f3245 100644 --- a/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php +++ b/clients/algoliasearch-client-php/lib/Model/BaseSearchResponseFacetsStats.php @@ -351,7 +351,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php b/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php index 60ad6bd7ef..d556abcaf8 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchAssignUserIdsObject.php @@ -300,7 +300,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php index d0ba7be83a..809dabd239 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntries.php @@ -297,7 +297,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php index e74c45c010..945c27dea7 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchDictionaryEntriesRequest.php @@ -333,7 +333,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BatchObject.php b/clients/algoliasearch-client-php/lib/Model/BatchObject.php index 11b433c681..69068c27fe 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchObject.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchObject.php @@ -263,7 +263,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BatchResponse.php b/clients/algoliasearch-client-php/lib/Model/BatchResponse.php index 149eae702c..13b488d920 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchResponse.php @@ -291,7 +291,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php b/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php index 9b61babd79..a0cbdc98fd 100644 --- a/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php +++ b/clients/algoliasearch-client-php/lib/Model/BatchWriteObject.php @@ -263,7 +263,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php b/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php index 1f2fe9ca43..5c53d672b9 100644 --- a/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/BrowseRequest.php @@ -291,7 +291,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php b/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php index a42ad93b22..fd2be587ff 100644 --- a/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/BrowseResponse.php @@ -430,7 +430,6 @@ public function getAroundLatLng() */ public function setAroundLatLng($aroundLatLng) { - if (!is_null($aroundLatLng) && (!preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $aroundLatLng))) { throw new \InvalidArgumentException("invalid value for $aroundLatLng when calling BrowseResponse., must conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."); } @@ -1054,7 +1053,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php b/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php index 0b47b91e5e..70680634bc 100644 --- a/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php +++ b/clients/algoliasearch-client-php/lib/Model/BuildInOperation.php @@ -345,7 +345,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/Condition.php b/clients/algoliasearch-client-php/lib/Model/Condition.php index df2723672e..21687ba4c1 100644 --- a/clients/algoliasearch-client-php/lib/Model/Condition.php +++ b/clients/algoliasearch-client-php/lib/Model/Condition.php @@ -351,7 +351,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/Consequence.php b/clients/algoliasearch-client-php/lib/Model/Consequence.php index d3d51ae219..36f7608c55 100644 --- a/clients/algoliasearch-client-php/lib/Model/Consequence.php +++ b/clients/algoliasearch-client-php/lib/Model/Consequence.php @@ -383,7 +383,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php b/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php index 8a5716ca77..439670db5c 100644 --- a/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php +++ b/clients/algoliasearch-client-php/lib/Model/ConsequenceHide.php @@ -267,7 +267,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php b/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php index 2851a1ea17..43312a1303 100644 --- a/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php +++ b/clients/algoliasearch-client-php/lib/Model/ConsequenceParams.php @@ -1219,7 +1219,6 @@ public function getLength() */ public function setLength($length) { - if (!is_null($length) && ($length > 1000)) { throw new \InvalidArgumentException('invalid value for $length when calling ConsequenceParams., must be smaller than or equal to 1000.'); } @@ -1347,7 +1346,6 @@ public function getMinimumAroundRadius() */ public function setMinimumAroundRadius($minimumAroundRadius) { - if (!is_null($minimumAroundRadius) && ($minimumAroundRadius < 1)) { throw new \InvalidArgumentException('invalid value for $minimumAroundRadius when calling ConsequenceParams., must be bigger than or equal to 1.'); } @@ -2610,7 +2608,6 @@ public function getDistinct() */ public function setDistinct($distinct) { - if (!is_null($distinct) && ($distinct > 4)) { throw new \InvalidArgumentException('invalid value for $distinct when calling ConsequenceParams., must be smaller than or equal to 4.'); } @@ -2690,7 +2687,6 @@ public function getMinProximity() */ public function setMinProximity($minProximity) { - if (!is_null($minProximity) && ($minProximity > 7)) { throw new \InvalidArgumentException('invalid value for $minProximity when calling ConsequenceParams., must be smaller than or equal to 7.'); } @@ -2746,7 +2742,6 @@ public function getMaxFacetHits() */ public function setMaxFacetHits($maxFacetHits) { - if (!is_null($maxFacetHits) && ($maxFacetHits > 100)) { throw new \InvalidArgumentException('invalid value for $maxFacetHits when calling ConsequenceParams., must be smaller than or equal to 100.'); } @@ -2866,7 +2861,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php b/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php index 05b718c055..25a3783669 100644 --- a/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php +++ b/clients/algoliasearch-client-php/lib/Model/CreatedAtObject.php @@ -265,7 +265,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php b/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php index 0161cef372..518f5e1dd9 100644 --- a/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/CreatedAtResponse.php @@ -267,7 +267,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php b/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php index 46eeb200e3..49799d84d4 100644 --- a/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/DeleteApiKeyResponse.php @@ -265,7 +265,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php b/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php index 32b42cf4da..ad6f17652f 100644 --- a/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/DeleteSourceResponse.php @@ -265,7 +265,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php b/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php index 6890a73dec..1101441536 100644 --- a/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/DeletedAtResponse.php @@ -300,7 +300,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php b/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php index f889b32a35..bd1d2403d8 100644 --- a/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php +++ b/clients/algoliasearch-client-php/lib/Model/DictionaryEntry.php @@ -454,7 +454,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php b/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php index 7f857ed561..48dc0a82eb 100644 --- a/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php +++ b/clients/algoliasearch-client-php/lib/Model/DictionaryLanguage.php @@ -263,7 +263,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php b/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php index 3d42992725..3a1a076d6e 100644 --- a/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/DictionarySettingsRequest.php @@ -267,7 +267,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/ErrorBase.php b/clients/algoliasearch-client-php/lib/Model/ErrorBase.php index 48b357631f..1bbea7821b 100644 --- a/clients/algoliasearch-client-php/lib/Model/ErrorBase.php +++ b/clients/algoliasearch-client-php/lib/Model/ErrorBase.php @@ -263,7 +263,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php index e76e778e39..3a5bdc91d9 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetDictionarySettingsResponse.php @@ -265,7 +265,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php index 4f45944265..ce4a52628a 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetLogsResponse.php @@ -265,7 +265,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php index 8ae96c2c9f..8fef10989e 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php +++ b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseInnerQueries.php @@ -321,7 +321,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php index 20a071dbf4..a8ff63bf14 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php +++ b/clients/algoliasearch-client-php/lib/Model/GetLogsResponseLogs.php @@ -715,7 +715,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php b/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php index 7d36088284..4db95782ef 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/GetObjectsObject.php @@ -263,7 +263,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php index fb8d8fcba6..27c7531669 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetObjectsResponse.php @@ -261,7 +261,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php b/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php index ae9e7c2f3c..b46ddac49f 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetTaskResponse.php @@ -299,7 +299,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php index 0c381becc3..fd18eb3cea 100644 --- a/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/GetTopUserIdsResponse.php @@ -267,7 +267,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/HighlightResult.php b/clients/algoliasearch-client-php/lib/Model/HighlightResult.php index 5fc77c2e70..2fb9d53ddb 100644 --- a/clients/algoliasearch-client-php/lib/Model/HighlightResult.php +++ b/clients/algoliasearch-client-php/lib/Model/HighlightResult.php @@ -390,7 +390,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/Index.php b/clients/algoliasearch-client-php/lib/Model/Index.php index aa437874bf..94651a0e9b 100644 --- a/clients/algoliasearch-client-php/lib/Model/Index.php +++ b/clients/algoliasearch-client-php/lib/Model/Index.php @@ -586,7 +586,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/IndexSettings.php b/clients/algoliasearch-client-php/lib/Model/IndexSettings.php index c409228d27..66c7494b07 100644 --- a/clients/algoliasearch-client-php/lib/Model/IndexSettings.php +++ b/clients/algoliasearch-client-php/lib/Model/IndexSettings.php @@ -1897,7 +1897,6 @@ public function getDistinct() */ public function setDistinct($distinct) { - if (!is_null($distinct) && ($distinct > 4)) { throw new \InvalidArgumentException('invalid value for $distinct when calling IndexSettings., must be smaller than or equal to 4.'); } @@ -1977,7 +1976,6 @@ public function getMinProximity() */ public function setMinProximity($minProximity) { - if (!is_null($minProximity) && ($minProximity > 7)) { throw new \InvalidArgumentException('invalid value for $minProximity when calling IndexSettings., must be smaller than or equal to 7.'); } @@ -2033,7 +2031,6 @@ public function getMaxFacetHits() */ public function setMaxFacetHits($maxFacetHits) { - if (!is_null($maxFacetHits) && ($maxFacetHits > 100)) { throw new \InvalidArgumentException('invalid value for $maxFacetHits when calling IndexSettings., must be smaller than or equal to 100.'); } @@ -2153,7 +2150,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php b/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php index 7b3c52043e..a8431235b8 100644 --- a/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/IndexSettingsAsSearchParams.php @@ -1535,7 +1535,6 @@ public function getDistinct() */ public function setDistinct($distinct) { - if (!is_null($distinct) && ($distinct > 4)) { throw new \InvalidArgumentException('invalid value for $distinct when calling IndexSettingsAsSearchParams., must be smaller than or equal to 4.'); } @@ -1615,7 +1614,6 @@ public function getMinProximity() */ public function setMinProximity($minProximity) { - if (!is_null($minProximity) && ($minProximity > 7)) { throw new \InvalidArgumentException('invalid value for $minProximity when calling IndexSettingsAsSearchParams., must be smaller than or equal to 7.'); } @@ -1671,7 +1669,6 @@ public function getMaxFacetHits() */ public function setMaxFacetHits($maxFacetHits) { - if (!is_null($maxFacetHits) && ($maxFacetHits > 100)) { throw new \InvalidArgumentException('invalid value for $maxFacetHits when calling IndexSettingsAsSearchParams., must be smaller than or equal to 100.'); } @@ -1791,7 +1788,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/KeyObject.php b/clients/algoliasearch-client-php/lib/Model/KeyObject.php index 1cbaf863a3..14b8aa70a7 100644 --- a/clients/algoliasearch-client-php/lib/Model/KeyObject.php +++ b/clients/algoliasearch-client-php/lib/Model/KeyObject.php @@ -557,7 +557,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/Languages.php b/clients/algoliasearch-client-php/lib/Model/Languages.php index da2866454c..22624b2f6f 100644 --- a/clients/algoliasearch-client-php/lib/Model/Languages.php +++ b/clients/algoliasearch-client-php/lib/Model/Languages.php @@ -333,7 +333,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php b/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php index 217841d9e2..3bc9ce390c 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListApiKeysResponse.php @@ -265,7 +265,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php b/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php index 32e7515265..9f47847915 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListClustersResponse.php @@ -267,7 +267,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php b/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php index 984b0f060d..b6cc55b479 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListIndicesResponse.php @@ -291,7 +291,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php index 0030ae0d27..d26bb071df 100644 --- a/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ListUserIdsResponse.php @@ -267,7 +267,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php b/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php index 338e9fcd9f..9ae0fcc264 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleBatchResponse.php @@ -291,7 +291,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php b/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php index d96e1b9763..c7aa0dff1b 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleGetObjectsObject.php @@ -330,7 +330,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php b/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php index 95669603ef..65afdbdc7c 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleQueries.php @@ -419,7 +419,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php index 5c1571c58f..221f62ee03 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesObject.php @@ -329,7 +329,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php index d441ad8268..8e9892d174 100644 --- a/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/MultipleQueriesResponse.php @@ -261,7 +261,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/Operation.php b/clients/algoliasearch-client-php/lib/Model/Operation.php index 49f65a5711..93b42c78d4 100644 --- a/clients/algoliasearch-client-php/lib/Model/Operation.php +++ b/clients/algoliasearch-client-php/lib/Model/Operation.php @@ -321,7 +321,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php b/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php index c6122908e0..4b9696fb5e 100644 --- a/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php +++ b/clients/algoliasearch-client-php/lib/Model/OperationIndexObject.php @@ -389,7 +389,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/Params.php b/clients/algoliasearch-client-php/lib/Model/Params.php index 7dc71a62fd..f177d67d17 100644 --- a/clients/algoliasearch-client-php/lib/Model/Params.php +++ b/clients/algoliasearch-client-php/lib/Model/Params.php @@ -323,7 +323,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/Promote.php b/clients/algoliasearch-client-php/lib/Model/Promote.php index 25d29916ee..27b86fae58 100644 --- a/clients/algoliasearch-client-php/lib/Model/Promote.php +++ b/clients/algoliasearch-client-php/lib/Model/Promote.php @@ -327,7 +327,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/RankingInfo.php b/clients/algoliasearch-client-php/lib/Model/RankingInfo.php index ecdde9adf6..0818d4c0a0 100644 --- a/clients/algoliasearch-client-php/lib/Model/RankingInfo.php +++ b/clients/algoliasearch-client-php/lib/Model/RankingInfo.php @@ -561,7 +561,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php b/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php index 089130d225..cc946d6772 100644 --- a/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php +++ b/clients/algoliasearch-client-php/lib/Model/RankingInfoMatchedGeoLocation.php @@ -321,7 +321,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/Record.php b/clients/algoliasearch-client-php/lib/Model/Record.php index 345113fad0..8865c7c54c 100644 --- a/clients/algoliasearch-client-php/lib/Model/Record.php +++ b/clients/algoliasearch-client-php/lib/Model/Record.php @@ -387,7 +387,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php b/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php index 74761cee9e..613ea7b881 100644 --- a/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/RemoveUserIdResponse.php @@ -265,7 +265,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php b/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php index b8c981e0f0..76fdb9b512 100644 --- a/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/ReplaceSourceResponse.php @@ -265,7 +265,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php b/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php index fea07393c7..9ad354fa1a 100644 --- a/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/RequiredSearchParams.php @@ -265,7 +265,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/Rule.php b/clients/algoliasearch-client-php/lib/Model/Rule.php index 646596e102..348f078ebe 100644 --- a/clients/algoliasearch-client-php/lib/Model/Rule.php +++ b/clients/algoliasearch-client-php/lib/Model/Rule.php @@ -420,7 +420,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php b/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php index 1512d4260c..f941a44abc 100644 --- a/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SaveObjectResponse.php @@ -321,7 +321,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php b/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php index 56a5f1ab5a..2cc8ccc681 100644 --- a/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SaveSynonymResponse.php @@ -331,7 +331,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php b/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php index 9ec71bf9f3..f43a843699 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchDictionaryEntries.php @@ -357,7 +357,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php index 29d33c4a97..941510a8ee 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesRequest.php @@ -258,7 +258,6 @@ public function getMaxFacetHits() */ public function setMaxFacetHits($maxFacetHits) { - if (!is_null($maxFacetHits) && ($maxFacetHits > 100)) { throw new \InvalidArgumentException('invalid value for $maxFacetHits when calling SearchForFacetValuesRequest., must be smaller than or equal to 100.'); } @@ -330,7 +329,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php index 3e5bdb2eeb..c69a1144ef 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponse.php @@ -265,7 +265,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php index 071e8412fc..f5c7b8bba5 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchForFacetValuesResponseFacetHits.php @@ -331,7 +331,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchHits.php b/clients/algoliasearch-client-php/lib/Model/SearchHits.php index dcce6cb2d2..9eea6d0bd9 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchHits.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchHits.php @@ -261,7 +261,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchParams.php b/clients/algoliasearch-client-php/lib/Model/SearchParams.php index bdde27f975..ec002c5001 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchParams.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchParams.php @@ -1168,7 +1168,6 @@ public function getLength() */ public function setLength($length) { - if (!is_null($length) && ($length > 1000)) { throw new \InvalidArgumentException('invalid value for $length when calling SearchParams., must be smaller than or equal to 1000.'); } @@ -1296,7 +1295,6 @@ public function getMinimumAroundRadius() */ public function setMinimumAroundRadius($minimumAroundRadius) { - if (!is_null($minimumAroundRadius) && ($minimumAroundRadius < 1)) { throw new \InvalidArgumentException('invalid value for $minimumAroundRadius when calling SearchParams., must be bigger than or equal to 1.'); } @@ -2583,7 +2581,6 @@ public function getDistinct() */ public function setDistinct($distinct) { - if (!is_null($distinct) && ($distinct > 4)) { throw new \InvalidArgumentException('invalid value for $distinct when calling SearchParams., must be smaller than or equal to 4.'); } @@ -2663,7 +2660,6 @@ public function getMinProximity() */ public function setMinProximity($minProximity) { - if (!is_null($minProximity) && ($minProximity > 7)) { throw new \InvalidArgumentException('invalid value for $minProximity when calling SearchParams., must be smaller than or equal to 7.'); } @@ -2719,7 +2715,6 @@ public function getMaxFacetHits() */ public function setMaxFacetHits($maxFacetHits) { - if (!is_null($maxFacetHits) && ($maxFacetHits > 100)) { throw new \InvalidArgumentException('invalid value for $maxFacetHits when calling SearchParams., must be smaller than or equal to 100.'); } @@ -2839,7 +2834,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php b/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php index e8ff8684b7..5fcfff23f1 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchParamsObject.php @@ -1138,7 +1138,6 @@ public function getLength() */ public function setLength($length) { - if (!is_null($length) && ($length > 1000)) { throw new \InvalidArgumentException('invalid value for $length when calling SearchParamsObject., must be smaller than or equal to 1000.'); } @@ -1266,7 +1265,6 @@ public function getMinimumAroundRadius() */ public function setMinimumAroundRadius($minimumAroundRadius) { - if (!is_null($minimumAroundRadius) && ($minimumAroundRadius < 1)) { throw new \InvalidArgumentException('invalid value for $minimumAroundRadius when calling SearchParamsObject., must be bigger than or equal to 1.'); } @@ -2553,7 +2551,6 @@ public function getDistinct() */ public function setDistinct($distinct) { - if (!is_null($distinct) && ($distinct > 4)) { throw new \InvalidArgumentException('invalid value for $distinct when calling SearchParamsObject., must be smaller than or equal to 4.'); } @@ -2633,7 +2630,6 @@ public function getMinProximity() */ public function setMinProximity($minProximity) { - if (!is_null($minProximity) && ($minProximity > 7)) { throw new \InvalidArgumentException('invalid value for $minProximity when calling SearchParamsObject., must be smaller than or equal to 7.'); } @@ -2689,7 +2685,6 @@ public function getMaxFacetHits() */ public function setMaxFacetHits($maxFacetHits) { - if (!is_null($maxFacetHits) && ($maxFacetHits > 100)) { throw new \InvalidArgumentException('invalid value for $maxFacetHits when calling SearchParamsObject., must be smaller than or equal to 100.'); } @@ -2809,7 +2804,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php b/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php index c8668a3daa..67a696312f 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchParamsString.php @@ -261,7 +261,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchResponse.php index e333813ee1..cc9398e50d 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchResponse.php @@ -421,7 +421,6 @@ public function getAroundLatLng() */ public function setAroundLatLng($aroundLatLng) { - if (!is_null($aroundLatLng) && (!preg_match('/^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/', $aroundLatLng))) { throw new \InvalidArgumentException("invalid value for $aroundLatLng when calling SearchResponse., must conform to the pattern /^(-?\\d+(\\.\\d+)?),\\s*(-?\\d+(\\.\\d+)?)$/."); } @@ -1021,7 +1020,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php b/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php index e5e167f954..b679355452 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchRulesParams.php @@ -443,7 +443,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php index a77a76adcc..7beafbe40c 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchRulesResponse.php @@ -364,7 +364,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php index 96ecbda0cc..d4c5c7b785 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchSynonymsResponse.php @@ -298,7 +298,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php index e0d149cc8e..b7e8b73076 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsObject.php @@ -357,7 +357,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php index f70343d00e..9e3f78f382 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponse.php @@ -399,7 +399,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php index 60367a5e5e..70e0bf88c0 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHighlightResult.php @@ -298,7 +298,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php index c95fc5ba92..a0c622479c 100644 --- a/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php +++ b/clients/algoliasearch-client-php/lib/Model/SearchUserIdsResponseHits.php @@ -430,7 +430,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SnippetResult.php b/clients/algoliasearch-client-php/lib/Model/SnippetResult.php index a53c369440..7a700a298d 100644 --- a/clients/algoliasearch-client-php/lib/Model/SnippetResult.php +++ b/clients/algoliasearch-client-php/lib/Model/SnippetResult.php @@ -328,7 +328,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/Source.php b/clients/algoliasearch-client-php/lib/Model/Source.php index a366214e5c..7aeceabdb5 100644 --- a/clients/algoliasearch-client-php/lib/Model/Source.php +++ b/clients/algoliasearch-client-php/lib/Model/Source.php @@ -297,7 +297,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/StandardEntries.php b/clients/algoliasearch-client-php/lib/Model/StandardEntries.php index a4725918f6..6f5806400e 100644 --- a/clients/algoliasearch-client-php/lib/Model/StandardEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/StandardEntries.php @@ -323,7 +323,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SynonymHit.php b/clients/algoliasearch-client-php/lib/Model/SynonymHit.php index dddf6bc20c..1b049ea917 100644 --- a/clients/algoliasearch-client-php/lib/Model/SynonymHit.php +++ b/clients/algoliasearch-client-php/lib/Model/SynonymHit.php @@ -550,7 +550,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php b/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php index a87187c8ed..fa78b4ce36 100644 --- a/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php +++ b/clients/algoliasearch-client-php/lib/Model/SynonymHitHighlightResult.php @@ -293,7 +293,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/TimeRange.php b/clients/algoliasearch-client-php/lib/Model/TimeRange.php index ed041ae6c9..477e431dee 100644 --- a/clients/algoliasearch-client-php/lib/Model/TimeRange.php +++ b/clients/algoliasearch-client-php/lib/Model/TimeRange.php @@ -298,7 +298,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php index e5cf8339e9..6e20bb2dd1 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdateApiKeyResponse.php @@ -298,7 +298,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php index 00ac404481..506732b308 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdatedAtResponse.php @@ -300,7 +300,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php index c5c6a6920d..99ecebb94b 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdatedAtWithObjectIdResponse.php @@ -323,7 +323,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php b/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php index 176d87e459..9c649c82d5 100644 --- a/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php +++ b/clients/algoliasearch-client-php/lib/Model/UpdatedRuleResponse.php @@ -331,7 +331,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/Model/UserId.php b/clients/algoliasearch-client-php/lib/Model/UserId.php index 575f4b4548..a38f50c958 100644 --- a/clients/algoliasearch-client-php/lib/Model/UserId.php +++ b/clients/algoliasearch-client-php/lib/Model/UserId.php @@ -366,7 +366,7 @@ public function offsetUnset($offset) */ public function jsonSerialize() { - return ObjectSerializer::sanitizeForSerialization($this); + return ObjectSerializer::sanitizeForSerialization($this); } /** diff --git a/clients/algoliasearch-client-php/lib/ObjectSerializer.php b/clients/algoliasearch-client-php/lib/ObjectSerializer.php index 9d7a5c6936..b390c5fad0 100644 --- a/clients/algoliasearch-client-php/lib/ObjectSerializer.php +++ b/clients/algoliasearch-client-php/lib/ObjectSerializer.php @@ -76,16 +76,15 @@ public static function sanitizeForSerialization($data, $type = null, $format = n } } } else { - foreach($data as $property => $value) { + foreach ($data as $property => $value) { $values[$property] = self::sanitizeForSerialization($value); } } return (object) $values; } - - return (string) $data; + return (string) $data; } /** @@ -101,9 +100,8 @@ public static function sanitizeFilename($filename) if (preg_match("/.*[\/\\\\](.*)$/", $filename, $match)) { return $match[1]; } - - return $filename; + return $filename; } /** @@ -134,9 +132,8 @@ public static function toQueryValue($object) if (is_array($object)) { return implode(',', $object); } - - return self::toString($object); + return self::toString($object); } /** @@ -172,9 +169,8 @@ public static function toFormValue($value) if ($value instanceof \SplFileObject) { return $value->getRealPath(); } - - return self::toString($value); + return self::toString($value); } /** @@ -194,9 +190,8 @@ public static function toString($value) } elseif (is_bool($value)) { return $value ? 'true' : 'false'; } - - return $value; + return $value; } /** @@ -288,7 +283,7 @@ public static function deserialize($data, $class, $httpHeaders = null) settype($data, 'array'); return $data; - } else if ($class === 'mixed') { + } elseif ($class === 'mixed') { settype($data, gettype($data)); return $data; @@ -349,33 +344,32 @@ public static function deserialize($data, $class, $httpHeaders = null) } return $data; - } - $data = is_string($data) ? json_decode($data) : $data; - // If a discriminator is defined and points to a valid subclass, use it. - $discriminator = $class::DISCRIMINATOR; - if (!empty($discriminator) && isset($data->{$discriminator}) && is_string($data->{$discriminator})) { - $subclass = '\Algolia\AlgoliaSearch\Model\\' . $data->{$discriminator}; - if (is_subclass_of($subclass, $class)) { - $class = $subclass; - } + } + $data = is_string($data) ? json_decode($data) : $data; + // If a discriminator is defined and points to a valid subclass, use it. + $discriminator = $class::DISCRIMINATOR; + if (!empty($discriminator) && isset($data->{$discriminator}) && is_string($data->{$discriminator})) { + $subclass = '\Algolia\AlgoliaSearch\Model\\' . $data->{$discriminator}; + if (is_subclass_of($subclass, $class)) { + $class = $subclass; } + } - /** @var ModelInterface $instance */ - $instance = new $class(); - foreach ($instance::openAPITypes() as $property => $type) { - $propertySetter = $instance::setters()[$property]; - - if (!isset($propertySetter) || !isset($data->{$instance::attributeMap()[$property]})) { - continue; - } + /** @var ModelInterface $instance */ + $instance = new $class(); + foreach ($instance::openAPITypes() as $property => $type) { + $propertySetter = $instance::setters()[$property]; - if (isset($data->{$instance::attributeMap()[$property]})) { - $propertyValue = $data->{$instance::attributeMap()[$property]}; - $instance->$propertySetter(self::deserialize($propertyValue, $type, null)); - } + if (!isset($propertySetter) || !isset($data->{$instance::attributeMap()[$property]})) { + continue; } - return $instance; + if (isset($data->{$instance::attributeMap()[$property]})) { + $propertyValue = $data->{$instance::attributeMap()[$property]}; + $instance->$propertySetter(self::deserialize($propertyValue, $type, null)); + } + } + return $instance; } } From 622a79843c6030946cef56b929a6c3f0f469d9fa Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Fri, 14 Jan 2022 15:38:44 +0100 Subject: [PATCH 09/13] fix: update linter --- templates/php/.php-cs-fixer.php | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/templates/php/.php-cs-fixer.php b/templates/php/.php-cs-fixer.php index 92c5739215..96dde31c05 100644 --- a/templates/php/.php-cs-fixer.php +++ b/templates/php/.php-cs-fixer.php @@ -1,24 +1,27 @@ setUsingCache(true) ->setRules([ 'array_syntax' => [ 'syntax' => 'short' ], 'blank_line_after_namespace' => false, 'blank_line_after_opening_tag' => true, - 'blank_line_before_return' => true, + 'blank_line_before_statement' => true, 'braces' => false, 'cast_spaces' => true, 'combine_consecutive_unsets' => true, + 'echo_tag_syntax' => true, + 'general_phpdoc_tag_rename' => true, 'mb_str_functions' => true, 'no_blank_lines_after_class_opening' => true, 'no_empty_phpdoc' => true, 'no_empty_statement' => true, - 'no_extra_consecutive_blank_lines' => true, + 'no_extra_blank_lines' => true, 'no_multiline_whitespace_around_double_arrow' => true, 'no_short_bool_cast' => true, - 'no_short_echo_tag' => true, - 'no_trailing_whitespace' => false, + 'no_trailing_whitespace' => true, 'no_trailing_whitespace_in_comment' => false, 'no_unneeded_control_parentheses' => true, 'no_unreachable_default_argument_value' => true, @@ -32,13 +35,14 @@ 'object_operator_without_whitespace' => true, 'ordered_imports' => true, 'phpdoc_annotation_without_dot' => true, - 'phpdoc_inline_tag' => true, + 'phpdoc_inline_tag_normalizer' => true, 'phpdoc_order' => true, 'phpdoc_scalar' => true, 'phpdoc_separation' => true, 'phpdoc_single_line_var_spacing' => true, + 'phpdoc_tag_type' => true, 'protected_to_private' => true, - 'psr4' => true, + '@PSR2' => true, 'short_scalar_cast' => true, 'single_blank_line_at_eof' => false, 'single_blank_line_before_namespace' => true, @@ -48,7 +52,7 @@ 'strict_comparison' => true, 'strict_param' => true, 'ternary_operator_spaces' => true, - 'trailing_comma_in_multiline_array' => true, + 'trailing_comma_in_multiline' => true, 'trim_array_spaces' => true, ]) ->setFinder( From e8ed041f3fbfe20ed9568cb4c6612000a8aab68c Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Fri, 14 Jan 2022 15:42:05 +0100 Subject: [PATCH 10/13] fix: php ci --- .github/workflows/check.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 1b8abe5f1b..9b0d1b2e80 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -36,7 +36,7 @@ jobs: RUN_JAVA: ${{ steps.setup.outputs.RUN_JAVA }} JAVA_MATRIX: ${{ steps.setup.outputs.JAVA_MATRIX }} - RUN_PHP: ${{ steps.setup.outputs.RUN_PHP_CLIENT }} + RUN_PHP: ${{ steps.setup.outputs.RUN_PHP }} PHP_MATRIX: ${{ steps.setup.outputs.PHP_MATRIX }} RUN_CTS: ${{ steps.setup.outputs.RUN_CTS }} @@ -124,7 +124,7 @@ jobs: needs: - setup - specs - if: ${{ always() && needs.setup.outputs.RUN_PHP_CLIENT == 'true' }} + if: ${{ always() && needs.setup.outputs.RUN_PHP == 'true' }} strategy: matrix: ${{ fromJSON(needs.setup.outputs.PHP_MATRIX) }} steps: From 1b9cdcc915308bd86da14716623d1d06ca0e0e1b Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Fri, 14 Jan 2022 16:03:46 +0100 Subject: [PATCH 11/13] fix: post generation script for php --- scripts/post-gen/php.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/post-gen/php.sh b/scripts/post-gen/php.sh index ff8091be79..85d5419507 100755 --- a/scripts/post-gen/php.sh +++ b/scripts/post-gen/php.sh @@ -9,7 +9,7 @@ lint_client() { echo "> Linting ${GENERATOR}..." cd $CLIENT composer install - php vendor/bin/php-cs-fixer fix lib/ -v --using-cache=no --allow-risky=yes + PHP_CS_FIXER_IGNORE_ENV=1 php vendor/bin/php-cs-fixer fix lib/ -v --using-cache=no --allow-risky=yes set -e } From 6b65f1f8e6289008fbdd603a8021857e4f5aca2d Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Fri, 14 Jan 2022 16:25:36 +0100 Subject: [PATCH 12/13] fix: removing unwanted files --- .../.openapi-generator/FILES | 105 ------------------ .../.openapi-generator/VERSION | 1 - 2 files changed, 106 deletions(-) delete mode 100644 clients/algoliasearch-client-php/.openapi-generator/FILES delete mode 100644 clients/algoliasearch-client-php/.openapi-generator/VERSION diff --git a/clients/algoliasearch-client-php/.openapi-generator/FILES b/clients/algoliasearch-client-php/.openapi-generator/FILES deleted file mode 100644 index 2fd6346ca8..0000000000 --- a/clients/algoliasearch-client-php/.openapi-generator/FILES +++ /dev/null @@ -1,105 +0,0 @@ -.gitignore -.php_cs -composer.json -lib/Api/SearchApi.php -lib/ApiException.php -lib/Configuration.php -lib/HeaderSelector.php -lib/Model/Action.php -lib/Model/AddApiKeyResponse.php -lib/Model/Anchoring.php -lib/Model/ApiKey.php -lib/Model/AssignUserIdObject.php -lib/Model/AutomaticFacetFilter.php -lib/Model/BaseBrowseResponse.php -lib/Model/BaseIndexSettings.php -lib/Model/BaseSearchParams.php -lib/Model/BaseSearchResponse.php -lib/Model/BaseSearchResponseFacetsStats.php -lib/Model/BatchAssignUserIdsObject.php -lib/Model/BatchDictionaryEntries.php -lib/Model/BatchDictionaryEntriesRequest.php -lib/Model/BatchObject.php -lib/Model/BatchResponse.php -lib/Model/BatchWriteObject.php -lib/Model/BrowseRequest.php -lib/Model/BrowseResponse.php -lib/Model/BuildInOperation.php -lib/Model/Condition.php -lib/Model/Consequence.php -lib/Model/ConsequenceHide.php -lib/Model/ConsequenceParams.php -lib/Model/CreatedAtObject.php -lib/Model/CreatedAtResponse.php -lib/Model/DeleteApiKeyResponse.php -lib/Model/DeleteSourceResponse.php -lib/Model/DeletedAtResponse.php -lib/Model/DictionaryEntry.php -lib/Model/DictionaryLanguage.php -lib/Model/DictionarySettingsRequest.php -lib/Model/ErrorBase.php -lib/Model/GetDictionarySettingsResponse.php -lib/Model/GetLogsResponse.php -lib/Model/GetLogsResponseInnerQueries.php -lib/Model/GetLogsResponseLogs.php -lib/Model/GetObjectsObject.php -lib/Model/GetObjectsResponse.php -lib/Model/GetTaskResponse.php -lib/Model/GetTopUserIdsResponse.php -lib/Model/HighlightResult.php -lib/Model/Index.php -lib/Model/IndexSettings.php -lib/Model/IndexSettingsAsSearchParams.php -lib/Model/KeyObject.php -lib/Model/Languages.php -lib/Model/ListApiKeysResponse.php -lib/Model/ListClustersResponse.php -lib/Model/ListIndicesResponse.php -lib/Model/ListUserIdsResponse.php -lib/Model/ModelInterface.php -lib/Model/MultipleBatchResponse.php -lib/Model/MultipleGetObjectsObject.php -lib/Model/MultipleQueries.php -lib/Model/MultipleQueriesObject.php -lib/Model/MultipleQueriesResponse.php -lib/Model/Operation.php -lib/Model/OperationIndexObject.php -lib/Model/Params.php -lib/Model/Promote.php -lib/Model/RankingInfo.php -lib/Model/RankingInfoMatchedGeoLocation.php -lib/Model/Record.php -lib/Model/RemoveUserIdResponse.php -lib/Model/ReplaceSourceResponse.php -lib/Model/RequiredSearchParams.php -lib/Model/Rule.php -lib/Model/SaveObjectResponse.php -lib/Model/SaveSynonymResponse.php -lib/Model/SearchDictionaryEntries.php -lib/Model/SearchForFacetValuesRequest.php -lib/Model/SearchForFacetValuesResponse.php -lib/Model/SearchForFacetValuesResponseFacetHits.php -lib/Model/SearchHits.php -lib/Model/SearchParams.php -lib/Model/SearchParamsObject.php -lib/Model/SearchParamsString.php -lib/Model/SearchResponse.php -lib/Model/SearchRulesParams.php -lib/Model/SearchRulesResponse.php -lib/Model/SearchSynonymsResponse.php -lib/Model/SearchUserIdsObject.php -lib/Model/SearchUserIdsResponse.php -lib/Model/SearchUserIdsResponseHighlightResult.php -lib/Model/SearchUserIdsResponseHits.php -lib/Model/SnippetResult.php -lib/Model/Source.php -lib/Model/StandardEntries.php -lib/Model/SynonymHit.php -lib/Model/SynonymHitHighlightResult.php -lib/Model/TimeRange.php -lib/Model/UpdateApiKeyResponse.php -lib/Model/UpdatedAtResponse.php -lib/Model/UpdatedAtWithObjectIdResponse.php -lib/Model/UpdatedRuleResponse.php -lib/Model/UserId.php -lib/ObjectSerializer.php diff --git a/clients/algoliasearch-client-php/.openapi-generator/VERSION b/clients/algoliasearch-client-php/.openapi-generator/VERSION deleted file mode 100644 index e230c8396d..0000000000 --- a/clients/algoliasearch-client-php/.openapi-generator/VERSION +++ /dev/null @@ -1 +0,0 @@ -5.3.0 \ No newline at end of file From 931e750d4e8deab82ac4af7d74f76b4a5c5a2561 Mon Sep 17 00:00:00 2001 From: Damien Couchez Date: Fri, 14 Jan 2022 16:31:35 +0100 Subject: [PATCH 13/13] fix: update post generation script --- scripts/post-gen/php.sh | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/scripts/post-gen/php.sh b/scripts/post-gen/php.sh index 85d5419507..ced475c742 100755 --- a/scripts/post-gen/php.sh +++ b/scripts/post-gen/php.sh @@ -1,17 +1,15 @@ #!/bin/bash - +set -e export GENERATOR=$1 export CLIENT=$(cat openapitools.json | jq -r --arg generator "$GENERATOR" '."generator-cli".generators[$generator].output' | sed 's/#{cwd}\///g') lint_client() { - set +e echo "> Linting ${GENERATOR}..." cd $CLIENT composer install PHP_CS_FIXER_IGNORE_ENV=1 php vendor/bin/php-cs-fixer fix lib/ -v --using-cache=no --allow-risky=yes - set -e } lint_client