Class ProductCombination Used to represent the relation between a product and one of its variants. More...

Public Member Functions
	__construct (DoliDB $db)
	Constructor.

	fetch ($rowid)
	Retrieves a ProductCombination by its rowid.

	fetchCombinationPriceLevels ($fk_price_level=0, $useCache=true)
	Retrieves combination price levels.

	saveCombinationPriceLevels ($clean=1)
	Retrieves combination price levels.

	fetchByFkProductChild ($productid, $donotloadpricelevel=0)
	Retrieves information of a variant product and ID of its parent product.

	fetchAllByFkProductParent ($fk_product_parent, $sort_by_ref=false)
	Retrieves all product combinations by the product parent row id.

	countNbOfCombinationForFkProductParent ($fk_product_parent)
	Retrieves all product combinations by the product parent row id.

	create ($user)
	Creates a product attribute combination.

	update (User $user)
	Updates a product combination.

	delete (User $user)
	Deletes a product combination.

	deleteByFkProductParent ($user, $fk_product_parent)
	Deletes all product combinations of a parent product.

	updateProperties (Product $parent, User $user)
	Updates the weight of the child product.

	fetchByProductCombination2ValuePairs ($prodid, array $features)
	Retrieves the combination that matches the given features.

	getUniqueAttributesAndValuesByFkProductParent ($productid)
	Retrieves all unique attributes for a parent product (filtered on its 'to sell' variants)

	createProductCombination (User $user, Product $product, array $combinations, array $variations, $price_var_percent=false, $forced_pricevar=false, $forced_weightvar=false, $forced_refvar=false, $ref_ext='')
	Creates a product combination.

	copyAll (User $user, $origProductId, Product $destProduct)
	Copies all product combinations from the origin product to the destination product.

	getCombinationLabel ($prod_child)
	Return label for combinations.

Detailed Description

Class ProductCombination Used to represent the relation between a product and one of its variants.

Example: a product "shirt" has two variants "shirt XL white" and "shirt XL grey". This is represented with two ProductCombination objects:

One for "shirt XL white":
- $object->fk_product_parent ID of the Product object "shirt"
- $object->fk_product_child ID of the Product object "shirt XL white"
Another for "shirt XL grey":
- $object->fk_product_parent ID of the Product object "shirt"
- $object->fk_product_child ID of the Product object "shirt XL grey"

Definition at line 41 of file ProductCombination.class.php.

Constructor & Destructor Documentation

◆ __construct()

ProductCombination::__construct ( DoliDB $db )

Constructor.

Parameters

DoliDB $db Database handler

Definition at line 121 of file ProductCombination.class.php.

Member Function Documentation

◆ copyAll()

ProductCombination::copyAll	(	User	$user,
			$origProductId,
		Product	$destProduct )

Copies all product combinations from the origin product to the destination product.

Parameters

User	$user	Object user
int	$origProductId	Origin product id
Product	$destProduct	Destination product

Returns: int >0 OK <0 KO

Definition at line 977 of file ProductCombination.class.php.

References createProductCombination(), and fetchAllByFkProductParent().

◆ countNbOfCombinationForFkProductParent()

ProductCombination::countNbOfCombinationForFkProductParent ( $fk_product_parent )

Retrieves all product combinations by the product parent row id.

Parameters

int $fk_product_parent Id of parent product

Returns: int Nb of record

Definition at line 355 of file ProductCombination.class.php.

References getEntity().

◆ create()

ProductCombination::create ( $user )

Creates a product attribute combination.

Parameters

User $user Object user

Returns: int Return integer <0 if KO, >0 if OK

Definition at line 377 of file ProductCombination.class.php.

References getDolGlobalString(), and saveCombinationPriceLevels().

◆ createProductCombination()

ProductCombination::createProductCombination	(	User	$user,
		Product	$product,
		array	$combinations,
		array	$variations,
			$price_var_percent = false,
			$forced_pricevar = false,
			$forced_weightvar = false,
			$forced_refvar = false,
			$ref_ext = '' )

Creates a product combination.

Check usages to find more about its use Format of $combinations array: array( 0 => array( attr => value, attr2 => value [...] ), [...] )

Parameters

User	$user	User
Product	$product	Parent Product
	array<int,int>	$combinations Attribute and value combinations.
	array<int,array<int,array{weight:string\|float,price:string\|float}>>	$variations Price and weight variations (example: $variations[fk_product_attribute][fk_product_attribute_value]['weight'])
bool \| bool[]	$price_var_percent	Is the price variation value a relative variation (in %)? (it is an array if global constant "PRODUIT_MULTIPRICES" is on)
false \| float \| float[]	$forced_pricevar	Value of the price variation if it is forced ; in currency or percent. (it is an array if global constant "PRODUIT_MULTIPRICES" is on)
false \| float	$forced_weightvar	Value of the weight variation if it is forced
false \| string	$forced_refvar	Value of the reference if it is forced
string	$ref_ext	External reference

Returns: int<-1,1> Return integer <0 KO, >0 OK

If there is an existing combination, then we update the prices and weight Otherwise, we try adding a random number to the ref

Definition at line 756 of file ProductCombination.class.php.

References getDolGlobalString(), and price2num().

Referenced by copyAll().

◆ delete()

ProductCombination::delete ( User $user )

Deletes a product combination.

Parameters

User $user Object user

Returns: int Return integer <0 if KO, >0 if OK

Definition at line 449 of file ProductCombination.class.php.

◆ deleteByFkProductParent()

ProductCombination::deleteByFkProductParent	(		$user,
			$fk_product_parent )

Deletes all product combinations of a parent product.

Parameters

User	$user	Object user
int	$fk_product_parent	Rowid of parent product

Returns: int Return integer <0 KO >0 OK

Definition at line 480 of file ProductCombination.class.php.

References fetchAllByFkProductParent().

◆ fetch()

ProductCombination::fetch ( $rowid )

Retrieves a ProductCombination by its rowid.

Parameters

int $rowid ID of the ProductCombination

Returns: int<-1,1> -1 if KO, 1 if OK

Definition at line 135 of file ProductCombination.class.php.

References fetchCombinationPriceLevels(), getDolGlobalString(), and getEntity().

◆ fetchAllByFkProductParent()

ProductCombination::fetchAllByFkProductParent	(		$fk_product_parent,
			$sort_by_ref = false )

Retrieves all product combinations by the product parent row id.

Parameters

int	$fk_product_parent	Rowid of parent product
bool	$sort_by_ref	Sort result by product child reference

Returns: int|ProductCombination[] Return integer <0 KO

Definition at line 307 of file ProductCombination.class.php.

References getDolGlobalString(), and getEntity().

Referenced by copyAll(), and deleteByFkProductParent().

◆ fetchByFkProductChild()

ProductCombination::fetchByFkProductChild	(		$productid,
			$donotloadpricelevel = 0 )

Retrieves information of a variant product and ID of its parent product.

Parameters

int	$productid	Product ID of variant
int	$donotloadpricelevel	Avoid loading price impact for each level. If PRODUIT_MULTIPRICES is not set, this has no effect.