Boms

class Boms extends DolibarrApi (View source)

API class for BOM

Properties

protected DoliDB $db from  DolibarrApi
Restler $r from  DolibarrApi
BOM $bom

Methods

__construct()

Constructor

string|array<string, mixed>
_checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

from  DolibarrApi
object
_filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

from  DolibarrApi
object
_cleanObjectDatas(object $object)

Clean sensible object datas

static bool
_checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

from  DolibarrApi
bool|string
_checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

from  DolibarrApi
static string
_forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

from  DolibarrApi
object
get(int $id)

Get properties of a bom object

array
index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $sqlfilters = '', string $properties = '')

List boms

int
post(array $request_data = null)

Create bom object

object
put(int $id, array $request_data = null)

Update bom

array
delete(int $id)

Delete bom

array
getLines(int $id)

Get lines of an BOM

int
postLine(int $id, array $request_data = null)

Add a line to given BOM

object|bool
putLine(int $id, int $lineid, array $request_data = null)

Update a line to given BOM

array
deleteLine(int $id, int $lineid)

Delete a line to given BOM

Details

at line 49
__construct()

Constructor

in DolibarrApi at line 98
protected string|array<string, mixed> _checkValForAPI(string $field, string|string[] $value, object $object)

Check and convert a string depending on its type/name.

Parameters

string $field

Field name
string|string[] $value

Value to check/clean
object $object Object

Return Value

string|array<string, mixed>

Value cleaned

in DolibarrApi at line 156
protected object _filterObjectProperties(object $object, string $properties)

Filter properties that will be returned on object

Parameters

object $object

Object to clean
string $properties

Comma separated list of properties names

Return Value

object

Object with cleaned properties

at line 529
protected object _cleanObjectDatas(object $object)

Clean sensible object datas

Parameters

object $object

Object to clean

Return Value

object

Object with cleaned properties

in DolibarrApi at line 393
static protected bool _checkAccessToResource(string $resource, int $resource_id = 0, string $dbtablename = '', string $feature2 = '', string $dbt_keyfield = 'fk_soc', string $dbt_select = 'rowid')

Check access by user to a given resource

Parameters

string $resource

element to check
int $resource_id

Object ID if we want to check a particular record (optional) is linked to a owned thirdparty (optional).
string $dbtablename

'TableName&SharedElement' with Tablename is table where object is stored. SharedElement is an optional key to define where to check entity. Not used if objectid is null (optional)
string $feature2

Feature to check, second level of permission (optional). Can be or check with 'level1|level2'.
string $dbt_keyfield

Field name for socid foreign key if not fk_soc. Not used if objectid is null (optional)
string $dbt_select

Field name for select if not rowid. Not used if objectid is null (optional)

Return Value

bool

in DolibarrApi at line 421
protected bool|string _checkFilters(string $sqlfilters, string $error = '')

Return if a $sqlfilters parameter is valid Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string $sqlfilters

sqlfilter string
string $error

Error message

Return Value

bool|string

True if valid, False if not valid

in DolibarrApi at line 439
static protected string _forge_criteria_callback(string[] $matches)

Function to forge a SQL criteria from a Generic filter string.

Function no more used. Kept for backward compatibility with old APIs of modules

Parameters

string[] $matches

Array of found string by regex search. Each entry is 1 and only 1 criteria. Example: "t.ref:like:'SO-%'", "t.date_creation:<:'20160101'", "t.date_creation:<:'2016-01-01 12:30:00'", "t.nature:is:NULL", "t.field2:isnot:NULL"

Return Value

string

Forged criteria. Example: "t.field like 'abc%'"

at line 72
object get(int $id)

Get properties of a bom object

Return an array with bom information

Parameters

int $id

ID of bom

Return Value

object

Object with cleaned properties

Exceptions

RestException
RestException

at line 110
array index(string $sortfield = "t.rowid", string $sortorder = 'ASC', int $limit = 100, int $page = 0, string $sqlfilters = '', string $properties = '')

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')"
string $properties

Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names

Return Value

array

Array of order objects

Exceptions

RestException
RestException
RestException

at line 196
int post(array $request_data = null)

Create bom object

Parameters

array $request_data

Request data

Return Value

int

ID of bom

Exceptions

RestException
RestException

at line 237
object put(int $id, array $request_data = null)

Update bom

Parameters

int $id

Id of bom to update
array $request_data Data

Return Value

object

Object after update

Exceptions

RestException
RestException
RestException

at line 292
array delete(int $id)

Delete bom

Parameters

int $id

BOM ID

Return Value

array

Exceptions

RestException
RestException
RestException

at line 332
array getLines(int $id)

Get lines of an BOM

Parameters

int $id

Id of BOM

Return Value

array

Exceptions

RestException
RestException

at line 370
int postLine(int $id, array $request_data = null)

Add a line to given BOM

Parameters

int $id

Id of BOM to update
array $request_data

BOMLine data

Return Value

int

Exceptions

RestException
RestException
RestException

at line 424
object|bool putLine(int $id, int $lineid, array $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

Return Value

object|bool

Exceptions

RestException
RestException

at line 479
array deleteLine(int $id, int $lineid)

Delete a line to given BOM

Parameters

int $id

Id of BOM to update
int $lineid

Id of line to delete

Return Value

array

Exceptions

RestException
RestException
RestException