feat(php): Generate remaining PHP clients with PHP docs APIC-327

.github/actions/cache/action.yml

@@ -367,12 +367,15 @@ runs:
       if: ${{ inputs.job == 'cts' || inputs.job == 'codegen' }}
       uses: actions/cache@v2
       with:
-        path: clients/algoliasearch-client-php/lib/Api/SearchApi.php
+        path: |
+          clients/algoliasearch-client-php/lib/Api/SearchApi.php
+          clients/algoliasearch-client-php/lib/Model/Search/**
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
             'clients/algoliasearch-client-php/lib/Api/SearchApi.php',
             'clients/algoliasearch-client-php/lib/Configuration/SearchConfig.php',
+            'clients/algoliasearch-client-php/lib/Model/Search/**',
             'specs/bundled/search.yml',
             'templates/php/**',
             'generators/src/**'
@@ -382,12 +385,15 @@ runs:
       if: ${{ inputs.job == 'cts' || inputs.job == 'codegen' }}
       uses: actions/cache@v2
       with:
-        path: clients/algoliasearch-client-php/lib/Api/RecommendApi.php
+        path: |
+          clients/algoliasearch-client-php/lib/Api/RecommendApi.php
+          clients/algoliasearch-client-php/lib/Model/Recommend/**
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
             'clients/algoliasearch-client-php/lib/Api/RecommendApi.php',
             'clients/algoliasearch-client-php/lib/Configuration/RecommendConfig.php',
+            'clients/algoliasearch-client-php/lib/Model/Recommend/**',
             'specs/bundled/recommend.yml',
             'templates/php/**',
             'generators/src/**'
@@ -397,12 +403,15 @@ runs:
       if: ${{ inputs.job == 'cts' || inputs.job == 'codegen' }}
       uses: actions/cache@v2
       with:
-        path: clients/algoliasearch-client-php/lib/Api/PersonalizationApi.php
+        path: |
+          clients/algoliasearch-client-php/lib/Api/PersonalizationApi.php
+          clients/algoliasearch-client-php/lib/Model/Personalization/**
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
             'clients/algoliasearch-client-php/lib/Api/PersonalizationApi.php',
             'clients/algoliasearch-client-php/lib/Configuration/PersonalizationConfig.php',
+            'clients/algoliasearch-client-php/lib/Model/Personalization/**',
             'specs/bundled/personalization.yml',
             'templates/php/**',
             'generators/src/**'
@@ -412,12 +421,15 @@ runs:
       if: ${{ inputs.job == 'cts' || inputs.job == 'codegen' }}
       uses: actions/cache@v2
       with:
-        path: clients/algoliasearch-client-php/lib/Api/AnalyticsApi.php
+        path: |
+          clients/algoliasearch-client-php/lib/Api/AnalyticsApi.php
+          clients/algoliasearch-client-php/lib/Model/Analytics/**
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
             'clients/algoliasearch-client-php/lib/Api/AnalyticsApi.php',
             'clients/algoliasearch-client-php/lib/Configuration/AnalyticsConfig.php',
+            'clients/algoliasearch-client-php/lib/Model/Analytics/**',
             'specs/bundled/analytics.yml',
             'templates/php/**',
             'generators/src/**'
@@ -427,12 +439,15 @@ runs:
       if: ${{ inputs.job == 'cts' || inputs.job == 'codegen' }}
       uses: actions/cache@v2
       with:
-        path: clients/algoliasearch-client-php/lib/Api/InsightsApi.php
+        path: |
+          clients/algoliasearch-client-php/lib/Api/InsightsApi.php
+          clients/algoliasearch-client-php/lib/Model/Insights/**
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
             'clients/algoliasearch-client-php/lib/Api/InsightsApi.php',
             'clients/algoliasearch-client-php/lib/Configuration/InsightsConfig.php',
+            'clients/algoliasearch-client-php/lib/Model/Insights/**',
             'specs/bundled/insights.yml',
             'templates/php/**',
             'generators/src/**'
@@ -442,12 +457,15 @@ runs:
       if: ${{ inputs.job == 'cts' || inputs.job == 'codegen' }}
       uses: actions/cache@v2
       with:
-        path: clients/algoliasearch-client-php/lib/Api/AbtestingApi.php
+        path: |
+          clients/algoliasearch-client-php/lib/Api/AbtestingApi.php
+          clients/algoliasearch-client-php/lib/Model/Abtesting/**
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
             'clients/algoliasearch-client-php/lib/Api/AbtestingApi.php',
             'clients/algoliasearch-client-php/lib/Configuration/AbtestingConfig.php',
+            'clients/algoliasearch-client-php/lib/Model/Abtesting/**',
             'specs/bundled/abtesting.yml',
             'templates/php/**',
             'generators/src/**'
@@ -457,12 +475,15 @@ runs:
       if: ${{ inputs.job == 'cts' || inputs.job == 'codegen' }}
       uses: actions/cache@v2
       with:
-        path: clients/algoliasearch-client-php/lib/Api/QuerySuggestionsApi.php
+        path: |
+          clients/algoliasearch-client-php/lib/Api/QuerySuggestionsApi.php
+          clients/algoliasearch-client-php/lib/Model/QuerySuggestions/**
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
             'clients/algoliasearch-client-php/lib/Api/QuerySuggestionsApi.php',
             'clients/algoliasearch-client-php/lib/Configuration/QuerySuggestionsConfig.php',
+            'clients/algoliasearch-client-php/lib/Model/QuerySuggestions/**',
             'specs/bundled/query-suggestions.yml',
             'templates/php/**',
             'generators/src/**'

.github/workflows/check.yml

@@ -302,7 +302,9 @@ jobs:
         id: cache
         uses: actions/cache@v2
         with:
-          path: ${{ format('{0}/lib/Api/{1}.php', matrix.client.folder, matrix.client.api) }}
+          path: |
+            ${{ format('{0}/lib/Api/{1}.php', matrix.client.folder, matrix.client.api) }}
+            ${{ format('{0}/lib/Model/{1}/**', matrix.client.folder, matrix.client.capitalizedName) }}
           key: |
             ${{ env.CACHE_VERSION }}-${{
             hashFiles(

clients/algoliasearch-client-php/.openapi-generator-ignore

@@ -6,8 +6,6 @@
 
 docs/**
 test/**
-lib/Model/**
-lib/Model/
 
 .travis.yml
 README.md

clients/algoliasearch-client-php/lib/Configuration/AbTestingConfig.php → clients/algoliasearch-client-php/lib/Configuration/AbtestingConfig.php

@@ -2,6 +2,6 @@
 
 namespace Algolia\AlgoliaSearch\Configuration;
 
-class AbTestingConfig extends ConfigWithRegion
+class AbtestingConfig extends ConfigWithRegion
 {
 }

clients/algoliasearch-client-php/lib/Configuration/RecommendConfig.php

@@ -2,6 +2,6 @@
 
 namespace Algolia\AlgoliaSearch\Configuration;
 
-class RecommendConfig extends ConfigWithRegion
+class RecommendConfig extends Configuration
 {
 }

clients/algoliasearch-client-php/lib/Model/AbstractModel.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Model;
+
+use \Algolia\AlgoliaSearch\ObjectSerializer;
+
+/**
+ * Abstract class extended by each models
+ *
+ * @category Class
+ * @package Algolia\AlgoliaSearch
+ */
+abstract class AbstractModel
+{
+    /**
+     * Serializes the object to a value that can be serialized natively by json_encode().
+     *
+     * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php
+     *
+     * @return mixed returns data which can be serialized by json_encode(), which is a value
+     * of any type other than a resource
+     */
+    public function jsonSerialize()
+    {
+        return ObjectSerializer::sanitizeForSerialization($this);
+    }
+
+    /**
+     * Gets the string presentation of the object
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return json_encode(
+            ObjectSerializer::sanitizeForSerialization($this),
+            JSON_PRETTY_PRINT
+        );
+    }
+
+    /**
+     * Gets a header-safe presentation of the object
+     *
+     * @return string
+     */
+    public function toHeaderValue()
+    {
+        return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+    }
+}

openapitools.json

@@ -264,7 +264,7 @@
         "gitUserId": "algolia",
         "gitRepoId": "algoliasearch-client-php",
         "invokerPackage": "Algolia\\AlgoliaSearch",
-        "globalProperty": "apis,supportingFiles",
+        "modelPackage": "Model\\Search",
         "additionalProperties": {
           "configClassname": "SearchConfig",
           "useCache": true,
@@ -283,7 +283,7 @@
         "gitUserId": "algolia",
         "gitRepoId": "algoliasearch-client-php",
         "invokerPackage": "Algolia\\AlgoliaSearch",
-        "globalProperty": "apis,supportingFiles",
+        "modelPackage": "Model\\Recommend",
         "additionalProperties": {
           "configClassname": "RecommendConfig",
           "useCache": true,
@@ -302,7 +302,7 @@
         "gitUserId": "algolia",
         "gitRepoId": "algoliasearch-client-php",
         "invokerPackage": "Algolia\\AlgoliaSearch",
-        "globalProperty": "apis,supportingFiles",
+        "modelPackage": "Model\\Personalization",
         "additionalProperties": {
           "configClassname": "PersonalizationConfig",
           "hasRegionalHost": true,
@@ -325,7 +325,7 @@
         "gitUserId": "algolia",
         "gitRepoId": "algoliasearch-client-php",
         "invokerPackage": "Algolia\\AlgoliaSearch",
-        "globalProperty": "apis,supportingFiles",
+        "modelPackage": "Model\\Analytics",
         "additionalProperties": {
           "configClassname": "AnalyticsConfig",
           "hasRegionalHost": true,
@@ -349,7 +349,7 @@
         "gitUserId": "algolia",
         "gitRepoId": "algoliasearch-client-php",
         "invokerPackage": "Algolia\\AlgoliaSearch",
-        "globalProperty": "apis,supportingFiles",
+        "modelPackage": "Model\\Insights",
         "additionalProperties": {
           "configClassname": "InsightsConfig",
           "hasRegionalHost": true,
@@ -373,7 +373,7 @@
         "gitUserId": "algolia",
         "gitRepoId": "algoliasearch-client-php",
         "invokerPackage": "Algolia\\AlgoliaSearch",
-        "globalProperty": "apis,supportingFiles",
+        "modelPackage": "Model\\Abtesting",
         "additionalProperties": {
           "configClassname": "AbtestingConfig",
           "hasRegionalHost": true,
@@ -397,7 +397,7 @@
         "gitUserId": "algolia",
         "gitRepoId": "algoliasearch-client-php",
         "invokerPackage": "Algolia\\AlgoliaSearch",
-        "globalProperty": "apis,supportingFiles",
+        "modelPackage": "Model\\QuerySuggestions",
         "additionalProperties": {
           "configClassname": "QuerySuggestionsConfig",
           "hasRegionalHost": true,

scripts/ci/createMatrix.ts

@@ -1,4 +1,5 @@
 import { CLIENTS, GENERATORS } from '../common';
+import { createClientName } from '../cts/utils';
 import type { Language } from '../types';
 
 import { getNbGitDiff } from './utils';
@@ -14,6 +15,7 @@ type ClientMatrix = {
   folder: string;
   config?: string;
   api?: string;
+  capitalizedName?: string;
 };
 
 type Matrix<TMatrix> = {
@@ -70,6 +72,7 @@ async function getClientMatrix({
         'Config',
         'Api'
       );
+      matchedGenerator.capitalizedName = createClientName(client, 'php');
     }
 
     matrix.client.push(matchedGenerator);

scripts/generate.ts

@@ -14,6 +14,7 @@ import {
   getLanguageFolder,
   getLanguageModelFolder,
 } from './config';
+import { createClientName } from './cts/utils';
 import { formatter } from './formatter';
 import { createSpinner } from './oraLog';
 import { setHostsOptions } from './pre-gen/setHostsOptions';
@@ -33,6 +34,9 @@ async function removeExistingModel(
     case 'java':
       clientModel = client;
       break;
+    case 'php':
+      clientModel = createClientName(client, 'php');
+      break;
     default:
       break;
   }

clients/algoliasearch-client-php/lib/ModelInterface.php → templates/php/ModelInterface.mustache

@@ -1,41 +1,27 @@
 <?php
 
-namespace Algolia\AlgoliaSearch\Model;
+namespace {{modelPackage}};
 
 /**
  * Interface abstracting model access.
  *
- * @package Algolia\AlgoliaSearch\Model
+ * @package {{modelPackage}}
  */
 interface ModelInterface
 {
-    /**
-     * The original name of the model.
-     *
-     * @return string
-     */
-    public function getModelName();
-
     /**
      * Array of property to type mappings. Used for (de)serialization
      *
      * @return array
      */
-    public static function openAPITypes();
+    public static function modelTypes();
 
     /**
      * Array of property to format mappings. Used for (de)serialization
      *
      * @return array
      */
-    public static function openAPIFormats();
-
-    /**
-     * Array of attributes where the key is the local name, and the value is the original name
-     *
-     * @return array
-     */
-    public static function attributeMap();
+    public static function modelFormats();
 
     /**
      * Array of attributes to setter functions (for deserialization of responses)

templates/php/api.mustache

@@ -75,7 +75,7 @@ use {{invokerPackage}}\RetryStrategy\ClusterHosts;
     {{/hasRegionalHost}}
 
     /**
-     * Instantiate the client with congiguration
+     * Instantiate the client with configuration
      *
      * @param {{configClassname}} $config Configuration
      */
@@ -134,10 +134,16 @@ use {{invokerPackage}}\RetryStrategy\ClusterHosts;
      *
 {{/description}}
 {{#allParams}}
-     * @param {{#isString}}string{{/isString}}{{#isInteger}}int{{/isInteger}}{{^isString}}{{^isInteger}}array{{/isInteger}}{{/isString}} ${{paramName}}{{#description}} {{.}}{{/description}}{{^description}} {{paramName}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
+     * @param {{#isString}}string{{/isString}}{{#isInteger}}int{{/isInteger}}{{#isBoolean}}bool{{/isBoolean}}{{^isString}}{{^isInteger}}{{^isBoolean}}array{{/isBoolean}}{{/isInteger}}{{/isString}} ${{paramName}}{{#description}} {{.}}{{/description}}{{^description}} {{paramName}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
+{{#isModel}}
+    {{#vars}}
+     * - ${{paramName}}{{> arrayParam}}
+    {{/vars}}
+     * @see {{{dataType}}}
+{{/isModel}}
 {{/allParams}}
      *
-     * @return array<string, mixed>
+     * @return {{#returnType}}{{#responses}}{{#dataType}}{{#-first}}array<string, mixed>|{{{dataType}}}{{/-first}}{{/dataType}}{{/responses}}{{/returnType}}{{^returnType}}void{{/returnType}}
   {{#isDeprecated}}
      * @deprecated
   {{/isDeprecated}}
@@ -241,7 +247,7 @@ use {{invokerPackage}}\RetryStrategy\ClusterHosts;
         if (${{paramName}} !== null) {
             $resourcePath = str_replace(
                 {{=<% %>=}}'{<%baseName%>}'<%={{ }}=%>,
-                {{#x-is-custom-request}}{{paramName}}{{/x-is-custom-request}}{{^x-is-custom-request}}ObjectSerializer::toPathValue(${{paramName}}){{/x-is-custom-request}},
+                {{#x-is-custom-request}}${{paramName}}{{/x-is-custom-request}}{{^x-is-custom-request}}ObjectSerializer::toPathValue(${{paramName}}){{/x-is-custom-request}},
                 $resourcePath
             );
         }

templates/php/arrayParam.mustache

@@ -0,0 +1 @@
+['{{{baseName}}}'] => ({{#isString}}string{{/isString}}{{#isInteger}}int{{/isInteger}}{{#isBoolean}}bool{{/isBoolean}}{{^isString}}{{^isInteger}}{{^isBoolean}}array{{/isBoolean}}{{/isInteger}}{{/isString}}) {{{description}}}{{#required}} (required){{/required}}