The base class for all value objects and structs.
Supports read-only properties by marking them as protected.
In this case they will only be writable using constructor, and need to be documented
using @property-read <type> <$var> annotation in class doc in addition to inline property doc.
Writable properties must be public and must be documented inline.
Methods¶
                 __construct()
            ¶
__construct()
            ¶
    
        
        AssignAttributeDefinitionStruct.php
                :
        22
                 
    
        Construct object optionally with a set of properties.
|  |  | 
Readonly properties values must be set using $properties as they aren't writable anymore
after object has been created.
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $attributeDefinition | AttributeDefinitionInterface | - | - | 
| $required | bool | true | - | 
| $isDiscriminator | bool | false | - | 
                 getAttributeDefinition()
            ¶
getAttributeDefinition()
            ¶
    
        
        AssignAttributeDefinitionStruct.php
                :
        34
                 
    
        |  |  | 
Return values
                 isDiscriminator()
            ¶
isDiscriminator()
            ¶
    
        
        AssignAttributeDefinitionStruct.php
                :
        54
                 
    
        |  |  | 
Return values
bool
                 isRequired()
            ¶
isRequired()
            ¶
    
        
        AssignAttributeDefinitionStruct.php
                :
        44
                 
    
        |  |  | 
Return values
bool
                 setAttributeDefinition()
            ¶
setAttributeDefinition()
            ¶
    
        
        AssignAttributeDefinitionStruct.php
                :
        39
                 
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $attributeDefinition | AttributeDefinitionInterface | - | - | 
                 setDiscriminator()
            ¶
setDiscriminator()
            ¶
    
        
        AssignAttributeDefinitionStruct.php
                :
        59
                 
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $isDiscriminator | bool | - | - | 
                 setRequired()
            ¶
setRequired()
            ¶
    
        
        AssignAttributeDefinitionStruct.php
                :
        49
                 
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $required | bool | - | - | 
                 getProperties()
            ¶
getProperties()
            ¶
    
        
        ValueObject.php
                :
        53
                 
    
        Returns list of available properties' names.
|  |  | 
Override to add dynamic properties.
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $dynamicProperties | array<int, string> | [] | Additional dynamic properties exposed on the object | 
Return values
array<int, string>
Attributes
- #[Ignore]