Holidays

Since: 23.0.0 Initial implementation

class Holidays extends DolibarrApi (View source)

API class for Leaves

Properties

protected DoliDB $db from  DolibarrApi
Restler $r from  DolibarrApi
static string[] $FIELDS
Holiday $holiday

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
object
get(int $id)

Get a leave

array<string, mixed>
index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $user_ids = '', string $sqlfilters = '', string $properties = '', bool $pagination_data = false)

List leaves

int
post(array $request_data = null)

Create a leave

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

Update expense report general fields

array
delete(int $id)

Delete holiday

object
validate(int $id, int $notrigger = 0)

Validate a holiday

object
approve(int $id, int $notrigger = 0)

Approve a leave

object
cancel(int $id, int $notrigger = 0)

Cancel a holiday

object
refuse(int $id, string $detail_refuse, int $notrigger = 0)

Refuse a holiday

object
reopen(int $id, int $notrigger = 0)

Reopen a canceled holiday

Details

at line 56
__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 581
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 76
object get(int $id)

Since: 23.0.0 Initial implementation

Get a leave

Return an array with leave information

Parameters

int $id

ID of Leave

Return Value

object

Object with cleaned properties

Exceptions

RestException

at line 114
array<string, mixed> index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $user_ids = '', string $sqlfilters = '', string $properties = '', bool $pagination_data = false)

Since: 23.0.0 Initial implementation

List leaves

Get a list of Leaves

Parameters

string $sortfield

Sort field
string $sortorder

Sort order
int $limit

List limit
int $page

Page number
string $user_ids

User ids filter field. Example: '1' or '1,2,3' {@pattern /^[0-9,]*$/i}
string $sqlfilters

Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
string $properties

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

If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0*

Return Value

array<string, mixed>

Array of order objects

Exceptions

RestException

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

Since: 23.0.0 Initial implementation

Create a leave

Parameters

array $request_data

Request data

Return Value

int

ID of Leave

Exceptions

RestException

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

Since: 23.0.0 Initial implementation

Update expense report general fields

Does not touch lines of the expense report

Parameters

int $id

Leave ID to update
array $request_data

Expense report data

Return Value

object

Updated object

Exceptions

RestException
RestException
RestException

at line 309
array delete(int $id)

Since: 23.0.0 Initial implementation

Delete holiday

Parameters

int $id

Leave Report ID

Return Value

array

Exceptions

RestException

at line 355
object validate(int $id, int $notrigger = 0)

Since: 23.0.0 Initial implementation

Validate a holiday

If you get a bad value for param notrigger check, provide this in body { "notrigger": 0 }

Parameters

int $id

Leave report ID
int $notrigger

1=Does not execute triggers, 0= execute triggers

Return Value

object

Exceptions

RestException

at line 401
object approve(int $id, int $notrigger = 0)

Since: 23.0.0 Initial implementation

Approve a leave

If you get a bad value for param notrigger check, provide this in body { "notrigger": 0 }

Parameters

int $id

Leave ID
int $notrigger

1=Does not execute triggers, 0= execute triggers

Return Value

object

Exceptions

RestException

at line 446
object cancel(int $id, int $notrigger = 0)

Since: 23.0.0 Initial implementation

Cancel a holiday

If you get a bad value for param notrigger check, provide this in body { "notrigger": 0 }

Parameters

int $id

Holiday ID
int $notrigger

1=Does not execute triggers, 0= execute triggers

Return Value

object

Exceptions

RestException

at line 493
object refuse(int $id, string $detail_refuse, int $notrigger = 0)

Since: 23.0.0 Initial implementation

Refuse a holiday

If you get a bad value for param notrigger check, provide this in body { "notrigger": 0 }

Parameters

int $id

Holiday ID
string $detail_refuse

Comments for refusal
int $notrigger

1=Does not execute triggers, 0= execute triggers

Return Value

object

Exceptions

RestException

at line 543
object reopen(int $id, int $notrigger = 0)

Since: 23.0.0 New endpoint

Reopen a canceled holiday

This method allows to reopen a holiday that was previously canceled and set its status back to VALIDATED

If you get a bad value for param notrigger check, provide this in body { "notrigger": 0 }

Parameters

int $id

Holiday ID
int $notrigger

1=Does not execute triggers, 0= execute triggers

Return Value

object

Exceptions

RestException