Contracts

class Contracts extends DolibarrApi (View source)

API class for contracts

Properties

protected DoliDB $db from  DolibarrApi
Restler $r from  DolibarrApi
static string[] $FIELDS
Contrat $contract

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, string $properties = '', bool $withLines = true)

Get properties of a contract object

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

List contracts

int
post(array $request_data = null)

Create contract object

array
getLines(int $id, string $sortfield = "d.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $sqlfilters = '', string $properties = '', bool $pagination_data = false)

Get lines of a contract

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

Add a line to given contract

object|bool
putLine(int $id, int $lineid, array $request_data = null)

Update a line to given contract

object|bool
activateLine(int $id, int $lineid, string $datestart, string $dateend = null, string $comment = null)

Activate a service line of a given contract

object|bool
unactivateLine(int $id, int $lineid, string $datestart, string $comment = null)

Unactivate a service line of a given contract

array|mixed
deleteLine(int $id, int $lineid)

Delete a line to given contract

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

Update contract general fields (won't touch lines of contract)

array
delete(int $id)

Delete contract

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

Validate a contract

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

Close all services of a contract

Details

at line 52
__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 977
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 73
object get(int $id, string $properties = '', bool $withLines = true)

Get properties of a contract object

Return an array with contract information

Parameters

int $id

ID of contract
string $properties

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

true or false to display or hide lines

Return Value

object

Object with cleaned properties

Exceptions

RestException
RestException
RestException

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

List contracts

Get a list of contracts

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 contracts 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 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*
bool $withLines

true or false to display or hide lines

Return Value

array

Array of order objects

Exceptions

RestException
RestException
RestException

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

Create contract object

Parameters

array $request_data

Request data

Return Value

int

ID of contrat

Exceptions

RestException
RestException
RestException
RestException

at line 309
array getLines(int $id, string $sortfield = "d.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $sqlfilters = '', string $properties = '', bool $pagination_data = false)

Get lines of a contract

Parameters

int $id

Id of contract
string $sortfield

Sort field
string $sortorder

Sort order
int $limit

Limit for list
int $page

Page number
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

Array of contrat det objects

Exceptions

RestException
RestException

at line 400
int|bool postLine(int $id, array $request_data = null)

Add a line to given contract

Parameters

int $id

Id of contrat to update
array $request_data

Contractline data

Return Value

int|bool

at line 460
object|bool putLine(int $id, int $lineid, array $request_data = null)

Update a line to given contract

Parameters

int $id

Id of contrat to update
int $lineid

Id of line to update
array $request_data

Contractline data

Return Value

object|bool

at line 611
object|bool activateLine(int $id, int $lineid, string $datestart, string $dateend = null, string $comment = null)

Activate a service line of a given contract

Parameters

int $id

Id of contract to activate
int $lineid

Id of line to activate
string $datestart

{@from body} Date start {@type timestamp}
string $dateend

{@from body} Date end {@type timestamp}
string $comment

{@from body} Comment

Return Value

object|bool

Exceptions

RestException
RestException

at line 652
object|bool unactivateLine(int $id, int $lineid, string $datestart, string $comment = null)

Unactivate a service line of a given contract

Parameters

int $id

Id of contract to activate
int $lineid

Id of line to activate
string $datestart

{@from body} Date start {@type timestamp}
string $comment

{@from body} Comment

Return Value

object|bool

Exceptions

RestException
RestException

at line 692
array|mixed deleteLine(int $id, int $lineid)

Delete a line to given contract

Parameters

int $id

Id of contract to update
int $lineid

Id of line to delete

Return Value

array|mixed

Exceptions

RestException
RestException

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

Update contract general fields (won't touch lines of contract)

Parameters

int $id

Id of contract to update
array $request_data Data

Return Value

object

Updated object

Exceptions

RestException
RestException
RestException
RestException

at line 822
array delete(int $id)

Delete contract

Parameters

int $id

Contract ID

Return Value

array

Exceptions

RestException
RestException
RestException
RestException

at line 875
array validate(int $id, int $notrigger = 0)

Validate a contract

Parameters

int $id

Contract ID
int $notrigger

1=Does not execute triggers, 0= execute triggers

Return Value

array

Exceptions

RestException
RestException
RestException
RestException

at line 932
array close(int $id, int $notrigger = 0)

Close all services of a contract

Parameters

int $id

Contract ID
int $notrigger

1=Does not execute triggers, 0= execute triggers

Return Value

array

Exceptions

RestException
RestException
RestException
RestException