dolibarr  16.0.4
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
Interventions Class Reference
Inheritance diagram for Interventions:
Inheritance graph
[legend]
Collaboration diagram for Interventions:
Collaboration graph
[legend]

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
 _checkValForAPI ($field, $value, $object)
 Check and convert a string depending on its type/name. More...
 
 _checkFilters ($sqlfilters, &$error='')
 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 access by user to a given resource. More...
 
static _forge_criteria_callback ($matches)
 Function to forge a SQL criteria from a Generic filter string. More...
 

Detailed Description

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

Member Function Documentation

◆ _cleanObjectDatas()

Interventions::_cleanObjectDatas (   $object)
protected

Clean sensible object datas.

Parameters
Object$objectObject to clean
Returns
Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

◆ _validate()

Interventions::_validate (   $data)
private

Validate fields before create or update object.

Parameters
array$dataData to validate
Returns
array
Exceptions
RestException

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

◆ _validateLine()

Interventions::_validateLine (   $data)
private

Validate fields before create or update object.

Parameters
array$dataData to validate
Returns
array
Exceptions
RestException

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

◆ closeFichinter()

Interventions::closeFichinter (   $id)

Close an intervention.

Parameters
int$idIntervention ID

@url POST {id}/close

Returns
array

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

◆ delete()

Interventions::delete (   $id)

Delete order.

Parameters
int$idOrder ID
Returns
array

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

◆ get()

Interventions::get (   $id)

Get properties of a Expense Report object.

Return an array with Expense Report information

Parameters
int$idID of Expense Report
Returns
array|mixed Data without useless information
Exceptions
RestException

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

◆ index()

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

List of interventions.

Return a list of interventions

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
string$thirdparty_idsThirdparty ids to filter orders of (example '1' or '1,2,3') {@pattern /^[0-9,]*$/i}
string$sqlfiltersOther 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.

◆ post()

Interventions::post (   $request_data = null)

Create intervention object.

Parameters
array$request_dataRequest data
Returns
int ID of intervention

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

◆ postLine()

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

Get lines of an intervention.

Parameters
int$idId of intervention

@url GET {id}/lines

Returns
int Add a line to given intervention
Parameters
int$idId of intervention to update
array$request_dataRequest data

@url POST {id}/lines

Returns
int

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

◆ 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$idIntervention ID
int$notrigger1=Does not execute triggers, 0= execute triggers

@url POST {id}/validate

Returns
array

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


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