Required values

By default the values of a schema are not required. In this case the input is valid if the property is not provided. If the value isn’t provided an optionally defined default value is used.

{
    "$id": "example",
    "type": "object",
    "properties": {
        "example": {
            "type": "string",
            "default": "Not provided"
        }
    },
    "required": []
}

Generated interface:

public function setExample(string $example): self;
// As the property is not required it may be initialized with null. Consequently the return value is nullable
public function getExample(): ?string;

Behaviour with different inputs:

// property example not provided
$example = new Example([]);
$example->getExample();     // returns "Not provided". If no default value has been defined in the schema NULL would be returned

// property example explicitly set to null.
// allowed as the property isn't required.
// Works only if implicitNull is enabled. Otherwise an exception will be thrown.
// If implicitNull is enabled the signature of setExample will also change to accept null.
$example = new Example(['example' => null]);
$example->getExample();     // returns NULL

// property example set to a custom value
$example = new Example(['example' => 'My Input']);
$example->getExample();     // returns "My Input"

By setting the property to a required value the property must be always provided.

{
    "$id": "example",
    "type": "object",
    "properties": {
        "example": {
            "type": "string"
        }
    },
    "required": ["example"]
}

Generated interface (type hints not nullable any longer):

public function setExample(string $example): self;
public function getExample(): string;

Possible exceptions:

• Missing required value for example

The thrown exception will be an PHPModelGenerator\Exception\Object\RequiredValueException which provides the following methods to get further error details:

// get the name of the property which failed
public function getPropertyName(): string
// get the value provided to the property
public function getProvidedValue()

Behaviour with different inputs:

// property example not provided --> throws an exception
$example = new Example([]);

// property example explicitly set to null --> throws an exception
$example = new Example(['example' => null]);

// property example set to a custom value
$example = new Example(['example' => 'My Input']);
$example->getExample();     // returns "My Input"