[php-nextgen]: Inherit model method docs and fix interface types (#23307)

Co-authored-by: coffeemakr <coffeemakr@users.noreply.github.com>

Author: coffeemakr

modules/openapi-generator/src/main/resources/php-nextgen/ModelInterface.mustache

@@ -37,50 +37,51 @@ interface ModelInterface
     /**
      * Array of property to type mappings. Used for (de)serialization
      *
-     * @return array
+     * @return array<string,string>
      */
     public static function openAPITypes(): array;
 
     /**
      * Array of property to format mappings. Used for (de)serialization
      *
-     * @return array
+     * @return array<string,string|null>
      */
     public static function openAPIFormats(): array;
 
     /**
-     * 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
      *
-     * @return array
+     * @return array<string,string>
      */
     public static function attributeMap(): array;
 
     /**
      * Array of attributes to setter functions (for deserialization of responses)
      *
-     * @return array
+     * @return array<string,string>
      */
     public static function setters(): array;
 
     /**
      * Array of attributes to getter functions (for serialization of requests)
      *
-     * @return array
+     * @return array<string,string>
      */
     public static function getters(): array;
 
     /**
      * Show all the invalid properties with reasons.
      *
-     * @return array
+     * @return string[] invalid properties with reasons
      */
     public function listInvalidProperties(): array;
 
     /**
      * Validate all the properties in the model
      * return true if all passed
      *
-     * @return bool
+     * @return bool True if all properties are valid
      */
     public function valid(): bool;
 

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

@@ -47,19 +47,15 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}}{{/parentSchema}}{{^par
     protected array $openAPINullablesSetToNull = [];
 
     /**
-     * Array of property to type mappings. Used for (de)serialization
-     *
-     * @return array<string, string>
+     * {@inheritdoc}
      */
     public static function openAPITypes(): array
     {
         return self::$openAPITypes{{#parentSchema}} + parent::openAPITypes(){{/parentSchema}};
     }
 
     /**
-     * Array of property to format mappings. Used for (de)serialization
-     *
-     * @return array<string, string>
+     * {@inheritdoc}
      */
     public static function openAPIFormats(): array
     {
@@ -97,21 +93,15 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}}{{/parentSchema}}{{^par
     }
 
     /**
-     * Checks if a property is nullable
-     *
-     * @param string $property
-     * @return bool
+     * {@inheritdoc}
      */
     public static function isNullable(string $property): bool
     {
         return self::openAPINullables()[$property] ?? false;
     }
 
     /**
-     * Checks if a nullable property is set to null.
-     *
-     * @param string $property
-     * @return bool
+     * {@inheritdoc}
      */
     public function isNullableSetToNull(string $property): bool
     {
@@ -150,40 +140,31 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}}{{/parentSchema}}{{^par
     ];
 
     /**
-     * Array of attributes where the key is the local name,
-     * and the value is the original name
-     *
-     * @return array<string, string>
+     * {@inheritdoc}
      */
     public static function attributeMap(): array
     {
         return {{#parentSchema}}parent::attributeMap() + {{/parentSchema}}self::$attributeMap;
     }
 
     /**
-     * Array of attributes to setter functions (for deserialization of responses)
-     *
-     * @return array<string, string>
+     * {@inheritdoc}
      */
     public static function setters(): array
     {
         return {{#parentSchema}}parent::setters() + {{/parentSchema}}self::$setters;
     }
 
     /**
-     * Array of attributes to getter functions (for serialization of requests)
-     *
-     * @return array<string, string>
+     * {@inheritdoc}
      */
     public static function getters(): array
     {
         return {{#parentSchema}}parent::getters() + {{/parentSchema}}self::$getters;
     }
 
     /**
-     * The original name of the model.
-     *
-     * @return string
+     * {@inheritdoc}
      */
     public function getModelName(): string
     {
@@ -280,9 +261,7 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}}{{/parentSchema}}{{^par
     }
 
     /**
-     * Show all the invalid properties with reasons.
-     *
-     * @return string[] invalid properties with reasons
+     * {@inheritdoc}
      */
     public function listInvalidProperties(): array
     {
@@ -361,10 +340,7 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}}{{/parentSchema}}{{^par
     }
 
     /**
-     * Validate all the properties in the model
-     * return true if all passed
-     *
-     * @return bool True if all properties are valid
+     * {@inheritdoc}
      */
     public function valid(): bool
     {

samples/client/echo_api/php-nextgen-streaming/src/Model/Bird.php

@@ -91,19 +91,15 @@ class Bird implements ModelInterface, ArrayAccess, JsonSerializable
     protected array $openAPINullablesSetToNull = [];
 
     /**
-     * Array of property to type mappings. Used for (de)serialization
-     *
-     * @return array<string, string>
+     * {@inheritdoc}
      */
     public static function openAPITypes(): array
     {
         return self::$openAPITypes;
     }
 
     /**
-     * Array of property to format mappings. Used for (de)serialization
-     *
-     * @return array<string, string>
+     * {@inheritdoc}
      */
     public static function openAPIFormats(): array
     {
@@ -141,21 +137,15 @@ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull):
     }
 
     /**
-     * Checks if a property is nullable
-     *
-     * @param string $property
-     * @return bool
+     * {@inheritdoc}
      */
     public static function isNullable(string $property): bool
     {
         return self::openAPINullables()[$property] ?? false;
     }
 
     /**
-     * Checks if a nullable property is set to null.
-     *
-     * @param string $property
-     * @return bool
+     * {@inheritdoc}
      */
     public function isNullableSetToNull(string $property): bool
     {
@@ -194,40 +184,31 @@ public function isNullableSetToNull(string $property): bool
     ];
 
     /**
-     * Array of attributes where the key is the local name,
-     * and the value is the original name
-     *
-     * @return array<string, string>
+     * {@inheritdoc}
      */
     public static function attributeMap(): array
     {
         return self::$attributeMap;
     }
 
     /**
-     * Array of attributes to setter functions (for deserialization of responses)
-     *
-     * @return array<string, string>
+     * {@inheritdoc}
      */
     public static function setters(): array
     {
         return self::$setters;
     }
 
     /**
-     * Array of attributes to getter functions (for serialization of requests)
-     *
-     * @return array<string, string>
+     * {@inheritdoc}
      */
     public static function getters(): array
     {
         return self::$getters;
     }
 
     /**
-     * The original name of the model.
-     *
-     * @return string
+     * {@inheritdoc}
      */
     public function getModelName(): string
     {
@@ -272,9 +253,7 @@ private function setIfExists(string $variableName, array $fields, mixed $default
     }
 
     /**
-     * Show all the invalid properties with reasons.
-     *
-     * @return string[] invalid properties with reasons
+     * {@inheritdoc}
      */
     public function listInvalidProperties(): array
     {
@@ -284,10 +263,7 @@ public function listInvalidProperties(): array
     }
 
     /**
-     * Validate all the properties in the model
-     * return true if all passed
-     *
-     * @return bool True if all properties are valid
+     * {@inheritdoc}
      */
     public function valid(): bool
     {