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

NEW : api setup - Add dictionnary holiday lists (#36402)

Browse Source 
* Add methods to retrieve holiday and public holiday lists

* Fix SQL query formatting in api_setup.class.php

* Add user permission checks for API access

Added permission checks for user access rights before fetching data for expense reports, holidays, and HR public holidays.
This commit is contained in:
Charlène Benke
2025-11-25 14:21:58 +01:00
committed by GitHub
parent 5377df3ba7
commit 712da5b172
1 changed files with 161 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -977,6 +977,10 @@ class Setup extends DolibarrApi
{
$list = array();
if (!DolibarrApiAccess::$user->hasRight('expensereport', 'lire')) {
throw new RestException(403);
}
$sql = "SELECT id, code, label, accountancy_code, active, module, position";
$sql .= " FROM ".MAIN_DB_PREFIX."c_type_fees as t";
$sql .= " WHERE t.active = ".((int) $active);
@@ -1019,6 +1023,163 @@ class Setup extends DolibarrApi
return $list;
}
/**
* Get the list of holiday types.
*
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Number of items per page
* @param int $page Page number (starting from zero)
* @param string $fk_country To filter on country
* @param int $active Holiday is active or not {@min 0} {@max 1}
* @param string $lang Code of the language the label of the holiday must be translated to
* @param string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"
* @return array List of holiday types
* @phan-return array<Object|false>
* @phpstan-return array<Object|false>
*
* @url GET dictionary/holiday_types
*
* @throws RestException 400 Bad value for sqlfilters
* @throws RestException 503 Error when retrieving list of holiday types
*/
public function getListOfHolidayTypes($sortfield = "sortorder", $sortorder = 'ASC', $limit = 100, $page = 0, $fk_country = '', $active = 1, $lang = '', $sqlfilters = '')
{
global $langs;
$langs->loadLangs(array('holiday'));
if (!DolibarrApiAccess::$user->hasRight('holiday', 'lire')) {
throw new RestException(403);
}
$list = array();
$sql = "SELECT rowid, code, label, affect, delay, newbymonth, fk_country";
$sql .= " FROM ".MAIN_DB_PREFIX."c_holiday_types as t";
$sql .= " WHERE t.active = ".((int) $active);
if ($fk_country) {
$sql .= " AND (t.fk_country = ".((int) $fk_country);
$sql .= " OR t.fk_country is null)";
}
// Add sql filters
if ($sqlfilters) {
$errormessage = '';
$sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
if ($errormessage) {
throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
}
}
$sql .= $this->db->order($sortfield, $sortorder);
if ($limit) {
if ($page < 0) {
$page = 0;
}
$offset = $limit * $page;
$sql .= $this->db->plimit($limit, $offset);
}
$result = $this->db->query($sql);
if ($result) {
$num = $this->db->num_rows($result);
$min = min($num, ($limit <= 0 ? $num : $limit));
for ($i = 0; $i < $min; $i++) {
$holiday = $this->db->fetch_object($result);
$tmplabel = $langs->trans($holiday->code);
if ($tmplabel != $holiday->code) {
$holiday->label = $tmplabel;
}
//$this->translateLabel($holiday, $lang, 'Holiday', array('dict'));
$list[] = $holiday;
}
} else {
throw new RestException(503, 'Error when retrieving list of holiday : '.$this->db->lasterror());
}
return $list;
}
/**
* Get the list of public holiday.
*
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Number of items per page
* @param int $page Page number (starting from zero)
* @param string $fk_country To filter on country
* @param int $active Holiday is active or not {@min 0} {@max 1}
* @param string $lang Code of the language the label of the holiday must be translated to
* @param string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"
* @return array List of public holiday
* @phan-return array<Object|false>
* @phpstan-return array<Object|false>
*
* @url GET dictionary/public_holiday
*
* @throws RestException 400 Bad value for sqlfilters
* @throws RestException 503 Error when retrieving list of holiday types
*/
public function getListOfPublicHolidays($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $fk_country = '', $active = 1, $lang = '', $sqlfilters = '')
{
global $langs;
$langs->loadLangs(array('hrm'));
if (!DolibarrApiAccess::$user->hasRight('holiday', 'lire')) {
throw new RestException(403);
}
$list = array();
$sql = "SELECT id, code, dayrule, day, month, year, fk_country, code as label";
$sql .= " FROM ".MAIN_DB_PREFIX."c_hrm_public_holiday as t";
$sql .= " WHERE t.active = ".((int) $active);
if ($fk_country) {
$sql .= " AND (t.fk_country = ".((int) $fk_country);
$sql .= " OR t.fk_country is null)";
}
// Add sql filters
if ($sqlfilters) {
$errormessage = '';
$sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
if ($errormessage) {
throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
}
}
$sql .= $this->db->order($sortfield, $sortorder);
if ($limit) {
if ($page < 0) {
$page = 0;
}
$offset = $limit * $page;
$sql .= $this->db->plimit($limit, $offset);
}
$result = $this->db->query($sql);
if ($result) {
$num = $this->db->num_rows($result);
$min = min($num, ($limit <= 0 ? $num : $limit));
for ($i = 0; $i < $min; $i++) {
$holiday = $this->db->fetch_object($result);
$tmplabel = $langs->trans($holiday->code);
if ($tmplabel != $holiday->code) {
$holiday->label = $tmplabel;
}
//$this->translateLabel($holiday, $lang, 'Holiday', array('dict'));
$list[] = $holiday;
}
} else {
throw new RestException(503, 'Error when retrieving list of public holiday : '.$this->db->lasterror());
}
return $list;
}
/**
* Get the list of contacts types.