Definition at line 37 of file api_boms.class.php.
◆ _cleanObjectDatas()
Boms::_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 290 of file api_boms.class.php.
◆ _validate()
Validate fields before create or update object.
- Parameters
-
array | $data | Array of data to validate |
- Returns
- array
- Exceptions
-
Definition at line 353 of file api_boms.class.php.
◆ delete()
◆ get()
Get properties of a bom object.
Return an array with bom informations
- Parameters
-
- Returns
- array|mixed data without useless information
@url GET {id}
- Exceptions
-
Definition at line 65 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 | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
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
-
Definition at line 98 of file api_boms.class.php.
◆ post()
Boms::post |
( |
|
$request_data = null | ) |
|
Create bom object.
- Parameters
-
array | $request_data | Request datas |
- Returns
- int ID of bom
Definition at line 196 of file api_boms.class.php.
◆ put()
Boms::put |
( |
|
$id, |
|
|
|
$request_data = null |
|
) |
| |
Update bom.
- Parameters
-
int | $id | Id of bom to update |
array | $request_data | Datas |
- Returns
- int
Definition at line 221 of file api_boms.class.php.
The documentation for this class was generated from the following file: