ProductAvailabilityUpdateStruct

ProductAvailabilityUpdateStruct.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() ¶

ProductAvailabilityUpdateStruct.php : 24 Copy path

Construct object optionally with a set of properties.

public __construct(ProductInterface $product[, bool|null $availability = null ][, bool|null $isInfinite = null ][, int|null $stock = null ])

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
$product	ProductInterface	-	-
$availability	bool\|null	null	-
$isInfinite	bool\|null	null	-
$stock	int\|null	null	-

createInfinite() ¶

ProductAvailabilityUpdateStruct.php : 78 Copy path

public static createInfinite(ProductInterface $product[, bool|null $available = null ]) : self

Parameters

Name	Type	Default value	Description
$product	ProductInterface	-	-
$available	bool\|null	null	-

Return values

self

createWithStock() ¶

ProductAvailabilityUpdateStruct.php : 73 Copy path

public static createWithStock(ProductInterface $product, bool $available[, int|null $stock = null ]) : self

Parameters

Name	Type	Default value	Description
$product	ProductInterface	-	-
$available	bool	-	-
$stock	int\|null	null	-

Return values

self

getAvailability() ¶

ProductAvailabilityUpdateStruct.php : 43 Copy path

public getAvailability() : bool|null

Return values

bool|null

getProduct() ¶

ProductAvailabilityUpdateStruct.php : 38 Copy path

public getProduct() : ProductInterface

Return values

ProductInterface

getStock() ¶

ProductAvailabilityUpdateStruct.php : 53 Copy path

public getStock() : int|null

Return values

int|null

isInfinite() ¶

ProductAvailabilityUpdateStruct.php : 63 Copy path

public isInfinite() : bool|null

Return values

bool|null

setAvailability() ¶

ProductAvailabilityUpdateStruct.php : 48 Copy path

public setAvailability(bool|null $availability) : void

Parameters

Name	Type	Default value	Description
$availability	bool\|null	-	-

setInfinite() ¶

ProductAvailabilityUpdateStruct.php : 68 Copy path

public setInfinite(bool|null $infinite) : void

Parameters

Name	Type	Default value	Description
$infinite	bool\|null	-	-

setStock() ¶

ProductAvailabilityUpdateStruct.php : 58 Copy path

public setStock(int|null $stock) : void

Parameters

Name	Type	Default value	Description
$stock	int\|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>