scenarioDefaultDescription: scenarioName, scenarioConst, modelName

php-openapi · Aug 25, 2024 · 69dfc10 · 69dfc10
1 parent 19d5c36
commit 69dfc10
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 6 deletions.
diff --git a/src/generator/ApiGenerator.php b/src/generator/ApiGenerator.php
@@ -138,7 +138,8 @@ class ApiGenerator extends Generator
      * @var array Map for custom dbModels
      * @example
      *  'dbModel' => [
-     *      'scenarioDefaultDescription' => " Scenario {name}",     @see DbModel::$scenarioDefaultDescription
+     *      AcceptedInputs: {scenarioName}, {scenarioConst}, {modelName}.
+     *      'scenarioDefaultDescription' => " Scenario {scenarioName}",     @see DbModel::$scenarioDefaultDescription
      *  ]
      */
     public $dbModel = [];

diff --git a/src/lib/Config.php b/src/lib/Config.php
@@ -113,7 +113,8 @@ class Config extends BaseObject
      * @var array Map for custom dbModels
      * @example
      *  'dbModel' => [
-     *      'scenarioDefaultDescription' => " Scenario {name}",             @see DbModel::$scenarioDefaultDescription
+     *      AcceptedInputs: {scenarioName}, {scenarioConst}, {modelName}.
+     *      'scenarioDefaultDescription' => " Scenario {scenarioName}",     @see DbModel::$scenarioDefaultDescription
      *  ]
      */
     public $dbModel = [];

diff --git a/src/lib/items/DbModel.php b/src/lib/items/DbModel.php
@@ -90,9 +90,9 @@ class DbModel extends BaseObject
     /**
      * @var string
      * Here, you can set your own default description for the scenario.
-     * You can use the {name} attribute from the schema for the YAML model.
+     * AcceptedInputs: {scenarioName}, {scenarioConst}, {modelName}.
      */
-    public string $scenarioDefaultDescription = " Scenario {name}";
+    public string $scenarioDefaultDescription = " Scenario {scenarioName}";
 
     public function getTableAlias():string
     {
@@ -237,8 +237,15 @@ private function getScenariosByOpenapiSchema(): array
             $scenarios[$key]['description'] = FormatHelper::getFormattedDescription(
             !empty($scenario['description']) ?
                 $scenario['description']
-                : str_replace('{name}', $scenario['name'], $this->scenarioDefaultDescription
-            ),
+                : str_replace([
+                    '{scenarioName}',
+                    '{scenarioConst}',
+                    '{modelName}',
+                ], [
+                    $scenario['name'],
+                    $scenarios[$key]['const'],
+                    $this->name,
+                ], $this->scenarioDefaultDescription),
             5);
         }