Copied!

AttributeDefinitionCreateStruct

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

AttributeDefinitionCreateStruct.php : 36

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 - -

publicgetDescriptions()

AttributeDefinitionCreateStruct.php : 93
public getDescriptions() : array<string, string>

Return values

array<string, string>

publicgetGroup()

AttributeDefinitionCreateStruct.php : 57
public getGroup() : AttributeGroupInterface

Return values

AttributeGroupInterface

publicgetIdentifier()

AttributeDefinitionCreateStruct.php : 47
public getIdentifier() : string

Return values

string

publicgetNames()

AttributeDefinitionCreateStruct.php : 80
public getNames() : array<string, string>

Return values

array<string, string>

publicgetOptions()

AttributeDefinitionCreateStruct.php : 116
public getOptions() : array<string, mixed>

Return values

array<string, mixed>

publicgetPosition()

AttributeDefinitionCreateStruct.php : 103
public getPosition() : int

Return values

int

publicgetType()

AttributeDefinitionCreateStruct.php : 67
public getType() : AttributeTypeInterface

Return values

AttributeTypeInterface

publicsetDescription()

AttributeDefinitionCreateStruct.php : 98
public setDescription(string $languageCode, string $description) : void

Parameters

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

publicsetGroup()

AttributeDefinitionCreateStruct.php : 62
public setGroup(AttributeGroupInterface $group) : void

Parameters

Name Type Default value Description
$group AttributeGroupInterface - -

publicsetIdentifier()

AttributeDefinitionCreateStruct.php : 52
public setIdentifier(string $identifier) : void

Parameters

Name Type Default value Description
$identifier string - -

publicsetName()

AttributeDefinitionCreateStruct.php : 85
public setName(string $languageCode, string $name) : void

Parameters

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

publicsetOptions()

AttributeDefinitionCreateStruct.php : 124
public setOptions(array<string, mixed> $options) : void

Parameters

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

publicsetPosition()

AttributeDefinitionCreateStruct.php : 108
public setPosition(int $position) : void

Parameters

Name Type Default value Description
$position int - -

publicsetType()

AttributeDefinitionCreateStruct.php : 72
public setType(AttributeTypeInterface $type) : void

Parameters

Name Type Default value Description
$type AttributeTypeInterface - -

protectedgetProperties()

ValueObject.php : 50

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>