[PHP] Improve generated codestyle

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/PhpClientCodegen.java

@@ -3,6 +3,7 @@ package io.swagger.codegen.languages;
 import io.swagger.codegen.CliOption;
 import io.swagger.codegen.CodegenConfig;
 import io.swagger.codegen.CodegenConstants;
+import io.swagger.codegen.CodegenOperation;
 import io.swagger.codegen.CodegenParameter;
 import io.swagger.codegen.CodegenProperty;
 import io.swagger.codegen.CodegenType;
@@ -13,6 +14,7 @@ import io.swagger.models.properties.*;
 import java.io.File;
 import java.util.Arrays;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.HashSet;
 import java.util.regex.Matcher;
@@ -626,4 +628,14 @@ public class PhpClientCodegen extends DefaultCodegen implements CodegenConfig {
         // process enum in models
         return postProcessModelsEnum(objs);
     }
+
+    @Override
+    public Map<String, Object> postProcessOperations(Map<String, Object> objs) {
+        Map<String, Object> operations = (Map<String, Object>) objs.get("operations");
+        List<CodegenOperation> operationList = (List<CodegenOperation>) operations.get("operation");
+        for (CodegenOperation op : operationList) {
+            op.vendorExtensions.put("x-testOperationId", camelize(op.operationId));
+        }
+        return objs;
+    }
 }

modules/swagger-codegen/src/main/resources/php/ApiClient.mustache

@@ -237,7 +237,7 @@ class ApiClient
         // Handle the response
         if ($response_info['http_code'] == 0) {
             throw new ApiException("API call to $url timed out: ".serialize($response_info), 0, null, null);
-        } elseif ($response_info['http_code'] >= 200 && $response_info['http_code'] <= 299 ) {
+        } elseif ($response_info['http_code'] >= 200 && $response_info['http_code'] <= 299) {
             // return raw body if response is a file
             if ($responseType == '\SplFileObject' || $responseType == 'string') {
                 return array($http_body, $response_info['http_code'], $http_header);
@@ -255,7 +255,9 @@ class ApiClient
 
             throw new ApiException(
                 "[".$response_info['http_code']."] Error connecting to the API ($url)",
-                $response_info['http_code'], $http_header, $data
+                $response_info['http_code'],
+                $http_header,
+                $data
             );
         }
         return array($data, $response_info['http_code'], $http_header);
@@ -310,31 +312,26 @@ class ApiClient
         $headers = array();
         $key = '';
 
-        foreach(explode("\n", $raw_headers) as $h)
+        foreach (explode("\n", $raw_headers) as $h) {
-        {
             $h = explode(':', $h, 2);
 
-            if (isset($h[1]))
+            if (isset($h[1])) {
-            {
+                if (!isset($headers[$h[0]])) {
-                if (!isset($headers[$h[0]]))
                     $headers[$h[0]] = trim($h[1]);
-                elseif (is_array($headers[$h[0]]))
+                } elseif (is_array($headers[$h[0]])) {
-                {
                     $headers[$h[0]] = array_merge($headers[$h[0]], array(trim($h[1])));
-                }
+                } else {
-                else
-                {
                     $headers[$h[0]] = array_merge(array($headers[$h[0]]), array(trim($h[1])));
                 }
 
                 $key = $h[0];
-            }
+            } else {
-            else
+                if (substr($h[0], 0, 1) == "\t") {
-            {
-                if (substr($h[0], 0, 1) == "\t")
                     $headers[$key] .= "\r\n\t".trim($h[0]);
-                elseif (!$key)
+                } elseif (!$key) {
-                    $headers[0] = trim($h[0]);trim($h[0]);
+                    $headers[0] = trim($h[0]);
+                }
+                trim($h[0]);
             }
         }
 

modules/swagger-codegen/src/main/resources/php/ApiException.mustache

@@ -75,7 +75,7 @@ class ApiException extends Exception
      * @param string $responseHeaders HTTP response header
      * @param mixed  $responseBody    HTTP body of the server response either as Json or string
      */
-    public function __construct($message="", $code=0, $responseHeaders=null, $responseBody=null)
+    public function __construct($message = "", $code = 0, $responseHeaders = null, $responseBody = null)
     {
         parent::__construct($message, $code);
         $this->responseHeaders = $responseHeaders;

modules/swagger-codegen/src/main/resources/php/ObjectSerializer.mustache

@@ -185,7 +185,7 @@ class ObjectSerializer
      *
      * @return string
      */
-    public function serializeCollection(array $collection, $collectionFormat, $allowCollectionFormatMulti=false)
+    public function serializeCollection(array $collection, $collectionFormat, $allowCollectionFormatMulti = false)
     {
         if ($allowCollectionFormatMulti && ('multi' === $collectionFormat)) {
             // http_build_query() almost does the job for us. We just
@@ -219,7 +219,7 @@ class ObjectSerializer
      *
      * @return object an instance of $class
      */
-    public static function deserialize($data, $class, $httpHeaders=null, $discriminator=null)
+    public static function deserialize($data, $class, $httpHeaders = null, $discriminator = null)
     {
         if (null === $data) {
             return null;
@@ -261,7 +261,8 @@ class ObjectSerializer
             return $data;
         } elseif ($class === '\SplFileObject') {
             // determine file name
-            if (array_key_exists('Content-Disposition', $httpHeaders) && preg_match('/inline; filename=[\'"]?([^\'"\s]+)[\'"]?$/i', $httpHeaders['Content-Disposition'], $match)) {
+            if (array_key_exists('Content-Disposition', $httpHeaders) &&
+                preg_match('/inline; filename=[\'"]?([^\'"\s]+)[\'"]?$/i', $httpHeaders['Content-Disposition'], $match)) {
                 $filename = Configuration::getDefaultConfiguration()->getTempFolderPath() . sanitizeFilename($match[1]);
             } else {
                 $filename = tempnam(Configuration::getDefaultConfiguration()->getTempFolderPath(), '');
@@ -274,7 +275,6 @@ class ObjectSerializer
             }
 
             return $deserialized;
-
         } else {
             // If a discriminator is defined and points to a valid subclass, use it.
             if (!empty($discriminator) && isset($data->{$discriminator}) && is_string($data->{$discriminator})) {

modules/swagger-codegen/src/main/resources/php/api.mustache

@@ -62,7 +62,7 @@ use \{{invokerPackage}}\ObjectSerializer;
      *
      * @param \{{invokerPackage}}\ApiClient|null $apiClient The api client to use
      */
-    function __construct(\{{invokerPackage}}\ApiClient $apiClient = null)
+    public function __construct(\{{invokerPackage}}\ApiClient $apiClient = null)
     {
         if ($apiClient == null) {
             $apiClient = new ApiClient();
@@ -99,7 +99,7 @@ use \{{invokerPackage}}\ObjectSerializer;
     /**
      * Operation {{{operationId}}}
      *
-     * {{{summary}}}
+     * {{{summary}}}.
      *
   {{#allParams}}   * @param {{dataType}} ${{paramName}} {{description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
   {{/allParams}}   *
@@ -116,7 +116,7 @@ use \{{invokerPackage}}\ObjectSerializer;
     /**
      * Operation {{{operationId}}}WithHttpInfo
      *
-     * {{{summary}}}
+     * {{{summary}}}.
      *
   {{#allParams}}   * @param {{dataType}} ${{paramName}} {{description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}
   {{/allParams}}   *
@@ -251,9 +251,12 @@ use \{{invokerPackage}}\ObjectSerializer;
         // make the API Call
         try {
             list($response, $statusCode, $httpHeader) = $this->apiClient->callApi(
-                $resourcePath, '{{httpMethod}}',
+                $resourcePath,
-                $queryParams, $httpBody,
+                '{{httpMethod}}',
-                $headerParams{{#returnType}}, '{{returnType}}'{{/returnType}}
+                $queryParams,
+                $httpBody,
+                $headerParams{{#returnType}},
+                '{{returnType}}'{{/returnType}}
             );
             {{#returnType}}
             if (!$response) {
@@ -261,15 +264,20 @@ use \{{invokerPackage}}\ObjectSerializer;
             }
 
             return array($this->apiClient->getSerializer()->deserialize($response, '{{returnType}}', $httpHeader{{#discriminator}}, '{{discriminator}}'{{/discriminator}}), $statusCode, $httpHeader);
-            {{/returnType}}{{^returnType}}
+            {{/returnType}}
+            {{^returnType}}
             return array(null, $statusCode, $httpHeader);
             {{/returnType}}
         } catch (ApiException $e) {
-            switch ($e->getCode()) { {{#responses}}{{#dataType}}
+            switch ($e->getCode()) {
+            {{#responses}}
+              {{#dataType}}
                 {{^isWildcard}}case {{code}}:{{/isWildcard}}{{#isWildcard}}default:{{/isWildcard}}
                     $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '{{dataType}}', $e->getResponseHeaders());
                     $e->setResponseObject($data);
-                break;{{/dataType}}{{/responses}}
+                    break;
+              {{/dataType}}
+            {{/responses}}
             }
 
             throw $e;

modules/swagger-codegen/src/main/resources/php/api_test.mustache

@@ -70,10 +70,10 @@ use \{{invokerPackage}}\ObjectSerializer;
     /**
      * Test case for {{{operationId}}}
      *
-     * {{{summary}}}
+     * {{{summary}}}.
      *
      */
-    public function test_{{operationId}}()
+    public function test{{vendorExtensions.x-testOperationId}}()
     {
 
     }

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

@@ -47,7 +47,7 @@ namespace {{invokerPackage}};
 class Configuration
 {
 
-    private static $_defaultConfiguration = null;
+    private static $defaultConfiguration = null;
 
     /**
      * Associate array to store API key(s)
@@ -487,11 +487,11 @@ class Configuration
      */
     public static function getDefaultConfiguration()
     {
-        if (self::$_defaultConfiguration == null) {
+        if (self::$defaultConfiguration == null) {
-            self::$_defaultConfiguration = new Configuration();
+            self::$defaultConfiguration = new Configuration();
         }
 
-        return self::$_defaultConfiguration;
+        return self::$defaultConfiguration;
     }
 
     /**
@@ -503,7 +503,7 @@ class Configuration
      */
     public static function setDefaultConfiguration(Configuration $config)
     {
-        self::$_defaultConfiguration = $config;
+        self::$defaultConfiguration = $config;
     }
 
     /**
@@ -522,5 +522,4 @@ class Configuration
 
         return $report;
     }
-
 }

modules/swagger-codegen/src/main/resources/php/model.mustache

@@ -41,7 +41,9 @@ use \ArrayAccess;
  * {{classname}} Class Doc Comment
  *
  * @category    Class
+{{#description}}
  * @description {{description}}
+{{/description}}
  * @package     {{invokerPackage}}
  * @author      http://github.com/swagger-api/swagger-codegen
  * @license     http://www.apache.org/licenses/LICENSE-2.0 Apache Licene v2
@@ -53,18 +55,19 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple
       * The original name of the model.
       * @var string
       */
-    static $swaggerModelName = '{{name}}';
+    protected static $swaggerModelName = '{{name}}';
 
     /**
       * Array of property to type mappings. Used for (de)serialization
       * @var string[]
       */
-    static $swaggerTypes = array(
+    protected static $swaggerTypes = array(
         {{#vars}}'{{name}}' => '{{{datatype}}}'{{#hasMore}},
         {{/hasMore}}{{/vars}}
     );
 
-    static function swaggerTypes() {
+    public static function swaggerTypes()
+    {
         return self::$swaggerTypes{{#parentSchema}} + parent::swaggerTypes(){{/parentSchema}};
     }
 
@@ -72,12 +75,13 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple
      * Array of attributes where the key is the local name, and the value is the original name
      * @var string[]
      */
-    static $attributeMap = array(
+    protected static $attributeMap = array(
         {{#vars}}'{{name}}' => '{{baseName}}'{{#hasMore}},
         {{/hasMore}}{{/vars}}
     );
 
-    static function attributeMap() {
+    public static function attributeMap()
+    {
         return {{#parentSchema}}parent::attributeMap() + {{/parentSchema}}self::$attributeMap;
     }
 
@@ -85,12 +89,13 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple
      * Array of attributes to setter functions (for deserialization of responses)
      * @var string[]
      */
-    static $setters = array(
+    protected static $setters = array(
         {{#vars}}'{{name}}' => '{{setter}}'{{#hasMore}},
         {{/hasMore}}{{/vars}}
     );
 
-    static function setters() {
+    public static function setters()
+    {
         return {{#parentSchema}}parent::setters() + {{/parentSchema}}self::$setters;
     }
 
@@ -98,12 +103,12 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple
      * Array of attributes to getter functions (for serialization of requests)
      * @var string[]
      */
-    static $getters = array(
+    protected static $getters = array(
         {{#vars}}'{{name}}' => '{{getter}}'{{#hasMore}},
         {{/hasMore}}{{/vars}}
     );
 
-    static function getters()
+    public static function getters()
     {
         return {{#parentSchema}}parent::getters() + {{/parentSchema}}self::$getters;
     }
@@ -267,7 +272,7 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}imple
 
     /**
      * Sets {{name}}
-     * @param {{datatype}} ${{name}} {{#description}}{{{description}}}{{/description}}
+     * @param {{datatype}} ${{name}}{{#description}} {{{description}}}{{/description}}
      * @return $this
      */
     public function {{setter}}(${{name}})

modules/swagger-codegen/src/main/resources/php/model_test.mustache

@@ -39,7 +39,7 @@ namespace {{modelPackage}};
  * {{classname}}Test Class Doc Comment
  *
  * @category    Class
- * @description {{description}}
+ * @description {{#description}}{{description}}{{/description}}{{^description}}{{classname}}{{/description}}
  * @package     {{invokerPackage}}
  * @author      http://github.com/swagger-api/swagger-codegen
  * @license     http://www.apache.org/licenses/LICENSE-2.0 Apache Licene v2
@@ -65,13 +65,12 @@ class {{classname}}Test extends \PHPUnit_Framework_TestCase
     }
 
     /**
-     * Test {{classname}}
+     * Test "{{classname}}"
      */
     public function test{{classname}}()
     {
 
     }
-
 }
 {{/model}}
 {{/models}}

samples/client/petstore/php/SwaggerClient-php/phpcs-generated-code.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<!-- See http://pear.php.net/manual/en/package.php.php-codesniffer.annotated-ruleset.php -->
+<ruleset name="PhpSwaggerCodegen">
+ <description>Arnes Drupal code checker</description>
+
+ <rule ref="PSR2" />
+ <rule ref="Generic.Files.LineLength">
+   <exclude-pattern>*</exclude-pattern>
+ </rule>
+</ruleset>