AssignAttributeDefinitionStruct

AssignAttributeDefinitionStruct.php : 14 Copy path

Extends ValueObject

The base class for all value objects and structs.

Supports readonly properties by marking them as protected. In this case they will only be writable using constructor, and need to be documented using property-read <$var> annotation in class doc in addition to inline property doc. Writable properties must be public and must be documented inline.

Methods¶

__construct() ¶

AssignAttributeDefinitionStruct.php : 22 Copy path

Construct object optionally with a set of properties.

public __construct(AttributeDefinitionInterface $attributeDefinition[, bool $required = true ][, bool $isDiscriminator = false ])

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

Name	Type	Default value	Description
$attributeDefinition	AttributeDefinitionInterface	-	-
$required	bool	true	-
$isDiscriminator	bool	false	-

getAttributeDefinition() ¶

AssignAttributeDefinitionStruct.php : 34 Copy path

public getAttributeDefinition() : AttributeDefinitionInterface

Return values

AttributeDefinitionInterface

isDiscriminator() ¶

AssignAttributeDefinitionStruct.php : 54 Copy path

public isDiscriminator() : bool

Return values

bool

isRequired() ¶

AssignAttributeDefinitionStruct.php : 44 Copy path

public isRequired() : bool

Return values

bool

setAttributeDefinition() ¶

AssignAttributeDefinitionStruct.php : 39 Copy path

public setAttributeDefinition(AttributeDefinitionInterface $attributeDefinition) : void

Parameters

Name	Type	Default value	Description
$attributeDefinition	AttributeDefinitionInterface	-	-

setDiscriminator() ¶

AssignAttributeDefinitionStruct.php : 59 Copy path

public setDiscriminator(bool $isDiscriminator) : void

Parameters

Name	Type	Default value	Description
$isDiscriminator	bool	-	-

setRequired() ¶

AssignAttributeDefinitionStruct.php : 49 Copy path

public setRequired(bool $required) : void

Parameters

Name	Type	Default value	Description
$required	bool	-	-

getProperties() ¶

ValueObject.php : 50 Copy path

Function where list of properties are returned.

    
                        protected getProperties([array<string|int, mixed> $dynamicProperties = [] ]) : array<string|int, mixed>

Used by attributes(), override to add dynamic properties

Parameters

Name	Type	Default value	Description
$dynamicProperties	array<string\|int, mixed>	[]	Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>