◆ _cleanObjectDatas()
MultiCurrencies::_cleanObjectDatas |
( |
|
$object | ) |
|
|
protected |
◆ _cleanObjectDatasRate()
MultiCurrencies::_cleanObjectDatasRate |
( |
|
$object | ) |
|
|
protected |
Clean sensible MultiCurrencyRate object datas.
- Parameters
-
- Returns
- Object Object with cleaned properties
Definition at line 365 of file api_multicurrencies.class.php.
◆ delete()
MultiCurrencies::delete |
( |
|
$id | ) |
|
◆ get()
MultiCurrencies::get |
( |
|
$id | ) |
|
Get properties of a Currency object.
Return an array with Currency informations
- Parameters
-
- Returns
- Object Object with cleaned properties
- Exceptions
-
Definition at line 116 of file api_multicurrencies.class.php.
◆ getByCode()
MultiCurrencies::getByCode |
( |
|
$code | ) |
|
Get properties of a Currency object by code.
Return an array with Currency informations @url GET /bycode/{code}
- Parameters
-
string | $code | Code of Currency (ex: EUR) |
- Returns
- array|mixed Data without useless information
- Exceptions
-
Definition at line 141 of file api_multicurrencies.class.php.
◆ getRates()
MultiCurrencies::getRates |
( |
|
$id | ) |
|
List Currency rates.
Get a list of Currency rates
@url GET {id}/rates
- Parameters
-
- Returns
- array|mixed Data without useless information
- Exceptions
-
Definition at line 166 of file api_multicurrencies.class.php.
◆ index()
MultiCurrencies::index |
( |
|
$sortfield = "t.rowid" , |
|
|
|
$sortorder = 'ASC' , |
|
|
|
$limit = 100 , |
|
|
|
$sqlfilters = '' |
|
) |
| |
List Currencies.
Get a list of Currencies
- Parameters
-
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
string | $sqlfilters | Other 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
-
Definition at line 54 of file api_multicurrencies.class.php.
◆ post()
MultiCurrencies::post |
( |
|
$request_data = null | ) |
|
Create Currency object.
- Parameters
-
array | $request_data | Request data |
- Returns
- int ID of Currency
- Exceptions
-
Definition at line 197 of file api_multicurrencies.class.php.
◆ put()
MultiCurrencies::put |
( |
|
$id, |
|
|
|
$request_data = null |
|
) |
| |
Update Currency.
- Parameters
-
int | $id | Id of Currency to update |
array | $request_data | Datas |
- Returns
- array The updated Currency
- Exceptions
-
Definition at line 241 of file api_multicurrencies.class.php.
◆ updateRate()
MultiCurrencies::updateRate |
( |
|
$id, |
|
|
|
$request_data = null |
|
) |
| |
Update Currency rate @url PUT {id}/rates.
- Parameters
-
int | $id | Currency ID |
array | $request_data | Request data |
- Returns
- Object|false Object with cleaned properties
- Exceptions
-
Definition at line 308 of file api_multicurrencies.class.php.
The documentation for this class was generated from the following file: