Package org.openapitools.codegen.languages

Class PhpSymfonyServerCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractPhpCodegen

org.openapitools.codegen.languages.PhpSymfonyServerCodegen

All Implemented Interfaces:

CodegenConfig

public class PhpSymfonyServerCodegen
extends AbstractPhpCodegen
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiTestsPackage
static String	BUNDLE_ALIAS
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	controllerTestsPackage
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

Fields inherited from class org.openapitools.codegen.languages.AbstractPhpCodegen

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

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, DefaultFeatureSet, defaultIncludes, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumUnknownDefaultCase, enumUnknownDefaultCaseName, falseSchema, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importBaseType, importContainerType, importMapping, inlineSchemaNameMapping, inlineSchemaOption, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, loadDeepObjectIntoItems, modelDocTemplateFiles, modelNameMapping, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openAPI, openapiNormalizer, outputFolder, parameterNameMapping, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, schemaMapping, serverVariables, skipOperationExample, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename, XML_MIME_PATTERN

Constructor Summary

Constructors

Constructor	Description
PhpSymfonyServerCodegen()

Method Summary

Modifier and Type	Method	Description
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 language-specific type declaration of the property.
String	getTypeDeclaration(String name)	Output the language-specific type declaration of a given OAS name.
protected String	getTypeHint(String type)
protected String	getTypeHintNullable(String type)
protected String	getTypeHintNullableForComments(String type)
protected Boolean	isModelClass(String type)
String	modelTestFileFolder()
ModelsMap	postProcessModels(ModelsMap objs)
OperationsMap	postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)
String	prependSlashToDataTypeOnlyIfNecessary(String dataType)
void	processOpts()
void	setBundleAlias(String alias)
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 the specified or default suffix Return DefaultApi if name is empty
String	toBooleanGetter(String name)	Output the Getter name for boolean property, e.g.
protected String	toControllerName(String name)
String	toEnumValue(String value, String datatype)	Return the enum value in the language specified format e.g.
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)

Methods inherited from class org.openapitools.codegen.languages.AbstractPhpCodegen

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

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addBodyModelSchema, addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFilename, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getEnumDefaultValue, getEnumUnknownDefaultCase, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getModelNameToSchemaCache, getMostInnerItems, getOneOfAnyOfDescendants, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenAPINormalizer, getVersionMetadataFilename, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isAnyTypeSchema, isDataTypeBinary, isDataTypeFile, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isReservedWord, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, isXmlMimeType, languageSpecificPrimitives, lowerCamelCase, modelDocTemplateFiles, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestTemplateFiles, modifyFeatureSet, nameMapping, needToImport, openapiNormalizer, outputFolder, parameterNameMapping, postProcess, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setAddProps, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterExampleValue, setParameterExampleValue, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, setVersionMetadataFilename, shouldAddImport, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toArrayModelParamName, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelImportMap, toOneOfName, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForObject, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, vendorExtensions, writePropertyBack

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFileFolder, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, escapeQuotationMark, escapeTextWhileAllowingNewLines, escapeUnsafeCharacters, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguage, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getUseInlineModelResolver, getUseOpenAPINormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openapiNormalizer, outputFolder, parameterNameMapping, postProcess, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toGetter, toModelDocFilename, toModelFilename, toModelImportMap, toModelName, toModelTestFilename, toParamName, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

Field Detail

BUNDLE_NAME

public static final String BUNDLE_NAME

See Also:

Constant Field Values

BUNDLE_ALIAS

public static final String BUNDLE_ALIAS

See Also:

Constant Field Values

COMPOSER_VENDOR_NAME

public static final String COMPOSER_VENDOR_NAME

See Also:

Constant Field Values

COMPOSER_PROJECT_NAME

public static final String COMPOSER_PROJECT_NAME

See Also:

Constant Field Values

PHP_LEGACY_SUPPORT

public static final String PHP_LEGACY_SUPPORT

See Also:

Constant Field Values

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

controllerTestsPackage

protected String controllerTestsPackage

servicePackage

protected String servicePackage

phpLegacySupport

protected Boolean phpLegacySupport

typeHintable

protected HashSet<String> typeHintable

Constructor Detail

PhpSymfonyServerCodegen

public PhpSymfonyServerCodegen()

Method Detail

getBundleName

public String getBundleName()

setBundleName

public void setBundleName(String bundleName)

setBundleAlias

public void setBundleAlias(String alias)

setPhpLegacySupport

public void setPhpLegacySupport(Boolean support)

controllerFileFolder

public String controllerFileFolder()

escapeText

public String escapeText(String input)

Specified by:

escapeText in interface CodegenConfig

Overrides:

escapeText in class AbstractPhpCodegen

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class DefaultCodegen

getName

public String getName()

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

apiFilename

public String apiFilename(String templateName,
                          String tag)

Specified by:

apiFilename in interface CodegenConfig

Overrides:

apiFilename in class DefaultCodegen

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractPhpCodegen

postProcessOperationsWithModels

public OperationsMap postProcessOperationsWithModels(OperationsMap objs,
                                                     List<ModelMap> allModels)

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class AbstractPhpCodegen

postProcessModels

public ModelsMap postProcessModels(ModelsMap objs)

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class AbstractPhpCodegen

prependSlashToDataTypeOnlyIfNecessary

public String prependSlashToDataTypeOnlyIfNecessary(String dataType)

toBooleanGetter

public String toBooleanGetter(String name)

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

Specified by:

toBooleanGetter in interface CodegenConfig

Overrides:

toBooleanGetter in class DefaultCodegen

Parameters:

name - the name of the property

Returns:

getter name based on naming convention

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: DefaultCodegen

Return the escaped name of the reserved word

Specified by:

escapeReservedWord in interface CodegenConfig

Overrides:

escapeReservedWord in class AbstractPhpCodegen

Parameters:

name - the name to be escaped

Returns:

the escaped reserved word

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

apiTestFileFolder

public String apiTestFileFolder()

Specified by:

apiTestFileFolder in interface CodegenConfig

Overrides:

apiTestFileFolder in class AbstractPhpCodegen

modelTestFileFolder

public String modelTestFileFolder()

Specified by:

modelTestFileFolder in interface CodegenConfig

Overrides:

modelTestFileFolder in class AbstractPhpCodegen

setComposerVendorName

public void setComposerVendorName(String composerVendorName)

setComposerProjectName

public void setComposerProjectName(String composerProjectName)

setInvokerPackage

public void setInvokerPackage(String invokerPackage)

Overrides:

setInvokerPackage in class AbstractPhpCodegen

getTypeDeclaration

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

Description copied from class: DefaultCodegen

Output the language-specific type declaration of the property.

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class AbstractPhpCodegen

Parameters:

p - property schema

Returns:

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

Parameters:

p - OpenAPI Schema object

Returns:

a string presentation of the property type

getTypeDeclaration

public String getTypeDeclaration(String name)

Description copied from class: DefaultCodegen

Output the language-specific type declaration of a given OAS name.

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class AbstractPhpCodegen

Parameters:

name - name

Returns:

a string presentation of the type

toModelImport

public String toModelImport(String name)

Return the fully-qualified "Model" name for import

Specified by:

toModelImport in interface CodegenConfig

Overrides:

toModelImport in class DefaultCodegen

Parameters:

name - the name of the "Model"

Returns:

the fully-qualified "Model" name for import

toEnumValue

public String toEnumValue(String value,
                          String datatype)

Description copied from class: DefaultCodegen

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

Overrides:

toEnumValue in class AbstractPhpCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

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)

Overrides:

toRegularExpression in class DefaultCodegen

Parameters:

pattern - the pattern (regular expression)

Returns:

properly-escaped pattern

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegen

Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty

Specified by:

toApiName in interface CodegenConfig

Overrides:

toApiName in class DefaultCodegen

Parameters:

name - the name of the Api

Returns:

capitalized Api name

toControllerName

protected String toControllerName(String name)

toSymfonyService

protected String toSymfonyService(String name)

getTypeHintNullable

protected String getTypeHintNullable(String type)

getTypeHintNullableForComments

protected String getTypeHintNullableForComments(String type)

getTypeHint

protected String getTypeHint(String type)

isModelClass

protected Boolean isModelClass(String type)