Inheritance diagram for Interventions:

Collaboration diagram for Interventions:

Public Member Functions
	__construct ()
	Constructor.

	get ($id, $ref='', $ref_ext='', $contact_list=1)
	Get an intervention Return an array with intervention information.

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

	post ($request_data=null)
	Create an intervention.

	put ($id, $request_data=null)
	Update intervention general fields (won't touch lines of fichinter)

	postLine ($id, $request_data=null)
	Get lines of intervention.

	delete ($id)
	Delete an intervention.

	validate ($id, $notrigger=0)
	Validate an intervention.

	close ($id, $notrigger=0)
	Close an intervention.

	deleteInterventionalLine ($id, $lineid)
	Delete the line of the interventional.

	settodraft ($id)
	Sets an intervention as draft.

	addContact ($id, $fk_socpeople, $type_contact, $source, $notrigger=0)
	Adds a contact to an interventional.

	getContacts ($id, $type='')
	Get contacts of given interventional.

	deleteContact ($id, $contactid, $type)
	Delete a contact type of given interventional.

	updateInterventionalLine ($id, $lineid, $request_data)
	update the line of the interventional.

Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor.

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object data @phpstan-template T.

Protected Member Functions inherited from DolibarrApi
	_checkValForAPI ($field, $value, $object)
	Check and convert a string depending on its type/name.

	_filterObjectProperties ($object, $properties)
	Filter properties that will be returned on object.

	_checkFilters ($sqlfilters, &$error='')
	Return if a $sqlfilters parameter is valid Function no more used.

Private Member Functions
	_validate ($data)
	Validate fields before create or update object.

	_validateLine ($data)
	Validate fields before create or update object.

Additional Inherited Members
Static Protected Member Functions inherited from DolibarrApi
static	_checkAccessToResource ($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid')
	Check access by user to a given resource.

static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria from a Generic filter string.

Detailed Description

Definition at line 42 of file api_interventions.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Interventions::_cleanObjectDatas ( $object )

protected

Clean sensible object data @phpstan-template T.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties @phpstan-param T $object @phpstan-return T

Reimplemented from DolibarrApi.

Definition at line 878 of file api_interventions.class.php.

References $object.

Referenced by addContact(), close(), deleteContact(), deleteInterventionalLine(), get(), index(), settodraft(), updateInterventionalLine(), and validate().

◆ _validate()

Interventions::_validate ( $data )

private

Validate fields before create or update object.

Parameters

?array<null|int|float|string> $data Data to validate

Returns: array<string,null|int|float|string>

Exceptions

RestException

Definition at line 855 of file api_interventions.class.php.

Referenced by post().

◆ _validateLine()

Interventions::_validateLine ( $data )

private

Validate fields before create or update object.

Parameters

?array<string,null|int|float|string> $data Data to validate

Returns: array<string,null|int|float|string> Return array with validated mandatory fields and their value

Exceptions

RestException

Definition at line 897 of file api_interventions.class.php.

Referenced by postLine().

◆ addContact()

Interventions::addContact	(	$id,
		$fk_socpeople,
		$type_contact,
		$source,
		$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

@url POST {id}/contacts

Returns: object

Exceptions

RestException	304
RestException	401
RestException	404
RestException	500 System error

Definition at line 676 of file api_interventions.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

◆ close()

Interventions::close	(		$id,
			$notrigger = 0 )

Close an intervention.

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

Since: 7.0.0 Initial implementation; 23.0.0 Added notrigger parameter

Parameters

int	$id	Intervention ID
int	$notrigger	1=Does not execute triggers, 0= execute triggers {@required true}

@url POST {id}/close

Returns: Object

Exceptions

RestException

Definition at line 544 of file api_interventions.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

◆ delete()

Interventions::delete ( $id )

Delete an intervention.

Since: 8.0.0 Initial implementation

Parameters

int $id Intervention ID

Returns: array @phan-return array<string,array{code:int,message:string}> @phpstan-return array<string,array{code:int,message:string}>

Exceptions

RestException

Definition at line 451 of file api_interventions.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ deleteContact()

Interventions::deleteContact	(	$id,
		$contactid,
		$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).

Returns: Object Object deleted

@url DELETE {id}/contact/{contactid}/{type}

Exceptions

RestException	401
RestException	404
RestException	500 System error

Definition at line 754 of file api_interventions.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

◆ deleteInterventionalLine()

Interventions::deleteInterventionalLine	(		$id,
			$lineid )

Delete the line of the interventional.

Parameters

int	$id	ID of the interventional
int	$lineid	ID of the line to delete

Returns: Object Object with cleaned properties

Exceptions

RestException

@url DELETE /{id}/lines/{lineid}

Definition at line 583 of file api_interventions.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

◆ get()

Interventions::get	(	$id,
		$ref = '',
		$ref_ext = '',
		$contact_list = 1 )

Get an intervention Return an array with intervention information.

Since: 7.0.0 Initial implementation

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

Returns: Object Cleaned intervention object

Exceptions

RestException

Definition at line 91 of file api_interventions.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

◆ getContacts()

Interventions::getContacts	(		$id,
			$type = '' )

Get contacts of given interventional.

Return an array with contact information

Parameters

int	$id	ID of interventional
string	$type	Type of the interventional

Returns: array<int,mixed> Object with cleaned properties

@url GET {id}/contacts

Exceptions

RestException

Definition at line 716 of file api_interventions.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ index()

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

List interventions.

Get a list of interventions

Since: 7.0.0 Initial implementation

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

Returns: array Array of order objects @phan-return array<object> @phpstan-return array<object>

Exceptions

RestException

Definition at line 146 of file api_interventions.class.php.

References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), dol_syslog(), and forgeSQLFromUniversalSearchCriteria().

◆ post()

Interventions::post ( $request_data = null )

Create an intervention.

Since: 7.0.0 Initial implementation

Parameters

array $request_data Request data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: int ID of created intervention

Exceptions

RestException

Definition at line 272 of file api_interventions.class.php.

References DolibarrApi\_checkValForAPI(), _validate(), and sanitizeVal().

◆ postLine()

Interventions::postLine	(		$id,
			$request_data = null )

Get lines of intervention.

Parameters

int $id Id of intervention

@url GET {id}/lines

Returns: int Add a line to an intervention

Since: 7.0.0 Initial implementation

Parameters

int	$id	ID of intervention to update
array	$request_data	Request data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

@url POST {id}/lines

Returns: int 0 if ok, <0 if ko

Exceptions

RestException

Definition at line 398 of file api_interventions.class.php.

References $id, DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), _validateLine(), and sanitizeVal().

◆ put()

Interventions::put	(		$id,
			$request_data = null )

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

Since: 22.0.0 Initial implementation

Parameters

int	$id	ID of fichinter to update
array	$request_data	Request data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: Object Updated object

Exceptions

RestException

Definition at line 309 of file api_interventions.class.php.

References $id, DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), and sanitizeVal().

◆ settodraft()

Interventions::settodraft ( $id )

Sets an intervention as draft.

Since: 23.0.0 Initial implementation

Parameters

int $id ID of intervention

Returns: Object Object with cleaned properties

@url POST {id}/settodraft

Exceptions

RestException	304
RestException	403
RestException	404
RestException	500 System error

Definition at line 632 of file api_interventions.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

◆ updateInterventionalLine()

Interventions::updateInterventionalLine	(	$id,
		$lineid,
		$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 @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: Object Object with cleaned properties

Exceptions

RestException

@url PUT /{id}/lines/{lineid}

Definition at line 798 of file api_interventions.class.php.

References $id, DolibarrApi\_checkAccessToResource(), _cleanObjectDatas(), and sanitizeVal().

◆ validate()

Interventions::validate	(		$id,
			$notrigger = 0 )

Validate an intervention.

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

Since: 7.0.0 Initial implementation

Parameters

int	$id	Intervention ID
int	$notrigger	1=Does not execute triggers, 0= execute triggers

@url POST {id}/validate

Returns: Object

Exceptions

RestException

Definition at line 496 of file api_interventions.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

The documentation for this class was generated from the following file:

dolibarr_23.0/htdocs/fichinter/class/api_interventions.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _validate()

◆ _validateLine()

◆ addContact()

◆ close()

◆ delete()

◆ deleteContact()

◆ deleteInterventionalLine()

◆ get()

◆ getContacts()

◆ index()

◆ post()

◆ postLine()

◆ put()

◆ settodraft()

◆ updateInterventionalLine()

◆ validate()