MultiCurrencies

class MultiCurrencies extends DolibarrApi (View source)

API class for MultiCurrency

Properties

protected DoliDB $db from  DolibarrApi
Restler $r from  DolibarrApi

Methods

__construct()

Constructor

string|array<string, mixed>
_checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

from  DolibarrApi
object
_filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

from  DolibarrApi
object
_cleanObjectDatas(object $object)

Clean sensible object datas

static bool
_checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

from  DolibarrApi
bool|string
_checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

from  DolibarrApi
static string
_forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

from  DolibarrApi
array
index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $sqlfilters = '', string $properties = '')

List Currencies

object
get(int $id)

Get properties of a Currency object

array|mixed
getByCode(string $code)

Get properties of a Currency object by code

array|mixed
getRates(int $id)

List Currency rates

int
post(array $request_data = null)

Create Currency object

object
put(int $id, array $request_data = null)

Update Currency

array
delete(int $id)

Delete Currency

object|false
updateRate(int $id, array $request_data = null)

Update Currency rate

object
_cleanObjectDatasRate(MultiCurrency $object)

Clean sensible MultiCurrencyRate object datas

Details

at line 36
__construct()

Constructor

in DolibarrApi at line 98
protected string|array<string, mixed> _checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

Parameters

string $field

Field name
string|string[] $value

Value to check/clean
object $object Object

Return Value

string|array<string, mixed>

Value cleaned

in DolibarrApi at line 156
protected object _filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

Parameters

object $object

Object to clean
string $properties

Comma separated list of properties names

Return Value

object

Object with cleaned properties

at line 373
protected object _cleanObjectDatas(object $object)

Clean sensible object datas

Parameters

object $object

Object to clean

Return Value

object

Object with cleaned properties

in DolibarrApi at line 393
static protected bool _checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

Parameters

string $resource

element to check
int $resource_id

Object ID if we want to check a particular record (optional) is linked to a owned thirdparty (optional).
string $dbtablename

'TableName&SharedElement' with Tablename is table where object is stored. SharedElement is an optional key to define where to check entity. Not used if objectid is null (optional)
string $feature2

Feature to check, second level of permission (optional). Can be or check with 'level1|level2'.
string $dbt_keyfield

Field name for socid foreign key if not fk_soc. Not used if objectid is null (optional)
string $dbt_select

Field name for select if not rowid. Not used if objectid is null (optional)

Return Value

bool

in DolibarrApi at line 421
protected bool|string _checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string $sqlfilters

sqlfilter string
string $error

Error message

Return Value

bool|string

True if valid, False if not valid

in DolibarrApi at line 439
static protected string _forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string[] $matches

Array of found string by regex search. Each entry is 1 and only 1 criteria. Example: "t.ref:like:'SO-%'", "t.date_creation:<:'20160101'", "t.date_creation:<:'2016-01-01 12:30:00'", "t.nature:is:NULL", "t.field2:isnot:NULL"

Return Value

string

Forged criteria. Example: "t.field like 'abc%'"

at line 60
array index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $sqlfilters = '', string $properties = '')

List Currencies

Get a list of Currencies

Parameters

string $sortfield

Sort field
string $sortorder

Sort order
int $limit

Limit for list
int $page

Page number
string $sqlfilters

Other criteria to filter answers separated by a comma. Syntax example "(t.product_id:=:1) and (t.date_creation:<:'20160101')"
string $properties

Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names

Return Value

array

Array of warehouse objects

Exceptions

RestException

at line 123
object get(int $id)

Get properties of a Currency object

Return an array with Currency information

Parameters

int $id

ID of Currency

Return Value

object

Object with cleaned properties

Exceptions

RestException

at line 148
array|mixed getByCode(string $code)

Get properties of a Currency object by code

Return an array with Currency information

Parameters

string $code

Code of Currency (ex: EUR)

Return Value

array|mixed

Data without useless information

Exceptions

RestException

at line 173
array|mixed getRates(int $id)

List Currency rates

Get a list of Currency rates

Parameters

int $id

ID of Currency

Return Value

array|mixed

Data without useless information

Exceptions

RestException

at line 206
int post(array $request_data = null)

Create Currency object

Parameters

array $request_data

Request data

Return Value

int

ID of Currency

Exceptions

RestException

at line 261
object put(int $id, array $request_data = null)

Update Currency

Parameters

int $id

Id of Currency to update
array $request_data Data

Return Value

object

The updated Currency

Exceptions

RestException

at line 302
array delete(int $id)

Delete Currency

Parameters

int $id

Currency ID

Return Value

array

Exceptions

RestException

at line 338
object|false updateRate(int $id, array $request_data = null)

Update Currency rate

Parameters

int $id

Currency ID
array $request_data

Request data

Return Value

object|false

Object with cleaned properties

Exceptions

RestException

at line 399
protected object _cleanObjectDatasRate(MultiCurrency $object)

Clean sensible MultiCurrencyRate object datas

Parameters

MultiCurrency $object

Object to clean

Return Value

object

Object with cleaned properties