dolibarr  20.0.0-alpha
Public Member Functions | List of all members
PriceGlobalVariable Class Reference

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

Public Member Functions

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

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$dbDatabase 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.

◆ create()

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

Create object into database.

Parameters
User$userUser that creates
int$notrigger0=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.

◆ delete()

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

Delete object in database.

Parameters
int$rowidRow id of global variable
User$userUser that deletes
int$notrigger0=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.

◆ fetch()

PriceGlobalVariable::fetch (   $id)

Load object in memory from the database.

Parameters
int$idId 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 $sql, 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 code, and 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 $sql, and dol_syslog().

◆ update()

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

Update object into database.

Parameters
User | null$userUser that modifies
int$notrigger0=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.


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