Class ProductCombination Used to represent a product combination. More...

Public Member Functions
	__construct (DoliDB $db)
	Constructor. More...

	fetch ($rowid)
	Retrieves a combination by its rowid. More...

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

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

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

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

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

	create ($user)
	Creates a product attribute combination. More...

	update (User $user)
	Updates a product combination. More...

	delete (User $user)
	Deletes a product combination. More...

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

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

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

	getUniqueAttributesAndValuesByFkProductParent ($productid)
	Retrieves all unique attributes for a parent product. More...

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

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

	getCombinationLabel ($prod_child)
	Return label for combinations. More...

Detailed Description

Class ProductCombination Used to represent a product combination.

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

Constructor & Destructor Documentation

◆ __construct()

ProductCombination::__construct ( DoliDB $db )

Constructor.

Parameters

DoliDB $db Database handler

Definition at line 101 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 937 of file ProductCombination.class.php.

◆ 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 331 of file ProductCombination.class.php.

◆ create()

ProductCombination::create ( $user )

Creates a product attribute combination.

Parameters

User $user Object user

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

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

◆ 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	Object user
Product	$product	Parent product
array	$combinations	Attribute and value combinations.
array	$variations	Price and weight variations
bool \| array	$price_var_percent	Is the price variation a relative variation?
bool \| float	$forced_pricevar	If the price variation is forced
bool \| float	$forced_weightvar	If the weight variation is forced
bool \| string	$forced_refvar	If the reference is forced
string	$ref_ext	External reference

Returns: int <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 716 of file ProductCombination.class.php.

◆ delete()

ProductCombination::delete ( User $user )

Deletes a product combination.

Parameters

User $user Object user

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

Definition at line 425 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 <0 KO >0 OK

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

◆ fetch()

ProductCombination::fetch ( $rowid )

Retrieves a combination by its rowid.

Parameters

int $rowid Row id

Returns: int <0 KO, >0 OK

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

◆ fetchAllByFkProductParent()

ProductCombination::fetchAllByFkProductParent ( $fk_product_parent )

Retrieves all product combinations by the product parent row id.

Parameters

int $fk_product_parent Rowid of parent product

Returns: int|ProductCombination[] <0 KO

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

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

Returns: int <0 if KO, 0 if product ID is not ID of a variant product (so parent not found), >0 if OK (ID of parent)

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

◆ fetchByProductCombination2ValuePairs()

ProductCombination::fetchByProductCombination2ValuePairs	(		$prodid,
		array	$features
	)

Retrieves the combination that matches the given features.

Parameters

int	$prodid	Id of parent product
array	$features	Format: [$attr] => $attr_val

Returns: false|ProductCombination False if not found

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

◆ fetchCombinationPriceLevels()

ProductCombination::fetchCombinationPriceLevels	(	$fk_price_level = `0`,
		$useCache = `true`
	)

Retrieves combination price levels.

Parameters

int	$fk_price_level	The price level to fetch, use 0 for all
bool	$useCache	To use cache or not

Returns: int <0 KO, >0 OK

for auto retrocompatibility with last behavior

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

◆ getCombinationLabel()

ProductCombination::getCombinationLabel ( $prod_child )

Return label for combinations.

Parameters

int $prod_child id of child

Returns: string combination label

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

◆ getUniqueAttributesAndValuesByFkProductParent()

ProductCombination::getUniqueAttributesAndValuesByFkProductParent ( $productid )

Retrieves all unique attributes for a parent product.

Parameters

int $productid Product rowid

Returns: ProductAttribute[] Array of attributes

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

◆ saveCombinationPriceLevels()

ProductCombination::saveCombinationPriceLevels ( $clean = 1 )

Retrieves combination price levels.

Parameters

int $clean Levels of PRODUIT_MULTIPRICES_LIMIT

Returns: int <0 KO, >0 OK

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

◆ update()

ProductCombination::update ( User $user )

Updates a product combination.

Parameters

User $user Object user

Returns: int <0 KO, >0 OK

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

◆ updateProperties()

ProductCombination::updateProperties	(	Product	$parent,
		User	$user
	)

Updates the weight of the child product.

The price must be updated using Product::updatePrices. This method is called by the update() of a product.

Parameters

Product	$parent	Parent product
User	$user	Object user

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

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

The documentation for this class was generated from the following file:

dolibarr_dev/htdocs/variants/class/ProductCombination.class.php

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ copyAll()

◆ countNbOfCombinationForFkProductParent()

◆ create()

◆ createProductCombination()

◆ delete()

◆ deleteByFkProductParent()

◆ fetch()

◆ fetchAllByFkProductParent()

◆ fetchByFkProductChild()

◆ fetchByProductCombination2ValuePairs()

◆ fetchCombinationPriceLevels()

◆ getCombinationLabel()

◆ getUniqueAttributesAndValuesByFkProductParent()

◆ saveCombinationPriceLevels()

◆ update()

◆ updateProperties()