Interventions Class Reference

Inheritance diagram for Interventions:

Collaboration diagram for Interventions:

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

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensible object datas.
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 36 of file api_interventions.class.php.

Member Function Documentation

_cleanObjectDatas()

Interventions::_cleanObjectDatas ( $object )

protected

Clean sensible object datas.

Parameters

Object

$object

Object to clean

Returns

Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

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

_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 431 of file api_interventions.class.php.

Referenced by post().

_validateLine()

Interventions::_validateLine ( $data )

private

Validate fields before create or update object.

Parameters

array

$data

Data to validate

Returns

array

Exceptions

RestException

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

Referenced by postLine().

closeFichinter()

Interventions::closeFichinter

(

$id

)

Close an intervention.

Parameters

int

$id

Intervention ID

@url POST {id}/close

Returns

Object

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

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

delete()

Interventions::delete

(

$id

)

Delete intervention.

Parameters

int

$id

Intervention ID

Returns

array

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

References DolibarrApi\_checkAccessToResource().

get()

Interventions::get

(

$id

)

Get properties of an intervention object.

Parameters

int

$id

ID of Expense Report

Returns

Object Object with cleaned properties

Exceptions

RestException

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

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

index()

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

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') {@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 theses properties. Ignored if empty. Comma separated list of properties names

Returns

array Array of order objects

Exceptions

RestException

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

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

post()

Interventions::post

(

$request_data = null

)

Create intervention object.

Parameters

array

$request_data

Request data

Returns

int ID of intervention

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

References _validate().

postLine()

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

Get lines of an intervention.

Parameters

int

$id

Id of intervention

@url GET {id}/lines

Returns

int Add a line to a given intervention

Parameters

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

@url POST {id}/lines

Returns

int

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

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

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 }

Parameters

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

@url POST {id}/validate

Returns

Object

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

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

---

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

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