php-nextgen.ModelInterface.mustache Maven / Gradle / Ivy
partial_header}}
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
namespace {{modelPackage}};
/**
* Interface abstracting model access.
*
* @package {{modelPackage}}
* @author OpenAPI Generator team
*/
interface ModelInterface
{
/**
* The original name of the model.
*
* @return string
*/
public function getModelName(): string;
/**
* Array of property to type mappings. Used for (de)serialization
*
* @return array
*/
public static function openAPITypes(): array;
/**
* Array of property to format mappings. Used for (de)serialization
*
* @return array
*/
public static function openAPIFormats(): array;
/**
* Array of attributes where the key is the local name, and the value is the original name
*
* @return array
*/
public static function attributeMap(): array;
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @return array
*/
public static function setters(): array;
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @return array
*/
public static function getters(): array;
/**
* Show all the invalid properties with reasons.
*
* @return array
*/
public function listInvalidProperties(): array;
/**
* Validate all the properties in the model
* return true if all passed
*
* @return bool
*/
public function valid(): bool;
/**
* Checks if a property is nullable
*
* @param string $property
* @return bool
*/
public static function isNullable(string $property): bool;
/**
* Checks if a nullable property is set to null.
*
* @param string $property
* @return bool
*/
public function isNullableSetToNull(string $property): bool;
}