Escape interpolated PHP vars in descriptions

swaggest · Dec 18, 2023 · 83dc3e7 · 83dc3e7
1 parent 395ef94
commit 83dc3e7
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 5 deletions.
diff --git a/src/JsonSchema/SchemaBuilder.php b/src/JsonSchema/SchemaBuilder.php
@@ -396,7 +396,7 @@ private function processOther()
             } elseif ($value instanceof \stdClass) {
                 $export = '(object)' . PhpCode::varExport((array)$value);
             } elseif (is_string($value)) {
-                $export = '"' . str_replace(array('\\', "\n", "\r", "\t", '"'), array('\\\\', '\n', '\r', '\t', '\"'), $value) . '"';
+                $export = '"' . str_replace(array('\\', "\n", "\r", "\t", '"', '${', '{$'), array('\\\\', '\n', '\r', '\t', '\"', '\${', '{\$'), $value) . '"';
             } else {
                 $export = PhpCode::varExport($value);
             }

diff --git a/src/Traits/Description.php b/src/Traits/Description.php
@@ -2,9 +2,6 @@
 
 namespace Swaggest\PhpCodeBuilder\Traits;
 
-
-use Swaggest\PhpCodeBuilder\PhpDoc;
-
 trait Description
 {
     use PhpDocable;

diff --git a/tests/src/PHPUnit/JsonSchema/TypeBuilderTest.php b/tests/src/PHPUnit/JsonSchema/TypeBuilderTest.php
@@ -22,6 +22,7 @@ public function testRef()
     "definitions": {
         "header": {
             "type": "object",
+            "description": "Something with an interpolated ${VALUE}",
             "properties": {
                 "maximum": {"$ref": "#/definitions/maximum"}
             }
@@ -68,6 +69,7 @@ public static function setUpProperties($properties, Schema $ownerSchema)
         $properties->maximum = Schema::number();
         $properties->maximum->setFromRef('#/definitions/maximum');
         $ownerSchema->type = Schema::OBJECT;
+        $ownerSchema->description = "Something with an interpolated \${VALUE}";
         $ownerSchema->setFromRef('#/definitions/header');
     }
 
@@ -92,7 +94,7 @@ public function setMaximum($maximum)
 
         eval(substr($file->render(), 6));
         $exported = Schema::export($className::schema());
-        $this->assertSame('{"properties":{"maximum":{"$ref":"#/definitions/maximum"}},"type":"object","definitions":{"maximum":{"type":"number"}}}',
+        $this->assertSame('{"description":"Something with an interpolated ${VALUE}","properties":{"maximum":{"$ref":"#/definitions/maximum"}},"type":"object","definitions":{"maximum":{"type":"number"}}}',
             json_encode($exported, JSON_UNESCAPED_SLASHES));
     }