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

Class with static methods for building HTML components related to products Only components common to products and services must be here. More...

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 loadWarehouses ($fk_product=0, $batch='', $status='', $sumStock=true, $exclude='')
 Load in cache array list of warehouses If fk_product is not 0, we do not use cache. More...
 
 selectWarehouses ($selected='', $htmlname='idwarehouse', $filterstatus='', $empty=0, $disabled=0, $fk_product=0, $empty_label='', $showstock=0, $forcecombo=0, $events=array(), $morecss='minwidth200', $exclude='', $showfullpath=1)
 Return list of warehouses. More...
 
 formSelectWarehouses ($page, $selected='', $htmlname='warehouse_id', $addempty=0)
 Display form to select warehouse. More...
 
 select_measuring_units ($name='measuring_units', $measuring_style='', $default='0', $adddefault=0)
 Output a combo box with list of units pour l'instant on ne definit pas les unites dans la base. More...
 
 load_measuring_units ($name='measuring_units', $measuring_style='', $default='0', $adddefault=0)
 Return a combo box with list of units For the moment, units labels are defined in measuring_units_string. More...
 
 selectLotStock ($selected='', $htmlname='batch_id', $filterstatus='', $empty=0, $disabled=0, $fk_product=0, $fk_entrepot=0, $objectLines=array(), $empty_label='', $forcecombo=0, $events=array(), $morecss='minwidth200')
 Return list of lot numbers (stock from product_batch) with stock location and stock qty. More...
 

Private Member Functions

 get_parent_path ($tab, $final_label='')
 Return full path to current warehouse in $tab (recursive function) More...
 
 loadLotStock ($productIdArray=array())
 Load in cache array list of lot available in stock from a given list of products. More...
 

Detailed Description

Class with static methods for building HTML components related to products Only components common to products and services must be here.

Definition at line 30 of file html.formproduct.class.php.

Constructor & Destructor Documentation

◆ __construct()

FormProduct::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 52 of file html.formproduct.class.php.

Member Function Documentation

◆ formSelectWarehouses()

FormProduct::formSelectWarehouses (   $page,
  $selected = '',
  $htmlname = 'warehouse_id',
  $addempty = 0 
)

Display form to select warehouse.

Parameters
string$pagePage
int$selectedId of warehouse
string$htmlnameName of select html field
int$addempty1=Add an empty value in list, 2=Add an empty value in list only if there is more than 2 entries.
Returns
void

Definition at line 258 of file html.formproduct.class.php.

◆ get_parent_path()

FormProduct::get_parent_path (   $tab,
  $final_label = '' 
)
private

Return full path to current warehouse in $tab (recursive function)

Parameters
array$tabwarehouse data in $this->cache_warehouses line
String$final_labelfull label with all parents, separated by ' >> ' (completed on each call)
Returns
String full label with all parents, separated by ' >> '

Definition at line 176 of file html.formproduct.class.php.

◆ load_measuring_units()

FormProduct::load_measuring_units (   $name = 'measuring_units',
  $measuring_style = '',
  $default = '0',
  $adddefault = 0 
)

Return a combo box with list of units For the moment, units labels are defined in measuring_units_string.

Parameters
string$nameName of HTML field
string$measuring_styleUnit to show: weight, size, surface, volume
string$defaultForce unit
int$adddefaultAdd empty unit called "Default"
Returns
string

Definition at line 311 of file html.formproduct.class.php.

◆ loadLotStock()

FormProduct::loadLotStock (   $productIdArray = array())
private

Load in cache array list of lot available in stock from a given list of products.

Parameters
array$productIdArrayarray of product id's from who to get lot numbers. A
Returns
int Nb of loaded lines, 0 if nothing loaded, <0 if KO

Definition at line 432 of file html.formproduct.class.php.

◆ loadWarehouses()

FormProduct::loadWarehouses (   $fk_product = 0,
  $batch = '',
  $status = '',
  $sumStock = true,
  $exclude = '' 
)

Load in cache array list of warehouses If fk_product is not 0, we do not use cache.

Parameters
int$fk_productAdd quantity of stock in label for product with id fk_product. Nothing if 0.
string$batchAdd quantity of batch stock in label for product with batch name batch, batch name precedes batch_id. Nothing if ''.
string$statuswarehouse status filter, following comma separated filter options can be used 'warehouseopen' = select products from open warehouses, 'warehouseclosed' = select products from closed warehouses, 'warehouseinternal' = select products from warehouses for internal correct/transfer only
boolean$sumStocksum total stock of a warehouse, default true
array$excludewarehouses ids to exclude
Returns
int Nb of loaded lines, 0 if already loaded, <0 if KO

Definition at line 72 of file html.formproduct.class.php.

◆ select_measuring_units()

FormProduct::select_measuring_units (   $name = 'measuring_units',
  $measuring_style = '',
  $default = '0',
  $adddefault = 0 
)

Output a combo box with list of units pour l'instant on ne definit pas les unites dans la base.

Parameters
string$nameName of HTML field
string$measuring_styleUnit to show: weight, size, surface, volume
string$defaultForce unit
int$adddefaultAdd empty unit called "Default"
Returns
void

Definition at line 294 of file html.formproduct.class.php.

◆ selectLotStock()

FormProduct::selectLotStock (   $selected = '',
  $htmlname = 'batch_id',
  $filterstatus = '',
  $empty = 0,
  $disabled = 0,
  $fk_product = 0,
  $fk_entrepot = 0,
  $objectLines = array(),
  $empty_label = '',
  $forcecombo = 0,
  $events = array(),
  $morecss = 'minwidth200' 
)

Return list of lot numbers (stock from product_batch) with stock location and stock qty.

Parameters
int$selectedId of preselected lot stock id ('' for no value, 'ifone'=select value if one value otherwise no value)
string$htmlnameName of html select html
string$filterstatuslot status filter, following comma separated filter options can be used
int$empty1=Can be empty, 0 if not
int$disabled1=Select is disabled
int$fk_productshow lot numbers of product with id fk_product. All from objectLines if 0.
int$fk_entrepotfilter lot numbers for warehouse with id fk_entrepot. All if 0.
array$objectLinesOnly cache lot numbers for products in lines of object. If no lines only for fk_product. If no fk_product, all.
string$empty_labelEmpty label if needed (only if $empty=1)
int$forcecombo1=Force combo iso ajax select2
array$eventsEvents to add to select2
string$morecssAdd more css classes to HTML select
Returns
string HTML select

Definition at line 361 of file html.formproduct.class.php.

◆ selectWarehouses()

FormProduct::selectWarehouses (   $selected = '',
  $htmlname = 'idwarehouse',
  $filterstatus = '',
  $empty = 0,
  $disabled = 0,
  $fk_product = 0,
  $empty_label = '',
  $showstock = 0,
  $forcecombo = 0,
  $events = array(),
  $morecss = 'minwidth200',
  $exclude = '',
  $showfullpath = 1 
)

Return list of warehouses.

Parameters
int$selectedId of preselected warehouse ('' for no value, 'ifone'=select value if one value otherwise no value)
string$htmlnameName of html select html
string$filterstatuswarehouse status filter, following comma separated filter options can be used 'warehouseopen' = select products from open warehouses, 'warehouseclosed' = select products from closed warehouses, 'warehouseinternal' = select products from warehouses for internal correct/transfer only
int$empty1=Can be empty, 0 if not
int$disabled1=Select is disabled
int$fk_productAdd quantity of stock in label for product with id fk_product. Nothing if 0.
string$empty_labelEmpty label if needed (only if $empty=1)
int$showstock1=Show stock count
int$forcecombo1=Force combo iso ajax select2
array$eventsEvents to add to select2
string$morecssAdd more css classes to HTML select
array$excludeWarehouses ids to exclude
int$showfullpath1=Show full path of name (parent ref into label), 0=Show only ref of current warehouse
Returns
string HTML select

Definition at line 213 of file html.formproduct.class.php.


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