loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

[PHP] remove deprecated options (#2083)

Browse Source 
* php remove deprecated options

* update php doc

* clean up composerVendorName in code, templates

* update samples
This commit is contained in:
William Cheng 2019-02-10 08:25:20 +08:00 committed by Akihito Nakano
parent e0ed6719a0
commit 20d5adcdd5
15 changed files with 15 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/generators/php.md
View File

@ -20,6 +20,4 @@ sidebar_label: php
|gitUserId|Git user ID, e.g. openapitools.| |null| |gitUserId|Git user ID, e.g. openapitools.| |null|
|gitRepoId|Git repo ID, e.g. openapi-generator.| |null| |gitRepoId|Git repo ID, e.g. openapi-generator.| |null|
|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null| |artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null|
|composerVendorName|The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets. IMPORTANT NOTE (2016/03): composerVendorName will be deprecated and replaced by gitUserId in the next openapi-generator release| |null|
|composerProjectName|The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client. IMPORTANT NOTE (2016/03): composerProjectName will be deprecated and replaced by gitRepoId in the next openapi-generator release| |null|
|hideGenerationTimestamp|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |true| |hideGenerationTimestamp|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |true|

27
modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPhpCodegen.java
View File

@ -40,11 +40,6 @@ public abstract class AbstractPhpCodegen extends DefaultCodegen implements Codeg
public static final String VARIABLE_NAMING_CONVENTION = "variableNamingConvention"; public static final String VARIABLE_NAMING_CONVENTION = "variableNamingConvention";
public static final String PACKAGE_NAME = "packageName"; public static final String PACKAGE_NAME = "packageName";
public static final String SRC_BASE_PATH = "srcBasePath"; public static final String SRC_BASE_PATH = "srcBasePath";
// composerVendorName/composerProjectName has be replaced by gitUserId/gitRepoId. prepare to remove these.
// public static final String COMPOSER_VENDOR_NAME = "composerVendorName";
// public static final String COMPOSER_PROJECT_NAME = "composerProjectName";
// protected String composerVendorName = null;
// protected String composerProjectName = null;
protected String invokerPackage = "php"; protected String invokerPackage = "php";
protected String packageName = "php-base"; protected String packageName = "php-base";
protected String artifactVersion = null; protected String artifactVersion = null;
@ -137,9 +132,7 @@ public abstract class AbstractPhpCodegen extends DefaultCodegen implements Codeg
cliOptions.add(new CliOption(CodegenConstants.INVOKER_PACKAGE, "The main namespace to use for all classes. e.g. Yay\\Pets")); cliOptions.add(new CliOption(CodegenConstants.INVOKER_PACKAGE, "The main namespace to use for all classes. e.g. Yay\\Pets"));
cliOptions.add(new CliOption(PACKAGE_NAME, "The main package name for classes. e.g. GeneratedPetstore")); cliOptions.add(new CliOption(PACKAGE_NAME, "The main package name for classes. e.g. GeneratedPetstore"));
cliOptions.add(new CliOption(SRC_BASE_PATH, "The directory to serve as source root.")); cliOptions.add(new CliOption(SRC_BASE_PATH, "The directory to serve as source root."));
// cliOptions.add(new CliOption(COMPOSER_VENDOR_NAME, "The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets. IMPORTANT NOTE (2016/03): composerVendorName will be deprecated and replaced by gitUserId in the next openapi-generator release"));
cliOptions.add(new CliOption(CodegenConstants.GIT_USER_ID, CodegenConstants.GIT_USER_ID_DESC)); cliOptions.add(new CliOption(CodegenConstants.GIT_USER_ID, CodegenConstants.GIT_USER_ID_DESC));
// cliOptions.add(new CliOption(COMPOSER_PROJECT_NAME, "The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client. IMPORTANT NOTE (2016/03): composerProjectName will be deprecated and replaced by gitRepoId in the next openapi-generator release"));
cliOptions.add(new CliOption(CodegenConstants.GIT_REPO_ID, CodegenConstants.GIT_REPO_ID_DESC)); cliOptions.add(new CliOption(CodegenConstants.GIT_REPO_ID, CodegenConstants.GIT_REPO_ID_DESC));
cliOptions.add(new CliOption(CodegenConstants.ARTIFACT_VERSION, "The version to use in the composer package version field. e.g. 1.2.3")); cliOptions.add(new CliOption(CodegenConstants.ARTIFACT_VERSION, "The version to use in the composer package version field. e.g. 1.2.3"));
} }
@ -187,24 +180,12 @@ public abstract class AbstractPhpCodegen extends DefaultCodegen implements Codeg
} }
additionalProperties.put(CodegenConstants.API_PACKAGE, apiPackage); additionalProperties.put(CodegenConstants.API_PACKAGE, apiPackage);
// if (additionalProperties.containsKey(COMPOSER_PROJECT_NAME)) {
// this.setComposerProjectName((String) additionalProperties.get(COMPOSER_PROJECT_NAME));
// } else {
// additionalProperties.put(COMPOSER_PROJECT_NAME, composerProjectName);
// }
if (additionalProperties.containsKey(CodegenConstants.GIT_USER_ID)) { if (additionalProperties.containsKey(CodegenConstants.GIT_USER_ID)) {
this.setGitUserId((String) additionalProperties.get(CodegenConstants.GIT_USER_ID)); this.setGitUserId((String) additionalProperties.get(CodegenConstants.GIT_USER_ID));
} else { } else {
additionalProperties.put(CodegenConstants.GIT_USER_ID, gitUserId); additionalProperties.put(CodegenConstants.GIT_USER_ID, gitUserId);
} }
// if (additionalProperties.containsKey(COMPOSER_VENDOR_NAME)) {
// this.setComposerVendorName((String) additionalProperties.get(COMPOSER_VENDOR_NAME));
// } else {
// additionalProperties.put(COMPOSER_VENDOR_NAME, composerVendorName);
// }
if (additionalProperties.containsKey(CodegenConstants.GIT_REPO_ID)) { if (additionalProperties.containsKey(CodegenConstants.GIT_REPO_ID)) {
this.setGitRepoId((String) additionalProperties.get(CodegenConstants.GIT_REPO_ID)); this.setGitRepoId((String) additionalProperties.get(CodegenConstants.GIT_REPO_ID));
} else { } else {
@ -409,14 +390,6 @@ public abstract class AbstractPhpCodegen extends DefaultCodegen implements Codeg
this.variableNamingConvention = variableNamingConvention; this.variableNamingConvention = variableNamingConvention;
} }
// public void setComposerVendorName(String composerVendorName) {
// this.composerVendorName = composerVendorName;
// }
// public void setComposerProjectName(String composerProjectName) {
// this.composerProjectName = composerProjectName;
// }
@Override @Override
public String toVarName(String name) { public String toVarName(String name) {
// sanitize name // sanitize name

27
modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpClientCodegen.java
View File

@ -34,11 +34,6 @@ public class PhpClientCodegen extends AbstractPhpCodegen {
@SuppressWarnings("hiding") @SuppressWarnings("hiding")
private static final Logger LOGGER = LoggerFactory.getLogger(PhpClientCodegen.class); private static final Logger LOGGER = LoggerFactory.getLogger(PhpClientCodegen.class);
public static final String COMPOSER_VENDOR_NAME = "composerVendorName";
public static final String COMPOSER_PROJECT_NAME = "composerProjectName";
protected String composerVendorName = null;
protected String composerProjectName = null;
public PhpClientCodegen() { public PhpClientCodegen() {
super(); super();
@ -64,8 +59,6 @@ public class PhpClientCodegen extends AbstractPhpCodegen {
String primitives = "'" + StringUtils.join(sortedLanguageSpecificPrimitives, "', '") + "'"; String primitives = "'" + StringUtils.join(sortedLanguageSpecificPrimitives, "', '") + "'";
additionalProperties.put("primitives", primitives); additionalProperties.put("primitives", primitives);
cliOptions.add(new CliOption(COMPOSER_VENDOR_NAME, "The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets. IMPORTANT NOTE (2016/03): composerVendorName will be deprecated and replaced by gitUserId in the next openapi-generator release"));
cliOptions.add(new CliOption(COMPOSER_PROJECT_NAME, "The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client. IMPORTANT NOTE (2016/03): composerProjectName will be deprecated and replaced by gitRepoId in the next openapi-generator release"));
cliOptions.add(new CliOption(CodegenConstants.HIDE_GENERATION_TIMESTAMP, CodegenConstants.ALLOW_UNICODE_IDENTIFIERS_DESC) cliOptions.add(new CliOption(CodegenConstants.HIDE_GENERATION_TIMESTAMP, CodegenConstants.ALLOW_UNICODE_IDENTIFIERS_DESC)
.defaultValue(Boolean.TRUE.toString())); .defaultValue(Boolean.TRUE.toString()));
} }
@ -89,18 +82,6 @@ public class PhpClientCodegen extends AbstractPhpCodegen {
public void processOpts() { public void processOpts() {
super.processOpts(); super.processOpts();
if (additionalProperties.containsKey(COMPOSER_PROJECT_NAME)) {
this.setComposerProjectName((String) additionalProperties.get(COMPOSER_PROJECT_NAME));
} else {
additionalProperties.put(COMPOSER_PROJECT_NAME, composerProjectName);
}
if (additionalProperties.containsKey(COMPOSER_VENDOR_NAME)) {
this.setComposerVendorName((String) additionalProperties.get(COMPOSER_VENDOR_NAME));
} else {
additionalProperties.put(COMPOSER_VENDOR_NAME, composerVendorName);
}
supportingFiles.add(new SupportingFile("ApiException.mustache", toSrcPath(invokerPackage, srcBasePath), "ApiException.php")); supportingFiles.add(new SupportingFile("ApiException.mustache", toSrcPath(invokerPackage, srcBasePath), "ApiException.php"));
supportingFiles.add(new SupportingFile("Configuration.mustache", toSrcPath(invokerPackage, srcBasePath), "Configuration.php")); supportingFiles.add(new SupportingFile("Configuration.mustache", toSrcPath(invokerPackage, srcBasePath), "Configuration.php"));
supportingFiles.add(new SupportingFile("ObjectSerializer.mustache", toSrcPath(invokerPackage, srcBasePath), "ObjectSerializer.php")); supportingFiles.add(new SupportingFile("ObjectSerializer.mustache", toSrcPath(invokerPackage, srcBasePath), "ObjectSerializer.php"));
@ -113,12 +94,4 @@ public class PhpClientCodegen extends AbstractPhpCodegen {
supportingFiles.add(new SupportingFile(".php_cs", "", ".php_cs")); supportingFiles.add(new SupportingFile(".php_cs", "", ".php_cs"));
supportingFiles.add(new SupportingFile("git_push.sh.mustache", "", "git_push.sh")); supportingFiles.add(new SupportingFile("git_push.sh.mustache", "", "git_push.sh"));
} }
public void setComposerVendorName(String composerVendorName) {
this.composerVendorName = composerVendorName;
}
public void setComposerProjectName(String composerProjectName) {
this.composerProjectName = composerProjectName;
}
} }

2
modules/openapi-generator/src/main/resources/lumen/composer.mustache vendored
View File

@ -1,5 +1,5 @@
{ {
"name": "{{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}", "name": "{{gitUserId}}/{{gitRepoId}}",
{{#artifactVersion}} {{#artifactVersion}}
"version": "{{artifactVersion}}", "version": "{{artifactVersion}}",
{{/artifactVersion}} {{/artifactVersion}}

2
modules/openapi-generator/src/main/resources/php-laravel/composer.mustache vendored
View File

@ -1,5 +1,5 @@
{ {
"name": "{{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}", "name": "{{gitUserId}}/{{gitRepoId}}",
"description": "{{description}}.", "description": "{{description}}.",
"keywords": ["framework", "laravel"], "keywords": ["framework", "laravel"],
{{#artifactVersion}} {{#artifactVersion}}

2
modules/openapi-generator/src/main/resources/php-symfony/README.mustache vendored
View File

@ -37,7 +37,7 @@ To install the dependencies via [Composer](http://getcomposer.org/), add the fol
Then run: Then run:
``` ```
composer require {{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}:dev-master composer require {{gitUserId}}/{{gitRepoId}}:dev-master
``` ```
to add the generated openapi bundle as a dependency. to add the generated openapi bundle as a dependency.

2
modules/openapi-generator/src/main/resources/php-symfony/composer.mustache vendored
View File

@ -1,5 +1,5 @@
{ {
"name": "{{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}", "name": "{{gitUserId}}/{{gitRepoId}}",
{{#artifactVersion}} {{#artifactVersion}}
"version": "{{artifactVersion}}", "version": "{{artifactVersion}}",
{{/artifactVersion}} {{/artifactVersion}}

4
modules/openapi-generator/src/main/resources/php/README.mustache vendored
View File

@ -31,11 +31,11 @@ To install the bindings via [Composer](http://getcomposer.org/), add the followi
"repositories": [ "repositories": [
{ {
"type": "vcs", "type": "vcs",
"url": "https://github.com/{{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}.git" "url": "https://github.com/{{gitUserId}}/{{gitRepoId}}.git"
} }
], ],
"require": { "require": {
"{{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}": "*@dev" "{{gitUserId}}/{{gitRepoId}}": "*@dev"
} }
} }
``` ```

5
modules/openapi-generator/src/main/resources/php/composer.mustache vendored
View File

@ -1,5 +1,5 @@
{ {
"name": "{{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}", "name": "{{gitUserId}}/{{gitRepoId}}",
{{#artifactVersion}} {{#artifactVersion}}
"version": "{{artifactVersion}}", "version": "{{artifactVersion}}",
{{/artifactVersion}} {{/artifactVersion}}
@ -7,12 +7,13 @@
"keywords": [ "keywords": [
"openapitools", "openapitools",
"openapi-generator", "openapi-generator",
"openapi",
"php", "php",
"sdk", "sdk",
"rest", "rest",
"api" "api"
], ],
"homepage": "http://openapi-generator.tech", "homepage": "https://openapi-generator.tech",
"license": "proprietary", "license": "proprietary",
"authors": [ "authors": [
{ {

4
modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpClientOptionsProvider.java
View File

@ -32,8 +32,6 @@ public class PhpClientOptionsProvider implements OptionsProvider {
public static final String INVOKER_PACKAGE_VALUE = "OpenAPITools\\Client\\Php"; public static final String INVOKER_PACKAGE_VALUE = "OpenAPITools\\Client\\Php";
public static final String PACKAGE_NAME_VALUE = "OpenAPIToolsClient-php"; public static final String PACKAGE_NAME_VALUE = "OpenAPIToolsClient-php";
public static final String SRC_BASE_PATH_VALUE = "libPhp"; public static final String SRC_BASE_PATH_VALUE = "libPhp";
public static final String COMPOSER_VENDOR_NAME_VALUE = "openAPIToolsPhp";
public static final String COMPOSER_PROJECT_NAME_VALUE = "openapi-tools-client-php";
public static final String GIT_USER_ID_VALUE = "gitOpenAPIToolsPhp"; public static final String GIT_USER_ID_VALUE = "gitOpenAPIToolsPhp";
public static final String GIT_REPO_ID_VALUE = "git-openapi-tools-client-php"; public static final String GIT_REPO_ID_VALUE = "git-openapi-tools-client-php";
public static final String ARTIFACT_VERSION_VALUE = "1.0.0-SNAPSHOT"; public static final String ARTIFACT_VERSION_VALUE = "1.0.0-SNAPSHOT";
@ -56,9 +54,7 @@ public class PhpClientOptionsProvider implements OptionsProvider {
.put(CodegenConstants.INVOKER_PACKAGE, INVOKER_PACKAGE_VALUE) .put(CodegenConstants.INVOKER_PACKAGE, INVOKER_PACKAGE_VALUE)
.put(PhpClientCodegen.PACKAGE_NAME, PACKAGE_NAME_VALUE) .put(PhpClientCodegen.PACKAGE_NAME, PACKAGE_NAME_VALUE)
.put(PhpClientCodegen.SRC_BASE_PATH, SRC_BASE_PATH_VALUE) .put(PhpClientCodegen.SRC_BASE_PATH, SRC_BASE_PATH_VALUE)
.put(PhpClientCodegen.COMPOSER_VENDOR_NAME, COMPOSER_VENDOR_NAME_VALUE)
.put(CodegenConstants.GIT_USER_ID, GIT_USER_ID_VALUE) .put(CodegenConstants.GIT_USER_ID, GIT_USER_ID_VALUE)
.put(PhpClientCodegen.COMPOSER_PROJECT_NAME, COMPOSER_PROJECT_NAME_VALUE)
.put(CodegenConstants.GIT_REPO_ID, GIT_REPO_ID_VALUE) .put(CodegenConstants.GIT_REPO_ID, GIT_REPO_ID_VALUE)
.put(CodegenConstants.ARTIFACT_VERSION, ARTIFACT_VERSION_VALUE) .put(CodegenConstants.ARTIFACT_VERSION, ARTIFACT_VERSION_VALUE)
.put(CodegenConstants.HIDE_GENERATION_TIMESTAMP, "true") .put(CodegenConstants.HIDE_GENERATION_TIMESTAMP, "true")

4
modules/openapi-generator/src/test/java/org/openapitools/codegen/php/PhpClientOptionsTest.java
View File

@ -56,12 +56,8 @@ public class PhpClientOptionsTest extends AbstractOptionsTest {
times = 1; times = 1;
clientCodegen.setSrcBasePath(PhpClientOptionsProvider.SRC_BASE_PATH_VALUE); clientCodegen.setSrcBasePath(PhpClientOptionsProvider.SRC_BASE_PATH_VALUE);
times = 1; times = 1;
clientCodegen.setComposerVendorName(PhpClientOptionsProvider.COMPOSER_VENDOR_NAME_VALUE);
times = 1;
clientCodegen.setGitUserId(PhpClientOptionsProvider.GIT_USER_ID_VALUE); clientCodegen.setGitUserId(PhpClientOptionsProvider.GIT_USER_ID_VALUE);
times = 1; times = 1;
clientCodegen.setComposerProjectName(PhpClientOptionsProvider.COMPOSER_PROJECT_NAME_VALUE);
times = 1;
clientCodegen.setGitRepoId(PhpClientOptionsProvider.GIT_REPO_ID_VALUE); clientCodegen.setGitRepoId(PhpClientOptionsProvider.GIT_REPO_ID_VALUE);
times = 1; times = 1;
clientCodegen.setArtifactVersion(PhpClientOptionsProvider.ARTIFACT_VERSION_VALUE); clientCodegen.setArtifactVersion(PhpClientOptionsProvider.ARTIFACT_VERSION_VALUE);

3
samples/client/petstore/php/OpenAPIClient-php/composer.json
View File

@ -4,12 +4,13 @@
"keywords": [ "keywords": [
"openapitools", "openapitools",
"openapi-generator", "openapi-generator",
"openapi",
"php", "php",
"sdk", "sdk",
"rest", "rest",
"api" "api"
], ],
"homepage": "http://openapi-generator.tech", "homepage": "https://openapi-generator.tech",
"license": "proprietary", "license": "proprietary",
"authors": [ "authors": [
{ {

3
samples/openapi3/client/petstore/php/OpenAPIClient-php/composer.json
View File

@ -4,12 +4,13 @@
"keywords": [ "keywords": [
"openapitools", "openapitools",
"openapi-generator", "openapi-generator",
"openapi",
"php", "php",
"sdk", "sdk",
"rest", "rest",
"api" "api"
], ],
"homepage": "http://openapi-generator.tech", "homepage": "https://openapi-generator.tech",
"license": "proprietary", "license": "proprietary",
"authors": [ "authors": [
{ {

2
samples/server/petstore/php-symfony/SymfonyBundle-php/README.md
View File

@ -26,7 +26,7 @@ To install the dependencies via [Composer](http://getcomposer.org/), add the fol
Then run: Then run:
``` ```
composer require openapi/server-bundle:dev-master composer require GIT_USER_ID/GIT_REPO_ID:dev-master
``` ```
to add the generated openapi bundle as a dependency. to add the generated openapi bundle as a dependency.

2
samples/server/petstore/php-symfony/SymfonyBundle-php/composer.json
View File

@ -1,5 +1,5 @@
{ {
"name": "openapi/server-bundle", "name": "GIT_USER_ID/GIT_REPO_ID",
"description": "", "description": "",
"keywords": [ "keywords": [
"openapi", "openapi",