org.openapitools.codegen.languages

类 PhpSymfonyServerCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractPhpCodegen

org.openapitools.codegen.languages.PhpSymfonyServerCodegen

所有已实现的接口:

CodegenConfig

public class PhpSymfonyServerCodegen
extends AbstractPhpCodegen
implements CodegenConfig

字段概要

字段

限定符和类型	字段和说明
protected String	apiTestsPackage
static String	BUNDLE_NAME
protected String	bundleAlias
protected String	bundleClassName
protected String	bundleExtensionName
protected String	bundleName
static String	COMPOSER_PROJECT_NAME
static String	COMPOSER_VENDOR_NAME
protected String	composerProjectName
protected String	composerVendorName
protected String	controllerDirName
protected String	controllerPackage
protected String	modelTestsPackage
static String	PHP_LEGACY_SUPPORT
protected Boolean	phpLegacySupport
protected String	serviceDirName
protected String	servicePackage
static Map<String,String>	SYMFONY_EXCEPTIONS
protected String	testsDirName
protected String	testsPackage
protected HashSet<String>	typeHintable

从类继承的字段 org.openapitools.codegen.languages.AbstractPhpCodegen

abstractNamePrefix, abstractNameSuffix, apiDirName, apiDocPath, artifactVersion, docsBasePath, interfaceNamePrefix, interfaceNameSuffix, invokerPackage, modelDirName, modelDocPath, PACKAGE_NAME, packageName, SRC_BASE_PATH, srcBasePath, testBasePath, traitNamePrefix, traitNameSuffix, VARIABLE_NAMING_CONVENTION, variableNamingConvention

从类继承的字段 org.openapitools.codegen.DefaultCodegen

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, defaultIncludes, docExtension, embeddedTemplateDir, enablePostProcessFile, ensureUniqueParams, fileSuffix, gitRepoId, gitUserId, globalOpenAPI, globalSchemas, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importMapping, inputSpec, instantiationTypes, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, prependFormOrBodyParameters, releaseNote, removeOperationIdPrefix, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, testPackage, typeAliases, typeMapping, vendorExtensions

构造器概要

构造器

构造器和说明
PhpSymfonyServerCodegen()

方法概要

限定符和类型	方法和说明
String	apiFilename(String templateName, String tag)
String	apiTestFileFolder()
String	controllerFileFolder()
String	escapeReservedWord(String name) Return the escaped name of the reserved word
String	escapeText(String input)
String	getBundleName()
String	getHelp()
String	getName()
String	getPropertyTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the type declaration of the property
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p) Output the type declaration of the property
String	getTypeDeclaration(String name) Output the type declaration of a given name
protected String	getTypeHint(String type)
protected Boolean	isModelClass(String type)
String	modelTestFileFolder()
Map<String,Object>	postProcessModels(Map<String,Object> objs)
Map<String,Object>	postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
void	processOpts()
void	setBundleName(String bundleName)
void	setComposerProjectName(String composerProjectName)
void	setComposerVendorName(String composerVendorName)
void	setInvokerPackage(String invokerPackage)
void	setPhpLegacySupport(Boolean support)
String	toApiName(String name) Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toBooleanGetter(String name) Output the Getter name for boolean property, e.g. isActive
protected String	toControllerName(String name)
String	toEnumValue(String value, String datatype) Return the enum value in the language specified format e.g. status becomes "status"
String	toModelImport(String name) Return the fully-qualified "Model" name for import
String	toRegularExpression(String pattern) Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)
protected String	toSymfonyService(String name)

从类继承的方法 org.openapitools.codegen.languages.AbstractPhpCodegen

apiDocFileFolder, apiFileFolder, escapeMediaType, escapeQuotationMark, escapeUnsafeCharacters, extractSimpleName, getInvokerPackage, getPackageName, getSchemaType, modelDocFileFolder, modelFileFolder, postProcessFile, setArtifactVersion, setPackageName, setParameterExampleValue, setParameterNamingConvention, setSrcBasePath, toAbstractName, toApiDocFilename, toDefaultValue, toEnumDefaultValue, toEnumName, toEnumVarName, toInterfaceName, toModelDocFilename, toModelFilename, toModelName, toModelTestFilename, toOperationId, toParamName, toSrcPath, toTraitName, toVarName

从类继承的方法 org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, embeddedTemplateDir, escapeSpecialCharacters, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAlias, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getMostInnerItems, getOrGenerateOperationId, getOutputDir, getParameterDataType, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSymbolName, getterAndSetterCapitalize, hasBodyParameter, hasFormParameter, importMapping, initalizeSpecialCharacterMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnablePostProcessFile, isHideGenerationTimestamp, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setDocExtension, setEnablePostProcessFile, setEnsureUniqueParams, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterExampleValue, setParameterExampleValue, setPrependFormOrBodyParameters, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toArrayModelParamName, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toSetter, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeQuotationMark, escapeTextWhileAllowingNewLines, escapeUnsafeCharacters, fileSuffix, fromModel, fromOperation, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, importMapping, instantiationTypes, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessOperations, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setDocExtension, setEnablePostProcessFile, setGitRepoId, setGitUserId, setGlobalOpenAPI, setGlobalSchemas, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOutputDir, setReleaseNote, setRemoveOperationIdPrefix, setSkipOverwrite, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toGetter, toModelDocFilename, toModelFilename, toModelName, toModelTestFilename, toParamName, toSetter, typeMapping, vendorExtensions

字段详细资料

BUNDLE_NAME

public static final String BUNDLE_NAME

另请参阅:

常量字段值

COMPOSER_VENDOR_NAME

public static final String COMPOSER_VENDOR_NAME

另请参阅:

常量字段值

COMPOSER_PROJECT_NAME

public static final String COMPOSER_PROJECT_NAME

另请参阅:

常量字段值

PHP_LEGACY_SUPPORT

public static final String PHP_LEGACY_SUPPORT

另请参阅:

常量字段值

SYMFONY_EXCEPTIONS

public static final Map<String,String> SYMFONY_EXCEPTIONS

testsPackage

protected String testsPackage

apiTestsPackage

protected String apiTestsPackage

modelTestsPackage

protected String modelTestsPackage

composerVendorName

protected String composerVendorName

composerProjectName

protected String composerProjectName

testsDirName

protected String testsDirName

bundleName

protected String bundleName

bundleClassName

protected String bundleClassName

bundleExtensionName

protected String bundleExtensionName

bundleAlias

protected String bundleAlias

controllerDirName

protected String controllerDirName

serviceDirName

protected String serviceDirName

controllerPackage

protected String controllerPackage

servicePackage

protected String servicePackage

phpLegacySupport

protected Boolean phpLegacySupport

typeHintable

protected HashSet<String> typeHintable

构造器详细资料

PhpSymfonyServerCodegen

public PhpSymfonyServerCodegen()

方法详细资料

getBundleName

public String getBundleName()

setBundleName

public void setBundleName(String bundleName)

setPhpLegacySupport

public void setPhpLegacySupport(Boolean support)

controllerFileFolder

public String controllerFileFolder()

escapeText

public String escapeText(String input)

指定者:

escapeText 在接口中 CodegenConfig

覆盖:

escapeText 在类中 AbstractPhpCodegen

getTag

public CodegenType getTag()

指定者:

getTag 在接口中 CodegenConfig

覆盖:

getTag 在类中 DefaultCodegen

getName

public String getName()

指定者:

getName 在接口中 CodegenConfig

覆盖:

getName 在类中 DefaultCodegen

getHelp

public String getHelp()

指定者:

getHelp 在接口中 CodegenConfig

覆盖:

getHelp 在类中 DefaultCodegen

apiFilename

public String apiFilename(String templateName,
                          String tag)

指定者:

apiFilename 在接口中 CodegenConfig

覆盖:

apiFilename 在类中 DefaultCodegen

processOpts

public void processOpts()

指定者:

processOpts 在接口中 CodegenConfig

覆盖:

processOpts 在类中 AbstractPhpCodegen

postProcessOperationsWithModels

public Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs,
                                                          List<Object> allModels)

指定者:

postProcessOperationsWithModels 在接口中 CodegenConfig

覆盖:

postProcessOperationsWithModels 在类中 AbstractPhpCodegen

postProcessModels

public Map<String,Object> postProcessModels(Map<String,Object> objs)

指定者:

postProcessModels 在接口中 CodegenConfig

覆盖:

postProcessModels 在类中 AbstractPhpCodegen

toBooleanGetter

public String toBooleanGetter(String name)

Output the Getter name for boolean property, e.g. isActive

指定者:

toBooleanGetter 在接口中 CodegenConfig

覆盖:

toBooleanGetter 在类中 DefaultCodegen

参数:

name - the name of the property

返回:

getter name based on naming convention

escapeReservedWord

public String escapeReservedWord(String name)

从类复制的说明: DefaultCodegen

Return the escaped name of the reserved word

指定者:

escapeReservedWord 在接口中 CodegenConfig

覆盖:

escapeReservedWord 在类中 AbstractPhpCodegen

参数:

name - the name to be escaped

返回:

the escaped reserved word

throws Runtime exception as reserved word is not allowed (default behavior)

apiTestFileFolder

public String apiTestFileFolder()

指定者:

apiTestFileFolder 在接口中 CodegenConfig

覆盖:

apiTestFileFolder 在类中 AbstractPhpCodegen

modelTestFileFolder

public String modelTestFileFolder()

指定者:

modelTestFileFolder 在接口中 CodegenConfig

覆盖:

modelTestFileFolder 在类中 AbstractPhpCodegen

setComposerVendorName

public void setComposerVendorName(String composerVendorName)

setComposerProjectName

public void setComposerProjectName(String composerProjectName)

setInvokerPackage

public void setInvokerPackage(String invokerPackage)

覆盖:

setInvokerPackage 在类中 AbstractPhpCodegen

getTypeDeclaration

public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)

从类复制的说明: DefaultCodegen

Output the type declaration of the property

指定者:

getTypeDeclaration 在接口中 CodegenConfig

覆盖:

getTypeDeclaration 在类中 AbstractPhpCodegen

参数:

p - property schema

返回:

a string presentation of the property type

getPropertyTypeDeclaration

public String getPropertyTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)

Output the type declaration of the property

参数:

p - OpenAPI Schema object

返回:

a string presentation of the property type

getTypeDeclaration

public String getTypeDeclaration(String name)

从类复制的说明: DefaultCodegen

Output the type declaration of a given name

指定者:

getTypeDeclaration 在接口中 CodegenConfig

覆盖:

getTypeDeclaration 在类中 AbstractPhpCodegen

参数:

name - name

返回:

a string presentation of the type

toModelImport

public String toModelImport(String name)

Return the fully-qualified "Model" name for import

指定者:

toModelImport 在接口中 CodegenConfig

覆盖:

toModelImport 在类中 DefaultCodegen

参数:

name - the name of the "Model"

返回:

the fully-qualified "Model" name for import

toEnumValue

public String toEnumValue(String value,
                          String datatype)

从类复制的说明: DefaultCodegen

Return the enum value in the language specified format e.g. status becomes "status"

覆盖:

toEnumValue 在类中 AbstractPhpCodegen

参数:

value - enum variable name

datatype - data type

返回:

the sanitized value for enum

toRegularExpression

public String toRegularExpression(String pattern)

Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)

覆盖:

toRegularExpression 在类中 DefaultCodegen

参数:

pattern - the pattern (regular expression)

返回:

properly-escaped pattern

toApiName

public String toApiName(String name)

从类复制的说明: DefaultCodegen

Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty

指定者:

toApiName 在接口中 CodegenConfig

覆盖:

toApiName 在类中 DefaultCodegen

参数:

name - the name of the Api

返回:

capitalized Api name ending with "Api"

toControllerName

protected String toControllerName(String name)

toSymfonyService

protected String toSymfonyService(String name)

getTypeHint

protected String getTypeHint(String type)

isModelClass

protected Boolean isModelClass(String type)