Interventions

Since: 7.0.0 Initial implementation

class Interventions extends DolibarrApi (View source)

API class for Interventions

Properties

protected DoliDB $db from  DolibarrApi
Restler $r from  DolibarrApi
static string[] $FIELDS
static string[] $FIELDSLINE
Fichinter $fichinter

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 data

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, string $ref = '', string $ref_ext = '', int $contact_list = 1)

Get an intervention Return an array with intervention information

array
index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $thirdparty_ids = '', string $sqlfilters = '', string $properties = '', string $contact_type = '', bool $pagination_data = false, int $loadlinkedobjects = 0)

List interventions

int
post(array $request_data = null)

Create an intervention

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

Update intervention general fields (won't touch lines of fichinter)

int
postLine(int $id, array $request_data = null)

Add a line to an intervention

array
delete(int $id)

Delete an intervention

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

Validate an intervention

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

Close an intervention

object
deleteInterventionalLine(int $id, int $lineid)

Delete the line of the interventional.

object
settodraft(int $id)

Sets an intervention as draft

object
addContact(int $id, int $fk_socpeople, string $type_contact, string $source, int $notrigger = 0)

Adds a contact to an interventional

array<int, mixed>
getContacts(int $id, string $type = '')

Get contacts of given interventional

object
deleteContact(int $id, int $contactid, string $type)

Delete a contact type of given interventional

object|false
updateInterventionalLine(int $id, int $lineid, array $request_data)

update the line of the interventional.

Details

at line 70
__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 864
protected object _cleanObjectDatas(object $object)

Clean sensible object data

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 91
object get(int $id, string $ref = '', string $ref_ext = '', int $contact_list = 1)

Since: 7.0.0 Initial implementation

Get an intervention Return an array with intervention information

Parameters

int $id

ID of intervention
string $ref

Ref of object
string $ref_ext

External reference of object
int $contact_list

0: Returned array of contacts/addresses contains all properties, 1: Return array contains just id, -1: Do not return contacts/adddesses

Return Value

object

Cleaned intervention object

Exceptions

RestException

at line 146
array index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $thirdparty_ids = '', string $sqlfilters = '', string $properties = '', string $contact_type = '', bool $pagination_data = false, int $loadlinkedobjects = 0)

Since: 7.0.0 Initial implementation

List interventions

Get a list of interventions

Parameters

string $sortfield

Sort field
string $sortorder

Sort order
int $limit

Limit for list
int $page

Page number
string $thirdparty_ids

Thirdparty ids to filter orders of (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 property names
string $contact_type

Type of contacts: thirdparty, internal or external
bool $pagination_data

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

Load also linked objects

Return Value

array

Array of order objects

Exceptions

RestException

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

Since: 7.0.0 Initial implementation

Create an intervention

Parameters

array $request_data

Request data

Return Value

int

ID of created intervention

Exceptions

RestException

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

Since: 22.0.0 Initial implementation

Update intervention general fields (won't touch lines of fichinter)

Parameters

int $id

ID of fichinter to update
array $request_data

Request data

Return Value

object

Updated object

Exceptions

RestException

at line 398
int postLine(int $id, array $request_data = null)

Since: 7.0.0 Initial implementation

Add a line to an intervention

Parameters

int $id

ID of intervention to update
array $request_data

Request data

Return Value

int

0 if ok, <0 if ko

Exceptions

RestException

at line 451
array delete(int $id)

Since: 8.0.0 Initial implementation

Delete an intervention

Parameters

int $id

Intervention ID

Return Value

array

Exceptions

RestException

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

Since: 7.0.0 Initial implementation

Validate an intervention

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

Parameters

int $id

Intervention ID
int $notrigger

1=Does not execute triggers, 0= execute triggers

Return Value

object

Exceptions

RestException

at line 544
object close(int $id, int $notrigger = 0)

Since: 7.0.0 Initial implementation

Close an intervention

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

Parameters

int $id

Intervention ID
int $notrigger

1=Does not execute triggers, 0= execute triggers {@required true}

Return Value

object

Exceptions

RestException

at line 583
object deleteInterventionalLine(int $id, int $lineid)

Delete the line of the interventional.

Parameters

int $id

ID of the interventional
int $lineid

ID of the line to delete

Return Value

object

Object with cleaned properties

Exceptions

RestException

at line 632
object settodraft(int $id)

Since: 23.0.0 Initial implementation

Sets an intervention as draft

Parameters

int $id

ID of intervention

Return Value

object

Object with cleaned properties

Exceptions

RestException
RestException
RestException
RestException

at line 676
object addContact(int $id, int $fk_socpeople, string $type_contact, string $source, int $notrigger = 0)

Adds a contact to an interventional

Parameters

int $id

Order ID
int $fk_socpeople

Id of thirdparty contact (if source = 'external') or id of user (if source = 'internal') to link
string $type_contact

Type of contact (code). Must a code found into table llx_c_type_contact. For example: BILLING
string $source

external=Contact extern (llx_socpeople), internal=Contact intern (llx_user)
int $notrigger

Disable all triggers

Return Value

object

Exceptions

RestException
RestException
RestException
RestException

at line 716
array<int, mixed> getContacts(int $id, string $type = '')

Get contacts of given interventional

Return an array with contact information

Parameters

int $id

ID of interventional
string $type

Type of the interventional

Return Value

array<int, mixed>

Object with cleaned properties

Exceptions

RestException

at line 754
object deleteContact(int $id, int $contactid, string $type)

Delete a contact type of given interventional

Parameters

int $id

Id of interventional to update
int $contactid

Row key of the contact in the array contact_ids.
string $type

Type of the contact (BILLING, SHIPPING, CUSTOMER).

Return Value

object

Object deleted

Exceptions

RestException
RestException
RestException

at line 798
object|false updateInterventionalLine(int $id, int $lineid, array $request_data)

update the line of the interventional.

Parameters

int $id

Id of order to update
int $lineid

Id of line to update
array $request_data

InternventionalLine data

Return Value

object|false

Object with cleaned properties

Exceptions

RestException