From f154e407d2e8cd06f2b798c53788301dddea5bc0 Mon Sep 17 00:00:00 2001 From: wing328 Date: Mon, 13 Jul 2015 00:53:32 +0800 Subject: [PATCH] update coding style based on CodeSniffer --- .../src/main/resources/php/ApiClient.mustache | 106 +++- .../main/resources/php/ApiException.mustache | 78 ++- .../resources/php/ObjectSerializer.mustache | 97 +++- .../src/main/resources/php/api.mustache | 88 ++- .../main/resources/php/configuration.mustache | 333 ++++++++--- .../src/main/resources/php/model.mustache | 122 +++- .../php/SwaggerClient-php/lib/Api/PetApi.php | 266 +++++---- .../SwaggerClient-php/lib/Api/StoreApi.php | 168 ++++-- .../php/SwaggerClient-php/lib/Api/UserApi.php | 244 +++++--- .../php/SwaggerClient-php/lib/ApiClient.php | 106 +++- .../SwaggerClient-php/lib/ApiException.php | 78 ++- .../SwaggerClient-php/lib/Configuration.php | 333 ++++++++--- .../SwaggerClient-php/lib/Model/Category.php | 135 ++++- .../php/SwaggerClient-php/lib/Model/Order.php | 203 +++++-- .../php/SwaggerClient-php/lib/Model/Pet.php | 203 +++++-- .../php/SwaggerClient-php/lib/Model/Tag.php | 135 ++++- .../php/SwaggerClient-php/lib/Model/User.php | 237 +++++--- .../lib/ObjectSerializer.php | 97 +++- .../php/SwaggerClient-php/lib/PetApi.php | 543 ------------------ .../php/SwaggerClient-php/lib/StoreApi.php | 294 ---------- .../php/SwaggerClient-php/lib/UserApi.php | 518 ----------------- 21 files changed, 2203 insertions(+), 2181 deletions(-) delete mode 100644 samples/client/petstore/php/SwaggerClient-php/lib/PetApi.php delete mode 100644 samples/client/petstore/php/SwaggerClient-php/lib/StoreApi.php delete mode 100644 samples/client/petstore/php/SwaggerClient-php/lib/UserApi.php diff --git a/modules/swagger-codegen/src/main/resources/php/ApiClient.mustache b/modules/swagger-codegen/src/main/resources/php/ApiClient.mustache index 158c9c662c00..3c6819ab73be 100644 --- a/modules/swagger-codegen/src/main/resources/php/ApiClient.mustache +++ b/modules/swagger-codegen/src/main/resources/php/ApiClient.mustache @@ -1,4 +1,15 @@ config; } /** - * get the serializer + * Get the serializer * @return ObjectSerializer */ - public function getSerializer() { + public function getSerializer() + { return $this->serializer; } /** * Get API key (with prefix if set) - * @param string $apiKey name of apikey + * @param string $apiKeyIdentifier name of apikey * @return string API key with the prefix */ - public function getApiKeyWithPrefix($apiKeyIdentifier) { + public function getApiKeyWithPrefix($apiKeyIdentifier) + { $prefix = $this->config->getApiKeyPrefix($apiKeyIdentifier); $apiKey = $this->config->getApiKey($apiKeyIdentifier); @@ -82,20 +119,26 @@ class ApiClient { } /** + * Make the HTTP call (Sync) * @param string $resourcePath path to method endpoint - * @param string $method method to call - * @param array $queryParams parameters to be place in query URL - * @param array $postData parameters to be placed in POST body - * @param array $headerParams parameters to be place in request header + * @param string $method method to call + * @param array $queryParams parameters to be place in query URL + * @param array $postData parameters to be placed in POST body + * @param array $headerParams parameters to be place in request header + * @param string $responseType expected response type of the endpoint * @throws \{{invokerPackage}}\ApiException on a non 2xx response * @return mixed */ - public function callApi($resourcePath, $method, $queryParams, $postData, $headerParams, $responseType=null) { + public function callApi($resourcePath, $method, $queryParams, $postData, $headerParams, $responseType=null) + { $headers = array(); - # construct the http header - $headerParams = array_merge((array)$this->config->getDefaultHeaders(), (array)$headerParams); + // construct the http header + $headerParams = array_merge( + (array)$this->config->getDefaultHeaders(), + (array)$headerParams + ); foreach ($headerParams as $key => $val) { $headers[] = "$key: $val"; @@ -104,8 +147,7 @@ class ApiClient { // form data if ($postData and in_array('Content-Type: application/x-www-form-urlencoded', $headers)) { $postData = http_build_query($postData); - } - else if ((is_object($postData) or is_array($postData)) and !in_array('Content-Type: multipart/form-data', $headers)) { // json model + } else if ((is_object($postData) or is_array($postData)) and !in_array('Content-Type: multipart/form-data', $headers)) { // json model $postData = json_encode($this->serializer->sanitizeForSerialization($postData)); } @@ -184,21 +226,25 @@ class ApiClient { $data = $http_body; } } else { - throw new ApiException("[".$response_info['http_code']."] Error connecting to the API ($url)", - $response_info['http_code'], $http_header, $http_body); + throw new ApiException( + "[".$response_info['http_code']."] Error connecting to the API ($url)", + $response_info['http_code'], $http_header, $http_body + ); } return array($data, $http_header); } - /* - * return the header 'Accept' based on an array of Accept provided + /** + * Return the header 'Accept' based on an array of Accept provided * * @param string[] $accept Array of header + * * @return string Accept (e.g. application/json) */ - public static function selectHeaderAccept($accept) { + public static function selectHeaderAccept($accept) + { if (count($accept) === 0 or (count($accept) === 1 and $accept[0] === '')) { - return NULL; + return null; } elseif (preg_grep("/application\/json/i", $accept)) { return 'application/json'; } else { @@ -206,13 +252,15 @@ class ApiClient { } } - /* - * return the content type based on an array of content-type provided + /** + * Return the content type based on an array of content-type provided + * + * @param string[] $content_type Array fo content-type * - * @param string[] content_type_array Array fo content-type * @return string Content-Type (e.g. application/json) */ - public static function selectHeaderContentType($content_type) { + public static function selectHeaderContentType($content_type) + { if (count($content_type) === 0 or (count($content_type) === 1 and $content_type[0] === '')) { return 'application/json'; } elseif (preg_grep("/application\/json/i", $content_type)) { diff --git a/modules/swagger-codegen/src/main/resources/php/ApiException.mustache b/modules/swagger-codegen/src/main/resources/php/ApiException.mustache index c57310ccece4..79d1b4fe0a15 100644 --- a/modules/swagger-codegen/src/main/resources/php/ApiException.mustache +++ b/modules/swagger-codegen/src/main/resources/php/ApiException.mustache @@ -1,4 +1,14 @@ responseHeaders = $responseHeaders; $this->responseBody = $responseBody; } /** - * Get the HTTP response header + * Gets the HTTP response header * * @return string HTTP response header */ - public function getResponseHeaders() { + public function getResponseHeaders() + { return $this->responseHeaders; } /** - * Get the HTTP response body + * Gets the HTTP response body * * @return string HTTP response body */ - public function getResponseBody() { + public function getResponseBody() + { return $this->responseBody; } /** - * sets the deseralized response object (during deserialization) - * @param mixed $obj + * Sets the deseralized response object (during deserialization) + * @param mixed $obj Deserialized response object + * @return void */ - public function setResponseObject($obj) { + public function setResponseObject($obj) + { $this->responseObject = $obj; } - - public function getResponseObject() { + + /** + * Gets the deseralized response object (during deserialization) + * + * @return mixed the deserialized response object + */ + public function getResponseObject() + { return $this->responseObject; } } diff --git a/modules/swagger-codegen/src/main/resources/php/ObjectSerializer.mustache b/modules/swagger-codegen/src/main/resources/php/ObjectSerializer.mustache index 930313865c76..1d63440b66fd 100644 --- a/modules/swagger-codegen/src/main/resources/php/ObjectSerializer.mustache +++ b/modules/swagger-codegen/src/main/resources/php/ObjectSerializer.mustache @@ -1,14 +1,59 @@ toString($value)); } @@ -49,10 +97,13 @@ class ObjectSerializer { * the query, by imploding comma-separated if it's an object. * If it's a string, pass through unchanged. It will be url-encoded * later. + * * @param object $object an object to be serialized to a string + * * @return string the serialized object */ - public function toQueryValue($object) { + public function toQueryValue($object) + { if (is_array($object)) { return implode(',', $object); } else { @@ -64,10 +115,13 @@ class ObjectSerializer { * Take value and turn it into a string suitable for inclusion in * the header. If it's a string, pass through unchanged * If it's a datetime object, format it in ISO8601 + * * @param string $value a string which will be part of the header + * * @return string the header string */ - public function toHeaderValue($value) { + public function toHeaderValue($value) + { return $this->toString($value); } @@ -75,10 +129,13 @@ class ObjectSerializer { * Take value and turn it into a string suitable for inclusion in * the http body (form parameter). If it's a string, pass through unchanged * If it's a datetime object, format it in ISO8601 + * * @param string $value the value of the form parameter + * * @return string the form string */ - public function toFormValue($value) { + public function toFormValue($value) + { if ($value instanceof SplFileObject) { return $value->getRealPath(); } else { @@ -90,10 +147,13 @@ class ObjectSerializer { * Take value and turn it into a string suitable for inclusion in * the parameter. If it's a string, pass through unchanged * If it's a datetime object, format it in ISO8601 + * * @param string $value the value of the parameter + * * @return string the header string */ - public function toString($value) { + public function toString($value) + { if ($value instanceof \DateTime) { // datetime in ISO8601 format return $value->format(\DateTime::ISO8601); } else { @@ -104,37 +164,40 @@ class ObjectSerializer { /** * Deserialize a JSON string into an object * - * @param mixed $data object or primitive to be deserialized - * @param string $class class name is passed as a string + * @param mixed $data object or primitive to be deserialized + * @param string $class class name is passed as a string + * @param string $httpHeader HTTP headers + * * @return object an instance of $class */ - public function deserialize($data, $class, $httpHeader=null) { + public function deserialize($data, $class, $httpHeader=null) + { if (null === $data) { $deserialized = null; - } elseif (substr($class, 0, 4) == 'map[') { # for associative array e.g. map[string,int] + } elseif (substr($class, 0, 4) === 'map[') { // for associative array e.g. map[string,int] $inner = substr($class, 4, -1); $deserialized = array(); - if(strrpos($inner, ",") !== false) { + if (strrpos($inner, ",") !== false) { $subClass_array = explode(',', $inner, 2); $subClass = $subClass_array[1]; foreach ($data as $key => $value) { $deserialized[$key] = $this->deserialize($value, $subClass); } } - } elseif (strcasecmp(substr($class, -2),'[]') == 0) { + } elseif (strcasecmp(substr($class, -2), '[]') == 0) { $subClass = substr($class, 0, -2); $values = array(); foreach ($data as $key => $value) { $values[] = $this->deserialize($value, $subClass); } $deserialized = $values; - } elseif ($class == 'DateTime') { + } elseif ($class === 'DateTime') { $deserialized = new \DateTime($data); } elseif (in_array($class, array('string', 'int', 'float', 'double', 'bool', 'object'))) { settype($data, $class); $deserialized = $data; } elseif ($class === '\SplFileObject') { - # determine file name + // determine file name if (preg_match('/Content-Disposition: inline; filename=[\'"]?([^\'"\s]+)[\'"]?$/i', $httpHeader, $match)) { $filename = Configuration::getDefaultConfiguration()->getTempFolderPath().$match[1]; } else { @@ -142,7 +205,7 @@ class ObjectSerializer { } $deserialized = new \SplFileObject($filename, "w"); $byte_written = $deserialized->fwrite($data); - error_log("[INFO] Written $byte_written byte to $filename. Please move the file to a proper folder or delete the temp file after processing.\n" , 3, Configuration::getDefaultConfiguration()->getDebugFile()); + error_log("[INFO] Written $byte_written byte to $filename. Please move the file to a proper folder or delete the temp file after processing.\n", 3, Configuration::getDefaultConfiguration()->getDebugFile()); } else { $instance = new $class(); @@ -150,7 +213,7 @@ class ObjectSerializer { $propertySetter = $instance::$setters[$property]; if (!isset($propertySetter) || !isset($data->{$instance::$attributeMap[$property]})) { - continue; + continue; } $propertyValue = $data->{$instance::$attributeMap[$property]}; diff --git a/modules/swagger-codegen/src/main/resources/php/api.mustache b/modules/swagger-codegen/src/main/resources/php/api.mustache index 6255a59d8e02..bb40ae7a98d6 100644 --- a/modules/swagger-codegen/src/main/resources/php/api.mustache +++ b/modules/swagger-codegen/src/main/resources/php/api.mustache @@ -1,4 +1,14 @@ getConfig()->setHost('{{basePath}}'); @@ -46,17 +71,21 @@ class {{classname}} { } /** + * Get API client * @return \{{invokerPackage}}\ApiClient get the API client */ - public function getApiClient() { + public function getApiClient() + { return $this->apiClient; } /** + * Set the API client * @param \{{invokerPackage}}\ApiClient $apiClient set the API client * @return {{classname}} */ - public function setApiClient(ApiClient $apiClient) { + public function setApiClient(ApiClient $apiClient) + { $this->apiClient = $apiClient; return $this; } @@ -71,7 +100,8 @@ class {{classname}} { {{/allParams}} * @return {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} * @throws \{{invokerPackage}}\ApiException on non-2xx response */ - public function {{nickname}}({{#allParams}}${{paramName}}{{^required}}=null{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) { + public function {{nickname}}({{#allParams}}${{paramName}}{{^required}}=null{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) + { {{#allParams}}{{#required}} // verify the required parameter '{{paramName}}' is set if (${{paramName}} === null) { @@ -93,18 +123,20 @@ class {{classname}} { $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array({{#consumes}}'{{mediaType}}'{{#hasMore}},{{/hasMore}}{{/consumes}})); {{#queryParams}}// query params - if(${{paramName}} !== null) { + if (${{paramName}} !== null) { $queryParams['{{baseName}}'] = $this->apiClient->getSerializer()->toQueryValue(${{paramName}}); }{{/queryParams}} {{#headerParams}}// header params - if(${{paramName}} !== null) { + if (${{paramName}} !== null) { $headerParams['{{baseName}}'] = $this->apiClient->getSerializer()->toHeaderValue(${{paramName}}); }{{/headerParams}} {{#pathParams}}// path params - if(${{paramName}} !== null) { - $resourcePath = str_replace("{" . "{{baseName}}" . "}", - $this->apiClient->getSerializer()->toPathValue(${{paramName}}), - $resourcePath); + if (${{paramName}} !== null) { + $resourcePath = str_replace( + "{" . "{{baseName}}" . "}", + $this->apiClient->getSerializer()->toPathValue(${{paramName}}), + $resourcePath + ); }{{/pathParams}} {{#formParams}}// form params if (${{paramName}} !== null) { @@ -120,8 +152,7 @@ class {{classname}} { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } {{#authMethods}}{{#isApiKey}} $apiKey = $this->apiClient->getApiKeyWithPrefix('{{keyParamName}}'); @@ -132,16 +163,19 @@ class {{classname}} { {{#isOAuth}}//TODO support oauth{{/isOAuth}} {{/authMethods}} // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams{{#returnType}}, '{{returnType}}'{{/returnType}}); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams{{#returnType}}, '{{returnType}}'{{/returnType}} + ); } catch (ApiException $e) { switch ($e->getCode()) { {{#responses}}{{#dataType}} - case {{code}}: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '{{dataType}}', $httpHeader); - $e->setResponseObject($data); - break;{{/dataType}}{{/responses}} + case {{code}}: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '{{dataType}}', $httpHeader); + $e->setResponseObject($data); + break;{{/dataType}}{{/responses}} } throw $e; @@ -151,7 +185,7 @@ class {{classname}} { return null; } - return $this->apiClient->getSerializer()->deserialize($response,'{{returnType}}'); + return $this->apiClient->getSerializer()->deserialize($response, '{{returnType}}'); {{/returnType}} } {{/operation}} diff --git a/modules/swagger-codegen/src/main/resources/php/configuration.mustache b/modules/swagger-codegen/src/main/resources/php/configuration.mustache index a1d8c78c40eb..73d4000d950f 100644 --- a/modules/swagger-codegen/src/main/resources/php/configuration.mustache +++ b/modules/swagger-codegen/src/main/resources/php/configuration.mustache @@ -1,4 +1,15 @@ tempFolderPath = sys_get_temp_dir(); } /** - * @param string $key - * @param string $value + * Sets API key + * + * @param string $apiKeyIdentifier API key identifier (authentication scheme) + * @param string $key API key or token + * * @return Configuration */ - public function setApiKey($key, $value) { - $this->apiKeys[$key] = $value; - return $this; + public function setApiKey($apiKeyIdentifier, $key) + { + $this->apiKeys[$apiKeyIdentifier] = $key; + return $this; } /** - * @param $key + * Gets API key + * + * @param string $apiKeyIdentifier API key identifier (authentication scheme) + * + * @return string API key or token + */ + public function getApiKey($apiKeyIdentifier) + { + return isset($this->apiKeys[$apiKeyIdentifier]) ? $this->apiKeys[$apiKeyIdentifier] : null; + } + + /** + * Sets the prefix for API key (e.g. Bearer) + * + * @param string $apiKeyIdentifier API key identifier (authentication scheme) + * @param string $prefix API key prefix, e.g. Bearer + * + * @return Configuration + */ + public function setApiKeyPrefix($apiKeyIdentifier, $prefix) + { + $this->apiKeyPrefixes[$apiKeyIdentifier] = $prefix; + return $this; + } + + /** + * Gets API key prefix + * + * @param string $apiKeyIdentifier API key identifier (authentication scheme) + * * @return string */ - public function getApiKey($key) { - return isset($this->apiKeys[$key]) ? $this->apiKeys[$key] : null; + public function getApiKeyPrefix($apiKeyIdentifier) + { + return isset($this->apiKeyPrefixes[$apiKeyIdentifier]) ? $this->apiKeyPrefixes[$apiKeyIdentifier] : null; } /** - * @param string $key - * @param string $value + * Sets the username for HTTP basic authentication + * + * @param string $username Username for HTTP basic authentication + * * @return Configuration */ - public function setApiKeyPrefix($key, $value) { - $this->apiKeyPrefixes[$key] = $value; - return $this; - } - - /** - * @param $key - * @return string - */ - public function getApiKeyPrefix($key) { - return isset($this->apiKeyPrefixes[$key]) ? $this->apiKeyPrefixes[$key] : null; - } - - /** - * @param string $username - * @return Configuration - */ - public function setUsername($username) { + public function setUsername($username) + { $this->username = $username; return $this; } /** - * @return string + * Gets the username for HTTP basic authentication + * + * @return string Username for HTTP basic authentication */ - public function getUsername() { + public function getUsername() + { return $this->username; } /** - * @param string $password + * Sets the password for HTTP basic authentication + * + * @param string $password Password for HTTP basic authentication + * * @return Configuration */ - public function setPassword($password) { + public function setPassword($password) + { $this->password = $password; return $this; } /** - * @return string + * Gets the password for HTTP basic authentication + * + * @return string Password for HTTP basic authentication */ - public function getPassword() { + public function getPassword() + { return $this->password; } /** - * add default header + * Adds a default header * - * @param string $headerName header name (e.g. Token) + * @param string $headerName header name (e.g. Token) * @param string $headerValue header value (e.g. 1z8wp3) + * * @return ApiClient */ - public function addDefaultHeader($headerName, $headerValue) { + public function addDefaultHeader($headerName, $headerValue) + { if (!is_string($headerName)) { throw new \InvalidArgumentException('Header name must be a string.'); } @@ -146,46 +251,59 @@ class Configuration { } /** - * get the default header + * Gets the default header * - * @return array default header + * @return array An array of default header(s) */ - public function getDefaultHeaders() { + public function getDefaultHeaders() + { return $this->defaultHeaders; } /** - * delete a default header + * Deletes a default header + * * @param string $headerName the header to delete + * * @return Configuration */ - public function deleteDefaultHeader($headerName) { + public function deleteDefaultHeader($headerName) + { unset($this->defaultHeaders[$headerName]); } /** - * @param string $host + * Sets the host + * + * @param string $host Host + * * @return Configuration */ - public function setHost($host) { + public function setHost($host) + { $this->host = $host; return $this; } /** - * @return string + * Gets the host + * + * @return string Host */ - public function getHost() { + public function getHost() + { return $this->host; } /** - * set the user agent of the api client + * Sets the user agent of the api client * * @param string $userAgent the user agent of the api client + * * @return ApiClient */ - public function setUserAgent($userAgent) { + public function setUserAgent($userAgent) + { if (!is_string($userAgent)) { throw new \InvalidArgumentException('User-agent must be a string.'); } @@ -195,21 +313,24 @@ class Configuration { } /** - * get the user agent of the api client + * Gets the user agent of the api client * * @return string user agent */ - public function getUserAgent() { + public function getUserAgent() + { return $this->userAgent; } /** - * set the HTTP timeout value + * Sets the HTTP timeout value * * @param integer $seconds Number of seconds before timing out [set to 0 for no timeout] + * * @return ApiClient */ - public function setCurlTimeout($seconds) { + public function setCurlTimeout($seconds) + { if (!is_numeric($seconds) || $seconds < 0) { throw new \InvalidArgumentException('Timeout value must be numeric and a non-negative number.'); } @@ -219,85 +340,117 @@ class Configuration { } /** - * get the HTTP timeout value + * Gets the HTTP timeout value * * @return string HTTP timeout value */ - public function getCurlTimeout() { + public function getCurlTimeout() + { return $this->curlTimeout; } /** - * @param bool $debug + * Sets debug flag + * + * @param bool $debug Debug flag + * * @return Configuration */ - public function setDebug($debug) { + public function setDebug($debug) + { $this->debug = $debug; return $this; } /** + * Gets the debug flag + * * @return bool */ - public function getDebug() { + public function getDebug() + { return $this->debug; } /** - * @param string $debugFile + * Sets the debug file + * + * @param string $debugFile Debug file + * * @return Configuration */ - public function setDebugFile($debugFile) { + public function setDebugFile($debugFile) + { $this->debugFile = $debugFile; return $this; } /** + * Gets the debug file + * * @return string */ - public function getDebugFile() { + public function getDebugFile() + { return $this->debugFile; } /** - * @param string $tempFolderPath + * Sets the temp folder path + * + * @param string $tempFolderPath Temp folder path + * * @return Configuration */ - public function setTempFolderPath($tempFolderPath) { + public function setTempFolderPath($tempFolderPath) + { $this->tempFolderPath = $tempFolderPath; return $this; } /** - * @return string + * Gets the temp folder path + * + * @return string Temp folder path */ - public function getTempFolderPath() { + public function getTempFolderPath() + { return $this->tempFolderPath; } - /** + * Gets the default configuration instance + * * @return Configuration */ - public static function getDefaultConfiguration() { - if (self::$defaultConfiguration == null) { - self::$defaultConfiguration = new Configuration(); + public static function getDefaultConfiguration() + { + if (self::$_defaultConfiguration == null) { + self::$_defaultConfiguration = new Configuration(); } - return self::$defaultConfiguration; + return self::$_defaultConfiguration; } /** - * @param Configuration $config + * Sets the detault configuration instance + * + * @param Configuration $config An instance of the Configuration Object + * + * @return void */ - public static function setDefaultConfiguration(Configuration $config) { - self::$defaultConfiguration = $config; + public static function setDefaultConfiguration(Configuration $config) + { + self::$_defaultConfiguration = $config; } - /* - * return the report for debugging + /** + * Gets the essential information for debugging + * + * @return string The report for debugging */ - public static function toDebugReport() { + public static function toDebugReport() + { $report = "PHP SDK ({{invokerPackage}}) Debug Report:\n"; $report .= " OS: ".php_uname()."\n"; $report .= " PHP Version: ".phpversion()."\n"; diff --git a/modules/swagger-codegen/src/main/resources/php/model.mustache b/modules/swagger-codegen/src/main/resources/php/model.mustache index df4ddc0b4f06..861673982f22 100644 --- a/modules/swagger-codegen/src/main/resources/php/model.mustache +++ b/modules/swagger-codegen/src/main/resources/php/model.mustache @@ -1,4 +1,17 @@ '{{{datatype}}}'{{#hasMore}}, {{/hasMore}}{{/vars}} ); - /** @var string[] Array of attributes where the key is the local name, and the value is the original name */ + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ static $attributeMap = array( {{#vars}}'{{name}}' => '{{baseName}}'{{#hasMore}}, {{/hasMore}}{{/vars}} ); - /** @var string[] Array of attributes to setter functions (for deserialization of responses) */ + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ static $setters = array( {{#vars}}'{{name}}' => '{{setter}}'{{#hasMore}}, {{/hasMore}}{{/vars}} ); - /** @var string[] Array of attributes to getter functions (for serialization of requests) */ + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ static $getters = array( {{#vars}}'{{name}}' => '{{getter}}'{{#hasMore}}, {{/hasMore}}{{/vars}} ); {{#vars}} - /** @var {{datatype}} ${{name}} {{#description}}{{{description}}} {{/description}}*/ + /** + * ${{name}} {{#description}}{{{description}}}{{/description}} + * @var {{datatype}} + */ protected ${{name}}; {{/vars}} - public function __construct(array $data = null) { + + /** + * Constructor + * @param mixed[] $data Associated array of property value initalizing the model + */ + public function __construct(array $data = null) + { if ($data != null) { {{#vars}}$this->{{name}} = $data["{{name}}"];{{#hasMore}} {{/hasMore}}{{/vars}} @@ -65,19 +105,21 @@ class {{classname}} implements ArrayAccess { } {{#vars}} /** - * get {{name}} + * Gets {{name}} * @return {{datatype}} */ - public function {{getter}}() { + public function {{getter}}() + { return $this->{{name}}; } /** - * set {{name}} - * @param {{datatype}} ${{name}} + * Sets {{name}} + * @param {{datatype}} ${{name}} {{#description}}{{{description}}}{{/description}} * @return $this */ - public function {{setter}}(${{name}}) { + public function {{setter}}(${{name}}) + { {{#isEnum}}$allowed_values = array({{#allowableValues}}{{#values}}"{{{this}}}"{{^-last}}, {{/-last}}{{/values}}{{/allowableValues}}); if (!in_array(${{{name}}}, $allowed_values)) { throw new \InvalidArgumentException("Invalid value for '{{name}}', must be one of {{#allowableValues}}{{#values}}'{{{this}}}'{{^-last}}, {{/-last}}{{/values}}{{/allowableValues}}"); @@ -86,23 +128,53 @@ class {{classname}} implements ArrayAccess { return $this; } {{/vars}} - public function offsetExists($offset) { + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { return isset($this->$offset); } - public function offsetGet($offset) { + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + public function offsetGet($offset) + { return $this->$offset; } - public function offsetSet($offset, $value) { + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + public function offsetSet($offset, $value) + { $this->$offset = $value; } - public function offsetUnset($offset) { + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + public function offsetUnset($offset) + { unset($this->$offset); } - public function __toString() { + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { if (defined('JSON_PRETTY_PRINT')) { return json_encode(get_object_vars($this), JSON_PRETTY_PRINT); } else { diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/Api/PetApi.php b/samples/client/petstore/php/SwaggerClient-php/lib/Api/PetApi.php index 3620252ea513..e9fef44a3ba1 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/Api/PetApi.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/Api/PetApi.php @@ -1,4 +1,14 @@ getConfig()->setHost('http://petstore.swagger.io/v2'); @@ -45,17 +71,21 @@ class PetApi { } /** + * Get API client * @return \Swagger\Client\ApiClient get the API client */ - public function getApiClient() { + public function getApiClient() + { return $this->apiClient; } /** + * Set the API client * @param \Swagger\Client\ApiClient $apiClient set the API client * @return PetApi */ - public function setApiClient(ApiClient $apiClient) { + public function setApiClient(ApiClient $apiClient) + { $this->apiClient = $apiClient; return $this; } @@ -67,10 +97,12 @@ class PetApi { * Update an existing pet * * @param \Swagger\Client\Model\Pet $body Pet object that needs to be added to the store (required) + * * @return void * @throws \Swagger\Client\ApiException on non-2xx response */ - public function updatePet($body) { + public function updatePet($body) + { // parse inputs @@ -101,18 +133,20 @@ class PetApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } //TODO support oauth // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams + ); } catch (ApiException $e) { switch ($e->getCode()) { } @@ -128,10 +162,12 @@ class PetApi { * Add a new pet to the store * * @param \Swagger\Client\Model\Pet $body Pet object that needs to be added to the store (required) + * * @return void * @throws \Swagger\Client\ApiException on non-2xx response */ - public function addPet($body) { + public function addPet($body) + { // parse inputs @@ -162,18 +198,20 @@ class PetApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } //TODO support oauth // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams + ); } catch (ApiException $e) { switch ($e->getCode()) { } @@ -189,10 +227,12 @@ class PetApi { * Finds Pets by status * * @param string[] $status Status values that need to be considered for filter (required) + * * @return \Swagger\Client\Model\Pet[] * @throws \Swagger\Client\ApiException on non-2xx response */ - public function findPetsByStatus($status) { + public function findPetsByStatus($status) + { // parse inputs @@ -210,7 +250,7 @@ class PetApi { $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array()); // query params - if($status !== null) { + if ($status !== null) { $queryParams['status'] = $this->apiClient->getSerializer()->toQueryValue($status); } @@ -222,24 +262,26 @@ class PetApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } //TODO support oauth // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, '\Swagger\Client\Model\Pet[]'); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams, '\Swagger\Client\Model\Pet[]' + ); } catch (ApiException $e) { switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\Swagger\Client\Model\Pet[]', $httpHeader); - $e->setResponseObject($data); - break; + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\Swagger\Client\Model\Pet[]', $httpHeader); + $e->setResponseObject($data); + break; } throw $e; @@ -249,7 +291,7 @@ class PetApi { return null; } - return $this->apiClient->getSerializer()->deserialize($response,'\Swagger\Client\Model\Pet[]'); + return $this->apiClient->getSerializer()->deserialize($response, '\Swagger\Client\Model\Pet[]'); } @@ -259,10 +301,12 @@ class PetApi { * Finds Pets by tags * * @param string[] $tags Tags to filter by (required) + * * @return \Swagger\Client\Model\Pet[] * @throws \Swagger\Client\ApiException on non-2xx response */ - public function findPetsByTags($tags) { + public function findPetsByTags($tags) + { // parse inputs @@ -280,7 +324,7 @@ class PetApi { $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array()); // query params - if($tags !== null) { + if ($tags !== null) { $queryParams['tags'] = $this->apiClient->getSerializer()->toQueryValue($tags); } @@ -292,24 +336,26 @@ class PetApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } //TODO support oauth // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, '\Swagger\Client\Model\Pet[]'); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams, '\Swagger\Client\Model\Pet[]' + ); } catch (ApiException $e) { switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\Swagger\Client\Model\Pet[]', $httpHeader); - $e->setResponseObject($data); - break; + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\Swagger\Client\Model\Pet[]', $httpHeader); + $e->setResponseObject($data); + break; } throw $e; @@ -319,7 +365,7 @@ class PetApi { return null; } - return $this->apiClient->getSerializer()->deserialize($response,'\Swagger\Client\Model\Pet[]'); + return $this->apiClient->getSerializer()->deserialize($response, '\Swagger\Client\Model\Pet[]'); } @@ -329,10 +375,12 @@ class PetApi { * Find pet by ID * * @param int $pet_id ID of pet that needs to be fetched (required) + * * @return \Swagger\Client\Model\Pet * @throws \Swagger\Client\ApiException on non-2xx response */ - public function getPetById($pet_id) { + public function getPetById($pet_id) + { // verify the required parameter 'pet_id' is set if ($pet_id === null) { throw new \InvalidArgumentException('Missing the required parameter $pet_id when calling getPetById'); @@ -355,10 +403,12 @@ class PetApi { // path params - if($pet_id !== null) { - $resourcePath = str_replace("{" . "petId" . "}", - $this->apiClient->getSerializer()->toPathValue($pet_id), - $resourcePath); + if ($pet_id !== null) { + $resourcePath = str_replace( + "{" . "petId" . "}", + $this->apiClient->getSerializer()->toPathValue($pet_id), + $resourcePath + ); } @@ -367,8 +417,7 @@ class PetApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } $apiKey = $this->apiClient->getApiKeyWithPrefix('api_key'); @@ -382,16 +431,19 @@ class PetApi { //TODO support oauth // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, '\Swagger\Client\Model\Pet'); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams, '\Swagger\Client\Model\Pet' + ); } catch (ApiException $e) { switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\Swagger\Client\Model\Pet', $httpHeader); - $e->setResponseObject($data); - break; + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\Swagger\Client\Model\Pet', $httpHeader); + $e->setResponseObject($data); + break; } throw $e; @@ -401,7 +453,7 @@ class PetApi { return null; } - return $this->apiClient->getSerializer()->deserialize($response,'\Swagger\Client\Model\Pet'); + return $this->apiClient->getSerializer()->deserialize($response, '\Swagger\Client\Model\Pet'); } @@ -413,10 +465,12 @@ class PetApi { * @param string $pet_id ID of pet that needs to be updated (required) * @param string $name Updated name of the pet (required) * @param string $status Updated status of the pet (required) + * * @return void * @throws \Swagger\Client\ApiException on non-2xx response */ - public function updatePetWithForm($pet_id, $name, $status) { + public function updatePetWithForm($pet_id, $name, $status) + { // verify the required parameter 'pet_id' is set if ($pet_id === null) { throw new \InvalidArgumentException('Missing the required parameter $pet_id when calling updatePetWithForm'); @@ -439,10 +493,12 @@ class PetApi { // path params - if($pet_id !== null) { - $resourcePath = str_replace("{" . "petId" . "}", - $this->apiClient->getSerializer()->toPathValue($pet_id), - $resourcePath); + if ($pet_id !== null) { + $resourcePath = str_replace( + "{" . "petId" . "}", + $this->apiClient->getSerializer()->toPathValue($pet_id), + $resourcePath + ); } // form params if ($name !== null) { @@ -457,18 +513,20 @@ class PetApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } //TODO support oauth // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams + ); } catch (ApiException $e) { switch ($e->getCode()) { } @@ -485,10 +543,12 @@ class PetApi { * * @param string $api_key (required) * @param int $pet_id Pet id to delete (required) + * * @return void * @throws \Swagger\Client\ApiException on non-2xx response */ - public function deletePet($api_key, $pet_id) { + public function deletePet($api_key, $pet_id) + { // verify the required parameter 'pet_id' is set if ($pet_id === null) { throw new \InvalidArgumentException('Missing the required parameter $pet_id when calling deletePet'); @@ -510,14 +570,16 @@ class PetApi { // header params - if($api_key !== null) { + if ($api_key !== null) { $headerParams['api_key'] = $this->apiClient->getSerializer()->toHeaderValue($api_key); } // path params - if($pet_id !== null) { - $resourcePath = str_replace("{" . "petId" . "}", - $this->apiClient->getSerializer()->toPathValue($pet_id), - $resourcePath); + if ($pet_id !== null) { + $resourcePath = str_replace( + "{" . "petId" . "}", + $this->apiClient->getSerializer()->toPathValue($pet_id), + $resourcePath + ); } @@ -526,18 +588,20 @@ class PetApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } //TODO support oauth // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams + ); } catch (ApiException $e) { switch ($e->getCode()) { } @@ -555,10 +619,12 @@ class PetApi { * @param int $pet_id ID of pet to update (required) * @param string $additional_metadata Additional data to pass to server (required) * @param \SplFileObject $file file to upload (required) + * * @return void * @throws \Swagger\Client\ApiException on non-2xx response */ - public function uploadFile($pet_id, $additional_metadata, $file) { + public function uploadFile($pet_id, $additional_metadata, $file) + { // verify the required parameter 'pet_id' is set if ($pet_id === null) { throw new \InvalidArgumentException('Missing the required parameter $pet_id when calling uploadFile'); @@ -581,10 +647,12 @@ class PetApi { // path params - if($pet_id !== null) { - $resourcePath = str_replace("{" . "petId" . "}", - $this->apiClient->getSerializer()->toPathValue($pet_id), - $resourcePath); + if ($pet_id !== null) { + $resourcePath = str_replace( + "{" . "petId" . "}", + $this->apiClient->getSerializer()->toPathValue($pet_id), + $resourcePath + ); } // form params if ($additional_metadata !== null) { @@ -599,18 +667,20 @@ class PetApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } //TODO support oauth // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams + ); } catch (ApiException $e) { switch ($e->getCode()) { } diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/Api/StoreApi.php b/samples/client/petstore/php/SwaggerClient-php/lib/Api/StoreApi.php index 9947628fdf68..5ad1da9e887c 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/Api/StoreApi.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/Api/StoreApi.php @@ -1,4 +1,14 @@ getConfig()->setHost('http://petstore.swagger.io/v2'); @@ -45,17 +71,21 @@ class StoreApi { } /** + * Get API client * @return \Swagger\Client\ApiClient get the API client */ - public function getApiClient() { + public function getApiClient() + { return $this->apiClient; } /** + * Set the API client * @param \Swagger\Client\ApiClient $apiClient set the API client * @return StoreApi */ - public function setApiClient(ApiClient $apiClient) { + public function setApiClient(ApiClient $apiClient) + { $this->apiClient = $apiClient; return $this; } @@ -66,10 +96,12 @@ class StoreApi { * * Returns pet inventories by status * + * * @return map[string,int] * @throws \Swagger\Client\ApiException on non-2xx response */ - public function getInventory() { + public function getInventory() + { // parse inputs @@ -96,8 +128,7 @@ class StoreApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } $apiKey = $this->apiClient->getApiKeyWithPrefix('api_key'); @@ -108,16 +139,19 @@ class StoreApi { // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, 'map[string,int]'); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams, 'map[string,int]' + ); } catch (ApiException $e) { switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), 'map[string,int]', $httpHeader); - $e->setResponseObject($data); - break; + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), 'map[string,int]', $httpHeader); + $e->setResponseObject($data); + break; } throw $e; @@ -127,7 +161,7 @@ class StoreApi { return null; } - return $this->apiClient->getSerializer()->deserialize($response,'map[string,int]'); + return $this->apiClient->getSerializer()->deserialize($response, 'map[string,int]'); } @@ -137,10 +171,12 @@ class StoreApi { * Place an order for a pet * * @param \Swagger\Client\Model\Order $body order placed for purchasing the pet (required) + * * @return \Swagger\Client\Model\Order * @throws \Swagger\Client\ApiException on non-2xx response */ - public function placeOrder($body) { + public function placeOrder($body) + { // parse inputs @@ -171,21 +207,23 @@ class StoreApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, '\Swagger\Client\Model\Order'); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams, '\Swagger\Client\Model\Order' + ); } catch (ApiException $e) { switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\Swagger\Client\Model\Order', $httpHeader); - $e->setResponseObject($data); - break; + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\Swagger\Client\Model\Order', $httpHeader); + $e->setResponseObject($data); + break; } throw $e; @@ -195,7 +233,7 @@ class StoreApi { return null; } - return $this->apiClient->getSerializer()->deserialize($response,'\Swagger\Client\Model\Order'); + return $this->apiClient->getSerializer()->deserialize($response, '\Swagger\Client\Model\Order'); } @@ -205,10 +243,12 @@ class StoreApi { * Find purchase order by ID * * @param string $order_id ID of pet that needs to be fetched (required) + * * @return \Swagger\Client\Model\Order * @throws \Swagger\Client\ApiException on non-2xx response */ - public function getOrderById($order_id) { + public function getOrderById($order_id) + { // verify the required parameter 'order_id' is set if ($order_id === null) { throw new \InvalidArgumentException('Missing the required parameter $order_id when calling getOrderById'); @@ -231,10 +271,12 @@ class StoreApi { // path params - if($order_id !== null) { - $resourcePath = str_replace("{" . "orderId" . "}", - $this->apiClient->getSerializer()->toPathValue($order_id), - $resourcePath); + if ($order_id !== null) { + $resourcePath = str_replace( + "{" . "orderId" . "}", + $this->apiClient->getSerializer()->toPathValue($order_id), + $resourcePath + ); } @@ -243,21 +285,23 @@ class StoreApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, '\Swagger\Client\Model\Order'); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams, '\Swagger\Client\Model\Order' + ); } catch (ApiException $e) { switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\Swagger\Client\Model\Order', $httpHeader); - $e->setResponseObject($data); - break; + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\Swagger\Client\Model\Order', $httpHeader); + $e->setResponseObject($data); + break; } throw $e; @@ -267,7 +311,7 @@ class StoreApi { return null; } - return $this->apiClient->getSerializer()->deserialize($response,'\Swagger\Client\Model\Order'); + return $this->apiClient->getSerializer()->deserialize($response, '\Swagger\Client\Model\Order'); } @@ -277,10 +321,12 @@ class StoreApi { * Delete purchase order by ID * * @param string $order_id ID of the order that needs to be deleted (required) + * * @return void * @throws \Swagger\Client\ApiException on non-2xx response */ - public function deleteOrder($order_id) { + public function deleteOrder($order_id) + { // verify the required parameter 'order_id' is set if ($order_id === null) { throw new \InvalidArgumentException('Missing the required parameter $order_id when calling deleteOrder'); @@ -303,10 +349,12 @@ class StoreApi { // path params - if($order_id !== null) { - $resourcePath = str_replace("{" . "orderId" . "}", - $this->apiClient->getSerializer()->toPathValue($order_id), - $resourcePath); + if ($order_id !== null) { + $resourcePath = str_replace( + "{" . "orderId" . "}", + $this->apiClient->getSerializer()->toPathValue($order_id), + $resourcePath + ); } @@ -315,15 +363,17 @@ class StoreApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams + ); } catch (ApiException $e) { switch ($e->getCode()) { } diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/Api/UserApi.php b/samples/client/petstore/php/SwaggerClient-php/lib/Api/UserApi.php index d0b98f348e31..37f739c50eaf 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/Api/UserApi.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/Api/UserApi.php @@ -1,4 +1,14 @@ getConfig()->setHost('http://petstore.swagger.io/v2'); @@ -45,17 +71,21 @@ class UserApi { } /** + * Get API client * @return \Swagger\Client\ApiClient get the API client */ - public function getApiClient() { + public function getApiClient() + { return $this->apiClient; } /** + * Set the API client * @param \Swagger\Client\ApiClient $apiClient set the API client * @return UserApi */ - public function setApiClient(ApiClient $apiClient) { + public function setApiClient(ApiClient $apiClient) + { $this->apiClient = $apiClient; return $this; } @@ -67,10 +97,12 @@ class UserApi { * Create user * * @param \Swagger\Client\Model\User $body Created user object (required) + * * @return void * @throws \Swagger\Client\ApiException on non-2xx response */ - public function createUser($body) { + public function createUser($body) + { // parse inputs @@ -101,15 +133,17 @@ class UserApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams + ); } catch (ApiException $e) { switch ($e->getCode()) { } @@ -125,10 +159,12 @@ class UserApi { * Creates list of users with given input array * * @param \Swagger\Client\Model\User[] $body List of user object (required) + * * @return void * @throws \Swagger\Client\ApiException on non-2xx response */ - public function createUsersWithArrayInput($body) { + public function createUsersWithArrayInput($body) + { // parse inputs @@ -159,15 +195,17 @@ class UserApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams + ); } catch (ApiException $e) { switch ($e->getCode()) { } @@ -183,10 +221,12 @@ class UserApi { * Creates list of users with given input array * * @param \Swagger\Client\Model\User[] $body List of user object (required) + * * @return void * @throws \Swagger\Client\ApiException on non-2xx response */ - public function createUsersWithListInput($body) { + public function createUsersWithListInput($body) + { // parse inputs @@ -217,15 +257,17 @@ class UserApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams + ); } catch (ApiException $e) { switch ($e->getCode()) { } @@ -242,10 +284,12 @@ class UserApi { * * @param string $username The user name for login (required) * @param string $password The password for login in clear text (required) + * * @return string * @throws \Swagger\Client\ApiException on non-2xx response */ - public function loginUser($username, $password) { + public function loginUser($username, $password) + { // parse inputs @@ -263,10 +307,10 @@ class UserApi { $headerParams['Content-Type'] = ApiClient::selectHeaderContentType(array()); // query params - if($username !== null) { + if ($username !== null) { $queryParams['username'] = $this->apiClient->getSerializer()->toQueryValue($username); }// query params - if($password !== null) { + if ($password !== null) { $queryParams['password'] = $this->apiClient->getSerializer()->toQueryValue($password); } @@ -278,21 +322,23 @@ class UserApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, 'string'); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams, 'string' + ); } catch (ApiException $e) { switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), 'string', $httpHeader); - $e->setResponseObject($data); - break; + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), 'string', $httpHeader); + $e->setResponseObject($data); + break; } throw $e; @@ -302,7 +348,7 @@ class UserApi { return null; } - return $this->apiClient->getSerializer()->deserialize($response,'string'); + return $this->apiClient->getSerializer()->deserialize($response, 'string'); } @@ -311,10 +357,12 @@ class UserApi { * * Logs out current logged in user session * + * * @return void * @throws \Swagger\Client\ApiException on non-2xx response */ - public function logoutUser() { + public function logoutUser() + { // parse inputs @@ -341,15 +389,17 @@ class UserApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams + ); } catch (ApiException $e) { switch ($e->getCode()) { } @@ -365,10 +415,12 @@ class UserApi { * Get user by user name * * @param string $username The name that needs to be fetched. Use user1 for testing. (required) + * * @return \Swagger\Client\Model\User * @throws \Swagger\Client\ApiException on non-2xx response */ - public function getUserByName($username) { + public function getUserByName($username) + { // verify the required parameter 'username' is set if ($username === null) { throw new \InvalidArgumentException('Missing the required parameter $username when calling getUserByName'); @@ -391,10 +443,12 @@ class UserApi { // path params - if($username !== null) { - $resourcePath = str_replace("{" . "username" . "}", - $this->apiClient->getSerializer()->toPathValue($username), - $resourcePath); + if ($username !== null) { + $resourcePath = str_replace( + "{" . "username" . "}", + $this->apiClient->getSerializer()->toPathValue($username), + $resourcePath + ); } @@ -403,21 +457,23 @@ class UserApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, '\Swagger\Client\Model\User'); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams, '\Swagger\Client\Model\User' + ); } catch (ApiException $e) { switch ($e->getCode()) { - case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\Swagger\Client\Model\User', $httpHeader); - $e->setResponseObject($data); - break; + case 200: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\Swagger\Client\Model\User', $httpHeader); + $e->setResponseObject($data); + break; } throw $e; @@ -427,7 +483,7 @@ class UserApi { return null; } - return $this->apiClient->getSerializer()->deserialize($response,'\Swagger\Client\Model\User'); + return $this->apiClient->getSerializer()->deserialize($response, '\Swagger\Client\Model\User'); } @@ -438,10 +494,12 @@ class UserApi { * * @param string $username name that need to be deleted (required) * @param \Swagger\Client\Model\User $body Updated user object (required) + * * @return void * @throws \Swagger\Client\ApiException on non-2xx response */ - public function updateUser($username, $body) { + public function updateUser($username, $body) + { // verify the required parameter 'username' is set if ($username === null) { throw new \InvalidArgumentException('Missing the required parameter $username when calling updateUser'); @@ -464,10 +522,12 @@ class UserApi { // path params - if($username !== null) { - $resourcePath = str_replace("{" . "username" . "}", - $this->apiClient->getSerializer()->toPathValue($username), - $resourcePath); + if ($username !== null) { + $resourcePath = str_replace( + "{" . "username" . "}", + $this->apiClient->getSerializer()->toPathValue($username), + $resourcePath + ); } // body params @@ -480,15 +540,17 @@ class UserApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams + ); } catch (ApiException $e) { switch ($e->getCode()) { } @@ -504,10 +566,12 @@ class UserApi { * Delete user * * @param string $username The name that needs to be deleted (required) + * * @return void * @throws \Swagger\Client\ApiException on non-2xx response */ - public function deleteUser($username) { + public function deleteUser($username) + { // verify the required parameter 'username' is set if ($username === null) { throw new \InvalidArgumentException('Missing the required parameter $username when calling deleteUser'); @@ -530,10 +594,12 @@ class UserApi { // path params - if($username !== null) { - $resourcePath = str_replace("{" . "username" . "}", - $this->apiClient->getSerializer()->toPathValue($username), - $resourcePath); + if ($username !== null) { + $resourcePath = str_replace( + "{" . "username" . "}", + $this->apiClient->getSerializer()->toPathValue($username), + $resourcePath + ); } @@ -542,15 +608,17 @@ class UserApi { if (isset($_tempBody)) { $httpBody = $_tempBody; // $_tempBody is the method argument, if present } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; + $httpBody = $formParams; // for HTTP post (form) } // make the API Call - try { - list($response, $httpHeader) = $this->apiClient->callApi($resourcePath, $method, - $queryParams, $httpBody, - $headerParams); + try + { + list($response, $httpHeader) = $this->apiClient->callApi( + $resourcePath, $method, + $queryParams, $httpBody, + $headerParams + ); } catch (ApiException $e) { switch ($e->getCode()) { } diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/ApiClient.php b/samples/client/petstore/php/SwaggerClient-php/lib/ApiClient.php index 1f466389cfdb..bf4f4e482bf6 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/ApiClient.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/ApiClient.php @@ -1,4 +1,15 @@ config; } /** - * get the serializer + * Get the serializer * @return ObjectSerializer */ - public function getSerializer() { + public function getSerializer() + { return $this->serializer; } /** * Get API key (with prefix if set) - * @param string $apiKey name of apikey + * @param string $apiKeyIdentifier name of apikey * @return string API key with the prefix */ - public function getApiKeyWithPrefix($apiKeyIdentifier) { + public function getApiKeyWithPrefix($apiKeyIdentifier) + { $prefix = $this->config->getApiKeyPrefix($apiKeyIdentifier); $apiKey = $this->config->getApiKey($apiKeyIdentifier); @@ -82,20 +119,26 @@ class ApiClient { } /** + * Make the HTTP call (Sync) * @param string $resourcePath path to method endpoint - * @param string $method method to call - * @param array $queryParams parameters to be place in query URL - * @param array $postData parameters to be placed in POST body - * @param array $headerParams parameters to be place in request header + * @param string $method method to call + * @param array $queryParams parameters to be place in query URL + * @param array $postData parameters to be placed in POST body + * @param array $headerParams parameters to be place in request header + * @param string $responseType expected response type of the endpoint * @throws \Swagger\Client\ApiException on a non 2xx response * @return mixed */ - public function callApi($resourcePath, $method, $queryParams, $postData, $headerParams, $responseType=null) { + public function callApi($resourcePath, $method, $queryParams, $postData, $headerParams, $responseType=null) + { $headers = array(); - # construct the http header - $headerParams = array_merge((array)$this->config->getDefaultHeaders(), (array)$headerParams); + // construct the http header + $headerParams = array_merge( + (array)$this->config->getDefaultHeaders(), + (array)$headerParams + ); foreach ($headerParams as $key => $val) { $headers[] = "$key: $val"; @@ -104,8 +147,7 @@ class ApiClient { // form data if ($postData and in_array('Content-Type: application/x-www-form-urlencoded', $headers)) { $postData = http_build_query($postData); - } - else if ((is_object($postData) or is_array($postData)) and !in_array('Content-Type: multipart/form-data', $headers)) { // json model + } else if ((is_object($postData) or is_array($postData)) and !in_array('Content-Type: multipart/form-data', $headers)) { // json model $postData = json_encode($this->serializer->sanitizeForSerialization($postData)); } @@ -184,21 +226,25 @@ class ApiClient { $data = $http_body; } } else { - throw new ApiException("[".$response_info['http_code']."] Error connecting to the API ($url)", - $response_info['http_code'], $http_header, $http_body); + throw new ApiException( + "[".$response_info['http_code']."] Error connecting to the API ($url)", + $response_info['http_code'], $http_header, $http_body + ); } return array($data, $http_header); } - /* - * return the header 'Accept' based on an array of Accept provided + /** + * Return the header 'Accept' based on an array of Accept provided * * @param string[] $accept Array of header + * * @return string Accept (e.g. application/json) */ - public static function selectHeaderAccept($accept) { + public static function selectHeaderAccept($accept) + { if (count($accept) === 0 or (count($accept) === 1 and $accept[0] === '')) { - return NULL; + return null; } elseif (preg_grep("/application\/json/i", $accept)) { return 'application/json'; } else { @@ -206,13 +252,15 @@ class ApiClient { } } - /* - * return the content type based on an array of content-type provided + /** + * Return the content type based on an array of content-type provided + * + * @param string[] $content_type Array fo content-type * - * @param string[] content_type_array Array fo content-type * @return string Content-Type (e.g. application/json) */ - public static function selectHeaderContentType($content_type) { + public static function selectHeaderContentType($content_type) + { if (count($content_type) === 0 or (count($content_type) === 1 and $content_type[0] === '')) { return 'application/json'; } elseif (preg_grep("/application\/json/i", $content_type)) { diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/ApiException.php b/samples/client/petstore/php/SwaggerClient-php/lib/ApiException.php index b1342921a0a1..ce6c19e245f1 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/ApiException.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/ApiException.php @@ -1,4 +1,14 @@ responseHeaders = $responseHeaders; $this->responseBody = $responseBody; } /** - * Get the HTTP response header + * Gets the HTTP response header * * @return string HTTP response header */ - public function getResponseHeaders() { + public function getResponseHeaders() + { return $this->responseHeaders; } /** - * Get the HTTP response body + * Gets the HTTP response body * * @return string HTTP response body */ - public function getResponseBody() { + public function getResponseBody() + { return $this->responseBody; } /** - * sets the deseralized response object (during deserialization) - * @param mixed $obj + * Sets the deseralized response object (during deserialization) + * @param mixed $obj Deserialized response object + * @return void */ - public function setResponseObject($obj) { + public function setResponseObject($obj) + { $this->responseObject = $obj; } - - public function getResponseObject() { + + /** + * Gets the deseralized response object (during deserialization) + * + * @return mixed the deserialized response object + */ + public function getResponseObject() + { return $this->responseObject; } } diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/Configuration.php b/samples/client/petstore/php/SwaggerClient-php/lib/Configuration.php index 664293f1a13c..002df7fc7133 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/Configuration.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/Configuration.php @@ -1,4 +1,15 @@ tempFolderPath = sys_get_temp_dir(); } /** - * @param string $key - * @param string $value + * Sets API key + * + * @param string $apiKeyIdentifier API key identifier (authentication scheme) + * @param string $key API key or token + * * @return Configuration */ - public function setApiKey($key, $value) { - $this->apiKeys[$key] = $value; - return $this; + public function setApiKey($apiKeyIdentifier, $key) + { + $this->apiKeys[$apiKeyIdentifier] = $key; + return $this; } /** - * @param $key + * Gets API key + * + * @param string $apiKeyIdentifier API key identifier (authentication scheme) + * + * @return string API key or token + */ + public function getApiKey($apiKeyIdentifier) + { + return isset($this->apiKeys[$apiKeyIdentifier]) ? $this->apiKeys[$apiKeyIdentifier] : null; + } + + /** + * Sets the prefix for API key (e.g. Bearer) + * + * @param string $apiKeyIdentifier API key identifier (authentication scheme) + * @param string $prefix API key prefix, e.g. Bearer + * + * @return Configuration + */ + public function setApiKeyPrefix($apiKeyIdentifier, $prefix) + { + $this->apiKeyPrefixes[$apiKeyIdentifier] = $prefix; + return $this; + } + + /** + * Gets API key prefix + * + * @param string $apiKeyIdentifier API key identifier (authentication scheme) + * * @return string */ - public function getApiKey($key) { - return isset($this->apiKeys[$key]) ? $this->apiKeys[$key] : null; + public function getApiKeyPrefix($apiKeyIdentifier) + { + return isset($this->apiKeyPrefixes[$apiKeyIdentifier]) ? $this->apiKeyPrefixes[$apiKeyIdentifier] : null; } /** - * @param string $key - * @param string $value + * Sets the username for HTTP basic authentication + * + * @param string $username Username for HTTP basic authentication + * * @return Configuration */ - public function setApiKeyPrefix($key, $value) { - $this->apiKeyPrefixes[$key] = $value; - return $this; - } - - /** - * @param $key - * @return string - */ - public function getApiKeyPrefix($key) { - return isset($this->apiKeyPrefixes[$key]) ? $this->apiKeyPrefixes[$key] : null; - } - - /** - * @param string $username - * @return Configuration - */ - public function setUsername($username) { + public function setUsername($username) + { $this->username = $username; return $this; } /** - * @return string + * Gets the username for HTTP basic authentication + * + * @return string Username for HTTP basic authentication */ - public function getUsername() { + public function getUsername() + { return $this->username; } /** - * @param string $password + * Sets the password for HTTP basic authentication + * + * @param string $password Password for HTTP basic authentication + * * @return Configuration */ - public function setPassword($password) { + public function setPassword($password) + { $this->password = $password; return $this; } /** - * @return string + * Gets the password for HTTP basic authentication + * + * @return string Password for HTTP basic authentication */ - public function getPassword() { + public function getPassword() + { return $this->password; } /** - * add default header + * Adds a default header * - * @param string $headerName header name (e.g. Token) + * @param string $headerName header name (e.g. Token) * @param string $headerValue header value (e.g. 1z8wp3) + * * @return ApiClient */ - public function addDefaultHeader($headerName, $headerValue) { + public function addDefaultHeader($headerName, $headerValue) + { if (!is_string($headerName)) { throw new \InvalidArgumentException('Header name must be a string.'); } @@ -146,46 +251,59 @@ class Configuration { } /** - * get the default header + * Gets the default header * - * @return array default header + * @return array An array of default header(s) */ - public function getDefaultHeaders() { + public function getDefaultHeaders() + { return $this->defaultHeaders; } /** - * delete a default header + * Deletes a default header + * * @param string $headerName the header to delete + * * @return Configuration */ - public function deleteDefaultHeader($headerName) { + public function deleteDefaultHeader($headerName) + { unset($this->defaultHeaders[$headerName]); } /** - * @param string $host + * Sets the host + * + * @param string $host Host + * * @return Configuration */ - public function setHost($host) { + public function setHost($host) + { $this->host = $host; return $this; } /** - * @return string + * Gets the host + * + * @return string Host */ - public function getHost() { + public function getHost() + { return $this->host; } /** - * set the user agent of the api client + * Sets the user agent of the api client * * @param string $userAgent the user agent of the api client + * * @return ApiClient */ - public function setUserAgent($userAgent) { + public function setUserAgent($userAgent) + { if (!is_string($userAgent)) { throw new \InvalidArgumentException('User-agent must be a string.'); } @@ -195,21 +313,24 @@ class Configuration { } /** - * get the user agent of the api client + * Gets the user agent of the api client * * @return string user agent */ - public function getUserAgent() { + public function getUserAgent() + { return $this->userAgent; } /** - * set the HTTP timeout value + * Sets the HTTP timeout value * * @param integer $seconds Number of seconds before timing out [set to 0 for no timeout] + * * @return ApiClient */ - public function setCurlTimeout($seconds) { + public function setCurlTimeout($seconds) + { if (!is_numeric($seconds) || $seconds < 0) { throw new \InvalidArgumentException('Timeout value must be numeric and a non-negative number.'); } @@ -219,85 +340,117 @@ class Configuration { } /** - * get the HTTP timeout value + * Gets the HTTP timeout value * * @return string HTTP timeout value */ - public function getCurlTimeout() { + public function getCurlTimeout() + { return $this->curlTimeout; } /** - * @param bool $debug + * Sets debug flag + * + * @param bool $debug Debug flag + * * @return Configuration */ - public function setDebug($debug) { + public function setDebug($debug) + { $this->debug = $debug; return $this; } /** + * Gets the debug flag + * * @return bool */ - public function getDebug() { + public function getDebug() + { return $this->debug; } /** - * @param string $debugFile + * Sets the debug file + * + * @param string $debugFile Debug file + * * @return Configuration */ - public function setDebugFile($debugFile) { + public function setDebugFile($debugFile) + { $this->debugFile = $debugFile; return $this; } /** + * Gets the debug file + * * @return string */ - public function getDebugFile() { + public function getDebugFile() + { return $this->debugFile; } /** - * @param string $tempFolderPath + * Sets the temp folder path + * + * @param string $tempFolderPath Temp folder path + * * @return Configuration */ - public function setTempFolderPath($tempFolderPath) { + public function setTempFolderPath($tempFolderPath) + { $this->tempFolderPath = $tempFolderPath; return $this; } /** - * @return string + * Gets the temp folder path + * + * @return string Temp folder path */ - public function getTempFolderPath() { + public function getTempFolderPath() + { return $this->tempFolderPath; } - /** + * Gets the default configuration instance + * * @return Configuration */ - public static function getDefaultConfiguration() { - if (self::$defaultConfiguration == null) { - self::$defaultConfiguration = new Configuration(); + public static function getDefaultConfiguration() + { + if (self::$_defaultConfiguration == null) { + self::$_defaultConfiguration = new Configuration(); } - return self::$defaultConfiguration; + return self::$_defaultConfiguration; } /** - * @param Configuration $config + * Sets the detault configuration instance + * + * @param Configuration $config An instance of the Configuration Object + * + * @return void */ - public static function setDefaultConfiguration(Configuration $config) { - self::$defaultConfiguration = $config; + public static function setDefaultConfiguration(Configuration $config) + { + self::$_defaultConfiguration = $config; } - /* - * return the report for debugging + /** + * Gets the essential information for debugging + * + * @return string The report for debugging */ - public static function toDebugReport() { + public static function toDebugReport() + { $report = "PHP SDK (Swagger\Client) Debug Report:\n"; $report .= " OS: ".php_uname()."\n"; $report .= " PHP Version: ".phpversion()."\n"; diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/Model/Category.php b/samples/client/petstore/php/SwaggerClient-php/lib/Model/Category.php index 02b3d3cde0f6..444c3c1ed7e1 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/Model/Category.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/Model/Category.php @@ -1,4 +1,15 @@ 'int', 'name' => 'string' ); - /** @var string[] Array of attributes where the key is the local name, and the value is the original name */ + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ static $attributeMap = array( 'id' => 'id', 'name' => 'name' ); - /** @var string[] Array of attributes to setter functions (for deserialization of responses) */ + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ static $setters = array( 'id' => 'setId', 'name' => 'setName' ); - /** @var string[] Array of attributes to getter functions (for serialization of requests) */ + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ static $getters = array( 'id' => 'getId', 'name' => 'getName' ); - /** @var int $id */ + /** + * $id + * @var int + */ protected $id; - /** @var string $name */ + /** + * $name + * @var string + */ protected $name; - public function __construct(array $data = null) { + + /** + * Constructor + * @param mixed[] $data Associated array of property value initalizing the model + */ + public function __construct(array $data = null) + { if ($data != null) { $this->id = $data["id"]; $this->name = $data["name"]; @@ -66,60 +109,94 @@ class Category implements ArrayAccess { } /** - * get id + * Gets id * @return int */ - public function getId() { + public function getId() + { return $this->id; } /** - * set id - * @param int $id + * Sets id + * @param int $id * @return $this */ - public function setId($id) { + public function setId($id) + { $this->id = $id; return $this; } /** - * get name + * Gets name * @return string */ - public function getName() { + public function getName() + { return $this->name; } /** - * set name - * @param string $name + * Sets name + * @param string $name * @return $this */ - public function setName($name) { + public function setName($name) + { $this->name = $name; return $this; } - public function offsetExists($offset) { + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { return isset($this->$offset); } - public function offsetGet($offset) { + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + public function offsetGet($offset) + { return $this->$offset; } - public function offsetSet($offset, $value) { + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + public function offsetSet($offset, $value) + { $this->$offset = $value; } - public function offsetUnset($offset) { + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + public function offsetUnset($offset) + { unset($this->$offset); } - public function __toString() { + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { if (defined('JSON_PRETTY_PRINT')) { return json_encode(get_object_vars($this), JSON_PRETTY_PRINT); } else { diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/Model/Order.php b/samples/client/petstore/php/SwaggerClient-php/lib/Model/Order.php index 9b20b159ab9f..b803bd7325e7 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/Model/Order.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/Model/Order.php @@ -1,4 +1,15 @@ 'int', 'pet_id' => 'int', @@ -37,7 +59,10 @@ class Order implements ArrayAccess { 'complete' => 'bool' ); - /** @var string[] Array of attributes where the key is the local name, and the value is the original name */ + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ static $attributeMap = array( 'id' => 'id', 'pet_id' => 'petId', @@ -47,7 +72,10 @@ class Order implements ArrayAccess { 'complete' => 'complete' ); - /** @var string[] Array of attributes to setter functions (for deserialization of responses) */ + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ static $setters = array( 'id' => 'setId', 'pet_id' => 'setPetId', @@ -57,7 +85,10 @@ class Order implements ArrayAccess { 'complete' => 'setComplete' ); - /** @var string[] Array of attributes to getter functions (for serialization of requests) */ + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ static $getters = array( 'id' => 'getId', 'pet_id' => 'getPetId', @@ -68,25 +99,49 @@ class Order implements ArrayAccess { ); - /** @var int $id */ + /** + * $id + * @var int + */ protected $id; - /** @var int $pet_id */ + /** + * $pet_id + * @var int + */ protected $pet_id; - /** @var int $quantity */ + /** + * $quantity + * @var int + */ protected $quantity; - /** @var \DateTime $ship_date */ + /** + * $ship_date + * @var \DateTime + */ protected $ship_date; - /** @var string $status Order Status */ + /** + * $status Order Status + * @var string + */ protected $status; - /** @var bool $complete */ + /** + * $complete + * @var bool + */ protected $complete; - public function __construct(array $data = null) { + + /** + * Constructor + * @param mixed[] $data Associated array of property value initalizing the model + */ + public function __construct(array $data = null) + { if ($data != null) { $this->id = $data["id"]; $this->pet_id = $data["pet_id"]; @@ -98,95 +153,105 @@ class Order implements ArrayAccess { } /** - * get id + * Gets id * @return int */ - public function getId() { + public function getId() + { return $this->id; } /** - * set id - * @param int $id + * Sets id + * @param int $id * @return $this */ - public function setId($id) { + public function setId($id) + { $this->id = $id; return $this; } /** - * get pet_id + * Gets pet_id * @return int */ - public function getPetId() { + public function getPetId() + { return $this->pet_id; } /** - * set pet_id - * @param int $pet_id + * Sets pet_id + * @param int $pet_id * @return $this */ - public function setPetId($pet_id) { + public function setPetId($pet_id) + { $this->pet_id = $pet_id; return $this; } /** - * get quantity + * Gets quantity * @return int */ - public function getQuantity() { + public function getQuantity() + { return $this->quantity; } /** - * set quantity - * @param int $quantity + * Sets quantity + * @param int $quantity * @return $this */ - public function setQuantity($quantity) { + public function setQuantity($quantity) + { $this->quantity = $quantity; return $this; } /** - * get ship_date + * Gets ship_date * @return \DateTime */ - public function getShipDate() { + public function getShipDate() + { return $this->ship_date; } /** - * set ship_date - * @param \DateTime $ship_date + * Sets ship_date + * @param \DateTime $ship_date * @return $this */ - public function setShipDate($ship_date) { + public function setShipDate($ship_date) + { $this->ship_date = $ship_date; return $this; } /** - * get status + * Gets status * @return string */ - public function getStatus() { + public function getStatus() + { return $this->status; } /** - * set status - * @param string $status + * Sets status + * @param string $status Order Status * @return $this */ - public function setStatus($status) { + public function setStatus($status) + { $allowed_values = array("placed", "approved", "delivered"); if (!in_array($status, $allowed_values)) { throw new \InvalidArgumentException("Invalid value for 'status', must be one of 'placed', 'approved', 'delivered'"); @@ -196,41 +261,73 @@ class Order implements ArrayAccess { } /** - * get complete + * Gets complete * @return bool */ - public function getComplete() { + public function getComplete() + { return $this->complete; } /** - * set complete - * @param bool $complete + * Sets complete + * @param bool $complete * @return $this */ - public function setComplete($complete) { + public function setComplete($complete) + { $this->complete = $complete; return $this; } - public function offsetExists($offset) { + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { return isset($this->$offset); } - public function offsetGet($offset) { + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + public function offsetGet($offset) + { return $this->$offset; } - public function offsetSet($offset, $value) { + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + public function offsetSet($offset, $value) + { $this->$offset = $value; } - public function offsetUnset($offset) { + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + public function offsetUnset($offset) + { unset($this->$offset); } - public function __toString() { + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { if (defined('JSON_PRETTY_PRINT')) { return json_encode(get_object_vars($this), JSON_PRETTY_PRINT); } else { diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/Model/Pet.php b/samples/client/petstore/php/SwaggerClient-php/lib/Model/Pet.php index 03c5b173532f..6871ea9d9be5 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/Model/Pet.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/Model/Pet.php @@ -1,4 +1,15 @@ 'int', 'category' => '\Swagger\Client\Model\Category', @@ -37,7 +59,10 @@ class Pet implements ArrayAccess { 'status' => 'string' ); - /** @var string[] Array of attributes where the key is the local name, and the value is the original name */ + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ static $attributeMap = array( 'id' => 'id', 'category' => 'category', @@ -47,7 +72,10 @@ class Pet implements ArrayAccess { 'status' => 'status' ); - /** @var string[] Array of attributes to setter functions (for deserialization of responses) */ + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ static $setters = array( 'id' => 'setId', 'category' => 'setCategory', @@ -57,7 +85,10 @@ class Pet implements ArrayAccess { 'status' => 'setStatus' ); - /** @var string[] Array of attributes to getter functions (for serialization of requests) */ + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ static $getters = array( 'id' => 'getId', 'category' => 'getCategory', @@ -68,25 +99,49 @@ class Pet implements ArrayAccess { ); - /** @var int $id */ + /** + * $id + * @var int + */ protected $id; - /** @var \Swagger\Client\Model\Category $category */ + /** + * $category + * @var \Swagger\Client\Model\Category + */ protected $category; - /** @var string $name */ + /** + * $name + * @var string + */ protected $name; - /** @var string[] $photo_urls */ + /** + * $photo_urls + * @var string[] + */ protected $photo_urls; - /** @var \Swagger\Client\Model\Tag[] $tags */ + /** + * $tags + * @var \Swagger\Client\Model\Tag[] + */ protected $tags; - /** @var string $status pet status in the store */ + /** + * $status pet status in the store + * @var string + */ protected $status; - public function __construct(array $data = null) { + + /** + * Constructor + * @param mixed[] $data Associated array of property value initalizing the model + */ + public function __construct(array $data = null) + { if ($data != null) { $this->id = $data["id"]; $this->category = $data["category"]; @@ -98,114 +153,126 @@ class Pet implements ArrayAccess { } /** - * get id + * Gets id * @return int */ - public function getId() { + public function getId() + { return $this->id; } /** - * set id - * @param int $id + * Sets id + * @param int $id * @return $this */ - public function setId($id) { + public function setId($id) + { $this->id = $id; return $this; } /** - * get category + * Gets category * @return \Swagger\Client\Model\Category */ - public function getCategory() { + public function getCategory() + { return $this->category; } /** - * set category - * @param \Swagger\Client\Model\Category $category + * Sets category + * @param \Swagger\Client\Model\Category $category * @return $this */ - public function setCategory($category) { + public function setCategory($category) + { $this->category = $category; return $this; } /** - * get name + * Gets name * @return string */ - public function getName() { + public function getName() + { return $this->name; } /** - * set name - * @param string $name + * Sets name + * @param string $name * @return $this */ - public function setName($name) { + public function setName($name) + { $this->name = $name; return $this; } /** - * get photo_urls + * Gets photo_urls * @return string[] */ - public function getPhotoUrls() { + public function getPhotoUrls() + { return $this->photo_urls; } /** - * set photo_urls - * @param string[] $photo_urls + * Sets photo_urls + * @param string[] $photo_urls * @return $this */ - public function setPhotoUrls($photo_urls) { + public function setPhotoUrls($photo_urls) + { $this->photo_urls = $photo_urls; return $this; } /** - * get tags + * Gets tags * @return \Swagger\Client\Model\Tag[] */ - public function getTags() { + public function getTags() + { return $this->tags; } /** - * set tags - * @param \Swagger\Client\Model\Tag[] $tags + * Sets tags + * @param \Swagger\Client\Model\Tag[] $tags * @return $this */ - public function setTags($tags) { + public function setTags($tags) + { $this->tags = $tags; return $this; } /** - * get status + * Gets status * @return string */ - public function getStatus() { + public function getStatus() + { return $this->status; } /** - * set status - * @param string $status + * Sets status + * @param string $status pet status in the store * @return $this */ - public function setStatus($status) { + public function setStatus($status) + { $allowed_values = array("available", "pending", "sold"); if (!in_array($status, $allowed_values)) { throw new \InvalidArgumentException("Invalid value for 'status', must be one of 'available', 'pending', 'sold'"); @@ -214,23 +281,53 @@ class Pet implements ArrayAccess { return $this; } - public function offsetExists($offset) { + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { return isset($this->$offset); } - public function offsetGet($offset) { + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + public function offsetGet($offset) + { return $this->$offset; } - public function offsetSet($offset, $value) { + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + public function offsetSet($offset, $value) + { $this->$offset = $value; } - public function offsetUnset($offset) { + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + public function offsetUnset($offset) + { unset($this->$offset); } - public function __toString() { + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { if (defined('JSON_PRETTY_PRINT')) { return json_encode(get_object_vars($this), JSON_PRETTY_PRINT); } else { diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/Model/Tag.php b/samples/client/petstore/php/SwaggerClient-php/lib/Model/Tag.php index 279618ac3bea..bcecb32fa7e2 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/Model/Tag.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/Model/Tag.php @@ -1,4 +1,15 @@ 'int', 'name' => 'string' ); - /** @var string[] Array of attributes where the key is the local name, and the value is the original name */ + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ static $attributeMap = array( 'id' => 'id', 'name' => 'name' ); - /** @var string[] Array of attributes to setter functions (for deserialization of responses) */ + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ static $setters = array( 'id' => 'setId', 'name' => 'setName' ); - /** @var string[] Array of attributes to getter functions (for serialization of requests) */ + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ static $getters = array( 'id' => 'getId', 'name' => 'getName' ); - /** @var int $id */ + /** + * $id + * @var int + */ protected $id; - /** @var string $name */ + /** + * $name + * @var string + */ protected $name; - public function __construct(array $data = null) { + + /** + * Constructor + * @param mixed[] $data Associated array of property value initalizing the model + */ + public function __construct(array $data = null) + { if ($data != null) { $this->id = $data["id"]; $this->name = $data["name"]; @@ -66,60 +109,94 @@ class Tag implements ArrayAccess { } /** - * get id + * Gets id * @return int */ - public function getId() { + public function getId() + { return $this->id; } /** - * set id - * @param int $id + * Sets id + * @param int $id * @return $this */ - public function setId($id) { + public function setId($id) + { $this->id = $id; return $this; } /** - * get name + * Gets name * @return string */ - public function getName() { + public function getName() + { return $this->name; } /** - * set name - * @param string $name + * Sets name + * @param string $name * @return $this */ - public function setName($name) { + public function setName($name) + { $this->name = $name; return $this; } - public function offsetExists($offset) { + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { return isset($this->$offset); } - public function offsetGet($offset) { + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + public function offsetGet($offset) + { return $this->$offset; } - public function offsetSet($offset, $value) { + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + public function offsetSet($offset, $value) + { $this->$offset = $value; } - public function offsetUnset($offset) { + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + public function offsetUnset($offset) + { unset($this->$offset); } - public function __toString() { + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { if (defined('JSON_PRETTY_PRINT')) { return json_encode(get_object_vars($this), JSON_PRETTY_PRINT); } else { diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/Model/User.php b/samples/client/petstore/php/SwaggerClient-php/lib/Model/User.php index 7dd45220cf93..1650635d8cec 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/Model/User.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/Model/User.php @@ -1,4 +1,15 @@ 'int', 'username' => 'string', @@ -39,7 +61,10 @@ class User implements ArrayAccess { 'user_status' => 'int' ); - /** @var string[] Array of attributes where the key is the local name, and the value is the original name */ + /** + * Array of attributes where the key is the local name, and the value is the original name + * @var string[] + */ static $attributeMap = array( 'id' => 'id', 'username' => 'username', @@ -51,7 +76,10 @@ class User implements ArrayAccess { 'user_status' => 'userStatus' ); - /** @var string[] Array of attributes to setter functions (for deserialization of responses) */ + /** + * Array of attributes to setter functions (for deserialization of responses) + * @var string[] + */ static $setters = array( 'id' => 'setId', 'username' => 'setUsername', @@ -63,7 +91,10 @@ class User implements ArrayAccess { 'user_status' => 'setUserStatus' ); - /** @var string[] Array of attributes to getter functions (for serialization of requests) */ + /** + * Array of attributes to getter functions (for serialization of requests) + * @var string[] + */ static $getters = array( 'id' => 'getId', 'username' => 'getUsername', @@ -76,31 +107,61 @@ class User implements ArrayAccess { ); - /** @var int $id */ + /** + * $id + * @var int + */ protected $id; - /** @var string $username */ + /** + * $username + * @var string + */ protected $username; - /** @var string $first_name */ + /** + * $first_name + * @var string + */ protected $first_name; - /** @var string $last_name */ + /** + * $last_name + * @var string + */ protected $last_name; - /** @var string $email */ + /** + * $email + * @var string + */ protected $email; - /** @var string $password */ + /** + * $password + * @var string + */ protected $password; - /** @var string $phone */ + /** + * $phone + * @var string + */ protected $phone; - /** @var int $user_status User Status */ + /** + * $user_status User Status + * @var int + */ protected $user_status; - public function __construct(array $data = null) { + + /** + * Constructor + * @param mixed[] $data Associated array of property value initalizing the model + */ + public function __construct(array $data = null) + { if ($data != null) { $this->id = $data["id"]; $this->username = $data["username"]; @@ -114,174 +175,220 @@ class User implements ArrayAccess { } /** - * get id + * Gets id * @return int */ - public function getId() { + public function getId() + { return $this->id; } /** - * set id - * @param int $id + * Sets id + * @param int $id * @return $this */ - public function setId($id) { + public function setId($id) + { $this->id = $id; return $this; } /** - * get username + * Gets username * @return string */ - public function getUsername() { + public function getUsername() + { return $this->username; } /** - * set username - * @param string $username + * Sets username + * @param string $username * @return $this */ - public function setUsername($username) { + public function setUsername($username) + { $this->username = $username; return $this; } /** - * get first_name + * Gets first_name * @return string */ - public function getFirstName() { + public function getFirstName() + { return $this->first_name; } /** - * set first_name - * @param string $first_name + * Sets first_name + * @param string $first_name * @return $this */ - public function setFirstName($first_name) { + public function setFirstName($first_name) + { $this->first_name = $first_name; return $this; } /** - * get last_name + * Gets last_name * @return string */ - public function getLastName() { + public function getLastName() + { return $this->last_name; } /** - * set last_name - * @param string $last_name + * Sets last_name + * @param string $last_name * @return $this */ - public function setLastName($last_name) { + public function setLastName($last_name) + { $this->last_name = $last_name; return $this; } /** - * get email + * Gets email * @return string */ - public function getEmail() { + public function getEmail() + { return $this->email; } /** - * set email - * @param string $email + * Sets email + * @param string $email * @return $this */ - public function setEmail($email) { + public function setEmail($email) + { $this->email = $email; return $this; } /** - * get password + * Gets password * @return string */ - public function getPassword() { + public function getPassword() + { return $this->password; } /** - * set password - * @param string $password + * Sets password + * @param string $password * @return $this */ - public function setPassword($password) { + public function setPassword($password) + { $this->password = $password; return $this; } /** - * get phone + * Gets phone * @return string */ - public function getPhone() { + public function getPhone() + { return $this->phone; } /** - * set phone - * @param string $phone + * Sets phone + * @param string $phone * @return $this */ - public function setPhone($phone) { + public function setPhone($phone) + { $this->phone = $phone; return $this; } /** - * get user_status + * Gets user_status * @return int */ - public function getUserStatus() { + public function getUserStatus() + { return $this->user_status; } /** - * set user_status - * @param int $user_status + * Sets user_status + * @param int $user_status User Status * @return $this */ - public function setUserStatus($user_status) { + public function setUserStatus($user_status) + { $this->user_status = $user_status; return $this; } - public function offsetExists($offset) { + /** + * Returns true if offset exists. False otherwise. + * @param integer $offset Offset + * @return boolean + */ + public function offsetExists($offset) + { return isset($this->$offset); } - public function offsetGet($offset) { + /** + * Gets offset. + * @param integer $offset Offset + * @return mixed + */ + public function offsetGet($offset) + { return $this->$offset; } - public function offsetSet($offset, $value) { + /** + * Sets value based on offset. + * @param integer $offset Offset + * @param mixed $value Value to be set + * @return void + */ + public function offsetSet($offset, $value) + { $this->$offset = $value; } - public function offsetUnset($offset) { + /** + * Unsets offset. + * @param integer $offset Offset + * @return void + */ + public function offsetUnset($offset) + { unset($this->$offset); } - public function __toString() { + /** + * Gets the string presentation of the object + * @return string + */ + public function __toString() + { if (defined('JSON_PRETTY_PRINT')) { return json_encode(get_object_vars($this), JSON_PRETTY_PRINT); } else { diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/ObjectSerializer.php b/samples/client/petstore/php/SwaggerClient-php/lib/ObjectSerializer.php index 3f78ea55bb93..535c623118ac 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/ObjectSerializer.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/ObjectSerializer.php @@ -1,14 +1,59 @@ toString($value)); } @@ -49,10 +97,13 @@ class ObjectSerializer { * the query, by imploding comma-separated if it's an object. * If it's a string, pass through unchanged. It will be url-encoded * later. + * * @param object $object an object to be serialized to a string + * * @return string the serialized object */ - public function toQueryValue($object) { + public function toQueryValue($object) + { if (is_array($object)) { return implode(',', $object); } else { @@ -64,10 +115,13 @@ class ObjectSerializer { * Take value and turn it into a string suitable for inclusion in * the header. If it's a string, pass through unchanged * If it's a datetime object, format it in ISO8601 + * * @param string $value a string which will be part of the header + * * @return string the header string */ - public function toHeaderValue($value) { + public function toHeaderValue($value) + { return $this->toString($value); } @@ -75,10 +129,13 @@ class ObjectSerializer { * Take value and turn it into a string suitable for inclusion in * the http body (form parameter). If it's a string, pass through unchanged * If it's a datetime object, format it in ISO8601 + * * @param string $value the value of the form parameter + * * @return string the form string */ - public function toFormValue($value) { + public function toFormValue($value) + { if ($value instanceof SplFileObject) { return $value->getRealPath(); } else { @@ -90,10 +147,13 @@ class ObjectSerializer { * Take value and turn it into a string suitable for inclusion in * the parameter. If it's a string, pass through unchanged * If it's a datetime object, format it in ISO8601 + * * @param string $value the value of the parameter + * * @return string the header string */ - public function toString($value) { + public function toString($value) + { if ($value instanceof \DateTime) { // datetime in ISO8601 format return $value->format(\DateTime::ISO8601); } else { @@ -104,37 +164,40 @@ class ObjectSerializer { /** * Deserialize a JSON string into an object * - * @param mixed $data object or primitive to be deserialized - * @param string $class class name is passed as a string + * @param mixed $data object or primitive to be deserialized + * @param string $class class name is passed as a string + * @param string $httpHeader HTTP headers + * * @return object an instance of $class */ - public function deserialize($data, $class, $httpHeader=null) { + public function deserialize($data, $class, $httpHeader=null) + { if (null === $data) { $deserialized = null; - } elseif (substr($class, 0, 4) == 'map[') { # for associative array e.g. map[string,int] + } elseif (substr($class, 0, 4) === 'map[') { // for associative array e.g. map[string,int] $inner = substr($class, 4, -1); $deserialized = array(); - if(strrpos($inner, ",") !== false) { + if (strrpos($inner, ",") !== false) { $subClass_array = explode(',', $inner, 2); $subClass = $subClass_array[1]; foreach ($data as $key => $value) { $deserialized[$key] = $this->deserialize($value, $subClass); } } - } elseif (strcasecmp(substr($class, -2),'[]') == 0) { + } elseif (strcasecmp(substr($class, -2), '[]') == 0) { $subClass = substr($class, 0, -2); $values = array(); foreach ($data as $key => $value) { $values[] = $this->deserialize($value, $subClass); } $deserialized = $values; - } elseif ($class == 'DateTime') { + } elseif ($class === 'DateTime') { $deserialized = new \DateTime($data); } elseif (in_array($class, array('string', 'int', 'float', 'double', 'bool', 'object'))) { settype($data, $class); $deserialized = $data; } elseif ($class === '\SplFileObject') { - # determine file name + // determine file name if (preg_match('/Content-Disposition: inline; filename=[\'"]?([^\'"\s]+)[\'"]?$/i', $httpHeader, $match)) { $filename = Configuration::getDefaultConfiguration()->getTempFolderPath().$match[1]; } else { @@ -142,7 +205,7 @@ class ObjectSerializer { } $deserialized = new \SplFileObject($filename, "w"); $byte_written = $deserialized->fwrite($data); - error_log("[INFO] Written $byte_written byte to $filename. Please move the file to a proper folder or delete the temp file after processing.\n" , 3, Configuration::getDefaultConfiguration()->getDebugFile()); + error_log("[INFO] Written $byte_written byte to $filename. Please move the file to a proper folder or delete the temp file after processing.\n", 3, Configuration::getDefaultConfiguration()->getDebugFile()); } else { $instance = new $class(); @@ -150,7 +213,7 @@ class ObjectSerializer { $propertySetter = $instance::$setters[$property]; if (!isset($propertySetter) || !isset($data->{$instance::$attributeMap[$property]})) { - continue; + continue; } $propertyValue = $data->{$instance::$attributeMap[$property]}; diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/PetApi.php b/samples/client/petstore/php/SwaggerClient-php/lib/PetApi.php deleted file mode 100644 index 4d1cba21c3e8..000000000000 --- a/samples/client/petstore/php/SwaggerClient-php/lib/PetApi.php +++ /dev/null @@ -1,543 +0,0 @@ -apiClient = Configuration::$apiClient; - } - else - $this->apiClient = Configuration::$apiClient; // use the default one - } else { - $this->apiClient = $apiClient; // use the one provided by the user - } - } - - private $apiClient; // instance of the ApiClient - - /** - * get the API client - */ - public function getApiClient() { - return $this->apiClient; - } - - /** - * set the API client - */ - public function setApiClient($apiClient) { - $this->apiClient = $apiClient; - } - - - /** - * updatePet - * - * Update an existing pet - * - * @param Pet $body Pet object that needs to be added to the store (required) - * @return void - */ - public function updatePet($body) { - - - // parse inputs - $resourcePath = "/pet"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "PUT"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array('application/json','application/xml')); - - - - - - // body params - $_tempBody = null; - if (isset($body)) { - $_tempBody = $body; - } - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array('petstore_auth'); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - - } - - /** - * addPet - * - * Add a new pet to the store - * - * @param Pet $body Pet object that needs to be added to the store (required) - * @return void - */ - public function addPet($body) { - - - // parse inputs - $resourcePath = "/pet"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "POST"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array('application/json','application/xml')); - - - - - - // body params - $_tempBody = null; - if (isset($body)) { - $_tempBody = $body; - } - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array('petstore_auth'); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - - } - - /** - * findPetsByStatus - * - * Finds Pets by status - * - * @param array[string] $status Status values that need to be considered for filter (required) - * @return array[Pet] - */ - public function findPetsByStatus($status) { - - - // parse inputs - $resourcePath = "/pet/findByStatus"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "GET"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - // query params - if($status !== null) { - $queryParams['status'] = $this->apiClient->toQueryValue($status); - } - - - - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array('petstore_auth'); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - if(! $response) { - return null; - } - - $responseObject = $this->apiClient->deserialize($response,'array[Pet]'); - return $responseObject; - } - - /** - * findPetsByTags - * - * Finds Pets by tags - * - * @param array[string] $tags Tags to filter by (required) - * @return array[Pet] - */ - public function findPetsByTags($tags) { - - - // parse inputs - $resourcePath = "/pet/findByTags"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "GET"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - // query params - if($tags !== null) { - $queryParams['tags'] = $this->apiClient->toQueryValue($tags); - } - - - - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array('petstore_auth'); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - if(! $response) { - return null; - } - - $responseObject = $this->apiClient->deserialize($response,'array[Pet]'); - return $responseObject; - } - - /** - * getPetById - * - * Find pet by ID - * - * @param int $pet_id ID of pet that needs to be fetched (required) - * @return Pet - */ - public function getPetById($pet_id) { - - // verify the required parameter 'pet_id' is set - if ($pet_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $pet_id when calling getPetById'); - } - - - // parse inputs - $resourcePath = "/pet/{petId}"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "GET"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - - // path params - if($pet_id !== null) { - $resourcePath = str_replace("{" . "petId" . "}", - $this->apiClient->toPathValue($pet_id), $resourcePath); - } - - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array('api_key', 'petstore_auth'); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - if(! $response) { - return null; - } - - $responseObject = $this->apiClient->deserialize($response,'Pet'); - return $responseObject; - } - - /** - * updatePetWithForm - * - * Updates a pet in the store with form data - * - * @param string $pet_id ID of pet that needs to be updated (required) - * @param string $name Updated name of the pet (required) - * @param string $status Updated status of the pet (required) - * @return void - */ - public function updatePetWithForm($pet_id, $name, $status) { - - // verify the required parameter 'pet_id' is set - if ($pet_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $pet_id when calling updatePetWithForm'); - } - - - // parse inputs - $resourcePath = "/pet/{petId}"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "POST"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array('application/x-www-form-urlencoded')); - - - - // path params - if($pet_id !== null) { - $resourcePath = str_replace("{" . "petId" . "}", - $this->apiClient->toPathValue($pet_id), $resourcePath); - } - // form params - if ($name !== null) { - $formParams['name'] = $this->apiClient->toFormValue($name); - }// form params - if ($status !== null) { - $formParams['status'] = $this->apiClient->toFormValue($status); - } - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array('petstore_auth'); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - - } - - /** - * deletePet - * - * Deletes a pet - * - * @param string $api_key (required) - * @param int $pet_id Pet id to delete (required) - * @return void - */ - public function deletePet($api_key, $pet_id) { - - // verify the required parameter 'pet_id' is set - if ($pet_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $pet_id when calling deletePet'); - } - - - // parse inputs - $resourcePath = "/pet/{petId}"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "DELETE"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - // header params - if($api_key !== null) { - $headerParams['api_key'] = $this->apiClient->toHeaderValue($api_key); - } - // path params - if($pet_id !== null) { - $resourcePath = str_replace("{" . "petId" . "}", - $this->apiClient->toPathValue($pet_id), $resourcePath); - } - - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array('petstore_auth'); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - - } - - /** - * uploadFile - * - * uploads an image - * - * @param int $pet_id ID of pet to update (required) - * @param string $additional_metadata Additional data to pass to server (required) - * @param string $file file to upload (required) - * @return void - */ - public function uploadFile($pet_id, $additional_metadata, $file) { - - // verify the required parameter 'pet_id' is set - if ($pet_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $pet_id when calling uploadFile'); - } - - - // parse inputs - $resourcePath = "/pet/{petId}/uploadImage"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "POST"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array('multipart/form-data')); - - - - // path params - if($pet_id !== null) { - $resourcePath = str_replace("{" . "petId" . "}", - $this->apiClient->toPathValue($pet_id), $resourcePath); - } - // form params - if ($additional_metadata !== null) { - $formParams['additionalMetadata'] = $this->apiClient->toFormValue($additional_metadata); - }// form params - if ($file !== null) { - $formParams['file'] = '@'.$this->apiClient->toFormValue($file); - } - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array('petstore_auth'); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - - } - - -} diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/StoreApi.php b/samples/client/petstore/php/SwaggerClient-php/lib/StoreApi.php deleted file mode 100644 index 87937a60283f..000000000000 --- a/samples/client/petstore/php/SwaggerClient-php/lib/StoreApi.php +++ /dev/null @@ -1,294 +0,0 @@ -apiClient = Configuration::$apiClient; - } - else - $this->apiClient = Configuration::$apiClient; // use the default one - } else { - $this->apiClient = $apiClient; // use the one provided by the user - } - } - - private $apiClient; // instance of the ApiClient - - /** - * get the API client - */ - public function getApiClient() { - return $this->apiClient; - } - - /** - * set the API client - */ - public function setApiClient($apiClient) { - $this->apiClient = $apiClient; - } - - - /** - * getInventory - * - * Returns pet inventories by status - * - * @return map[string,int] - */ - public function getInventory() { - - - // parse inputs - $resourcePath = "/store/inventory"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "GET"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - - - - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array('api_key'); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - if(! $response) { - return null; - } - - $responseObject = $this->apiClient->deserialize($response,'map[string,int]'); - return $responseObject; - } - - /** - * placeOrder - * - * Place an order for a pet - * - * @param Order $body order placed for purchasing the pet (required) - * @return Order - */ - public function placeOrder($body) { - - - // parse inputs - $resourcePath = "/store/order"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "POST"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - - - - // body params - $_tempBody = null; - if (isset($body)) { - $_tempBody = $body; - } - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array(); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - if(! $response) { - return null; - } - - $responseObject = $this->apiClient->deserialize($response,'Order'); - return $responseObject; - } - - /** - * getOrderById - * - * Find purchase order by ID - * - * @param string $order_id ID of pet that needs to be fetched (required) - * @return Order - */ - public function getOrderById($order_id) { - - // verify the required parameter 'order_id' is set - if ($order_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $order_id when calling getOrderById'); - } - - - // parse inputs - $resourcePath = "/store/order/{orderId}"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "GET"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - - // path params - if($order_id !== null) { - $resourcePath = str_replace("{" . "orderId" . "}", - $this->apiClient->toPathValue($order_id), $resourcePath); - } - - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array(); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - if(! $response) { - return null; - } - - $responseObject = $this->apiClient->deserialize($response,'Order'); - return $responseObject; - } - - /** - * deleteOrder - * - * Delete purchase order by ID - * - * @param string $order_id ID of the order that needs to be deleted (required) - * @return void - */ - public function deleteOrder($order_id) { - - // verify the required parameter 'order_id' is set - if ($order_id === null) { - throw new \InvalidArgumentException('Missing the required parameter $order_id when calling deleteOrder'); - } - - - // parse inputs - $resourcePath = "/store/order/{orderId}"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "DELETE"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - - // path params - if($order_id !== null) { - $resourcePath = str_replace("{" . "orderId" . "}", - $this->apiClient->toPathValue($order_id), $resourcePath); - } - - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array(); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - - } - - -} diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/UserApi.php b/samples/client/petstore/php/SwaggerClient-php/lib/UserApi.php deleted file mode 100644 index 2e16022f25a5..000000000000 --- a/samples/client/petstore/php/SwaggerClient-php/lib/UserApi.php +++ /dev/null @@ -1,518 +0,0 @@ -apiClient = Configuration::$apiClient; - } - else - $this->apiClient = Configuration::$apiClient; // use the default one - } else { - $this->apiClient = $apiClient; // use the one provided by the user - } - } - - private $apiClient; // instance of the ApiClient - - /** - * get the API client - */ - public function getApiClient() { - return $this->apiClient; - } - - /** - * set the API client - */ - public function setApiClient($apiClient) { - $this->apiClient = $apiClient; - } - - - /** - * createUser - * - * Create user - * - * @param User $body Created user object (required) - * @return void - */ - public function createUser($body) { - - - // parse inputs - $resourcePath = "/user"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "POST"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - - - - // body params - $_tempBody = null; - if (isset($body)) { - $_tempBody = $body; - } - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array(); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - - } - - /** - * createUsersWithArrayInput - * - * Creates list of users with given input array - * - * @param array[User] $body List of user object (required) - * @return void - */ - public function createUsersWithArrayInput($body) { - - - // parse inputs - $resourcePath = "/user/createWithArray"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "POST"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - - - - // body params - $_tempBody = null; - if (isset($body)) { - $_tempBody = $body; - } - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array(); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - - } - - /** - * createUsersWithListInput - * - * Creates list of users with given input array - * - * @param array[User] $body List of user object (required) - * @return void - */ - public function createUsersWithListInput($body) { - - - // parse inputs - $resourcePath = "/user/createWithList"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "POST"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - - - - // body params - $_tempBody = null; - if (isset($body)) { - $_tempBody = $body; - } - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array(); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - - } - - /** - * loginUser - * - * Logs user into the system - * - * @param string $username The user name for login (required) - * @param string $password The password for login in clear text (required) - * @return string - */ - public function loginUser($username, $password) { - - - // parse inputs - $resourcePath = "/user/login"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "GET"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - // query params - if($username !== null) { - $queryParams['username'] = $this->apiClient->toQueryValue($username); - }// query params - if($password !== null) { - $queryParams['password'] = $this->apiClient->toQueryValue($password); - } - - - - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array(); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - if(! $response) { - return null; - } - - $responseObject = $this->apiClient->deserialize($response,'string'); - return $responseObject; - } - - /** - * logoutUser - * - * Logs out current logged in user session - * - * @return void - */ - public function logoutUser() { - - - // parse inputs - $resourcePath = "/user/logout"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "GET"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - - - - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array(); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - - } - - /** - * getUserByName - * - * Get user by user name - * - * @param string $username The name that needs to be fetched. Use user1 for testing. (required) - * @return User - */ - public function getUserByName($username) { - - // verify the required parameter 'username' is set - if ($username === null) { - throw new \InvalidArgumentException('Missing the required parameter $username when calling getUserByName'); - } - - - // parse inputs - $resourcePath = "/user/{username}"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "GET"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - - // path params - if($username !== null) { - $resourcePath = str_replace("{" . "username" . "}", - $this->apiClient->toPathValue($username), $resourcePath); - } - - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array(); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - if(! $response) { - return null; - } - - $responseObject = $this->apiClient->deserialize($response,'User'); - return $responseObject; - } - - /** - * updateUser - * - * Updated user - * - * @param string $username name that need to be deleted (required) - * @param User $body Updated user object (required) - * @return void - */ - public function updateUser($username, $body) { - - // verify the required parameter 'username' is set - if ($username === null) { - throw new \InvalidArgumentException('Missing the required parameter $username when calling updateUser'); - } - - - // parse inputs - $resourcePath = "/user/{username}"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "PUT"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - - // path params - if($username !== null) { - $resourcePath = str_replace("{" . "username" . "}", - $this->apiClient->toPathValue($username), $resourcePath); - } - - // body params - $_tempBody = null; - if (isset($body)) { - $_tempBody = $body; - } - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array(); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - - } - - /** - * deleteUser - * - * Delete user - * - * @param string $username The name that needs to be deleted (required) - * @return void - */ - public function deleteUser($username) { - - // verify the required parameter 'username' is set - if ($username === null) { - throw new \InvalidArgumentException('Missing the required parameter $username when calling deleteUser'); - } - - - // parse inputs - $resourcePath = "/user/{username}"; - $resourcePath = str_replace("{format}", "json", $resourcePath); - $method = "DELETE"; - $httpBody = ''; - $queryParams = array(); - $headerParams = array(); - $formParams = array(); - $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', 'application/xml')); - if (!is_null($_header_accept)) { - $headerParams['Accept'] = $_header_accept; - } - $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array()); - - - - // path params - if($username !== null) { - $resourcePath = str_replace("{" . "username" . "}", - $this->apiClient->toPathValue($username), $resourcePath); - } - - - - // for model (json/xml) - if (isset($_tempBody)) { - $httpBody = $_tempBody; // $_tempBody is the method argument, if present - } else if (count($formParams) > 0) { - // for HTTP post (form) - $httpBody = $formParams; - } - - // authentication setting, if any - $authSettings = array(); - - // make the API Call - $response = $this->apiClient->callAPI($resourcePath, $method, - $queryParams, $httpBody, - $headerParams, $authSettings); - - - } - - -}