dolibarr  21.0.0-alpha
Public Member Functions | List of all members
ProductCombination Class Reference

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

Public Member Functions

 __construct (DoliDB $db)
 Constructor. More...
 
 fetch ($rowid)
 Retrieves a ProductCombination 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, $sort_by_ref=false)
 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 (filtered on its 'to sell' variants) 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 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:

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

Constructor & Destructor Documentation

◆ __construct()

ProductCombination::__construct ( DoliDB  $db)

Constructor.

Parameters
DoliDB$dbDatabase 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$userObject user
int$origProductIdOrigin product id
Product$destProductDestination product
Returns
int >0 OK <0 KO

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

◆ create()

ProductCombination::create (   $user)

Creates a product attribute combination.

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

Definition at line 381 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$userUser
Product$productParent 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_percentIs the price variation value a relative variation (in %)? (it is an array if global constant "PRODUIT_MULTIPRICES" is on)
false | float | float[]$forced_pricevarValue 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_weightvarValue of the weight variation if it is forced
false | string$forced_refvarValue of the reference if it is forced
string$ref_extExternal 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 760 of file ProductCombination.class.php.

◆ delete()

ProductCombination::delete ( User  $user)

Deletes a product combination.

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

Definition at line 453 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 Return integer <0 KO >0 OK

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

◆ fetch()

ProductCombination::fetch (   $rowid)

Retrieves a ProductCombination by its rowid.

Parameters
int$rowidID of the ProductCombination
Returns
-1|1 -1 if KO, 1 if OK

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

◆ fetchAllByFkProductParent()

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

Retrieves all product combinations by the product parent row id.

Parameters
int$fk_product_parentRowid of parent product
bool$sort_by_refSort result by product child reference
Returns
int|ProductCombination[] Return integer <0 KO

Definition at line 311 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$productidProduct ID of variant
int$donotloadpricelevelAvoid loading price impact for each level. If PRODUIT_MULTIPRICES is not set, this has no effect.
Returns
int Return integer <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 271 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<string,string>$features Format: [$attr] => $attr_val
Returns
false|ProductCombination False if not found
Parameters
mixed$vFeature information of a product.
Returns
bool

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

◆ fetchCombinationPriceLevels()

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

Retrieves combination price levels.

Parameters
int$fk_price_levelThe price level to fetch, use 0 for all
bool$useCacheTo use cache or not
Returns
-1|1 -1 if KO, 1 if OK

for auto retrocompatibility with last behavior

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

◆ getUniqueAttributesAndValuesByFkProductParent()

ProductCombination::getUniqueAttributesAndValuesByFkProductParent (   $productid)

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

Parameters
int$productidParent Product rowid
Returns
array<object{id:int,ref:string,label:string,values:ProductAttributeValue[]}> Array of attributes

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

◆ saveCombinationPriceLevels()

ProductCombination::saveCombinationPriceLevels (   $clean = 1)

Retrieves combination price levels.

Parameters
int$cleanLevels of PRODUIT_MULTIPRICES_LIMIT
Returns
int Return integer <0 KO, >0 OK

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

◆ update()

ProductCombination::update ( User  $user)

Updates a product combination.

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

Definition at line 417 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$parentParent product
User$userObject user
Returns
int >0 if OK, <0 if KO

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


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