github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/php/ModelInterface.mustache (about)

     1  <?php
     2  /**
     3   * ModelInterface
     4   *
     5   * PHP version 5
     6   *
     7   * @category Class
     8   * @package  {{modelPackage}}
     9   * @author   OpenAPI Generator team
    10   * @link     https://openapi-generator.tech
    11   */
    12  
    13  {{>partial_header}}
    14  /**
    15   * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
    16   * https://openapi-generator.tech
    17   * Do not edit the class manually.
    18   */
    19  
    20  namespace {{modelPackage}};
    21  
    22  /**
    23   * Interface abstracting model access.
    24   *
    25   * @package {{modelPackage}}
    26   * @author  OpenAPI Generator team
    27   */
    28  interface ModelInterface
    29  {
    30      /**
    31       * The original name of the model.
    32       *
    33       * @return string
    34       */
    35      public function getModelName();
    36  
    37      /**
    38       * Array of property to type mappings. Used for (de)serialization
    39       *
    40       * @return array
    41       */
    42      public static function openAPITypes();
    43  
    44      /**
    45       * Array of property to format mappings. Used for (de)serialization
    46       *
    47       * @return array
    48       */
    49      public static function openAPIFormats();
    50  
    51      /**
    52       * Array of attributes where the key is the local name, and the value is the original name
    53       *
    54       * @return array
    55       */
    56      public static function attributeMap();
    57  
    58      /**
    59       * Array of attributes to setter functions (for deserialization of responses)
    60       *
    61       * @return array
    62       */
    63      public static function setters();
    64  
    65      /**
    66       * Array of attributes to getter functions (for serialization of requests)
    67       *
    68       * @return array
    69       */
    70      public static function getters();
    71  
    72      /**
    73       * Show all the invalid properties with reasons.
    74       *
    75       * @return array
    76       */
    77      public function listInvalidProperties();
    78  
    79      /**
    80       * Validate all the properties in the model
    81       * return true if all passed
    82       *
    83       * @return bool
    84       */
    85      public function valid();
    86  }