NullΒΆ
Used for properties which only accept null.
{
"$id": "example",
"type": "object",
"properties": {
"example": {
"type": "null"
}
}
}
Generated interface (as null is no explicit type no typehints are generated):
public function setExample($example): self;
public function getExample();
Possible exceptions:
Invalid type for property. Requires null, got __TYPE__
The main use case for the null type is a property with multiple types accepting for example a string and null values when using explicit null types.
The thrown exception will be a PHPModelGenerator\Exception\Generic\InvalidTypeException which provides the following methods to get further error details:
// returns a string if the property expects exactly one type, an array if the property accepts multiple types
public function getExpectedType()
// get the name of the property which failed
public function getPropertyName(): string
// get the value provided to the property
public function getProvidedValue()