Skip to content

Latest commit

 

History

History
271 lines (247 loc) · 8.96 KB

File metadata and controls

271 lines (247 loc) · 8.96 KB
title
Documentation for the php Generator

METADATA

Property Value Notes
generator name php pass this to the generate command after -g
generator stability STABLE
generator type CLIENT
generator language PHP
generator default templating engine mustache
helpTxt Generates a PHP client library.

CONFIG OPTIONS

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

Option Description Values Default
allowUnicodeIdentifiers boolean, toggles whether unicode identifiers are allowed in names or not, default is false false
apiPackage package for generated api classes null
artifactUrl artifact URL in generated pom.xml null
artifactVersion The version to use in the composer package version field. e.g. 1.2.3 null
composerPackageName The name to use in the composer package name field. e.g. vendor/project (must be lowercase and consist of words separated by -, . or _). null
developerOrganization developer organization in generated pom.xml null
developerOrganizationUrl developer organization URL in generated pom.xml null
disallowAdditionalPropertiesIfNotPresent If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
false
The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.
true
Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.
true
ensureUniqueParams Whether to ensure parameter names are unique in an operation (rename parameters that are not). true
enumUnknownDefaultCase If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.
false
No changes to the enum's are made, this is the default option.
true
With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.
false
hideGenerationTimestamp boolean, toggles whether unicode identifiers are allowed in names or not, default is false true
invokerPackage The main namespace to use for all classes. e.g. Yay\Pets null
legacyDiscriminatorBehavior Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C# have this enabled by default).
true
The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.
false
The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.
true
library HTTP library template (sub-template) to use
guzzle
Guzzle
psr-18
psr/http-client-implementation, also known as PSR-18. (beta support)
guzzle
licenseName The name of the license null
modelPackage package for generated models null
packageName The main package name for classes. e.g. GeneratedPetstore null
prependFormOrBodyParameters Add form or body parameters to the beginning of the parameter list. false
sortModelPropertiesByRequiredFlag Sort model properties to place required parameters before optional parameters. true
sortParamsByRequiredFlag Sort method arguments to place required parameters before optional parameters. true
srcBasePath The directory to serve as source root. null
variableNamingConvention naming convention of variable name, e.g. camelCase. snake_case

IMPORT MAPPING

Type/Alias Imports

INSTANTIATION TYPES

Type/Alias Instantiated By
array array
map array

LANGUAGE PRIMITIVES

  • \DateTime
  • \SplFileObject
  • array
  • bool
  • boolean
  • byte
  • float
  • int
  • integer
  • mixed
  • number
  • object
  • string
  • void

RESERVED WORDS

  • __halt_compiler
  • _header_accept
  • _tempbody
  • abstract
  • and
  • array
  • as
  • break
  • callable
  • case
  • catch
  • class
  • clone
  • const
  • continue
  • declare
  • default
  • die
  • do
  • echo
  • else
  • elseif
  • empty
  • enddeclare
  • endfor
  • endforeach
  • endif
  • endswitch
  • endwhile
  • eval
  • exit
  • extends
  • final
  • for
  • foreach
  • formparams
  • function
  • global
  • goto
  • headerparams
  • httpbody
  • if
  • implements
  • include
  • include_once
  • instanceof
  • insteadof
  • interface
  • isset
  • list
  • namespace
  • new
  • or
  • print
  • private
  • protected
  • public
  • queryparams
  • require
  • require_once
  • resourcepath
  • return
  • static
  • switch
  • throw
  • trait
  • try
  • unset
  • use
  • var
  • while
  • xor

FEATURE SET

Client Modification Feature

Name Supported Defined By
BasePath ToolingExtension
Authorizations ToolingExtension
UserAgent ToolingExtension
MockServer ToolingExtension

Data Type Feature

Name Supported Defined By
Custom OAS2,OAS3
Int32 OAS2,OAS3
Int64 OAS2,OAS3
Float OAS2,OAS3
Double OAS2,OAS3
Decimal ToolingExtension
String OAS2,OAS3
Byte OAS2,OAS3
Binary OAS2,OAS3
Boolean OAS2,OAS3
Date OAS2,OAS3
DateTime OAS2,OAS3
Password OAS2,OAS3
File OAS2
Uuid
Array OAS2,OAS3
Null OAS3
AnyType OAS2,OAS3
Object OAS2,OAS3
Maps ToolingExtension
CollectionFormat OAS2
CollectionFormatMulti OAS2
Enum OAS2,OAS3
ArrayOfEnum ToolingExtension
ArrayOfModel ToolingExtension
ArrayOfCollectionOfPrimitives ToolingExtension
ArrayOfCollectionOfModel ToolingExtension
ArrayOfCollectionOfEnum ToolingExtension
MapOfEnum ToolingExtension
MapOfModel ToolingExtension
MapOfCollectionOfPrimitives ToolingExtension
MapOfCollectionOfModel ToolingExtension
MapOfCollectionOfEnum ToolingExtension

Documentation Feature

Name Supported Defined By
Readme ToolingExtension
Model ToolingExtension
Api ToolingExtension

Global Feature

Name Supported Defined By
Host OAS2,OAS3
BasePath OAS2,OAS3
Info OAS2,OAS3
Schemes OAS2,OAS3
PartialSchemes OAS2,OAS3
Consumes OAS2
Produces OAS2
ExternalDocumentation OAS2,OAS3
Examples OAS2,OAS3
XMLStructureDefinitions OAS2,OAS3
MultiServer OAS3
ParameterizedServer OAS3
ParameterStyling OAS3
Callbacks OAS3
LinkObjects OAS3

Parameter Feature

Name Supported Defined By
Path OAS2,OAS3
Query OAS2,OAS3
Header OAS2,OAS3
Body OAS2
FormUnencoded OAS2
FormMultipart OAS2
Cookie OAS3

Schema Support Feature

Name Supported Defined By
Simple OAS2,OAS3
Composite OAS2,OAS3
Polymorphism OAS2,OAS3
Union OAS3
allOf OAS2,OAS3
anyOf OAS3
oneOf OAS3
not OAS3

Security Feature

Name Supported Defined By
BasicAuth OAS2,OAS3
ApiKey OAS2,OAS3
OpenIDConnect OAS3
BearerToken OAS3
OAuth2_Implicit OAS2,OAS3
OAuth2_Password OAS2,OAS3
OAuth2_ClientCredentials OAS2,OAS3
OAuth2_AuthorizationCode OAS2,OAS3
SignatureAuth OAS3
AWSV4Signature ToolingExtension

Wire Format Feature

Name Supported Defined By
JSON OAS2,OAS3
XML OAS2,OAS3
PROTOBUF ToolingExtension
Custom OAS2,OAS3