Wavyzz/dolibarr
2
0
Fork 1
mirror of https://github.com/Dolibarr/dolibarr.git synced 2026-02-08 00:52:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Clean code

Browse Source
This commit is contained in:
Laurent Destailleur
2023-01-04 11:36:46 +01:00
parent 4ea81b4a96
commit 43a0ccce2b
20 changed files with 302 additions and 335 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
htdocs/api/class/api_setup.class.php
View File

@@ -319,8 +319,8 @@ class Setup extends DolibarrApi
/**
* Get state by ID.
*
* @param int $id ID of state
* @return array Array of cleaned object properties
* @param int $id ID of state
* @return Object Object with cleaned properties
*
* @url GET dictionary/states/{id}
*
@@ -334,8 +334,8 @@ class Setup extends DolibarrApi
/**
* Get state by Code.
*
* @param string $code Code of state
* @return array Array of cleaned object properties
* @param string $code Code of state
* @return Object Object with cleaned properties
*
* @url GET dictionary/states/byCode/{code}
*
@@ -424,10 +424,9 @@ class Setup extends DolibarrApi
/**
* Get country by ID.
*
* @param int $id ID of country
* @param string $lang Code of the language the name of the
* country must be translated to
* @return array Array of cleaned object properties
* @param int $id ID of country
* @param string $lang Code of the language the name of the country must be translated to
* @return Object Object with cleaned properties
*
* @url GET dictionary/countries/{id}
*
@@ -441,10 +440,9 @@ class Setup extends DolibarrApi
/**
* Get country by Code.
*
* @param string $code Code of country (2 characters)
* @param string $lang Code of the language the name of the
* country must be translated to
* @return array Array of cleaned object properties
* @param string $code Code of country (2 characters)
* @param string $lang Code of the language the name of the country must be translated to
* @return Object Object with cleaned properties
*
* @url GET dictionary/countries/byCode/{code}
*
@@ -458,10 +456,9 @@ class Setup extends DolibarrApi
/**
* Get country by Iso.
*
* @param string $iso ISO of country (3 characters)
* @param string $lang Code of the language the name of the
* country must be translated to
* @return array Array of cleaned object properties
* @param string $iso ISO of country (3 characters)
* @param string $lang Code of the language the name of the country must be translated to
* @return Object Object with cleaned properties
*
* @url GET dictionary/countries/byISO/{iso}
*
@@ -475,9 +472,9 @@ class Setup extends DolibarrApi
/**
* Get state.
*
* @param int $id ID of state
* @param string $code Code of state
* @return array Array of cleaned object properties
* @param int $id ID of state
* @param string $code Code of state
* @return Object Object with cleaned properties
*
* @throws RestException
*/
@@ -498,12 +495,11 @@ class Setup extends DolibarrApi
/**
* Get country.
*
* @param int $id ID of country
* @param string $code Code of country (2 characters)
* @param string $iso ISO of country (3 characters)
* @param string $lang Code of the language the name of the
* country must be translated to
* @return array Array of cleaned object properties
* @param int $id ID of country
* @param string $code Code of country (2 characters)
* @param string $iso ISO of country (3 characters)
* @param string $lang Code of the language the name of the country must be translated to
* @return Object Object with cleaned properties
*
* @throws RestException
*/
@@ -527,12 +523,12 @@ class Setup extends DolibarrApi
/**
* Get the list of delivery times.
*
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Number of items per page
* @param int $page Page number {@min 0}
* @param int $active Delivery times is active or not {@min 0} {@max 1}
* @param string $sqlfilters SQL criteria to filter with.
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Number of items per page
* @param int $page Page number {@min 0}
* @param int $active Delivery times is active or not {@min 0} {@max 1}
* @param string $sqlfilters SQL criteria to filter with.
*
* @url GET dictionary/availability
*
@@ -592,8 +588,8 @@ class Setup extends DolibarrApi
/**
* Clean sensible object datas
*
* @param Object $object Object to clean
* @return Object Object with cleaned properties
* @param Object $object Object to clean
* @return Object Object with cleaned properties
*/
protected function _cleanObjectDatas($object)
{
@@ -1786,8 +1782,8 @@ class Setup extends DolibarrApi
/**
* Get establishment by ID.
*
* @param int $id ID of establishment
* @return array Array of cleaned object properties
* @param int $id ID of establishment
* @return Object Object with cleaned properties
*
* @url GET establishments/{id}
*
@@ -1813,7 +1809,7 @@ class Setup extends DolibarrApi
* Note that conf variables that stores security key or password hashes can't be loaded with API.
*
* @param string $constantname Name of conf variable to get
* @return array|mixed Data without useless information
* @return string Data without useless information
*
* @url GET conf/{constantname}
*
@@ -1825,7 +1821,7 @@ class Setup extends DolibarrApi
global $conf;
if (!DolibarrApiAccess::$user->admin
&& (empty($conf->global->API_LOGINS_ALLOWED_FOR_CONST_READ) || DolibarrApiAccess::$user->login != $conf->global->API_LOGINS_ALLOWED_FOR_CONST_READ)) {
&& (!getDolGlobalString('API_LOGINS_ALLOWED_FOR_CONST_READ') || DolibarrApiAccess::$user->login != getDolGlobalString('API_LOGINS_ALLOWED_FOR_CONST_READ'))) {
throw new RestException(403, 'Error API open to admin users only or to the users with logins defined into constant API_LOGINS_ALLOWED_FOR_CONST_READ');
}
@@ -1836,7 +1832,7 @@ class Setup extends DolibarrApi
throw new RestException(403, 'Forbidden. This parameter cant be read with APIs');
}
return $conf->global->$constantname;
return getDolGlobalString($constantname);
}
/**