Copied!

AttributeDefinitionUpdateStruct

AttributeDefinitionUpdateStruct.php : 14
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

public__construct()

ValueObject.php : 31

Construct object optionally with a set of properties.

 
public __construct([array<string|int, mixed> $properties = [] ])

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
$properties array<string|int, mixed> [] -

publicgetDescriptions()

AttributeDefinitionUpdateStruct.php : 77 
public getDescriptions() : array<string, string>

Return values

array<string, string>

publicgetGroup()

AttributeDefinitionUpdateStruct.php : 43 
public getGroup() : AttributeGroupInterface|null

Return values

AttributeGroupInterface|null

publicgetIdentifier()

AttributeDefinitionUpdateStruct.php : 33 
public getIdentifier() : string|null

Return values

string|null

publicgetNames()

AttributeDefinitionUpdateStruct.php : 56 
public getNames() : array<string, string>

Return values

array<string, string>

publicgetOptions()

AttributeDefinitionUpdateStruct.php : 108 
public getOptions() : array<string, mixed>|null

Return values

array<string, mixed>|null

publicgetPosition()

AttributeDefinitionUpdateStruct.php : 95 
public getPosition() : int|null

Return values

int|null

publicsetDescription()

AttributeDefinitionUpdateStruct.php : 90 
public setDescription(string $languageCode, string $description) : void

Parameters

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

publicsetDescriptions()

AttributeDefinitionUpdateStruct.php : 85 
public setDescriptions(array<string, string> $descriptions) : void

Parameters

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

publicsetGroup()

AttributeDefinitionUpdateStruct.php : 48 
public setGroup(AttributeGroupInterface|null $group) : void

Parameters

Name Type Default value Description
$group AttributeGroupInterface|null - -

publicsetIdentifier()

AttributeDefinitionUpdateStruct.php : 38 
public setIdentifier(string|null $identifier) : void

Parameters

Name Type Default value Description
$identifier string|null - -

publicsetName()

AttributeDefinitionUpdateStruct.php : 69 
public setName(string $languageCode, string $name) : void

Parameters

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

publicsetNames()

AttributeDefinitionUpdateStruct.php : 64 
public setNames(array<string, string> $names) : void

Parameters

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

publicsetOptions()

AttributeDefinitionUpdateStruct.php : 116 
public setOptions(array<string, mixed>|null $options) : void

Parameters

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

publicsetPosition()

AttributeDefinitionUpdateStruct.php : 100 
public setPosition(int|null $position) : void

Parameters

Name Type Default value Description
$position int|null - -

protectedgetProperties()

ValueObject.php : 53

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>

Tags
Serializerignore

()