ProductAvailabilityCreateStruct

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

ProductAvailabilityCreateStruct.php : 24 Copy path

Construct object optionally with a set of properties.

public __construct(ProductInterface $product[, bool $availability = false ][, bool $isInfinite = false ][, 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	false	-
$isInfinite	bool	false	-
$stock	int\|null	null	-

createInfinite() ¶

ProductAvailabilityCreateStruct.php : 68 Copy path

public static createInfinite(ProductInterface $product, bool $available) : self

Parameters

Name	Type	Default value	Description
$product	ProductInterface	-	-
$available	bool	-	-

Return values

self

createWithStock() ¶

ProductAvailabilityCreateStruct.php : 63 Copy path

public static createWithStock(ProductInterface $product, bool $available, int $stock) : self

Parameters

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

Return values

self

getAvailability() ¶

ProductAvailabilityCreateStruct.php : 43 Copy path

public getAvailability() : bool

Return values

bool

getProduct() ¶

ProductAvailabilityCreateStruct.php : 38 Copy path

public getProduct() : ProductInterface

Return values

ProductInterface

getStock() ¶

ProductAvailabilityCreateStruct.php : 53 Copy path

public getStock() : int|null

Return values

int|null

isInfinite() ¶

ProductAvailabilityCreateStruct.php : 58 Copy path

public isInfinite() : bool

Return values

bool

setAvailability() ¶

ProductAvailabilityCreateStruct.php : 48 Copy path

public setAvailability(bool $availability) : void

Parameters

Name	Type	Default value	Description
$availability	bool	-	-

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>