CUnits Class Reference

Class of dictionary type of thirdparty (used by imports) More...

Inheritance diagram for CUnits:

Collaboration diagram for CUnits:

Public Member Functions
	__construct ($db)
	Constructor.
	create ($user, $notrigger=0)
	Create object into database.
	fetch ($id, $code='', $short_label='', $unit_type='')
	Load object in memory from database.
	fetchAll ($sortorder='', $sortfield='', $limit=0, $offset=0, $filter='', $filtermode='AND')
	Load list of objects in memory from the database.
	update ($user=null, $notrigger=0)
	Update object into database.
	delete ($user, $notrigger=0)
	Delete object in database.
	getUnitFromCode ($code, $mode='code', $unit_type='')
	Get unit from code.
	unitConverter ($value, $fk_unit, $fk_new_unit=0)
	Unit converter.
	scaleOfUnitPow ($id)
	Get scale of unit factor.

Detailed Description

Class of dictionary type of thirdparty (used by imports)

Definition at line 33 of file cunits.class.php.

Constructor & Destructor Documentation

__construct()

CUnits::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 76 of file cunits.class.php.

Member Function Documentation

create()

CUnits::create	(		$user,
			$notrigger = 0 )

Create object into database.

Parameters

User	$user	User that create
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers

Returns

int Return integer <0 if KO, Id of created object if OK

Definition at line 89 of file cunits.class.php.

References dol_syslog().

delete()

CUnits::delete	(		$user,
			$notrigger = 0 )

Delete object in database.

Parameters

User	$user	User that delete
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 402 of file cunits.class.php.

References dol_syslog().

fetch()

CUnits::fetch	(		$id,
			$code = '',
			$short_label = '',
			$unit_type = '' )

Load object in memory from database.

Parameters

int	$id	Id of CUnit object to fetch (rowid)
string	$code	Code
string	$short_label	Short Label ('g', 'kg', ...)
string	$unit_type	Unit type ('size', 'surface', 'volume', 'weight', ...)

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 174 of file cunits.class.php.

fetchAll()

CUnits::fetchAll	(		$sortorder = '',
			$sortfield = '',
			$limit = 0,
			$offset = 0,
			$filter = '',
			$filtermode = 'AND' )

Load list of objects in memory from the database.

Parameters

string	$sortorder	Sort Order
string	$sortfield	Sort field
int	$limit	Limit
int	$offset	Offset
	string|array<string,mixed>	$filter Filter USF
string	$filtermode	Filter mode (AND or OR)

Returns

CUnits[]|int int <0 if KO, array of pages if OK

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

References dol_syslog(), and forgeSQLFromUniversalSearchCriteria().

getUnitFromCode()

CUnits::getUnitFromCode	(		$code,
			$mode = 'code',
			$unit_type = '' )

Get unit from code.

Parameters

string	$code	code of unit
string	$mode	0= id , short_label=Use short label as value, code=use code
string	$unit_type	weight,size,surface,volume,qty,time...

Returns

int|string Return integer <0 if KO, Id of code if OK (or $code if $mode is different from '', 'short_label' or 'code')

Definition at line 440 of file cunits.class.php.

References dol_getIdFromCode().

scaleOfUnitPow()

CUnits::scaleOfUnitPow

(

$id

)

Get scale of unit factor.

Parameters

int

$id

Id of unit in dictionary

Returns

float|int Scale of unit

Definition at line 482 of file cunits.class.php.

Referenced by unitConverter().

unitConverter()

CUnits::unitConverter	(		$value,
			$fk_unit,
			$fk_new_unit = 0 )

Unit converter.

Parameters

float	$value	value to convert
int	$fk_unit	current unit id of value
int	$fk_new_unit	the id of unit to convert in

Returns

float

Definition at line 455 of file cunits.class.php.

References price2num(), and scaleOfUnitPow().

update()

CUnits::update	(		$user = null,
			$notrigger = 0 )

Update object into database.

Parameters

User	$user	User that modify
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 330 of file cunits.class.php.

References dol_syslog().

---

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

• dolibarr_dev/htdocs/core/class/cunits.class.php