AttributeDefinitionCreateStruct

AttributeDefinitionCreateStruct.php : 15 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() ¶

AttributeDefinitionCreateStruct.php : 36 Copy path

Construct object optionally with a set of properties.

public __construct(string $identifier)

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
$identifier	string	-	-

getDescriptions() ¶

AttributeDefinitionCreateStruct.php : 93 Copy path

public getDescriptions() : array<string, string>

Return values

array<string, string>

getGroup() ¶

AttributeDefinitionCreateStruct.php : 57 Copy path

public getGroup() : AttributeGroupInterface

Return values

AttributeGroupInterface

getIdentifier() ¶

AttributeDefinitionCreateStruct.php : 47 Copy path

public getIdentifier() : string

Return values

string

getNames() ¶

AttributeDefinitionCreateStruct.php : 80 Copy path

public getNames() : array<string, string>

Return values

array<string, string>

getOptions() ¶

AttributeDefinitionCreateStruct.php : 116 Copy path

public getOptions() : array<string, mixed>

Return values

array<string, mixed>

getPosition() ¶

AttributeDefinitionCreateStruct.php : 103 Copy path

public getPosition() : int

Return values

int

getType() ¶

AttributeDefinitionCreateStruct.php : 67 Copy path

public getType() : AttributeTypeInterface

Return values

AttributeTypeInterface

setDescription() ¶

AttributeDefinitionCreateStruct.php : 98 Copy path

public setDescription(string $languageCode, string $description) : void

Parameters

Name	Type	Default value	Description
$languageCode	string	-	-
$description	string	-	-

setGroup() ¶

AttributeDefinitionCreateStruct.php : 62 Copy path

public setGroup(AttributeGroupInterface $group) : void

Parameters

Name	Type	Default value	Description
$group	AttributeGroupInterface	-	-

setIdentifier() ¶

AttributeDefinitionCreateStruct.php : 52 Copy path

public setIdentifier(string $identifier) : void

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

setName() ¶

AttributeDefinitionCreateStruct.php : 85 Copy path

public setName(string $languageCode, string $name) : void

Parameters

Name	Type	Default value	Description
$languageCode	string	-	-
$name	string	-	-

setOptions() ¶

AttributeDefinitionCreateStruct.php : 124 Copy path

public setOptions(array<string, mixed> $options) : void

Parameters

Name	Type	Default value	Description
$options	array<string, mixed>	-	-

setPosition() ¶

AttributeDefinitionCreateStruct.php : 108 Copy path

public setPosition(int $position) : void

Parameters

Name	Type	Default value	Description
$position	int	-	-

setType() ¶

AttributeDefinitionCreateStruct.php : 72 Copy path

public setType(AttributeTypeInterface $type) : void

Parameters

Name	Type	Default value	Description
$type	AttributeTypeInterface	-	-

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>