loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

minor improvements to Configuration php template (#4989)

Browse Source
This commit is contained in:
baartosz 2017-03-09 09:28:19 +00:00 committed by wing328
parent 4fe79f0078
commit cffaaa027a
2 changed files with 56 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
modules/swagger-codegen/src/main/resources/php/configuration.mustache
View File

@ -29,7 +29,7 @@ namespace {{invokerPackage}};
*/ */
class Configuration class Configuration
{ {
private static $defaultConfiguration = null; private static $defaultConfiguration;
/** /**
* Associate array to store API key(s) * Associate array to store API key(s)
@ -99,7 +99,7 @@ class Configuration
* *
* @var string * @var string
*/ */
protected $userAgent = "{{#httpUserAgent}}{{{.}}}{{/httpUserAgent}}{{^httpUserAgent}}Swagger-Codegen/{{#artifactVersion}}{{{.}}}{{/artifactVersion}}{{^artifactVersion}}1.0.0{{/artifactVersion}}/php{{/httpUserAgent}}"; protected $userAgent = '{{#httpUserAgent}}{{{.}}}{{/httpUserAgent}}{{^httpUserAgent}}Swagger-Codegen/{{#artifactVersion}}{{{.}}}{{/artifactVersion}}{{^artifactVersion}}1.0.0{{/artifactVersion}}/php{{/httpUserAgent}}';
/** /**
* Debug switch (default set to false) * Debug switch (default set to false)
@ -181,7 +181,7 @@ class Configuration
* @param string $apiKeyIdentifier API key identifier (authentication scheme) * @param string $apiKeyIdentifier API key identifier (authentication scheme)
* @param string $key API key or token * @param string $key API key or token
* *
* @return Configuration * @return $this
*/ */
public function setApiKey($apiKeyIdentifier, $key) public function setApiKey($apiKeyIdentifier, $key)
{ {
@ -207,7 +207,7 @@ class Configuration
* @param string $apiKeyIdentifier API key identifier (authentication scheme) * @param string $apiKeyIdentifier API key identifier (authentication scheme)
* @param string $prefix API key prefix, e.g. Bearer * @param string $prefix API key prefix, e.g. Bearer
* *
* @return Configuration * @return $this
*/ */
public function setApiKeyPrefix($apiKeyIdentifier, $prefix) public function setApiKeyPrefix($apiKeyIdentifier, $prefix)
{ {
@ -232,7 +232,7 @@ class Configuration
* *
* @param string $accessToken Token for OAuth * @param string $accessToken Token for OAuth
* *
* @return Configuration * @return $this
*/ */
public function setAccessToken($accessToken) public function setAccessToken($accessToken)
{ {
@ -255,7 +255,7 @@ class Configuration
* *
* @param string $username Username for HTTP basic authentication * @param string $username Username for HTTP basic authentication
* *
* @return Configuration * @return $this
*/ */
public function setUsername($username) public function setUsername($username)
{ {
@ -278,7 +278,7 @@ class Configuration
* *
* @param string $password Password for HTTP basic authentication * @param string $password Password for HTTP basic authentication
* *
* @return Configuration * @return $this
*/ */
public function setPassword($password) public function setPassword($password)
{ {
@ -302,7 +302,8 @@ class Configuration
* @param string $headerName header name (e.g. Token) * @param string $headerName header name (e.g. Token)
* @param string $headerValue header value (e.g. 1z8wp3) * @param string $headerValue header value (e.g. 1z8wp3)
* *
* @return Configuration * @throws \InvalidArgumentException
* @return $this
*/ */
public function addDefaultHeader($headerName, $headerValue) public function addDefaultHeader($headerName, $headerValue)
{ {
@ -329,11 +330,12 @@ class Configuration
* *
* @param string $headerName the header to delete * @param string $headerName the header to delete
* *
* @return Configuration * @return $this
*/ */
public function deleteDefaultHeader($headerName) public function deleteDefaultHeader($headerName)
{ {
unset($this->defaultHeaders[$headerName]); unset($this->defaultHeaders[$headerName]);
return $this;
} }
/** /**
@ -341,7 +343,7 @@ class Configuration
* *
* @param string $host Host * @param string $host Host
* *
* @return Configuration * @return $this
*/ */
public function setHost($host) public function setHost($host)
{ {
@ -364,7 +366,8 @@ class Configuration
* *
* @param string $userAgent the user agent of the api client * @param string $userAgent the user agent of the api client
* *
* @return Configuration * @throws \InvalidArgumentException
* @return $this
*/ */
public function setUserAgent($userAgent) public function setUserAgent($userAgent)
{ {
@ -391,7 +394,8 @@ class Configuration
* *
* @param integer $seconds Number of seconds before timing out [set to 0 for no timeout] * @param integer $seconds Number of seconds before timing out [set to 0 for no timeout]
* *
* @return Configuration * @throws \InvalidArgumentException
* @return $this
*/ */
public function setCurlTimeout($seconds) public function setCurlTimeout($seconds)
{ {
@ -418,7 +422,8 @@ class Configuration
* *
* @param integer $seconds Number of seconds before connection times out [set to 0 for no timeout] * @param integer $seconds Number of seconds before connection times out [set to 0 for no timeout]
* *
* @return Configuration * @throws \InvalidArgumentException
* @return $this
*/ */
public function setCurlConnectTimeout($seconds) public function setCurlConnectTimeout($seconds)
{ {
@ -446,7 +451,7 @@ class Configuration
* *
* @param string $proxyHost HTTP Proxy URL * @param string $proxyHost HTTP Proxy URL
* *
* @return ApiClient * @return $this
*/ */
public function setCurlProxyHost($proxyHost) public function setCurlProxyHost($proxyHost)
{ {
@ -469,7 +474,7 @@ class Configuration
* *
* @param integer $proxyPort HTTP Proxy Port * @param integer $proxyPort HTTP Proxy Port
* *
* @return ApiClient * @return $this
*/ */
public function setCurlProxyPort($proxyPort) public function setCurlProxyPort($proxyPort)
{ {
@ -492,7 +497,7 @@ class Configuration
* *
* @param integer $proxyType HTTP Proxy Type * @param integer $proxyType HTTP Proxy Type
* *
* @return ApiClient * @return $this
*/ */
public function setCurlProxyType($proxyType) public function setCurlProxyType($proxyType)
{ {
@ -515,7 +520,7 @@ class Configuration
* *
* @param string $proxyUser HTTP Proxy User * @param string $proxyUser HTTP Proxy User
* *
* @return ApiClient * @return $this
*/ */
public function setCurlProxyUser($proxyUser) public function setCurlProxyUser($proxyUser)
{ {
@ -538,7 +543,7 @@ class Configuration
* *
* @param string $proxyPassword HTTP Proxy Password * @param string $proxyPassword HTTP Proxy Password
* *
* @return ApiClient * @return $this
*/ */
public function setCurlProxyPassword($proxyPassword) public function setCurlProxyPassword($proxyPassword)
{ {
@ -561,7 +566,7 @@ class Configuration
* *
* @param bool $debug Debug flag * @param bool $debug Debug flag
* *
* @return Configuration * @return $this
*/ */
public function setDebug($debug) public function setDebug($debug)
{ {
@ -584,7 +589,7 @@ class Configuration
* *
* @param string $debugFile Debug file * @param string $debugFile Debug file
* *
* @return Configuration * @return $this
*/ */
public function setDebugFile($debugFile) public function setDebugFile($debugFile)
{ {
@ -607,7 +612,7 @@ class Configuration
* *
* @param string $tempFolderPath Temp folder path * @param string $tempFolderPath Temp folder path
* *
* @return Configuration * @return $this
*/ */
public function setTempFolderPath($tempFolderPath) public function setTempFolderPath($tempFolderPath)
{ {
@ -630,7 +635,7 @@ class Configuration
* *
* @param boolean $sslVerification True if the certificate should be validated, false otherwise * @param boolean $sslVerification True if the certificate should be validated, false otherwise
* *
* @return Configuration * @return $this
*/ */
public function setSSLVerification($sslVerification) public function setSSLVerification($sslVerification)
{ {
@ -683,7 +688,7 @@ class Configuration
{ {
$report = 'PHP SDK ({{invokerPackage}}) Debug Report:' . PHP_EOL; $report = 'PHP SDK ({{invokerPackage}}) Debug Report:' . PHP_EOL;
$report .= ' OS: ' . php_uname() . PHP_EOL; $report .= ' OS: ' . php_uname() . PHP_EOL;
$report .= ' PHP Version: ' . phpversion() . PHP_EOL; $report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL;
$report .= ' OpenAPI Spec Version: {{version}}' . PHP_EOL; $report .= ' OpenAPI Spec Version: {{version}}' . PHP_EOL;
{{#artifactVersion}} {{#artifactVersion}}
$report .= ' SDK Package Version: {{artifactVersion}}' . PHP_EOL; $report .= ' SDK Package Version: {{artifactVersion}}' . PHP_EOL;

51
samples/client/petstore/php/SwaggerClient-php/lib/Configuration.php
View File

@ -39,7 +39,7 @@ namespace Swagger\Client;
*/ */
class Configuration class Configuration
{ {
private static $defaultConfiguration = null; private static $defaultConfiguration;
/** /**
* Associate array to store API key(s) * Associate array to store API key(s)
@ -109,7 +109,7 @@ class Configuration
* *
* @var string * @var string
*/ */
protected $userAgent = "Swagger-Codegen/1.0.0/php"; protected $userAgent = 'Swagger-Codegen/1.0.0/php';
/** /**
* Debug switch (default set to false) * Debug switch (default set to false)
@ -191,7 +191,7 @@ class Configuration
* @param string $apiKeyIdentifier API key identifier (authentication scheme) * @param string $apiKeyIdentifier API key identifier (authentication scheme)
* @param string $key API key or token * @param string $key API key or token
* *
* @return Configuration * @return $this
*/ */
public function setApiKey($apiKeyIdentifier, $key) public function setApiKey($apiKeyIdentifier, $key)
{ {
@ -217,7 +217,7 @@ class Configuration
* @param string $apiKeyIdentifier API key identifier (authentication scheme) * @param string $apiKeyIdentifier API key identifier (authentication scheme)
* @param string $prefix API key prefix, e.g. Bearer * @param string $prefix API key prefix, e.g. Bearer
* *
* @return Configuration * @return $this
*/ */
public function setApiKeyPrefix($apiKeyIdentifier, $prefix) public function setApiKeyPrefix($apiKeyIdentifier, $prefix)
{ {
@ -242,7 +242,7 @@ class Configuration
* *
* @param string $accessToken Token for OAuth * @param string $accessToken Token for OAuth
* *
* @return Configuration * @return $this
*/ */
public function setAccessToken($accessToken) public function setAccessToken($accessToken)
{ {
@ -265,7 +265,7 @@ class Configuration
* *
* @param string $username Username for HTTP basic authentication * @param string $username Username for HTTP basic authentication
* *
* @return Configuration * @return $this
*/ */
public function setUsername($username) public function setUsername($username)
{ {
@ -288,7 +288,7 @@ class Configuration
* *
* @param string $password Password for HTTP basic authentication * @param string $password Password for HTTP basic authentication
* *
* @return Configuration * @return $this
*/ */
public function setPassword($password) public function setPassword($password)
{ {
@ -312,7 +312,8 @@ class Configuration
* @param string $headerName header name (e.g. Token) * @param string $headerName header name (e.g. Token)
* @param string $headerValue header value (e.g. 1z8wp3) * @param string $headerValue header value (e.g. 1z8wp3)
* *
* @return Configuration * @throws \InvalidArgumentException
* @return $this
*/ */
public function addDefaultHeader($headerName, $headerValue) public function addDefaultHeader($headerName, $headerValue)
{ {
@ -339,11 +340,12 @@ class Configuration
* *
* @param string $headerName the header to delete * @param string $headerName the header to delete
* *
* @return Configuration * @return $this
*/ */
public function deleteDefaultHeader($headerName) public function deleteDefaultHeader($headerName)
{ {
unset($this->defaultHeaders[$headerName]); unset($this->defaultHeaders[$headerName]);
return $this;
} }
/** /**
@ -351,7 +353,7 @@ class Configuration
* *
* @param string $host Host * @param string $host Host
* *
* @return Configuration * @return $this
*/ */
public function setHost($host) public function setHost($host)
{ {
@ -374,7 +376,8 @@ class Configuration
* *
* @param string $userAgent the user agent of the api client * @param string $userAgent the user agent of the api client
* *
* @return Configuration * @throws \InvalidArgumentException
* @return $this
*/ */
public function setUserAgent($userAgent) public function setUserAgent($userAgent)
{ {
@ -401,7 +404,8 @@ class Configuration
* *
* @param integer $seconds Number of seconds before timing out [set to 0 for no timeout] * @param integer $seconds Number of seconds before timing out [set to 0 for no timeout]
* *
* @return Configuration * @throws \InvalidArgumentException
* @return $this
*/ */
public function setCurlTimeout($seconds) public function setCurlTimeout($seconds)
{ {
@ -428,7 +432,8 @@ class Configuration
* *
* @param integer $seconds Number of seconds before connection times out [set to 0 for no timeout] * @param integer $seconds Number of seconds before connection times out [set to 0 for no timeout]
* *
* @return Configuration * @throws \InvalidArgumentException
* @return $this
*/ */
public function setCurlConnectTimeout($seconds) public function setCurlConnectTimeout($seconds)
{ {
@ -456,7 +461,7 @@ class Configuration
* *
* @param string $proxyHost HTTP Proxy URL * @param string $proxyHost HTTP Proxy URL
* *
* @return ApiClient * @return $this
*/ */
public function setCurlProxyHost($proxyHost) public function setCurlProxyHost($proxyHost)
{ {
@ -479,7 +484,7 @@ class Configuration
* *
* @param integer $proxyPort HTTP Proxy Port * @param integer $proxyPort HTTP Proxy Port
* *
* @return ApiClient * @return $this
*/ */
public function setCurlProxyPort($proxyPort) public function setCurlProxyPort($proxyPort)
{ {
@ -502,7 +507,7 @@ class Configuration
* *
* @param integer $proxyType HTTP Proxy Type * @param integer $proxyType HTTP Proxy Type
* *
* @return ApiClient * @return $this
*/ */
public function setCurlProxyType($proxyType) public function setCurlProxyType($proxyType)
{ {
@ -525,7 +530,7 @@ class Configuration
* *
* @param string $proxyUser HTTP Proxy User * @param string $proxyUser HTTP Proxy User
* *
* @return ApiClient * @return $this
*/ */
public function setCurlProxyUser($proxyUser) public function setCurlProxyUser($proxyUser)
{ {
@ -548,7 +553,7 @@ class Configuration
* *
* @param string $proxyPassword HTTP Proxy Password * @param string $proxyPassword HTTP Proxy Password
* *
* @return ApiClient * @return $this
*/ */
public function setCurlProxyPassword($proxyPassword) public function setCurlProxyPassword($proxyPassword)
{ {
@ -571,7 +576,7 @@ class Configuration
* *
* @param bool $debug Debug flag * @param bool $debug Debug flag
* *
* @return Configuration * @return $this
*/ */
public function setDebug($debug) public function setDebug($debug)
{ {
@ -594,7 +599,7 @@ class Configuration
* *
* @param string $debugFile Debug file * @param string $debugFile Debug file
* *
* @return Configuration * @return $this
*/ */
public function setDebugFile($debugFile) public function setDebugFile($debugFile)
{ {
@ -617,7 +622,7 @@ class Configuration
* *
* @param string $tempFolderPath Temp folder path * @param string $tempFolderPath Temp folder path
* *
* @return Configuration * @return $this
*/ */
public function setTempFolderPath($tempFolderPath) public function setTempFolderPath($tempFolderPath)
{ {
@ -640,7 +645,7 @@ class Configuration
* *
* @param boolean $sslVerification True if the certificate should be validated, false otherwise * @param boolean $sslVerification True if the certificate should be validated, false otherwise
* *
* @return Configuration * @return $this
*/ */
public function setSSLVerification($sslVerification) public function setSSLVerification($sslVerification)
{ {
@ -693,7 +698,7 @@ class Configuration
{ {
$report = 'PHP SDK (Swagger\Client) Debug Report:' . PHP_EOL; $report = 'PHP SDK (Swagger\Client) Debug Report:' . PHP_EOL;
$report .= ' OS: ' . php_uname() . PHP_EOL; $report .= ' OS: ' . php_uname() . PHP_EOL;
$report .= ' PHP Version: ' . phpversion() . PHP_EOL; $report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL;
$report .= ' OpenAPI Spec Version: 1.0.0' . PHP_EOL; $report .= ' OpenAPI Spec Version: 1.0.0' . PHP_EOL;
$report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL; $report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;