product.lib.php File Reference

Ensemble de functions de base pour le module produit et service. More...

Go to the source code of this file.

Functions
	product_prepare_head ($object)
	Prepare array with list of tabs.
	productlot_prepare_head ($object)
	Prepare array with list of tabs.
	product_admin_prepare_head ()
	Return array head with list of tabs to view object information.
	product_lot_admin_prepare_head ()
	Return array head with list of tabs to view object information.
	show_stats_for_company ($product, $socid)
	Show stats for a product.
	show_stats_for_batch ($batch, $socid)
	Show stats for product batch.
	measuring_units_string ($scale='', $measuring_style='', $unit=0, $use_short_label=0, $outputlangs=null)
	Return translation label of a unit key.
	measuringUnitString ($unit, $measuring_style='', $scale='', $use_short_label=0, $outputlangs=null)
	Return translation label of a unit key.
	measuring_units_squared ($unit)
	Transform a given unit scale into the square of that unit, if known.
	measuring_units_cubed ($unit)
	Transform a given unit scale into the cube of that unit, if known.

Detailed Description

Ensemble de functions de base pour le module produit et service.

Definition in file product.lib.php.

Function Documentation

measuring_units_cubed()

measuring_units_cubed

(

$unit

)

Transform a given unit scale into the cube of that unit, if known.

Parameters

int

$unit

Unit scale key (-3,-2,-1,0,98,99...)

Returns

int Cubed unit key (-9,-6,-3,0,88,89...)

See also

formproduct->selectMeasuringUnits

Definition at line 967 of file product.lib.php.

Referenced by Product\update().

measuring_units_squared()

measuring_units_squared

(

$unit

)

Transform a given unit scale into the square of that unit, if known.

Parameters

int

$unit

Unit scale key (-3,-2,-1,0,98,99...)

Returns

int Squared unit key (-6,-4,-2,0,98,99...)

See also

formproduct->selectMeasuringUnits

Definition at line 947 of file product.lib.php.

Referenced by Product\update().

measuring_units_string()

measuring_units_string	(		$scale = '',
			$measuring_style = '',
			$unit = 0,
			$use_short_label = 0,
			$outputlangs = null )

Return translation label of a unit key.

Function kept for backward compatibility.

Parameters

string	$scale	Scale of unit: '0', '-3', '6', ...
string	$measuring_style	Style of unit: weight, volume,...
int	$unit	ID of unit (rowid in llx_c_units table)
int	$use_short_label	1=Use short label ('g' instead of 'gram'). Short labels are not translated.
Translate	$outputlangs	Language object

Returns

string Unit string

See also

measuringUnitString() formproduct->selectMeasuringUnits()

Definition at line 869 of file product.lib.php.

References measuringUnitString().

measuringUnitString()

measuringUnitString	(		$unit,
			$measuring_style = '',
			$scale = '',
			$use_short_label = 0,
			$outputlangs = null )

Return translation label of a unit key.

Parameters

int	$unit	ID of unit (rowid in llx_c_units table)
string	$measuring_style	Style of unit: 'weight', 'volume', ..., '' = 'net_measure' for option PRODUCT_ADD_NET_MEASURE
string	$scale	Scale of unit: '0', '-3', '6', ...
int	$use_short_label	1=Use very short label ('g' instead of 'gram'), not translated. 2=Use translated short label.
Translate	$outputlangs	Language object

Returns

string|-1 Unit string if OK, -1 if KO

See also

formproduct->selectMeasuringUnits()

Definition at line 885 of file product.lib.php.

Referenced by pdf_espadon\_tableau_tot(), ActionsCardProduct\assign_values(), BOM\calculateCosts(), Form\constructProductListOption(), CommonDocGenerator\get_substitutionarray_shipment(), ProductFournisseur\getNomUrl(), Product\getTooltipContentArray(), measuring_units_string(), Form\select_produits_fournisseurs_list(), pdf_eagle\write_file(), pdf_espadon\write_file(), pdf_rouget\write_file(), pdf_squille\write_file(), and pdf_standard\write_file().

product_admin_prepare_head()

product_admin_prepare_head

(

)

Return array head with list of tabs to view object information.

Returns

array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 329 of file product.lib.php.

References complete_head_from_modules(), and getDolGlobalString().

product_lot_admin_prepare_head()

product_lot_admin_prepare_head

(

)

Return array head with list of tabs to view object information.

Returns

array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 410 of file product.lib.php.

References complete_head_from_modules().

product_prepare_head()

product_prepare_head

(

$object

)

Prepare array with list of tabs.

Parameters

Product

$object

Object related to tabs

Returns

array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 40 of file product.lib.php.

References $object, complete_head_from_modules(), Link\count(), dol_dir_list(), dol_sanitizeFileName(), get_exdir(), getDolGlobalInt(), getDolGlobalString(), Product\TYPE_PRODUCT, and Product\TYPE_SERVICE.

Referenced by ActionsCardProduct\assign_values(), and ActionsCardService\assign_values().

productlot_prepare_head()

productlot_prepare_head

(

$object

)

Prepare array with list of tabs.

Parameters

ProductLot

$object

Object related to tabs

Returns

array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 251 of file product.lib.php.

References $object, complete_head_from_modules(), Link\count(), dol_dir_list(), dol_sanitizeFileName(), and getDolGlobalString().

show_stats_for_batch()

show_stats_for_batch	(		$batch,
			$socid )

Show stats for product batch.

Parameters

Productlot	$batch	Product batch object
int	$socid	Thirdparty id

Returns

integer NB of lines shown into array

Definition at line 744 of file product.lib.php.

References dol_print_error(), img_object(), and setEventMessages().

show_stats_for_company()

show_stats_for_company	(		$product,
			$socid )

Show stats for a product.

Parameters

Product	$product	Product object
int	$socid	Thirdparty id

Returns

integer NB of lines shown into array

Definition at line 454 of file product.lib.php.

References dol_print_error(), getDolGlobalString(), img_object(), price(), setEventMessage(), and setEventMessages().