dolibarr  x.y.z
Public Member Functions | Protected Member Functions | List of all members
MultiCurrencies Class Reference
Inheritance diagram for MultiCurrencies:
Inheritance graph
[legend]
Collaboration diagram for MultiCurrencies:
Collaboration graph
[legend]

Public Member Functions

 __construct ()
 Constructor.
 
 index ($sortfield="t.rowid", $sortorder='ASC', $sqlfilters='')
 Get a list of currencies. More...
 
- Public Member Functions inherited from DolibarrApi
 __construct ($db, $cachedir='', $refreshCache=false)
 Constructor. More...
 

Protected Member Functions

 _cleanObjectDatas ($object)
 Clean sensible object datas. More...
 
- Protected Member Functions inherited from DolibarrApi
 _checkValForAPI ($field, $value, $object)
 Check and convert a string depending on its type/name. More...
 
 _checkFilters ($sqlfilters, &$error='')
 Return if a $sqlfilters parameter is valid. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from DolibarrApi
static _checkAccessToResource ($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid')
 Check access by user to a given resource. More...
 
static _forge_criteria_callback ($matches)
 Function to forge a SQL criteria from a Generic filter string. More...
 

Detailed Description

Definition at line 29 of file api_multicurrencies.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

MultiCurrencies::_cleanObjectDatas (   $object)
protected

Clean sensible object datas.

Parameters
MultiCurrency$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 110 of file api_multicurrencies.class.php.

◆ index()

MultiCurrencies::index (   $sortfield = "t.rowid",
  $sortorder = 'ASC',
  $sqlfilters = '' 
)

Get a list of currencies.

Parameters
string$sortfieldSort field
string$sortorderSort order
string$sqlfiltersOther criteria to filter answers separated by a comma. Syntax example "(t.product_id:=:1) and (t.date_creation:<:'20160101')"
Returns
array Array of warehouse objects
Exceptions
RestException

Definition at line 51 of file api_multicurrencies.class.php.


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