dolibarr  9.0.0
Public Member Functions | List of all members
ProductCombination Class Reference

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...
 
 fetchByFkProductChild ($fk_child)
 Retrieves a product combination by a child product row id. 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)
 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 attributres for a parent product. More...
 
 createProductCombination (Product $product, array $combinations, array $variations, $price_var_percent=false, $forced_pricevar=false, $forced_weightvar=false)
 Creates a product combination. More...
 
 copyAll ($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$dbDatabase handler

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

Member Function Documentation

◆ copyAll()

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

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

Parameters
int$origProductIdOrigin product id
Product$destProductDestination product
Returns
int >0 OK <0 KO

Definition at line 671 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_parentId of parent product
Returns
int Nb of record

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

◆ create()

ProductCombination::create (   $user)

Creates a product attribute combination.

Parameters
User$userObject user
Returns
int <0 if KO, >0 if OK

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

◆ createProductCombination()

ProductCombination::createProductCombination ( Product  $product,
array  $combinations,
array  $variations,
  $price_var_percent = false,
  $forced_pricevar = false,
  $forced_weightvar = false 
)

Creates a product combination.

Check usages to find more about its use

Format of $combinations array: array( 0 => array( attr => value, attr2 => value [...] ), [...] )

Parameters
Product$productParent product
array$combinationsAttribute and value combinations.
array$variationsPrice and weight variations
bool$price_var_percentIs the price variation a relative variation?
bool | float$forced_pricevarIf the price variation is forced
bool | float$forced_weightvarIf the weight variation is forced
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 509 of file ProductCombination.class.php.

◆ delete()

ProductCombination::delete ( User  $user)

Deletes a product combination.

Parameters
User$userObject user
Returns
int <0 if KO, >0 if OK

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

◆ deleteByFkProductParent()

ProductCombination::deleteByFkProductParent (   $user,
  $fk_product_parent 
)

Deletes all product combinations of a parent product.

Parameters
User$userObject user
int$fk_product_parentRowid of parent product
Returns
int <0 KO >0 OK

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

◆ fetch()

ProductCombination::fetch (   $rowid)

Retrieves a combination by its rowid.

Parameters
int$rowidRow id
Returns
int <0 KO, >0 OK

Definition at line 93 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_parentRowid of parent product
Returns
int|ProductCombination[] <0 KO

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

◆ fetchByFkProductChild()

ProductCombination::fetchByFkProductChild (   $fk_child)

Retrieves a product combination by a child product row id.

Parameters
int$fk_childProduct row id
Returns
int <0 KO, >0 OK

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

◆ fetchByProductCombination2ValuePairs()

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

Retrieves the combination that matches the given features.

Parameters
int$prodidId of parent product
array$featuresFormat: [$attr] => $attr_val
Returns
false|ProductCombination False if not found

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

◆ getCombinationLabel()

ProductCombination::getCombinationLabel (   $prod_child)

Return label for combinations.

Parameters
int$prod_childid of child
Returns
string combination label

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

◆ getUniqueAttributesAndValuesByFkProductParent()

ProductCombination::getUniqueAttributesAndValuesByFkProductParent (   $productid)

Retrieves all unique attributres for a parent product.

Parameters
int$productidProduct rowid
Returns
ProductAttribute[]

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

◆ update()

ProductCombination::update ( User  $user)

Updates a product combination.

Parameters
User$userObject user
Returns
int <0 KO, >0 OK

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

◆ updateProperties()

ProductCombination::updateProperties ( Product  $parent)

Updates the weight of the child product.

The price must be updated using Product::updatePrices

Parameters
Product$parentParent product
Returns
int >0 OK <0 KO

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


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