io.swagger.codegen.languages

Class SymfonyServerCodegen

java.lang.Object

io.swagger.codegen.DefaultCodegen

io.swagger.codegen.languages.AbstractPhpCodegen

io.swagger.codegen.languages.SymfonyServerCodegen

All Implemented Interfaces:

CodegenConfig

public class SymfonyServerCodegen
extends AbstractPhpCodegen
implements CodegenConfig

Field Summary

Fields

Modifier and Type	Field and Description
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

Fields inherited from class io.swagger.codegen.languages.AbstractPhpCodegen

apiDirName, apiDocPath, artifactVersion, docsBasePath, invokerPackage, modelDirName, modelDocPath, PACKAGE_PATH, packagePath, SRC_BASE_PATH, srcBasePath, testBasePath, VARIABLE_NAMING_CONVENTION, variableNamingConvention

Fields inherited from class io.swagger.codegen.DefaultCodegen

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

Constructor Summary

Constructors

Constructor and Description
SymfonyServerCodegen()

Method Summary

Modifier and Type	Method and 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 schema) Output the type declaration of the property
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema) 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>	postProcessOperations(Map<String,Object> objs)
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
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 io.swagger.codegen.languages.AbstractPhpCodegen

apiDocFileFolder, apiFileFolder, escapeQuotationMark, escapeUnsafeCharacters, extractSimpleName, getPackagePath, getSchemaType, modelDocFileFolder, modelFileFolder, setArtifactVersion, setPackagePath, setParameterExampleValue, setParameterNamingConvention, setSrcBasePath, toApiDocFilename, toDefaultValue, toEnumDefaultValue, toEnumName, toEnumVarName, toModelDocFilename, toModelFilename, toModelName, toModelTestFilename, toOperationId, toPackagePath, toParamName, toSrcPath, toVarName

Methods inherited from class io.swagger.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addConsumesInfo, addHandlebarHelpers, addImport, additionalProperties, addOperationToGroup, addProducesInfo, addProperties, addRegularExpressionDelimiter, apiDocFilename, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, dashize, defaultIncludes, detectParent, embeddedTemplateDir, fileSuffix, findMethodResponse, fromModel, fromModel, fromOperation, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getLibrary, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromResponse, getSimpleRef, getSymbolName, getterAndSetterCapitalize, hasSchemaProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, needToImport, outputFolder, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processOpenAPI, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoId, setGitUserId, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setReleaseNote, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, shouldOverwrite, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiFilename, toApiImport, toApiTestFilename, toApiVarName, toBooleanGetter, toDefaultValueWithParam, toExamples, toExampleValue, toGetter, toInstantiationType, toSetter, typeMapping, underscore, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.codegen.CodegenConfig

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

Field Detail

BUNDLE_NAME

public static final String BUNDLE_NAME

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

servicePackage

protected String servicePackage

phpLegacySupport

protected Boolean phpLegacySupport

typeHintable

protected HashSet<String> typeHintable

Constructor Detail

SymfonyServerCodegen

public SymfonyServerCodegen()

Method Detail

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)

Specified by:

escapeText in interface CodegenConfig

Overrides:

escapeText in class DefaultCodegen

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

postProcessOperations

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

Specified by:

postProcessOperations in interface CodegenConfig

Overrides:

postProcessOperations in class AbstractPhpCodegen

postProcessModels

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

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class AbstractPhpCodegen

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 schema)

Description copied from class: DefaultCodegen

Output the type declaration of the property

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class AbstractPhpCodegen

Parameters:

schema - Schema Property object

Returns:

a string presentation of the property type

getPropertyTypeDeclaration

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

Output the type declaration of the property

Parameters:

schema - Swagger Property object

Returns:

a string presentation of the property type

getTypeDeclaration

public String getTypeDeclaration(String name)

Description copied from class: DefaultCodegen

Output the type declaration of a given 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 "Api" 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 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)