ProductUpdateStruct

ProductUpdateStruct.php : 18 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() ¶

ProductUpdateStruct.php : 41 Copy path

Construct object optionally with a set of properties.

public __construct(ProductInterface|ContentAwareProductInterface $product, ContentUpdateStruct $contentUpdateStruct)

Parameters

Name	Type	Default value	Description
$product	ProductInterface\|ContentAwareProductInterface	-	-
$contentUpdateStruct	ContentUpdateStruct	-	-

getAttributes() ¶

ProductUpdateStruct.php : 70 Copy path

public getAttributes() : array<string, mixed>

Return values

array<string, mixed>

getCode() ¶

ProductUpdateStruct.php : 57 Copy path

public getCode() : string|null

Return values

string|null

getContentMetadataUpdateStruct() ¶

ProductUpdateStruct.php : 101 Copy path

public getContentMetadataUpdateStruct() : ContentMetadataUpdateStruct|null

Return values

ContentMetadataUpdateStruct|null

getContentUpdateStruct() ¶

ProductUpdateStruct.php : 91 Copy path

public getContentUpdateStruct() : ContentUpdateStruct

Return values

ContentUpdateStruct

getProduct() ¶

ProductUpdateStruct.php : 52 Copy path

public getProduct() : ProductInterface|ContentAwareProductInterface

Return values

ProductInterface|ContentAwareProductInterface

setAttribute() ¶

ProductUpdateStruct.php : 78 Copy path

public setAttribute(string $name, mixed $value) : void

Parameters

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

setAttributes() ¶

ProductUpdateStruct.php : 86 Copy path

public setAttributes(array<string, mixed> $attributes) : void

Parameters

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

setCode() ¶

ProductUpdateStruct.php : 62 Copy path

public setCode(string|null $code) : void

Parameters

Name	Type	Default value	Description
$code	string\|null	-	-

setContentMetadataUpdateStruct() ¶

ProductUpdateStruct.php : 106 Copy path

public setContentMetadataUpdateStruct(ContentMetadataUpdateStruct|null $contentMetadataUpdateStruct) : void

Parameters

Name	Type	Default value	Description
$contentMetadataUpdateStruct	ContentMetadataUpdateStruct\|null	-	-

setContentUpdateStruct() ¶

ProductUpdateStruct.php : 96 Copy path

public setContentUpdateStruct(ContentUpdateStruct $contentUpdateStruct) : void

Parameters

Name	Type	Default value	Description
$contentUpdateStruct	ContentUpdateStruct	-	-

setField() ¶

ProductUpdateStruct.php : 114 Copy path

    
                        public setField(string $fieldDefIdentifier, mixed $value[, string|null $language = null ]) : void

Parameters

Name	Type	Default value	Description
$fieldDefIdentifier	string	-	-
$value	mixed	-	-
$language	string\|null	null	-

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>