Boms Class Reference

Inheritance diagram for Boms:

Collaboration diagram for Boms:

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. 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

$object

Object to clean

Returns

Object Object with cleaned properties

Reimplemented from DolibarrApi.

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

_validate()

Boms::_validate (   $data )

private

Validate fields before create or update object.

Parameters

array

$data

Array of data to validate

Returns

array

Exceptions

RestException

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

delete()

Boms::delete

(

$id

)

Delete bom.

Parameters

int

$id

BOM ID

Returns

array

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

deleteLine()

Boms::deleteLine	(		$id,
			$lineid
	)

Delete a line to given BOM.

Parameters

int	$id	Id of BOM to update
int	$lineid	Id of line to delete

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

Returns

int

Exceptions

RestException	401
RestException	404
RestException	500

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

get()

Boms::get

(

$id

)

Get properties of a bom object.

Return an array with bom informations

Parameters

int

$id

ID 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

$id

Id of BOM

@url GET {id}/lines

Returns

array

Definition at line 292 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

RestException

Definition at line 99 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 197 of file api_boms.class.php.

postLine()

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

Add a line to given BOM.

Parameters

int	$id	Id of BOM to update
array	$request_data	BOMLine data

@url POST {id}/lines

Returns

int

Definition at line 324 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 222 of file api_boms.class.php.

putLine()

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

Update a line to given BOM.

Parameters

int	$id	Id of BOM to update
int	$lineid	Id of line to update
array	$request_data	BOMLine data

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

Returns

array|bool

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

---

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

• htdocs/bom/class/api_boms.class.php