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

Public Member Functions

 __construct ()
 Constructor.
 
 get ($id)
 Get properties of a bom object. More...
 
 index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='')
 List boms. More...
 
 post ($request_data=null)
 Create bom object. More...
 
 put ($id, $request_data=null)
 Update bom. More...
 
 delete ($id)
 Delete bom. More...
 
 getLines ($id)
 Get lines of an BOM. More...
 
 postLine ($id, $request_data=null)
 Add a line to given BOM. More...
 
 putLine ($id, $lineid, $request_data=null)
 Update a line to given BOM. More...
 
 deleteLine ($id, $lineid)
 Delete a line to given BOM. 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 Function no more used. More...
 

Private Member Functions

 _validate ($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 38 of file api_boms.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Boms::_cleanObjectDatas (   $object)
protected

Clean sensible object datas.

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

Reimplemented from DolibarrApi.

Definition at line 461 of file api_boms.class.php.

◆ _validate()

Boms::_validate (   $data)
private

Validate fields before create or update object.

Parameters
array$dataArray of data to validate
Returns
array
Exceptions
RestException

Definition at line 524 of file api_boms.class.php.

◆ delete()

Boms::delete (   $id)

Delete bom.

Parameters
int$idBOM ID
Returns
array

Definition at line 256 of file api_boms.class.php.

◆ deleteLine()

Boms::deleteLine (   $id,
  $lineid 
)

Delete a line to given BOM.

Parameters
int$idId of BOM to update
int$lineidId of line to delete

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

Returns
int
Exceptions
RestException401
RestException404
RestException500

Definition at line 419 of file api_boms.class.php.

◆ get()

Boms::get (   $id)

Get properties of a bom object.

Return an array with bom informations

Parameters
int$idID of bom
Returns
array|mixed data without useless information

@url GET {id}

Exceptions
RestException

Definition at line 66 of file api_boms.class.php.

◆ getLines()

Boms::getLines (   $id)

Get lines of an BOM.

Parameters
int$idId of BOM

@url GET {id}/lines

Returns
array

Definition at line 291 of file api_boms.class.php.

◆ index()

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

List boms.

Get a list of boms

Parameters
string$sortfieldSort field
string$sortorderSort order
int$limitLimit for list
int$pagePage number
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 99 of file api_boms.class.php.

◆ post()

Boms::post (   $request_data = null)

Create bom object.

Parameters
array$request_dataRequest datas
Returns
int ID of bom

Definition at line 196 of file api_boms.class.php.

◆ postLine()

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

Add a line to given BOM.

Parameters
int$idId of BOM to update
array$request_dataBOMLine data

@url POST {id}/lines

Returns
int

Definition at line 323 of file api_boms.class.php.

◆ put()

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

Update bom.

Parameters
int$idId of bom to update
array$request_dataDatas
Returns
int

Definition at line 221 of file api_boms.class.php.

◆ putLine()

Boms::putLine (   $id,
  $lineid,
  $request_data = null 
)

Update a line to given BOM.

Parameters
int$idId of BOM to update
int$lineidId of line to update
array$request_dataBOMLine data

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

Returns
array|bool

Definition at line 369 of file api_boms.class.php.


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