PriceGlobalVariable Class Reference

Class for accessing price global variables table. More...

Public Member Functions
	__construct ($db)
	Constructor.
	create ($user, $notrigger=0)
	Create object into database.
	fetch ($id)
	Load object in memory from the database.
	update ($user=null, $notrigger=0)
	Update object into database.
	delete ($rowid, $user, $notrigger=0)
	Delete object in database.
	initAsSpecimen ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	checkParameters ()
	Checks if all parameters are in order.
	listGlobalVariables ()
	List all price global variables.

Detailed Description

Class for accessing price global variables table.

Definition at line 31 of file price_global_variable.class.php.

Constructor & Destructor Documentation

__construct()

PriceGlobalVariable::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 72 of file price_global_variable.class.php.

Member Function Documentation

checkParameters()

PriceGlobalVariable::checkParameters

(

)

Checks if all parameters are in order.

Returns

void

Definition at line 301 of file price_global_variable.class.php.

References description.

Referenced by create(), fetch(), and update().

create()

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

Create object into database.

Parameters

User	$user	User that creates
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

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

Definition at line 85 of file price_global_variable.class.php.

References checkParameters(), description, and dol_syslog().

delete()

PriceGlobalVariable::delete	(		$rowid,
			$user,
			$notrigger = 0 )

Delete object in database.

Parameters

int	$rowid	Row id of global variable
User	$user	User that deletes
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

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

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

References dol_syslog().

fetch()

PriceGlobalVariable::fetch

(

$id

)

Load object in memory from the database.

Parameters

int

$id

Id object

Returns

int Return integer < 0 if KO, 0 if OK but not found, > 0 if OK

Definition at line 144 of file price_global_variable.class.php.

References checkParameters(), description, and dol_syslog().

initAsSpecimen()

PriceGlobalVariable::initAsSpecimen

(

)

Initialise object with example values Id must be 0 if object instance is a specimen.

Returns

int

Definition at line 286 of file price_global_variable.class.php.

References description.

listGlobalVariables()

PriceGlobalVariable::listGlobalVariables

(

)

List all price global variables.

Returns

array|int Array of price global variables, <0 if ko

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

References dol_syslog().

update()

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

Update object into database.

Parameters

User | null	$user	User that modifies
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

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

Definition at line 177 of file price_global_variable.class.php.

References checkParameters(), description, and dol_syslog().

---

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

• dolibarr_20.0/htdocs/product/dynamic_price/class/price_global_variable.class.php