Setup Class Reference

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...
	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, $sqlfilters= '')
	Get the list of contacts types. More...
	getListOfCivilities ($sortfield="code", $sortorder= 'ASC', $limit=100, $page=0, $module= '', $active=1, $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', $type= '', $sqlfilters= '')
	Get the list of extra fields. 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, $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, $sqlfilters= '')
	Get the list of tickets categories. More...
	getTicketsSeverities ($sortfield="code", $sortorder= 'ASC', $limit=100, $page=0, $active=1, $sqlfilters= '')
	Get the list of tickets severity. More...
	getTicketsTypes ($sortfield="code", $sortorder= 'ASC', $limit=100, $page=0, $active=1, $sqlfilters= '')
	Get the list of tickets types. 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...
	_cleanObjectDatas ($object)
	Clean sensible object datas. More...
	_checkFilters ($sqlfilters, &$error= '')
	Return if a $sqlfilters parameter is valid. More...

Private Member Functions
	_fetchCstate ($id, $code= '')
	Get state. More...
	_fetchCcountry ($id, $code= '', $iso= '', $lang= '')
	Get country. More...
	translateLabel ($object, $lang, $prefix= 'Country')
	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 37 of file api_setup.class.php.

Member Function Documentation

Setup::_cleanObjectDatas (   $object )

protected

Clean sensible object datas.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

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

Referenced by _fetchCcountry(), _fetchCstate(), getCompany(), getEtablishmentByID(), getListOfCountries(), getListOfStates(), and getModules().

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

array Array of cleaned object properties

Exceptions

RestException

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

References _cleanObjectDatas(), db, and translateLabel().

Referenced by getCountryByCode(), getCountryByID(), and getCountryByISO().

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

private

Get state.

Parameters

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

Returns

array Array of cleaned object properties

Exceptions

RestException

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

References _cleanObjectDatas(), and db.

Referenced by getStateByCode(), and getStateByID().

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 { 0}
int	$active	Delivery times is active or not { 0} { 1}
string	$sqlfilters	SQL criteria to filter with.

GET dictionary/availability

Returns

array [List of availability]

Exceptions

RestException

400

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

References DolibarrApi\_checkFilters(), and db.

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

GET checkintegrity

Exceptions

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

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

References dol_dir_list(), dol_filemtime(), dol_filesize(), dol_is_file(), dol_sanitizeFileName(), dol_sort_array(), getFilesUpdated(), GETPOST(), getURLContent(), and load_fiche_titre().

Setup::getCompany

(

)

Get properties of company.

GET /company

Returns

array|mixed Mysoc object

Exceptions

RestException

403 Forbidden

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

References _cleanObjectDatas().

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

array|mixed Data without useless information

GET conf/{constantname}

Exceptions

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

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

References isASecretKey().

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

array Array of cleaned object properties

GET dictionary/countries/byCode/{code}

Exceptions

RestException

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

References _fetchCcountry().

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

array Array of cleaned object properties

GET dictionary/countries/{id}

Exceptions

RestException

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

References _fetchCcountry().

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

array Array of cleaned object properties

GET dictionary/countries/byISO/{iso}

Exceptions

RestException

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

References _fetchCcountry().

Setup::getEstablishments

(

)

Get the list of establishments.

Returns

array List of establishments

GET /establishments

Exceptions

RestException

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

References db.

Setup::getEtablishmentByID

(

$id

)

Get establishment by ID.

Parameters

int

$id

ID of establishment

Returns

array Array of cleaned object properties

GET establishments/{id}

Exceptions

RestException

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

References _cleanObjectDatas(), and db.

Setup::getListOfCivilities	(		$sortfield = "code",
			$sortorder = 'ASC',
			$limit = 100,
			$page = 0,
			$module = '',
			$active = 1,
			$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 { 0} { 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 civility types

GET dictionary/civilities

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

Setup::getListOfContactTypes	(		$sortfield = "code",
			$sortorder = 'ASC',
			$limit = 100,
			$page = 0,
			$type = '',
			$module = '',
			$active = 1,
			$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 { 0} { 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 Contacts types

GET dictionary/contact_types

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

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

GET dictionary/countries

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), _cleanObjectDatas(), db, and translateLabel().

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) { 0} { 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 { 0} { 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

GET dictionary/currencies

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

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 { 0} { 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

GET dictionary/event_types

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

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 { 0} { 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

GET dictionary/expensereport_types

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

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

Get the list of extra fields.

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
string	$type	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

GET extrafields

Exceptions

RestException

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

References $resql, DolibarrApi\_checkFilters(), db, and jsonOrUnserialize().

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 { 0} { 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

GET dictionary/legal_form

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

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 { 0} { 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

GET dictionary/units

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

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 { 0} { 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

GET dictionary/socialnetworks

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

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 { 0} { 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

GET dictionary/staff

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

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

GET dictionary/states

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), _cleanObjectDatas(), and db.

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 { 0} { 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

GET dictionary/towns

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

Setup::getModules

(

)

Get list of enabled modules.

GET /modules

Returns

array|mixed Data without useless information

Exceptions

RestException

403 Forbidden

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

References _cleanObjectDatas().

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 { 0}
int	$active	Payment type is active or not { 0} { 1}
string	$sqlfilters	SQL criteria to filter with. Syntax example "(t.code:=:'OrderByWWW')"

GET dictionary/ordering_methods

Returns

array [List of ordering methods]

Exceptions

RestException

400

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

References DolibarrApi\_checkFilters(), and db.

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 { 0}
int	$active	Payment type is active or not { 0} { 1}
string	$sqlfilters	SQL criteria to filter with. Syntax example "(t.code:=:'OrderByWWW')"

GET dictionary/ordering_origins

Returns

array [List of ordering reasons]

Exceptions

RestException

400

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

References DolibarrApi\_checkFilters(), and db.

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 { 0}
int	$active	Payment term is active or not { 0} { 1}
string	$sqlfilters	SQL criteria to filter. Syntax example "(t.code:=:'CHQ')"

GET dictionary/payment_terms

Returns

array List of payment terms

Exceptions

RestException

400

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

References DolibarrApi\_checkFilters(), and db.

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 { 0}
int	$active	Payment type is active or not { 0} { 1}
string	$sqlfilters	SQL criteria to filter with. Syntax example "(t.code:=:'CHQ')"

GET dictionary/payment_types

Returns

array [List of payment types]

Exceptions

RestException

400

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

References DolibarrApi\_checkFilters(), and db.

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

Get the list of shipping methods.

Parameters

int	$limit	Number of items per page
int	$page	Page number { 0}
int	$active	Shipping methodsm is active or not { 0} { 1}
string	$sqlfilters	SQL criteria to filter. Syntax example "(t.code:=:'CHQ')"

GET dictionary/shipping_methods

Returns

array List of shipping methods

Exceptions

RestException

400

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

References DolibarrApi\_checkFilters(), and db.

Setup::getStateByCode

(

$code

)

Get state by Code.

Parameters

string

$code

Code of state

Returns

array Array of cleaned object properties

GET dictionary/states/byCode/{code}

Exceptions

RestException

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

References _fetchCstate().

Setup::getStateByID

(

$id

)

Get state by ID.

Parameters

int

$id

ID of state

Returns

array Array of cleaned object properties

GET dictionary/states/{id}

Exceptions

RestException

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

References _fetchCstate().

Setup::getTicketsCategories	(		$sortfield = "code",
			$sortorder = 'ASC',
			$limit = 100,
			$page = 0,
			$active = 1,
			$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 { 0} { 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 ticket categories

GET dictionary/ticket_categories

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

Setup::getTicketsSeverities	(		$sortfield = "code",
			$sortorder = 'ASC',
			$limit = 100,
			$page = 0,
			$active = 1,
			$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 { 0} { 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 ticket severities

GET dictionary/ticket_severities

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

Setup::getTicketsTypes	(		$sortfield = "code",
			$sortorder = 'ASC',
			$limit = 100,
			$page = 0,
			$active = 1,
			$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 { 0} { 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 ticket types

GET dictionary/ticket_types

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), and db.

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

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

Returns

void

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

Referenced by _fetchCcountry(), and getListOfCountries().

---

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

• htdocs/api/class/api_setup.class.php