Interventions Class Reference

Inheritance diagram for Interventions:

Collaboration diagram for Interventions:

Public Member Functions
	__construct ()
	Constructor.
	get ($id)
	Get properties of a Expense Report object. More...
	index ($sortfield="t.rowid", $sortorder= 'ASC', $limit=100, $page=0, $thirdparty_ids= '', $sqlfilters= '')
	List of interventions. More...
	post ($request_data=null)
	Create intervention object. More...
	postLine ($id, $request_data=null)
	Get lines of an intervention. More...
	delete ($id)
	Delete order. More...
	validate ($id, $notrigger=0)
	Validate an intervention. More...
	closeFichinter ($id)
	Close an intervention. More...
Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir= '', $refreshCache=false)
	Constructor. More...

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas. More...
Protected Member Functions inherited from DolibarrApi
	_cleanObjectDatas ($object)
	Executed method when API is called without parameter. More...
	_checkFilters ($sqlfilters)
	Return if a $sqlfilters parameter is valid. More...

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

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 user access to a resource. More...
static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria. More...

Detailed Description

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

Member Function Documentation

Interventions::_cleanObjectDatas (   $object )

protected

Clean sensible object datas.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

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

Referenced by closeFichinter(), get(), index(), and validate().

Interventions::_validate (   $data )

private

Validate fields before create or update object.

Parameters

array

$data

Data to validate

Returns

array

Exceptions

RestException

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

Referenced by post().

Interventions::_validateLine (   $data )

private

Validate fields before create or update object.

Parameters

array

$data

Data to validate

Returns

array

Exceptions

RestException

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

Referenced by postLine().

Interventions::closeFichinter

(

$id

)

Close an intervention.

Parameters

int

$id

Intervention ID

POST {id}/close

Returns

array

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

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

Interventions::delete

(

$id

)

Delete order.

Parameters

int

$id

Order ID

Returns

array

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

References DolibarrApi\_checkAccessToResource().

Interventions::get

(

$id

)

Get properties of a Expense Report object.

Return an array with Expense Report information

Parameters

int

$id

ID of Expense Report

Returns

array|mixed Data without useless information

Exceptions

RestException

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

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

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

List of interventions.

Return 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') { /^[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')"

Returns

array Array of order objects

Exceptions

RestException

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

References DolibarrApi\_checkFilters(), _cleanObjectDatas(), db, and dol_syslog().

Interventions::post

(

$request_data = null

)

Create intervention object.

Parameters

array

$request_data

Request data

Returns

int ID of intervention

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

References _validate().

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

Get lines of an intervention.

Parameters

int

$id

Id of intervention

GET {id}/lines

Returns

int Add a line to given intervention

Parameters

int	$id	Id of intervention to update
array	$request_data	Request data

POST {id}/lines

Returns

int

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

References DolibarrApi\_checkAccessToResource(), and _validateLine().

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

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

POST {id}/validate

Returns

array

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

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

---

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

• htdocs/fichinter/class/api_interventions.class.php