Inheritance diagram for Setup:

Collaboration diagram for Setup:

Public Member Functions
	__construct ()
	Constructor.

	getOrderingMethods ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $active=1, $sqlfilters='')
	Get the list of ordering methods. More...

	getOrderingOrigins ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $active=1, $sqlfilters='')
	Get the list of ordering origins. More...

	getPaymentTypes ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $active=1, $sqlfilters='')
	Get the list of payments types. More...

	getListOfRegions ($sortfield="code_region", $sortorder='ASC', $limit=100, $page=0, $country=0, $filter='', $sqlfilters='')
	Get the list of regions. More...

	getRegionByID ($id)
	Get region by ID. More...

	getRegionByCode ($code)
	Get region by Code. More...

	getListOfStates ($sortfield="code_departement", $sortorder='ASC', $limit=100, $page=0, $country=0, $filter='', $sqlfilters='')
	Get the list of states/provinces. More...

	getStateByID ($id)
	Get state by ID. More...

	getStateByCode ($code)
	Get state by Code. More...

	getListOfCountries ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $filter='', $lang='', $sqlfilters='')
	Get the list of countries. More...

	getCountryByID ($id, $lang='')
	Get country by ID. More...

	getCountryByCode ($code, $lang='')
	Get country by Code. More...

	getCountryByISO ($iso, $lang='')
	Get country by Iso. More...

	getAvailability ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $active=1, $sqlfilters='')
	Get the list of delivery times. More...

	getListOfEventTypes ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $type='', $module='', $active=1, $sqlfilters='')
	Get the list of events types. More...

	getListOfExpenseReportsTypes ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $module='', $active=1, $sqlfilters='')
	Get the list of Expense Report types. More...

	getListOfContactTypes ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $type='', $module='', $active=1, $lang='', $sqlfilters='')
	Get the list of contacts types. More...

	getListOfCivilities ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $module='', $active=1, $lang='', $sqlfilters='')
	Get the list of civilities. More...

	getListOfCurrencies ($multicurrency=0, $sortfield="code_iso", $sortorder='ASC', $limit=100, $page=0, $active=1, $sqlfilters='')
	Get the list of currencies. More...

	getListOfExtrafields ($sortfield="t.pos", $sortorder='ASC', $elementtype='', $sqlfilters='')
	Get the list of extra fields. More...

	deleteExtrafieldsFromNames ($attrname, $elementtype)
	Delete extrafield. More...

	getExtrafields ($attrname, $elementtype)
	get Extrafield object More...

	postExtrafields ($attrname, $elementtype, $request_data=null)
	Create Extrafield object. More...

	updateExtrafields ($attrname, $elementtype, $request_data=null)
	Update Extrafield object. More...

	getListOfTowns ($sortfield="zip,town", $sortorder='ASC', $limit=100, $page=0, $zipcode='', $town='', $active=1, $sqlfilters='')
	Get the list of towns. More...

	getPaymentTerms ($sortfield="sortorder", $sortorder='ASC', $limit=100, $page=0, $active=1, $sqlfilters='')
	Get the list of payments terms. More...

	getShippingModes ($limit=100, $page=0, $active=1, $lang='', $sqlfilters='')
	Get the list of shipping methods. More...

	getListOfMeasuringUnits ($sortfield="rowid", $sortorder='ASC', $limit=100, $page=0, $active=1, $sqlfilters='')
	Get the list of measuring units. More...

	getListOfLegalForm ($sortfield="rowid", $sortorder='ASC', $limit=100, $page=0, $country=0, $active=1, $sqlfilters='')
	Get the list of legal form of business. More...

	getListOfStaff ($sortfield="id", $sortorder='ASC', $limit=100, $page=0, $active=1, $sqlfilters='')
	Get the list of staff. More...

	getListOfsocialNetworks ($sortfield="rowid", $sortorder='ASC', $limit=100, $page=0, $active=1, $sqlfilters='')
	Get the list of social networks. More...

	getTicketsCategories ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $active=1, $lang='', $sqlfilters='')
	Get the list of tickets categories. More...

	getTicketsSeverities ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $active=1, $lang='', $sqlfilters='')
	Get the list of tickets severity. More...

	getTicketsTypes ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $active=1, $lang='', $sqlfilters='')
	Get the list of tickets types. More...

	getListOfIncoterms ($sortfield="code", $sortorder='ASC', $limit=100, $page=0, $active=1, $lang='', $sqlfilters='')
	Get the list of incoterms. More...

	getCompany ()
	Get properties of company. More...

	getEstablishments ()
	Get the list of establishments. More...

	getEtablishmentByID ($id)
	Get establishment by ID. More...

	getConf ($constantname)
	Get value of a setup variables. More...

	getCheckIntegrity ($target)
	Do a test of integrity for files and setup. More...

	getModules ()
	Get list of enabled modules. 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...

	_filterObjectProperties ($object, $properties)
	Filter properties that will be returned on object. More...

	_checkFilters ($sqlfilters, &$error='')
	Return if a $sqlfilters parameter is valid Function no more used. More...

Private Member Functions
	_fetchCregion ($id, $code='')
	Get region. More...

	_fetchCstate ($id, $code='')
	Get state. More...

	_fetchCcountry ($id, $code='', $iso='', $lang='')
	Get country. More...

	translateLabel ($object, $lang, $prefix='Country', $dict=array('dict'))
	Translate the name of the object to the given language. 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 40 of file api_setup.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Setup::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

Reimplemented from DolibarrApi.

Definition at line 732 of file api_setup.class.php.

References $object.

◆ _fetchCcountry()

Setup::_fetchCcountry	(	$id,
		$code = `''`,
		$iso = `''`,
		$lang = `''`
	)

private

Get country.

Parameters

int	$id	ID of country
string	$code	Code of country (2 characters)
string	$iso	ISO of country (3 characters)
string	$lang	Code of the language the name of the country must be translated to

Returns: Object Object with cleaned properties

Exceptions

RestException

Definition at line 643 of file api_setup.class.php.

◆ _fetchCregion()

Setup::_fetchCregion	(	$id,
		$code = `''`
	)

private

Get region.

Parameters

int	$id	ID of region
string	$code	Code of region

Returns: Object Object with cleaned properties

Exceptions

RestException

Definition at line 595 of file api_setup.class.php.

◆ _fetchCstate()

Setup::_fetchCstate	(	$id,
		$code = `''`
	)

private

Get state.

Parameters

int	$id	ID of state
string	$code	Code of state

Returns: Object Object with cleaned properties

Exceptions

RestException

Definition at line 618 of file api_setup.class.php.

◆ deleteExtrafieldsFromNames()

Setup::deleteExtrafieldsFromNames	(	$attrname,
		$elementtype
	)

Delete extrafield.

Parameters

string	$attrname	extrafield attrname
string	$elementtype	extrafield elementtype

Returns: array

@url DELETE extrafields/{elementtype}/{attrname}

Definition at line 1211 of file api_setup.class.php.

◆ getAvailability()

Setup::getAvailability	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of delivery times.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number {@min 0}
int	$active	Delivery times is active or not {@min 0} {@max 1}
string	$sqlfilters	SQL criteria to filter with.

@url GET dictionary/availability

Returns: array [List of availability]

Exceptions

RestException	400 Bad value for sqlfilters
RestException	403 Access denied
RestException	503 Error when retrieving list of availabilities

Definition at line 678 of file api_setup.class.php.

◆ getCheckIntegrity()

Setup::getCheckIntegrity ( $target )

Do a test of integrity for files and setup.

Parameters

string $target Can be 'local' or 'default' or Url of the signatures file to use for the test. Must be reachable by the tested Dolibarr.

Returns: array Result of file and setup integrity check

@url GET checkintegrity

Exceptions

RestException	403 Forbidden
RestException	404 Signature file not found
RestException	500 Technical error

Definition at line 2342 of file api_setup.class.php.

◆ getCompany()

Setup::getCompany ( )

Get properties of company.

@url GET /company

Returns: array|mixed Mysoc object

Exceptions

RestException 403 Forbidden

Definition at line 2190 of file api_setup.class.php.

◆ getConf()

Setup::getConf ( $constantname )

Get value of a setup variables.

Note that conf variables that stores security key or password hashes can't be loaded with API.

Parameters

string $constantname Name of conf variable to get

Returns: string Data without useless information

@url GET conf/{constantname}

Exceptions

RestException	400 Error Bad or unknown value for constantname
RestException	403 Forbidden

Definition at line 2311 of file api_setup.class.php.

◆ getCountryByCode()

Setup::getCountryByCode	(	$code,
		$lang = `''`
	)

Get country by Code.

Parameters

string	$code	Code of country (2 characters)
string	$lang	Code of the language the name of the country must be translated to

Returns: Object Object with cleaned properties

@url GET dictionary/countries/byCode/{code}

Exceptions

RestException	404 Country not found
RestException	503 Error retrieving country

Definition at line 564 of file api_setup.class.php.

◆ getCountryByID()

Setup::getCountryByID	(	$id,
		$lang = `''`
	)

Get country by ID.

Parameters

int	$id	ID of country
string	$lang	Code of the language the name of the country must be translated to

Returns: Object Object with cleaned properties

@url GET dictionary/countries/{id}

Exceptions

RestException	404 Country not found
RestException	503 Error retrieving country

Definition at line 547 of file api_setup.class.php.

◆ getCountryByISO()

Setup::getCountryByISO	(	$iso,
		$lang = `''`
	)

Get country by Iso.

Parameters

string	$iso	ISO of country (3 characters)
string	$lang	Code of the language the name of the country must be translated to

Returns: Object Object with cleaned properties

@url GET dictionary/countries/byISO/{iso}

Exceptions

RestException	404 Country not found
RestException	503 Error retrieving country

Definition at line 581 of file api_setup.class.php.

◆ getEstablishments()

Setup::getEstablishments ( )

Get the list of establishments.

Returns: array List of establishments

@url GET /establishments

Exceptions

RestException 503 Error when retrieving list of establishments

Definition at line 2245 of file api_setup.class.php.

◆ getEtablishmentByID()

Setup::getEtablishmentByID ( $id )

Get establishment by ID.

Parameters

int $id ID of establishment

Returns: Object Object with cleaned properties

@url GET establishments/{id}

Exceptions

RestException	404 Establishment not found
RestException	503 Error when retrieving establishment

Definition at line 2284 of file api_setup.class.php.

◆ getExtrafields()

Setup::getExtrafields	(	$attrname,
		$elementtype
	)

get Extrafield object

Parameters

string	$attrname	extrafield attrname
string	$elementtype	extrafield elementtype

Returns: array List of extra fields

@url GET extrafields/{elementtype}/{attrname}

@suppress PhanPluginUnknownArrayMethodParamType Luracast limitation

Definition at line 1249 of file api_setup.class.php.

◆ getListOfCivilities()

Setup::getListOfCivilities	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$module = `''`,
		$active = `1`,
		$lang = `''`,
		$sqlfilters = `''`
	)

Get the list of civilities.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
string	$module	To filter on module events
int	$active	Civility is active or not {@min 0} {@max 1}
string	$lang	Code of the language the label of the civility must be translated to
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of civility types

@url GET dictionary/civilities

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of civilities

Definition at line 993 of file api_setup.class.php.

◆ getListOfContactTypes()

Setup::getListOfContactTypes	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$type = `''`,
		$module = `''`,
		$active = `1`,
		$lang = `''`,
		$sqlfilters = `''`
	)

Get the list of contacts types.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
string	$type	To filter on type of contact
string	$module	To filter on module contacts
int	$active	Contact's type is active or not {@min 0} {@max 1}
string	$lang	Code of the language the label of the civility must be translated to
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of Contacts types

@url GET dictionary/contact_types

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of contacts types

Definition at line 924 of file api_setup.class.php.

◆ getListOfCountries()

Setup::getListOfCountries	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$filter = `''`,
		$lang = `''`,
		$sqlfilters = `''`
	)

Get the list of countries.

The names of the countries will be translated to the given language if the $lang parameter is provided. The value of $lang must be a language code supported by Dolibarr, for example 'en_US' or 'fr_FR'. The returned list is sorted by country ID.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
string	$filter	To filter the countries by name
string	$lang	Code of the language the label of the countries must be translated to
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of countries

@url GET dictionary/countries

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error retrieving list of countries

Definition at line 482 of file api_setup.class.php.

◆ getListOfCurrencies()

Setup::getListOfCurrencies	(	$multicurrency = `0`,
		$sortfield = `"code_iso"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of currencies.

Parameters

int	$multicurrency	Multicurrency rates (0: no multicurrency, 1: last rate, 2: all rates) {@min 0} {@max 2}
string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
int	$active	Payment term is active or not {@min 0} {@max 1}
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of currencies

@url GET dictionary/currencies

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of currencies

Definition at line 1058 of file api_setup.class.php.

◆ getListOfEventTypes()

Setup::getListOfEventTypes	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$type = `''`,
		$module = `''`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of events types.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
string	$type	To filter on type of event
string	$module	To filter on module events
int	$active	Event's type is active or not {@min 0} {@max 1}
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of events types

@url GET dictionary/event_types

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of events types

Definition at line 791 of file api_setup.class.php.

◆ getListOfExpenseReportsTypes()

Setup::getListOfExpenseReportsTypes	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$module = `''`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of Expense Report types.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
string	$module	To filter on module
int	$active	Event's type is active or not {@min 0} {@max 1}
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of expense report types

@url GET dictionary/expensereport_types

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of expense report types

Definition at line 858 of file api_setup.class.php.

◆ getListOfExtrafields()

Setup::getListOfExtrafields	(	$sortfield = `"t.pos"`,
		$sortorder = `'ASC'`,
		$elementtype = `''`,
		$sqlfilters = `''`
	)

Get the list of extra fields.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
string	$elementtype	Type of element ('adherent', 'commande', 'thirdparty', 'facture', 'propal', 'product', ...)
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.label:like:'SO-%')"

Returns: array List of extra fields

@url GET extrafields

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of extra fields

Definition at line 1128 of file api_setup.class.php.

◆ getListOfIncoterms()

Setup::getListOfIncoterms	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$lang = `''`,
		$sqlfilters = `''`
	)

Get the list of incoterms.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
int	$active	Payment term is active or not {@min 0} {@max 1}
string	$lang	Code of the language the label of the type must be translated to
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of incoterm types

@url GET dictionary/incoterms

Exceptions

RestException 503 Error when retrieving list of incoterms types

Definition at line 2135 of file api_setup.class.php.

◆ getListOfLegalForm()

Setup::getListOfLegalForm	(	$sortfield = `"rowid"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$country = `0`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of legal form of business.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
int	$country	To filter on country
int	$active	Lega form is active or not {@min 0} {@max 1}
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of legal form

@url GET dictionary/legal_form

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of legal form

Definition at line 1758 of file api_setup.class.php.

◆ getListOfMeasuringUnits()

Setup::getListOfMeasuringUnits	(	$sortfield = `"rowid"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of measuring units.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
int	$active	Measuring unit is active or not {@min 0} {@max 1}
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of measuring unit

@url GET dictionary/units

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of measuring units

Definition at line 1698 of file api_setup.class.php.

◆ getListOfRegions()

Setup::getListOfRegions	(	$sortfield = `"code_region"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$country = `0`,
		$filter = `''`,
		$sqlfilters = `''`
	)

Get the list of regions.

The returned list is sorted by region ID.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
int	$country	To filter on country
string	$filter	To filter the regions by name
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of regions

@url GET dictionary/regions

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error retrieving list of regions

Definition at line 266 of file api_setup.class.php.

◆ getListOfsocialNetworks()

Setup::getListOfsocialNetworks	(	$sortfield = `"rowid"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of social networks.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
int	$active	Social network is active or not {@min 0} {@max 1}
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of social networks

@url GET dictionary/socialnetworks

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of social networks

Definition at line 1879 of file api_setup.class.php.

◆ getListOfStaff()

Setup::getListOfStaff	(	$sortfield = `"id"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of staff.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
int	$active	Staff is active or not {@min 0} {@max 1}
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of staff

@url GET dictionary/staff

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of staff

Definition at line 1820 of file api_setup.class.php.

◆ getListOfStates()

Setup::getListOfStates	(	$sortfield = `"code_departement"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$country = `0`,
		$filter = `''`,
		$sqlfilters = `''`
	)

Get the list of states/provinces.

The names of the states will be translated to the given language if the $lang parameter is provided. The value of $lang must be a language code supported by Dolibarr, for example 'en_US' or 'fr_FR'. The returned list is sorted by state ID.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
int	$country	To filter on country
string	$filter	To filter the states by name
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of states

@url GET dictionary/states

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error retrieving list of states

Definition at line 373 of file api_setup.class.php.

◆ getListOfTowns()

Setup::getListOfTowns	(	$sortfield = `"zip,town"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$zipcode = `''`,
		$town = `''`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of towns.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
string	$zipcode	To filter on zipcode
string	$town	To filter on city name
int	$active	Town is active or not {@min 0} {@max 1}
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of towns

@url GET dictionary/towns

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of towns

Definition at line 1505 of file api_setup.class.php.

◆ getModules()

Setup::getModules ( )

Get list of enabled modules.

@url GET /modules

Returns: array|mixed Data without useless information

Exceptions

RestException 403 Forbidden

Definition at line 2660 of file api_setup.class.php.

◆ getOrderingMethods()

Setup::getOrderingMethods	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of ordering methods.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number {@min 0}
int	$active	Payment type is active or not {@min 0} {@max 1}
string	$sqlfilters	SQL criteria to filter with. Syntax example "(t.code:=:'OrderByWWW')"

@url GET dictionary/ordering_methods

Returns: array [List of ordering methods]

Exceptions

RestException	400 Bad value for sqlfilters
RestException	403 Access denied
RestException	503 Error retrieving list of ordering methods

Definition at line 71 of file api_setup.class.php.

◆ getOrderingOrigins()

Setup::getOrderingOrigins	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of ordering origins.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number {@min 0}
int	$active	Payment type is active or not {@min 0} {@max 1}
string	$sqlfilters	SQL criteria to filter with. Syntax example "(t.code:=:'OrderByWWW')"

Returns: array [List of ordering reasons]

@url GET dictionary/ordering_origins

Exceptions

RestException	400 Bad value for sqlfilters
RestException	403 Access denied
RestException	503 Error retrieving list of ordering origins

Definition at line 135 of file api_setup.class.php.

◆ getPaymentTerms()

Setup::getPaymentTerms	(	$sortfield = `"sortorder"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of payments terms.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number {@min 0}
int	$active	Payment term is active or not {@min 0} {@max 1}
string	$sqlfilters	SQL criteria to filter. Syntax example "(t.code:=:'CHQ')"

@url GET dictionary/payment_terms

Returns: array List of payment terms

Exceptions

RestException	400 Bad value for sqlfilters
RestException	403 Access denied
RestException	503 Error when retrieving list of payments terms

Definition at line 1572 of file api_setup.class.php.

◆ getPaymentTypes()

Setup::getPaymentTypes	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$sqlfilters = `''`
	)

Get the list of payments types.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number {@min 0}
int	$active	Payment type is active or not {@min 0} {@max 1}
string	$sqlfilters	SQL criteria to filter with. Syntax example "(t.code:=:'CHQ')"

@url GET dictionary/payment_types

Returns: array [List of payment types]

Exceptions

RestException	400 Bad value for sqlfilters
RestException	403 Access denied
RestException	503 Error retrieving list of payment types

Definition at line 200 of file api_setup.class.php.

◆ getRegionByCode()

Setup::getRegionByCode ( $code )

Get region by Code.

Parameters

string $code Code of region

Returns: Object Object with cleaned properties

@url GET dictionary/regions/byCode/{code}

Exceptions

RestException	404 Region not found
RestException	503 Error when retrieving region

Definition at line 346 of file api_setup.class.php.

◆ getRegionByID()

Setup::getRegionByID ( $id )

Get region by ID.

Parameters

int $id ID of region

Returns: Object Object with cleaned properties

@url GET dictionary/regions/{id}

Exceptions

RestException	404 Region not found
RestException	503 Error retrieving region

Definition at line 330 of file api_setup.class.php.

◆ getShippingModes()

Setup::getShippingModes	(	$limit = `100`,
		$page = `0`,
		$active = `1`,
		$lang = `''`,
		$sqlfilters = `''`
	)

Get the list of shipping methods.

Parameters

int	$limit	Number of items per page
int	$page	Page number {@min 0}
int	$active	Shipping methodsm is active or not {@min 0} {@max 1}
string	$lang	Code of the language the label of the method must be translated to
string	$sqlfilters	SQL criteria to filter. Syntax example "(t.code:=:'CHQ')"

@url GET dictionary/shipping_methods

Returns: array List of shipping methods

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of shipping modes

Definition at line 1636 of file api_setup.class.php.

◆ getStateByCode()

Setup::getStateByCode ( $code )

Get state by Code.

Parameters

string $code Code of state

Returns: Object Object with cleaned properties

@url GET dictionary/states/byCode/{code}

Exceptions

RestException	404 State not found
RestException	503 Error retrieving state

Definition at line 455 of file api_setup.class.php.

◆ getStateByID()

Setup::getStateByID ( $id )

Get state by ID.

Parameters

int $id ID of state

Returns: Object Object with cleaned properties

@url GET dictionary/states/{id}

Exceptions

RestException	404 State not found
RestException	503 Error retrieving state

Definition at line 439 of file api_setup.class.php.

◆ getTicketsCategories()

Setup::getTicketsCategories	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$lang = `''`,
		$sqlfilters = `''`
	)

Get the list of tickets categories.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
int	$active	Payment term is active or not {@min 0} {@max 1}
string	$lang	Code of the language the label of the category must be translated to
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of ticket categories

@url GET dictionary/ticket_categories

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of tickets categories

Definition at line 1946 of file api_setup.class.php.

◆ getTicketsSeverities()

Setup::getTicketsSeverities	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$lang = `''`,
		$sqlfilters = `''`
	)

Get the list of tickets severity.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
int	$active	Payment term is active or not {@min 0} {@max 1}
string	$lang	Code of the language the label of the severity must be translated to
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of ticket severities

@url GET dictionary/ticket_severities

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of tickets severities

Definition at line 2009 of file api_setup.class.php.

◆ getTicketsTypes()

Setup::getTicketsTypes	(	$sortfield = `"code"`,
		$sortorder = `'ASC'`,
		$limit = `100`,
		$page = `0`,
		$active = `1`,
		$lang = `''`,
		$sqlfilters = `''`
	)

Get the list of tickets types.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Number of items per page
int	$page	Page number (starting from zero)
int	$active	Payment term is active or not {@min 0} {@max 1}
string	$lang	Code of the language the label of the type must be translated to
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"

Returns: array List of ticket types

@url GET dictionary/ticket_types

Exceptions

RestException	400 Bad value for sqlfilters
RestException	503 Error when retrieving list of tickets types

Definition at line 2072 of file api_setup.class.php.

◆ postExtrafields()

Setup::postExtrafields	(	$attrname,
		$elementtype,
		$request_data = `null`
	)

Create Extrafield object.

Parameters

string	$attrname	extrafield attrname
string	$elementtype	extrafield elementtype
array	$request_data	Request datas

Returns: int ID of extrafield

@url POST extrafields/{elementtype}/{attrname}

@suppress PhanPluginUnknownArrayMethodParamType Luracast limitation

Definition at line 1326 of file api_setup.class.php.

◆ translateLabel()

Setup::translateLabel	(	$object,
		$lang,
		$prefix = `'Country'`,
		$dict = `array('dict')`
	)

private

Translate the name of the object to the given language.

Parameters

object	$object	Object with label to translate
string	$lang	Code of the language the name of the object must be translated to
string	$prefix	Prefix for translation key
array	$dict	Array of dictionary for translation

Returns: void

Definition at line 752 of file api_setup.class.php.

◆ updateExtrafields()

Setup::updateExtrafields	(	$attrname,
		$elementtype,
		$request_data = `null`
	)

Update Extrafield object.

Parameters

string	$attrname	extrafield attrname
string	$elementtype	extrafield elementtype
array	$request_data	Request datas

Returns: int ID of extrafield

@url PUT extrafields/{elementtype}/{attrname}

@suppress PhanPluginUnknownArrayMethodParamType Luracast limitation

Definition at line 1415 of file api_setup.class.php.

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

dolibarr_dev/htdocs/api/class/api_setup.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _fetchCcountry()

◆ _fetchCregion()

◆ _fetchCstate()

◆ deleteExtrafieldsFromNames()

◆ getAvailability()

◆ getCheckIntegrity()

◆ getCompany()

◆ getConf()

◆ getCountryByCode()

◆ getCountryByID()

◆ getCountryByISO()

◆ getEstablishments()

◆ getEtablishmentByID()

◆ getExtrafields()

◆ getListOfCivilities()

◆ getListOfContactTypes()

◆ getListOfCountries()

◆ getListOfCurrencies()

◆ getListOfEventTypes()

◆ getListOfExpenseReportsTypes()

◆ getListOfExtrafields()

◆ getListOfIncoterms()

◆ getListOfLegalForm()

◆ getListOfMeasuringUnits()

◆ getListOfRegions()

◆ getListOfsocialNetworks()

◆ getListOfStaff()

◆ getListOfStates()

◆ getListOfTowns()

◆ getModules()

◆ getOrderingMethods()

◆ getOrderingOrigins()

◆ getPaymentTerms()

◆ getPaymentTypes()

◆ getRegionByCode()

◆ getRegionByID()

◆ getShippingModes()

◆ getStateByCode()

◆ getStateByID()

◆ getTicketsCategories()

◆ getTicketsSeverities()

◆ getTicketsTypes()

◆ postExtrafields()

◆ translateLabel()

◆ updateExtrafields()