[PHP] Correctly format JSON in headers (#4024)

* [PHP] Correctly format JSON in headers

`ObjectSerializer::toHeaderValue()` in the generated PHP code calls
`toString()` on the values, which formats JSON with the `JSON_PRETTY_PRINT`
option. This will result in a multi-line header which cannot be parsed
since linebreaks aren't allowed by RFC 7230.

In my case I have a header schema called `UpdateUser` which I had hoped
would be serialized as `{"type":"staff","id":123}`.

Every single `__toString()` in the generator does the same thing, so I
figured it's safe to change `toHeaderValue()` to convert to JSON directly,
without `JSON_PRETTY_PRINT`. This fix works for me.

* More sensible approach to providing a header value

* Just strip the newlines

* Go back to previous solution

Author: hinrik

modules/openapi-generator/src/main/resources/php/ObjectSerializer.mustache

@@ -140,6 +140,10 @@ class ObjectSerializer
      */
     public static function toHeaderValue($value)
     {
+        if (method_exists($value, 'toHeaderValue')) {
+            return $value->toHeaderValue();
+        }
+
         return self::toString($value);
     }
 

modules/openapi-generator/src/main/resources/php/model_generic.mustache

@@ -410,4 +410,14 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}} {{/parentSchema}}{{^pa
             JSON_PRETTY_PRINT
         );
     }
+
+    /**
+     * Gets a header-safe presentation of the object
+     *
+     * @return string
+     */
+    public function toHeaderValue()
+    {
+        return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+    }
 }

samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesAnyType.php

@@ -292,6 +292,16 @@ public function __toString()
             JSON_PRETTY_PRINT
         );
     }
+
+    /**
+     * Gets a header-safe presentation of the object
+     *
+     * @return string
+     */
+    public function toHeaderValue()
+    {
+        return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+    }
 }
 
 

samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesArray.php

@@ -292,6 +292,16 @@ public function __toString()
             JSON_PRETTY_PRINT
         );
     }
+
+    /**
+     * Gets a header-safe presentation of the object
+     *
+     * @return string
+     */
+    public function toHeaderValue()
+    {
+        return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+    }
 }
 
 

samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesBoolean.php

@@ -292,6 +292,16 @@ public function __toString()
             JSON_PRETTY_PRINT
         );
     }
+
+    /**
+     * Gets a header-safe presentation of the object
+     *
+     * @return string
+     */
+    public function toHeaderValue()
+    {
+        return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+    }
 }
 
 

samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesClass.php

@@ -592,6 +592,16 @@ public function __toString()
             JSON_PRETTY_PRINT
         );
     }
+
+    /**
+     * Gets a header-safe presentation of the object
+     *
+     * @return string
+     */
+    public function toHeaderValue()
+    {
+        return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+    }
 }
 
 

samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesInteger.php

@@ -292,6 +292,16 @@ public function __toString()
             JSON_PRETTY_PRINT
         );
     }
+
+    /**
+     * Gets a header-safe presentation of the object
+     *
+     * @return string
+     */
+    public function toHeaderValue()
+    {
+        return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+    }
 }
 
 

samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesNumber.php

@@ -292,6 +292,16 @@ public function __toString()
             JSON_PRETTY_PRINT
         );
     }
+
+    /**
+     * Gets a header-safe presentation of the object
+     *
+     * @return string
+     */
+    public function toHeaderValue()
+    {
+        return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+    }
 }
 
 

samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesObject.php

@@ -292,6 +292,16 @@ public function __toString()
             JSON_PRETTY_PRINT
         );
     }
+
+    /**
+     * Gets a header-safe presentation of the object
+     *
+     * @return string
+     */
+    public function toHeaderValue()
+    {
+        return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+    }
 }
 
 

samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesString.php

@@ -292,6 +292,16 @@ public function __toString()
             JSON_PRETTY_PRINT
         );
     }
+
+    /**
+     * Gets a header-safe presentation of the object
+     *
+     * @return string
+     */
+    public function toHeaderValue()
+    {
+        return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+    }
 }