dolibarr  21.0.0-alpha
Public Member Functions | Public Attributes | List of all members
PriceGlobalVariableUpdater Class Reference

Class for price global variable updaters 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...
 
 getLastUpdated ()
 Returns the last updated time in string html format, returns "never" if its less than 1. More...
 
 checkParameters ()
 Checks if all parameters are in order. More...
 
 listUpdaters ()
 List all price global variables. More...
 
 listPendingUpdaters ()
 List all updaters which need to be processed. More...
 
 process ()
 Handles the processing of this updater. More...
 
 update_next_update ($next_update, $user=null, $notrigger=0)
 Update next_update into database. More...
 
 update_status ($last_status, $user=null, $notrigger=0)
 Update last_status into database. More...
 

Public Attributes

 $types = array(0, 1)
 Updater types.
 
 $update_min = 5
 Minimal update rate.
 
 $update_interval
 Interval in mins.
 
 $next_update
 Next update timestamp.
 

Detailed Description

Class for price global variable updaters table.

Definition at line 32 of file price_global_variable_updater.class.php.

Constructor & Destructor Documentation

◆ __construct()

PriceGlobalVariableUpdater::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

Member Function Documentation

◆ checkParameters()

PriceGlobalVariableUpdater::checkParameters ( )

Checks if all parameters are in order.

Returns
void

Definition at line 347 of file price_global_variable_updater.class.php.

◆ create()

PriceGlobalVariableUpdater::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 98 of file price_global_variable_updater.class.php.

◆ delete()

PriceGlobalVariableUpdater::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 260 of file price_global_variable_updater.class.php.

◆ fetch()

PriceGlobalVariableUpdater::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 161 of file price_global_variable_updater.class.php.

References $sql, and dol_syslog().

◆ getLastUpdated()

PriceGlobalVariableUpdater::getLastUpdated ( )

Returns the last updated time in string html format, returns "never" if its less than 1.

Returns
string

Definition at line 331 of file price_global_variable_updater.class.php.

◆ initAsSpecimen()

PriceGlobalVariableUpdater::initAsSpecimen ( )

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

Returns
int

Definition at line 312 of file price_global_variable_updater.class.php.

References description, and type.

◆ listPendingUpdaters()

PriceGlobalVariableUpdater::listPendingUpdaters ( )

List all updaters which need to be processed.

Returns
array|int Array of price global variable updaters

Definition at line 416 of file price_global_variable_updater.class.php.

References $sql, and dol_syslog().

◆ listUpdaters()

PriceGlobalVariableUpdater::listUpdaters ( )

List all price global variables.

Returns
array|int Array of price global variable updaters

Definition at line 379 of file price_global_variable_updater.class.php.

References $sql, and dol_syslog().

◆ process()

PriceGlobalVariableUpdater::process ( )

Handles the processing of this updater.

Returns
int Return integer <0 if KO, 0 if OK but no global variable found, >0 if OK

Definition at line 454 of file price_global_variable_updater.class.php.

◆ update()

PriceGlobalVariableUpdater::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 198 of file price_global_variable_updater.class.php.

◆ update_next_update()

PriceGlobalVariableUpdater::update_next_update (   $next_update,
  $user = null,
  $notrigger = 0 
)

Update next_update into database.

Parameters
string$next_updateNext update to write
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 569 of file price_global_variable_updater.class.php.

◆ update_status()

PriceGlobalVariableUpdater::update_status (   $last_status,
  $user = null,
  $notrigger = 0 
)

Update last_status into database.

Parameters
string$last_statusStatus to write
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 614 of file price_global_variable_updater.class.php.


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