public abstract class AbstractPhpCodegen extends DefaultCodegen implements CodegenConfig
| 限定符和类型 | 字段和说明 |
|---|---|
protected String |
abstractNamePrefix |
protected String |
abstractNameSuffix |
protected String |
apiDirName |
protected String |
apiDocPath |
protected String |
artifactVersion |
protected String |
docsBasePath |
protected String |
interfaceNamePrefix |
protected String |
interfaceNameSuffix |
protected String |
invokerPackage |
protected String |
modelDirName |
protected String |
modelDocPath |
static String |
PACKAGE_NAME |
protected String |
packageName |
static String |
SRC_BASE_PATH |
protected String |
srcBasePath |
protected String |
testBasePath |
protected String |
traitNamePrefix |
protected String |
traitNameSuffix |
static String |
VARIABLE_NAMING_CONVENTION |
protected String |
variableNamingConvention |
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| 构造器和说明 |
|---|
AbstractPhpCodegen() |
| 限定符和类型 | 方法和说明 |
|---|---|
String |
apiDocFileFolder() |
String |
apiFileFolder() |
String |
apiTestFileFolder() |
void |
escapeMediaType(List<CodegenOperation> operationList) |
String |
escapeQuotationMark(String input)
Escape single and/or double quote to avoid code injection
|
String |
escapeReservedWord(String name)
Return the escaped name of the reserved word
|
String |
escapeText(String input) |
String |
escapeUnsafeCharacters(String input)
override with any special text escaping logic to handle unsafe
characters so as to avoid code injection
|
protected String |
extractSimpleName(String phpClassName) |
String |
getInvokerPackage() |
String |
getPackageName() |
String |
getSchemaType(io.swagger.v3.oas.models.media.Schema p)
returns the OpenAPI type for the property.
|
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
|
String |
modelDocFileFolder() |
String |
modelFileFolder() |
String |
modelTestFileFolder() |
void |
postProcessFile(File file,
String fileType)
Post-process the auto-generated file, e.g. using go-fmt to format the Go code.
|
Map<String,Object> |
postProcessModels(Map<String,Object> objs) |
Map<String,Object> |
postProcessOperationsWithModels(Map<String,Object> objs,
List<Object> allModels) |
void |
processOpts() |
void |
setArtifactVersion(String artifactVersion) |
void |
setInvokerPackage(String invokerPackage) |
void |
setPackageName(String packageName) |
void |
setParameterExampleValue(CodegenParameter p)
Return the example value of the parameter.
|
void |
setParameterNamingConvention(String variableNamingConvention) |
void |
setSrcBasePath(String srcBasePath) |
String |
toAbstractName(String name)
Output the proper abstract class name (capitalized).
|
String |
toApiDocFilename(String name)
Return the file name of the Api Documentation
|
String |
toDefaultValue(io.swagger.v3.oas.models.media.Schema p)
Return the default value of the property
|
String |
toEnumDefaultValue(String value,
String datatype)
Return the enum default value in the language specified format
|
String |
toEnumName(CodegenProperty property)
Return the Enum name (e.g.
|
String |
toEnumValue(String value,
String datatype)
Return the enum value in the language specified format
e.g. status becomes "status"
|
String |
toEnumVarName(String name,
String datatype)
Return the sanitized variable name for enum
|
String |
toInterfaceName(String name)
Output the proper interface name (capitalized).
|
String |
toModelDocFilename(String name)
Return the capitalized file name of the model documentation
|
String |
toModelFilename(String name)
Return the capitalized file name of the model
|
String |
toModelName(String name)
Output the proper model name (capitalized).
|
String |
toModelTestFilename(String name)
Return the capitalized file name of the model test
|
String |
toOperationId(String operationId)
Return the operation ID (method name)
|
String |
toParamName(String name)
Return the parameter name by removing invalid characters and proper escaping if
it's a reserved word.
|
String |
toSrcPath(String packageName,
String basePath) |
String |
toTraitName(String name)
Output the proper trait name (capitalized).
|
String |
toVarName(String name)
Return the variable name by removing invalid characters and proper escaping if
it's a reserved word.
|
addAdditionPropertiesToCodeGenModel, addImport, additionalProperties, addOperationToGroup, addOption, addProperties, addRegularExpressionDelimiter, addSwitch, apiDocFilename, apiDocTemplateFiles, apiFilename, 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, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getMostInnerItems, getName, getOrGenerateOperationId, getOutputDir, getParameterDataType, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSymbolName, getTag, 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, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toGetter, toInstantiationType, toModelImport, toRegularExpression, toSetter, toSetter, typeMapping, underscore, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBackclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitadditionalProperties, addOperationToGroup, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, embeddedTemplateDir, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getCommonTemplateDir, getDocExtension, getGitRepoId, getGitUserId, getHelp, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getName, getOutputDir, getReleaseNote, getTag, importMapping, instantiationTypes, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveOperationIdPrefix, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, outputFolder, postProcessAllModels, 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, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelImport, toSetter, typeMapping, vendorExtensionsprotected String invokerPackage
protected String packageName
protected String artifactVersion
protected String srcBasePath
protected String testBasePath
protected String docsBasePath
protected String apiDirName
protected String modelDirName
protected String variableNamingConvention
protected String apiDocPath
protected String modelDocPath
protected String interfaceNamePrefix
protected String interfaceNameSuffix
protected String abstractNamePrefix
protected String abstractNameSuffix
protected String traitNamePrefix
protected String traitNameSuffix
public void processOpts()
processOpts 在接口中 CodegenConfigprocessOpts 在类中 DefaultCodegenpublic String getPackageName()
public String escapeReservedWord(String name)
DefaultCodegenescapeReservedWord 在接口中 CodegenConfigescapeReservedWord 在类中 DefaultCodegenname - the name to be escapedthrows Runtime exception as reserved word is not allowed (default behavior)
public String apiFileFolder()
apiFileFolder 在接口中 CodegenConfigapiFileFolder 在类中 DefaultCodegenpublic String modelFileFolder()
modelFileFolder 在接口中 CodegenConfigmodelFileFolder 在类中 DefaultCodegenpublic String apiTestFileFolder()
apiTestFileFolder 在接口中 CodegenConfigapiTestFileFolder 在类中 DefaultCodegenpublic String modelTestFileFolder()
modelTestFileFolder 在接口中 CodegenConfigmodelTestFileFolder 在类中 DefaultCodegenpublic String apiDocFileFolder()
apiDocFileFolder 在接口中 CodegenConfigapiDocFileFolder 在类中 DefaultCodegenpublic String modelDocFileFolder()
modelDocFileFolder 在接口中 CodegenConfigmodelDocFileFolder 在类中 DefaultCodegenpublic String toModelDocFilename(String name)
DefaultCodegentoModelDocFilename 在接口中 CodegenConfigtoModelDocFilename 在类中 DefaultCodegenname - the model namepublic String toApiDocFilename(String name)
DefaultCodegentoApiDocFilename 在接口中 CodegenConfigtoApiDocFilename 在类中 DefaultCodegenname - the file name of the Apipublic String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegengetTypeDeclaration 在接口中 CodegenConfiggetTypeDeclaration 在类中 DefaultCodegenp - property schemapublic String getTypeDeclaration(String name)
DefaultCodegengetTypeDeclaration 在接口中 CodegenConfiggetTypeDeclaration 在类中 DefaultCodegenname - namepublic String getSchemaType(io.swagger.v3.oas.models.media.Schema p)
DefaultCodegengetSchemaType 在类中 DefaultCodegenp - property schemapublic String getInvokerPackage()
public void setInvokerPackage(String invokerPackage)
public void setArtifactVersion(String artifactVersion)
public void setPackageName(String packageName)
public void setSrcBasePath(String srcBasePath)
public void setParameterNamingConvention(String variableNamingConvention)
public String toVarName(String name)
DefaultCodegentoVarName 在类中 DefaultCodegenname - the variable namepublic String toParamName(String name)
DefaultCodegentoParamName 在接口中 CodegenConfigtoParamName 在类中 DefaultCodegenname - Codegen property objectpublic String toModelName(String name)
DefaultCodegentoModelName 在接口中 CodegenConfigtoModelName 在类中 DefaultCodegenname - the name of the modelpublic String toModelFilename(String name)
DefaultCodegentoModelFilename 在接口中 CodegenConfigtoModelFilename 在类中 DefaultCodegenname - the model namepublic String toModelTestFilename(String name)
DefaultCodegentoModelTestFilename 在接口中 CodegenConfigtoModelTestFilename 在类中 DefaultCodegenname - the model namepublic String toInterfaceName(String name)
name - the name of the interfacepublic String toAbstractName(String name)
name - the name of the classpublic String toTraitName(String name)
name - the name of the traitpublic String toOperationId(String operationId)
DefaultCodegentoOperationId 在类中 DefaultCodegenoperationId - operation IDpublic String toDefaultValue(io.swagger.v3.oas.models.media.Schema p)
toDefaultValue 在类中 DefaultCodegenp - Swagger property objectpublic void setParameterExampleValue(CodegenParameter p)
DefaultCodegensetParameterExampleValue 在类中 DefaultCodegenp - Codegen parameterpublic String toEnumValue(String value, String datatype)
DefaultCodegentoEnumValue 在类中 DefaultCodegenvalue - enum variable namedatatype - data typepublic String toEnumDefaultValue(String value, String datatype)
DefaultCodegentoEnumDefaultValue 在类中 DefaultCodegenvalue - enum variable namedatatype - data typepublic String toEnumVarName(String name, String datatype)
DefaultCodegentoEnumVarName 在类中 DefaultCodegenname - enum variable namedatatype - data typepublic String toEnumName(CodegenProperty property)
DefaultCodegentoEnumName 在类中 DefaultCodegenproperty - Codegen propertypublic Map<String,Object> postProcessModels(Map<String,Object> objs)
postProcessModels 在接口中 CodegenConfigpostProcessModels 在类中 DefaultCodegenpublic Map<String,Object> postProcessOperationsWithModels(Map<String,Object> objs, List<Object> allModels)
public String escapeQuotationMark(String input)
DefaultCodegenescapeQuotationMark 在接口中 CodegenConfigescapeQuotationMark 在类中 DefaultCodegeninput - String to be cleaned uppublic String escapeUnsafeCharacters(String input)
DefaultCodegenescapeUnsafeCharacters 在接口中 CodegenConfigescapeUnsafeCharacters 在类中 DefaultCodegeninput - String to be cleaned uppublic String escapeText(String input)
escapeText 在接口中 CodegenConfigescapeText 在类中 DefaultCodegenpublic void escapeMediaType(List<CodegenOperation> operationList)
public void postProcessFile(File file, String fileType)
DefaultCodegenTODO: store these values in enum instead
postProcessFile 在接口中 CodegenConfigpostProcessFile 在类中 DefaultCodegenfile - file to be processedfileType - file typeCopyright © 2019. All rights reserved.